Eine Basisklasse für alle Schaltflächen.
Verfügbar für Google Workspace-Add-ons und Google Chat-Apps.
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
setAuthorizationAction(action) | Button | Legt eine Autorisierungsaktion fest, die beim Anklicken des Objekts eine URL zum Autorisierungsablauf öffnet. |
setComposeAction(action, composedEmailType) | Button | Legt eine Aktion fest, mit der ein E-Mail-Entwurf erstellt wird, wenn auf das Objekt geklickt wird. |
setOnClickAction(action) | Button | Legt eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird. |
setOnClickOpenLinkAction(action) | Button | Legt eine Aktion fest, bei der eine URL in einem Tab geöffnet wird, wenn auf das Objekt geklickt wird. |
setOpenLink(openLink) | Button | Legt eine URL fest, die geöffnet wird, wenn auf das Objekt geklickt wird. |
Detaillierte Dokumentation
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
Name | Typ | Beschreibung |
---|---|---|
action | AuthorizationAction | Das Objekt, das die Autorisierungsaktion angibt, die beim Klicken auf dieses Element ausgeführt werden soll. |
Return
Button
: 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
Name | Typ | Beschreibung |
---|---|---|
action | Action | Objekt, das die Schreibaktion angibt, die ausgeführt werden soll, wenn auf dieses Element geklickt wird. |
composedEmailType | ComposedEmailType | Ein ENUM-Wert, der angibt, ob der erstellte Entwurf ein eigenständiger oder Antwortentwurf ist. |
Return
Button
: 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
Name | Typ | Beschreibung |
---|---|---|
action | Action | Die auszuführende Aktion, wenn auf dieses Element geklickt wird. |
Return
Button
: 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
Name | Typ | Beschreibung |
---|---|---|
action | Action | Das Objekt, das die Aktion zum Öffnen eines Links angibt, die beim Klicken auf dieses Element ausgeführt werden soll. |
Return
Button
: Dieses Objekt zur Verkettung.
setOpenLink(openLink)
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
Name | Typ | Beschreibung |
---|---|---|
openLink | OpenLink | Ein OpenLink -Objekt, das die zu öffnende URL beschreibt. |
Return
Button
: Dieses Objekt zur Verkettung.