Class Chip

Chip

Ein Chip mit einem Symbol und einem Textlabel. Sie können den Chip bei Bedarf deaktivieren.

Verfügbar für Google Chat-Apps. In der Entwicklervorschau für Google Workspace-Add-ons

const chip = CardService.newChip()
                 .setLabel('Open Link')
                 .setOpenLink(CardService.newOpenLink().setUrl(
                     'https://www.google.com'));

Methoden

MethodeRückgabetypKurzbeschreibung
setAltText(altText)ChipLegt den alternativen Text des Chips für die Barrierefreiheit fest.
setAuthorizationAction(action)ChipHiermit wird eine Autorisierungsaktion festgelegt, durch die beim Klicken auf das Objekt eine URL zum Autorisierungsvorgang geöffnet wird.
setComposeAction(action, composedEmailType)ChipLegt eine Aktion fest, durch die ein E-Mail-Entwurf erstellt wird, wenn auf das Objekt geklickt wird.
setDisabled(disabled)ChipLegt fest, ob der Chip deaktiviert ist.
setIcon(icon)ChipHier legen Sie das Symbol fest, das als Chip verwendet werden soll.
setLabel(label)ChipHiermit wird der Titel des Chips festgelegt.
setOnClickAction(action)ChipHier legen Sie eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird.
setOnClickOpenLinkAction(action)ChipHiermit wird eine Aktion festgelegt, durch die eine URL in einem Tab geöffnet wird, wenn auf das Objekt geklickt wird.
setOpenLink(openLink)ChipHiermit wird eine URL festgelegt, die geöffnet werden soll, wenn auf das Objekt geklickt wird.

Detaillierte Dokumentation

setAltText(altText)

Legt den alternativen Text des Chips für die Barrierefreiheit fest. Wenn nicht festgelegt, wird standardmäßig der Text verwendet, der auf dem Chip angezeigt wird.

Parameter

NameTypBeschreibung
altTextStringDer alternative Text, der diesem Chip zugewiesen werden soll.

Rückflug

Chip – dieses Objekt, zur Verkettung


setAuthorizationAction(action)

Hiermit wird eine Autorisierungsaktion festgelegt, durch die beim Klicken auf das Objekt eine URL zum Autorisierungsvorgang 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

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

Rückflug

Chip – 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. 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(e) {
  const thread = GmailApp.getThreadById(e.threadId);
  const draft = thread.createDraftReply('This is a reply');
  return CardService.newComposeActionResponseBuilder()
      .setGmailDraft(draft)
      .build();
}

Parameter

NameTypBeschreibung
actionActionDas Objekt, das die 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.

Rückflug

Chip – dieses Objekt, zur Verkettung


setDisabled(disabled)

Legt fest, ob der Chip deaktiviert ist. Ein deaktivierter Chip ist ausgegraut und kann nicht angeklickt werden.

const chip = CardService.newChip().setLabel('bug Report').setDisabled(true);

Parameter

NameTypBeschreibung
disabledBooleanDer deaktivierte Status.

Rückflug

Chip – dieses Objekt, zur Verkettung


setIcon(icon)

Hier legen Sie das Symbol fest, das als Chip verwendet werden soll.

const chip = CardService.newChip().setIcon(
    CardService.newIconImage().setMaterialIcon(
        CardService.newMaterialIcon().setName('bug_report'),
        ),
);

Parameter

NameTypBeschreibung
iconIconImageEiner der vordefinierten IconImage-Werte.

Rückflug

Chip – dieses Objekt, zur Verkettung


setLabel(label)

Hiermit wird der Titel des Chips festgelegt. Erforderlich.

const chip = CardService.newChip().setLabel('bug Report');

Parameter

NameTypBeschreibung
labelStringDer anzuzeigende Text.

Rückflug

Chip – 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

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

Rückflug

Chip – 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

NameTypBeschreibung
actionActionDas Objekt, das die Aktion zum Öffnen eines Links angibt, die ausgeführt werden soll, wenn auf dieses Element geklickt wird.

Rückflug

Chip – dieses Objekt, zur Verkettung


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

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

Rückflug

Chip – dieses Objekt, zur Verkettung