Class ImageButton

ImageButton

Ein ImageButton mit einem Bild.

var imageButton = CardService.newImageButton()
    .setAltText("An image button with an airplane icon.")
    .setIcon(CardService.Icon.AIRPLANE)
    .setOpenLink(CardService.newOpenLink()
        .setUrl("https://airplane.com"));

Methoden

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

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

Return

ImageButton: Dieses Objekt für Verkettungen.


setAuthorizationAction(action)

Legt eine Autorisierungsaktion fest, durch die beim Anklicken des Objekts 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 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);

Parameter

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

Return

ImageButton: Dieses Objekt für Verkettungen.


setComposeAction(action, composedEmailType)

Legt eine Aktion fest, bei der ein E-Mail-Entwurf erstellt 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 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 zusammensetzende Aktion angibt, die ausgeführt werden soll, wenn auf dieses Element geklickt wird.
composedEmailTypeComposedEmailTypeEin ENUM-Wert, der angibt, ob der verfasste Entwurf ein eigenständiger Entwurf oder ein Antwortentwurf ist.

Return

ImageButton: Dieses Objekt für Verkettungen.


setIcon(icon)

Legt einen vordefinierten Icon fest, der auf der Schaltfläche angezeigt wird. Zum Definieren des Schaltflächenbildes muss entweder dieses Feld oder setIconUrl(url) verwendet werden.

Parameter

NameTypBeschreibung
iconIconEiner der vordefinierten Werte für Icon.

Return

ImageButton: Dieses Objekt für Verkettungen.


setIconUrl(url)

Legt die URL eines Bildes fest, das als Symbol dieser Schaltfläche verwendet werden soll. Zum Definieren des Schaltflächenbildes muss entweder dies oder setIcon(icon) verwendet werden.

Parameter

NameTypBeschreibung
urlStringDie URL-Adresse eines gehosteten Bildes, das als Symbol für diese Schaltfläche verwendet werden soll.

Return

ImageButton: Dieses Objekt für Verkettungen.


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

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
actionActionAktion, die ausgeführt werden soll, wenn auf dieses Element geklickt wird.

Return

ImageButton: Dieses Objekt für Verkettungen.


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 Erstellen des OpenLink-Objekts weitere Aktionen ausführen möchten. 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 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 Aktion zum Öffnen eines Links angibt, die ausgeführt werden soll, wenn auf dieses Element geklickt wird.

Return

ImageButton: Dieses Objekt für Verkettungen.


Legt eine URL fest, 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 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.

Return

ImageButton: Dieses Objekt für Verkettungen.