Diese Seite wurde von der Cloud Translation API übersetzt.

Class ImageButton

Ein ImageButton mit einem Bild.

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

var 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`	Legt den alternativen Text der Schaltfläche für die Barrierefreiheit fest.
`setAuthorizationAction(action)`	`ImageButton`	Legt eine Autorisierungsaktion fest, durch die eine URL zum Autorisierungsablauf geöffnet wird, wenn das Objekt angeklickt wurde.
`setComposeAction(action, composedEmailType)`	`ImageButton`	Legt eine Aktion fest, durch die ein E-Mail-Entwurf erstellt wird, wenn auf das Objekt geklickt wird.
`setIcon(icon)`	`ImageButton`	Legt fest, dass eine vordefinierte `Icon` auf der Schaltfläche angezeigt wird.
`setIconUrl(url)`	`ImageButton`	Legt die URL eines Bilds fest, das als Symbol dieser Schaltfläche verwendet werden soll.
`setOnClickAction(action)`	`ImageButton`	Legt eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird.
`setOnClickOpenLinkAction(action)`	`ImageButton`	Legt eine Aktion fest, durch die beim Anklicken des Objekts eine URL in einem Tab geöffnet wird.
`setOpenLink(openLink)`	`ImageButton`	Legt eine URL fest, die geöffnet werden soll, wenn auf das Objekt geklickt wird.

Detaillierte Dokumentation

`setAltText(altText)`

Legt den alternativen Text der Schaltfläche für die Barrierefreiheit fest. 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)`

Legt eine Autorisierungsaktion fest, durch die eine URL zum Autorisierungsablauf geöffnet wird, wenn das Objekt angeklickt wurde. Daraufhin wird die URL in einem neuen Fenster geöffnet. Wenn der Nutzer den Autorisierungsvorgang abgeschlossen hat und an die 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

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

Rückflug

ImageButton: Dieses Objekt zur Verkettung.

`setComposeAction(action, composedEmailType)`

Legt eine Aktion fest, durch die ein E-Mail-Entwurf erstellt wird, wenn auf das Objekt geklickt wird. Ein UI-Objekt kann nur haben einen der folgenden Werte: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) oder setComposeAction(action, composedEmailType) festgelegt.

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

</ph> Hinweis: Mit dieser Methode wird keine compose-Aktion festgelegt, die zum Erweitern der Benutzeroberfläche zum Schreiben. Stattdessen verbindet diese Methode dieses UI-Element mit einem Action, das in Apps Script Nachrichtenentwürfe verfasst, die nach Abschluss der Aktion in Gmail geöffnet.

// ...

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 Zusammensetzungsaktion angibt, die ausgeführt werden soll, wenn dieses Element angeklickt wurde.
`composedEmailType`	`ComposedEmailType`	Ein Enum-Wert, der angibt, ob der zusammengestellte Entwurf ein als eigenständiger Entwurf oder als Antwortentwurf.

Rückflug

ImageButton: Dieses Objekt zur Verkettung.

`setIcon(icon)`

Legt fest, dass eine vordefinierte Icon auf der Schaltfläche angezeigt wird. Entweder dieser oder setIconUrl(url) muss zur Definition des Schaltflächenbilds verwendet werden.

Parameter

Name	Typ	Beschreibung
`icon`	`Icon`	Einer der vordefinierten `Icon`-Werte.

Rückflug

ImageButton: Dieses Objekt zur Verkettung.

`setIconUrl(url)`

Legt die URL eines Bilds fest, das als Symbol dieser Schaltfläche verwendet werden soll. Entweder dies oder setIcon(icon) muss zur Definition des Schaltflächenbilds.

Parameter

Name	Typ	Beschreibung
`url`	`String`	Die URL-Adresse eines gehosteten Bildes, das als Symbol für diese Schaltfläche verwendet werden soll.

Rückflug

ImageButton: Dieses Objekt zur Verkettung.

`setOnClickAction(action)`

Legt eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird. Ein UI-Objekt kann nur eines der folgenden Elemente haben: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) oder setComposeAction(action, composedEmailType) festgelegt.

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

Rückflug

ImageButton: Dieses Objekt zur Verkettung.

`setOnClickOpenLinkAction(action)`

Legt eine Aktion fest, durch die beim Anklicken des Objekts eine URL in einem Tab geöffnet wird. Verwenden Sie diese Funktion, wenn das Die URL muss erstellt werden oder wenn Sie zusätzlich zum Erstellen des OpenLink-Objekts weitere Aktionen ausführen müssen. Ein UI-Objekt kann nur setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) oder setComposeAction(action, composedEmailType) festgelegt.

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

// ...

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 von Links angibt, die ausgeführt werden soll, wenn dieses Element angeklickt wurde.

Rückflug

ImageButton: Dieses Objekt zur Verkettung.

`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 und muss nur geöffnet werden. Ein UI-Objekt kann nur einen der folgenden Werte haben: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) oder setComposeAction(action, composedEmailType) festgelegt.

Parameter

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

Rückflug

ImageButton: Dieses Objekt zur Verkettung.