Class Button

Button

Eine Basisklasse für alle Schaltflächen.

Methoden

MethodeRückgabetypKurzbeschreibung
setAuthorizationAction(action)ButtonLegt eine Autorisierungsaktion fest, mit der eine URL zum Autorisierungsablauf geöffnet wird, wenn auf das Objekt geklickt wird.
setComposeAction(action, composedEmailType)ButtonLegt eine Aktion fest, die einen E-Mail-Entwurf erstellt, wenn auf das Objekt geklickt wird.
setOnClickAction(action)ButtonLegt eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird.
setOnClickOpenLinkAction(action)ButtonLegt eine Aktion fest, mit der eine URL in einem Tab geöffnet wird, wenn auf das Objekt geklickt wird.
setOpenLink(openLink)ButtonLegt eine URL fest, die beim Klicken auf das Objekt geöffnet werden soll.

Detaillierte Dokumentation

setAuthorizationAction(action)

Legt eine Autorisierungsaktion fest, mit der eine URL zum Autorisierungsablauf geöffnet wird, wenn auf das Objekt geklickt wird. Die URL wird in einem neuen Fenster geöffnet. Wenn der Nutzer den Autorisierungsvorgang abschließt 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 werden.

// ...

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

Parameter

NameTypBeschreibung
actionAuthorizationActionDas Objekt, das die Autorisierungsaktion angibt, die ausgeführt werden soll, wenn auf dieses Element geklickt wird.

Zurücksenden

Button: Dieses Objekt zum Verketten.


setComposeAction(action, composedEmailType)

Legt eine Aktion fest, die einen E-Mail-Entwurf erstellt, 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.

// ...

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

NameTypBeschreibung
actionActionDas Objekt, das die Zusammensetzungsaktion angibt, die ausgeführt werden soll, wenn auf dieses Element geklickt wird.
composedEmailTypeComposedEmailTypeEin Enum-Wert, der angibt, ob es sich beim erstellten Entwurf um einen eigenständigen oder einen Antwortentwurf handelt.

Zurücksenden

Button: Dieses Objekt zum Verketten.


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 werden.

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

NameTypBeschreibung
actionActionDie Aktion, die ausgeführt werden soll, wenn auf dieses Element geklickt wird.

Zurücksenden

Button: Dieses Objekt zum Verketten.


setOnClickOpenLinkAction(action)

Legt eine Aktion fest, mit der eine URL in einem Tab geöffnet wird, wenn auf das Objekt geklickt wird. Verwende diese Funktion, wenn die URL erstellt werden muss oder du zusätzliche Aktionen ausführen musst, um das Objekt OpenLink zu erstellen. Für ein UI-Objekt kann nur setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) oder setComposeAction(action, composedEmailType) festgelegt werden.

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

NameTypBeschreibung
actionActionDas Objekt, das die offene Linkaktion angibt, die ausgeführt werden soll, wenn auf dieses Element geklickt wird.

Zurücksenden

Button: Dieses Objekt zum Verketten.


Legt eine URL fest, die beim Klicken auf das Objekt geöffnet werden soll. 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

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

Zurücksenden

Button: Dieses Objekt zum Verketten.