Class TextButton

TextButton

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

Verfügbar für Google Workspace-Add-ons und Google Chat-Apps.

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

Methoden

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

Detaillierte Dokumentation

setAltText(altText)

Legt den alternativen Text der Schaltfläche für Barrierefreiheit fest. Wenn nichts festgelegt ist, wird standardmäßig der Text verwendet, der auf der Schaltfläche angezeigt wird.

Parameters

NameTypBeschreibung
altTextStringDer alternative Text, der dieser Schaltfläche zugewiesen werden soll.

Return

TextButton: Dieses Objekt zur Verkettung.


setAuthorizationAction(action)

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

Für ein UI-Objekt kann entweder 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);

Parameters

NameTypBeschreibung
actionAuthorizationActionDas Objekt, das die Autorisierungsaktion angibt, die beim Klicken auf dieses Element ausgeführt werden soll.

Return

TextButton: Dieses Objekt zur Verkettung.


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, wird die im Add-on-Manifest definierte sekundäre Farbe verwendet. Diese Methode ist für TextButtonStyle.TEXT-Schaltflächen nicht funktionsfähig.

Parameters

NameTypBeschreibung
backgroundColorStringDie Farbe im #rgb-Format.

Return

TextButton: Dieses Objekt zur Verkettung.


setComposeAction(action, composedEmailType)

Legt eine Aktion fest, mit der ein E-Mail-Entwurf erstellt wird, wenn auf das Objekt geklickt wird. Für ein UI-Objekt kann nur entweder 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.

// ...

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();
}

Parameters

NameTypBeschreibung
actionActionObjekt, das die Schreibaktion angibt, die ausgeführt werden soll, wenn auf dieses Element geklickt wird.
composedEmailTypeComposedEmailTypeEin ENUM-Wert, der angibt, ob der erstellte Entwurf ein eigenständiger oder Antwortentwurf ist.

Return

TextButton: Dieses Objekt zur Verkettung.


setDisabled(disabled)

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

Parameters

NameTypBeschreibung
disabledBooleanDer Status „Deaktiviert“.

Return

TextButton: Dieses Objekt zur Verkettung.


setOnClickAction(action)

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

Der Action-Parameter 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();
}

Parameters

NameTypBeschreibung
actionActionDie auszuführende Aktion, wenn auf dieses Element geklickt wird.

Return

TextButton: Dieses Objekt zur Verkettung.


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 OpenLink-Objekt weitere Aktionen ausführen müssen. Für ein UI-Objekt kann nur entweder 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();
}

Parameters

NameTypBeschreibung
actionActionDas Objekt, das die Aktion zum Öffnen eines Links angibt, die beim Klicken auf dieses Element ausgeführt werden soll.

Return

TextButton: Dieses Objekt zur Verkettung.


Legt eine URL fest, die geöffnet wird, 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 entweder setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) oder setComposeAction(action, composedEmailType) festgelegt sein.

Parameters

NameTypBeschreibung
openLinkOpenLinkEin OpenLink-Objekt, das die zu öffnende URL beschreibt.

Return

TextButton: Dieses Objekt zur Verkettung.


setText(text)

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

Parameters

NameTypBeschreibung
textStringDer Text, der auf der Schaltfläche angezeigt wird.

Return

TextButton: Dieses Objekt zur Verkettung.


setTextButtonStyle(textButtonStyle)

Legt den Stil der Schaltfläche fest. Wenn nichts festgelegt ist, wird standardmäßig die Schaltfläche TextButtonStyle.TEXT verwendet.

Parameters

NameTypBeschreibung
textButtonStyleTextButtonStyleDer Schaltflächenstil.

Return

TextButton: Dieses Objekt zur Verkettung.