Ein ImageButton
mit einem Bild.
Verfügbar für Google Workspace-Add-ons und Google Chat-Apps.
const imageButton = CardService.newImageButton() .setAltText('An image button with an airplane icon.') .setIcon(CardService.Icon.AIRPLANE) .setOpenLink(CardService.newOpenLink().setUrl('https://airplane.com'));
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
setAltText(altText) | ImageButton | Hiermit wird der alternative Text der Schaltfläche für die Barrierefreiheit festgelegt. |
setAuthorizationAction(action) | ImageButton | Hiermit wird eine Autorisierungsaktion festgelegt, durch die beim Klicken auf das Objekt eine URL zum Autorisierungsablauf geöffnet wird. |
setComposeAction(action, composedEmailType) | ImageButton | Hier legen Sie eine Aktion fest, durch die ein E-Mail-Entwurf erstellt wird, wenn auf das Objekt geklickt wird. |
setIcon(icon) | ImageButton | Hiermit wird eine vordefinierte Icon festgelegt, die auf der Schaltfläche angezeigt wird. |
setIconUrl(url) | ImageButton | Hier wird die URL eines Bildes festgelegt, das als Symbol für diese Schaltfläche verwendet werden soll. |
setImageButtonStyle(imageButtonStyle) | ImageButton | Hier legen Sie den Schaltflächenstil fest. |
setMaterialIcon(icon) | ImageButton | Hiermit wird das Material Design-Symbol festgelegt. |
setOnClickAction(action) | ImageButton | Hier legen Sie eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird. |
setOnClickOpenLinkAction(action) | ImageButton | Hiermit wird eine Aktion festgelegt, durch die eine URL in einem Tab geöffnet wird, wenn auf das Objekt geklickt wird. |
setOpenLink(openLink) | ImageButton | Hiermit wird eine URL festgelegt, die geöffnet werden soll, wenn auf das Objekt geklickt wird. |
setOverflowMenu(menu) | ImageButton | Hiermit wird ein Pop-up-Menü festgelegt, das geöffnet wird, wenn auf das Objekt geklickt wird. |
Detaillierte Dokumentation
setAltText(altText)
Hiermit wird der alternative Text der Schaltfläche für die Barrierefreiheit festgelegt. Erforderlich.
Parameter
Name | Typ | Beschreibung |
---|---|---|
altText | String | Der alternative Text, der dieser Schaltfläche zugewiesen werden soll. |
Rückflug
ImageButton
– dieses Objekt, zur Verkettung
setAuthorizationAction(action)
Hiermit wird eine Autorisierungsaktion festgelegt, durch die beim Klicken auf das Objekt 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 einer der folgenden Werte festgelegt werden: setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
oder setComposeAction(action, composedEmailType)
.
// ... const 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. |
Rückflug
ImageButton
– dieses Objekt, zur Verkettung
setComposeAction(action, composedEmailType)
Hier legen Sie eine Aktion fest, durch die ein E-Mail-Entwurf erstellt wird, wenn auf das Objekt geklickt wird. Für ein UI-Objekt kann nur einer der folgenden Werte festgelegt werden: setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
oder setComposeAction(action, composedEmailType)
.
Der Parameter Action
muss eine Callback-Funktion angeben, die ein mit ComposeActionResponseBuilder.setGmailDraft(draft)
konfiguriertes ComposeActionResponse
-Objekt zurückgibt.
// ... const action = CardService.newAction().setFunctionName('composeEmailCallback'); CardService.newTextButton() .setText('Compose Email') .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT); // ... function composeEmailCallback() { const thread = GmailApp.getThreadById(e.threadId); const draft = thread.createDraftReply('This is a reply'); return CardService.newComposeActionResponseBuilder() .setGmailDraft(draft) .build(); }
Parameter
Name | Typ | Beschreibung |
---|---|---|
action | Action | Das Objekt, das die 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. |
Rückflug
ImageButton
– dieses Objekt, zur Verkettung
setIcon(icon)
Hiermit wird eine vordefinierte Icon
festgelegt, die auf der Schaltfläche angezeigt wird. Entweder dieses oder setIconUrl(url)
muss verwendet werden, um das Schaltflächenbild zu definieren.
Parameter
Name | Typ | Beschreibung |
---|---|---|
icon | Icon | Einer der vordefinierten Icon -Werte. |
Rückflug
ImageButton
– dieses Objekt, zur Verkettung
setIconUrl(url)
Hier wird die URL eines Bildes festgelegt, das als Symbol für diese Schaltfläche verwendet werden soll. Entweder dieses oder setIcon(icon)
muss verwendet werden, um das Schaltflächenbild zu definieren.
Parameter
Name | Typ | Beschreibung |
---|---|---|
url | String | Die URL eines gehosteten Bildes, das als Symbol für diese Schaltfläche verwendet werden soll. |
Rückflug
ImageButton
– dieses Objekt, zur Verkettung
setImageButtonStyle(imageButtonStyle)
Hier legen Sie den Schaltflächenstil fest. Wenn nicht festgelegt, wird standardmäßig die Taste ImageButtonStyle.BORDERLESS
verwendet.
Nur für Google Chat-Apps verfügbar. Nicht verfügbar für Google Workspace-Add-ons.
const imageButton = CardService.newImageButton().setImageButtonStyle( CardService.ImageButtonStyle.BORDERLESS, );
Parameter
Name | Typ | Beschreibung |
---|---|---|
imageButtonStyle | ImageButtonStyle | Der Schaltflächenstil. |
Rückflug
ImageButton
– dieses Objekt, zur Verkettung
setMaterialIcon(icon)
Hiermit wird das Material Design-Symbol festgelegt.
const imageButton = CardService.newImageButton().setMaterialIcon( CardService.newMaterialIcon().setName('search'), );
Parameter
Name | Typ | Beschreibung |
---|---|---|
icon | MaterialIcon | Das Symbol für Material Design. |
Rückflug
ImageButton
– dieses Objekt, zur Verkettung
setOnClickAction(action)
Hier legen Sie eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird. Für ein UI-Objekt kann nur einer der folgenden Werte festgelegt werden: setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
oder setComposeAction(action, composedEmailType)
.
Der Parameter Action
muss eine Callback-Funktion angeben, die ein ActionResponse
-Objekt zurückgibt.
// ... const 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 | Die Aktion, die ausgeführt werden soll, wenn auf dieses Element geklickt wird. |
Rückflug
ImageButton
– dieses Objekt, zur Verkettung
setOnClickOpenLinkAction(action)
Hiermit wird eine Aktion festgelegt, durch die 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 Sie zusätzlich zum Erstellen des OpenLink
-Objekts noch andere Aktionen ausführen müssen. Für ein UI-Objekt kann nur einer der folgenden Werte festgelegt werden: setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
oder setComposeAction(action, composedEmailType)
.
Der Parameter Action
muss eine Callback-Funktion angeben, die ein mit ActionResponseBuilder.setOpenLink(openLink)
konfiguriertes ActionResponse
-Objekt zurückgibt.
// ... const 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. |
Rückflug
ImageButton
– dieses Objekt, zur Verkettung
setOpenLink(openLink)
Hiermit wird eine URL festgelegt, 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 einer der folgenden Werte festgelegt werden: setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
oder setComposeAction(action, composedEmailType)
.
Parameter
Name | Typ | Beschreibung |
---|---|---|
openLink | OpenLink | Ein OpenLink -Objekt, das die zu öffnende URL beschreibt. |
Rückflug
ImageButton
– dieses Objekt, zur Verkettung
setOverflowMenu(menu)
Hiermit wird ein Pop-up-Menü festgelegt, das geöffnet wird, wenn auf das Objekt geklickt wird. Für jeden Menüpunkt kann eine Aktion festgelegt werden, die ausgelöst wird, wenn darauf geklickt wird. Verschachtelte Menüs werden nicht unterstützt. Aktionen für Menüpunkte dürfen kein Dreipunkt-Menü angeben.
Nur für Google Chat-Apps verfügbar. Nicht verfügbar für Google Workspace-Add-ons.
const overflowMenuItem = CardService.newOverflowMenuItem() .setStartIcon( CardService.newIconImage().setIconUrl( 'https://www.google.com/images/branding/googleg/1x/googleg_standard_color_64dp.png', ), ) .setText('Open Link') .setOpenLink( CardService.newOpenLink().setUrl('https://www.google.com')); const overflowMenu = CardService.newOverflowMenu().addMenuItem(overflowMenuItem).build();
Parameter
Name | Typ | Beschreibung |
---|---|---|
menu | OverflowMenu | Das Objekt, das das Dreipunkt-Menü angibt, das angezeigt werden soll, wenn auf dieses Element geklickt wird. |
Rückflug
ImageButton
– dieses Objekt, zur Verkettung