Diese Seite wurde von der Cloud Translation API übersetzt.

Class TextButton

Ein TextButton mit einem Textlabel. Du kannst die Hintergrundfarbe festlegen und die Schaltfläche bei Bedarf deaktivieren.

var textButton = CardService.newTextButton()
    .setText("Open Link")
    .setOpenLink(CardService.newOpenLink()
        .setUrl("https://www.google.com"));

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
`setAltText(altText)`	`TextButton`	Legt den alternativen Text der Schaltfläche für die Barrierefreiheit fest.
`setAuthorizationAction(action)`	`TextButton`	Legt eine Autorisierungsaktion fest, durch die beim Anklicken des Objekts eine URL zum Autorisierungsablauf geöffnet wird.
`setBackgroundColor(backgroundColor)`	`TextButton`	Legt die Hintergrundfarbe für die Schaltfläche "`TextButtonStyle.FILLED`" fest.
`setComposeAction(action, composedEmailType)`	`TextButton`	Legt eine Aktion fest, bei der ein E-Mail-Entwurf erstellt wird, wenn auf das Objekt geklickt wird.
`setDisabled(disabled)`	`TextButton`	Legt fest, ob die Schaltfläche deaktiviert ist.
`setOnClickAction(action)`	`TextButton`	Legt eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird.
`setOnClickOpenLinkAction(action)`	`TextButton`	Legt eine Aktion fest, bei der eine URL in einem Tab geöffnet wird, wenn auf das Objekt geklickt wird.
`setOpenLink(openLink)`	`TextButton`	Legt eine URL fest, die geöffnet werden soll, wenn auf das Objekt geklickt wird.
`setText(text)`	`TextButton`	Legt den Text fest, der auf der Schaltfläche angezeigt wird.
`setTextButtonStyle(textButtonStyle)`	`TextButton`	Legt den Stil der Schaltfläche fest.

Detaillierte Dokumentation

`setAltText(altText)`

Legt den alternativen Text der Schaltfläche für die Barrierefreiheit fest. Ist sie nicht konfiguriert, wird standardmäßig der Text verwendet, der auf der Schaltfläche angezeigt wird.

Parameter

Name	Typ	Beschreibung
`altText`	`String`	Der alternative Text, der dieser Schaltfläche zugewiesen werden soll.

Return

TextButton: Dieses Objekt für Verkettungen.

`setAuthorizationAction(action)`

Legt eine Autorisierungsaktion fest, durch die beim Anklicken des Objekts eine URL zum Autorisierungsablauf geöffnet wird. Dadurch wird die URL in einem neuen Fenster geöffnet. Wenn der Nutzer den Autorisierungsvorgang abgeschlossen hat und zur Anwendung zurückkehrt, wird das Add-on neu geladen.

Für ein UI-Objekt kann nur setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) oder setComposeAction(action, composedEmailType) festgelegt sein.

// ...

var action = CardService.newAuthorizationAction().setAuthorizationUrl('url');
CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);

Parameter

Name	Typ	Beschreibung
`action`	`AuthorizationAction`	Das Objekt, das die Autorisierungsaktion angibt, die ausgeführt werden soll, wenn auf dieses Element geklickt wird.

Return

TextButton: Dieses Objekt für Verkettungen.

`setBackgroundColor(backgroundColor)`

Legt die Hintergrundfarbe für die Schaltfläche "TextButtonStyle.FILLED" fest. Wenn die Schaltfläche für eine TextButtonStyle.FILLED-Schaltfläche nicht konfiguriert ist, verwendet die Schaltfläche die im Add-on-Manifest definierte sekundäre Farbe. Diese Methode ist eine No-Operation für TextButtonStyle.TEXT-Schaltflächen.

Parameter

Name	Typ	Beschreibung
`backgroundColor`	`String`	Die Farbe im #rgb-Format.

Return

TextButton: Dieses Objekt für Verkettungen.

`setComposeAction(action, composedEmailType)`

Legt eine Aktion fest, bei der ein E-Mail-Entwurf erstellt wird, wenn auf das Objekt geklickt wird. Für ein UI-Objekt kann nur setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) oder setComposeAction(action, composedEmailType) festgelegt sein.

Der Parameter Action muss eine Callback-Funktion angeben, die ein mit ComposeActionResponseBuilder.setGmailDraft(draft) konfiguriertes ComposeActionResponse-Objekt zurückgibt.

Hinweis: Diese Methode legt keine Zusammensetzungsaktion fest, mit der die Benutzeroberfläche zum Erstellen einer Nachricht erweitert wird. Stattdessen wird bei dieser Methode dieses UI-Element mit einem Action verbunden, der in Apps Script Entwürfe erstellt und die nach Abschluss der Aktion in Gmail geöffnet werden.

// ...

var action = CardService.newAction().setFunctionName('composeEmailCallback');
CardService.newTextButton()
    .setText('Compose Email')
    .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT);

// ...

function composeEmailCallback() {
  var thread = GmailApp.getThreadById(e.threadId);
  var draft = thread.createDraftReply('This is a reply');
  return CardService.newComposeActionResponseBuilder()
      .setGmailDraft(draft)
      .build();
}

Parameter

Name	Typ	Beschreibung
`action`	`Action`	Das Objekt, das die zusammensetzende Aktion angibt, die ausgeführt werden soll, wenn auf dieses Element geklickt wird.
`composedEmailType`	`ComposedEmailType`	Ein ENUM-Wert, der angibt, ob der verfasste Entwurf ein eigenständiger Entwurf oder ein Antwortentwurf ist.

Return

TextButton: Dieses Objekt für Verkettungen.

`setDisabled(disabled)`

Legt fest, ob die Schaltfläche deaktiviert ist. Eine deaktivierte Schaltfläche ist ausgegraut und kann nicht angeklickt werden.

Parameter

Name	Typ	Beschreibung
`disabled`	`Boolean`	Der deaktivierte Status.

Return

TextButton: Dieses Objekt für Verkettungen.

`setOnClickAction(action)`

Legt eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird. Für ein UI-Objekt kann nur setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) oder setComposeAction(action, composedEmailType) festgelegt sein.

Der Parameter Action muss eine Callback-Funktion angeben, die ein ActionResponse-Objekt zurückgibt.

// ...

var action = CardService.newAction().setFunctionName('notificationCallback');
CardService.newTextButton().setText('Create notification').setOnClickAction(action);

// ...

function notificationCallback() {
  return CardService.newActionResponseBuilder()
      .setNotification(CardService.newNotification()
          .setText("Some info to display to user"))
      .build();
}

Parameter

Name	Typ	Beschreibung
`action`	`Action`	Aktion, die ausgeführt werden soll, wenn auf dieses Element geklickt wird.

Return

TextButton: Dieses Objekt für Verkettungen.

`setOnClickOpenLinkAction(action)`

Legt eine Aktion fest, bei der eine URL in einem Tab geöffnet wird, wenn auf das Objekt geklickt wird. Verwenden Sie diese Funktion, wenn die URL erstellt werden muss oder wenn Sie neben dem Erstellen des OpenLink-Objekts weitere Aktionen ausführen möchten. Für ein UI-Objekt kann nur setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) oder setComposeAction(action, composedEmailType) festgelegt sein.

Der Parameter Action muss eine Callback-Funktion angeben, die ein mit ActionResponseBuilder.setOpenLink(openLink) konfiguriertes ActionResponse-Objekt zurückgibt.

// ...

var action = CardService.newAction().setFunctionName('openLinkCallback');
CardService.newTextButton().setText('Open Link').setOnClickOpenLinkAction(action);

// ...

function openLinkCallback() {
  return CardService.newActionResponseBuilder()
      .setOpenLink(CardService.newOpenLink()
          .setUrl('https://www.google.com'))
      .build();
}

Parameter

Name	Typ	Beschreibung
`action`	`Action`	Das Objekt, das die Aktion zum Öffnen eines Links angibt, die ausgeführt werden soll, wenn auf dieses Element geklickt wird.

Return

TextButton: Dieses Objekt für Verkettungen.

`setOpenLink(openLink)`

Legt eine URL fest, die geöffnet werden soll, wenn auf das Objekt geklickt wird. Verwenden Sie diese Funktion, wenn die URL bereits bekannt ist und nur geöffnet werden muss. Für ein UI-Objekt kann nur setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) oder setComposeAction(action, composedEmailType) festgelegt sein.

Parameter

Name	Typ	Beschreibung
`openLink`	`OpenLink`	Ein `OpenLink`-Objekt, das die zu öffnende URL beschreibt.

Return

TextButton: Dieses Objekt für Verkettungen.

`setText(text)`

Legt den Text fest, der auf der Schaltfläche angezeigt wird.

Parameter

Name	Typ	Beschreibung
`text`	`String`	Der Text, der auf der Schaltfläche angezeigt wird.

Return

TextButton: Dieses Objekt für Verkettungen.

`setTextButtonStyle(textButtonStyle)`

Legt den Stil der Schaltfläche fest. Wenn sie nicht konfiguriert ist, wird standardmäßig die Schaltfläche „TextButtonStyle.TEXT“ verwendet.

Parameter

Name	Typ	Beschreibung
`textButtonStyle`	`TextButtonStyle`	Der Schaltflächenstil.

Return

TextButton: Dieses Objekt für Verkettungen.