Class Chip

Chip

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

Für Google Chat-Apps verfügbar. In der Entwicklervorschau für Google Workspace-Add‑ons.

Entwicklervorschau:Im Rahmen des Google Workspace Developer Preview Program verfügbar, das Vorabzugriff auf bestimmte Funktionen bietet.

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

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
setAltText(altText)	Chip	Legt den Alternativtext des Chips für die Barrierefreiheit fest.
setAuthorizationAction(action)	Chip	Legt eine Autorisierungsaktion fest, die beim Klicken auf das Objekt eine URL für den Autorisierungsablauf öffnet.
setComposeAction(action, composedEmailType)	Chip	Legt eine Aktion fest, mit der beim Klicken auf das Objekt eine E‑Mail-Nachricht erstellt wird.
setDisabled(disabled)	Chip	Legt fest, ob der Chip deaktiviert ist.
setIcon(icon)	Chip	Legt das Symbol fest, das als Chip verwendet werden soll.
setLabel(label)	Chip	Legt den Titel des Chips fest.
setOnClickAction(action)	Chip	Legt eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird.
setOnClickOpenLinkAction(action)	Chip	Legt eine Aktion fest, mit der beim Klicken auf das Objekt eine URL auf einem Tab geöffnet wird.
setOpenLink(openLink)	Chip	Legt eine URL fest, die geöffnet werden soll, wenn auf das Objekt geklickt wird.

Detaillierte Dokumentation

setAltText(altText)

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

Parameter

Name	Typ	Beschreibung
altText	String	Der Alternativtext, der diesem Chip zugewiesen werden soll.

Rückflug

Chip – Dieses Objekt zur Verkettung.

---

setAuthorizationAction(action)

Legt eine Autorisierungsaktion fest, die beim Klicken auf das Objekt eine URL für den Autorisierungsablauf öffnet. 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 eines der Attribute setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) oder setComposeAction(action, composedEmailType) festgelegt werden.

// ...

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

Chip – Dieses Objekt zur Verkettung.

---

setComposeAction(action, composedEmailType)

Legt eine Aktion fest, mit der beim Klicken auf das Objekt eine E‑Mail-Nachricht erstellt wird. Für ein UI-Objekt kann nur eines der Attribute setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) oder setComposeAction(action, composedEmailType) festgelegt werden.

Mit dem Parameter Action muss eine Callback-Funktion angegeben werden, die ein mit ComposeActionResponseBuilder.setGmailDraft(draft) konfiguriertes ComposeActionResponse-Objekt zurückgibt.

Hinweis: Mit dieser Methode wird keine Compose-Aktion festgelegt, die zum Erweitern der Compose-Benutzeroberfläche verwendet wird. Stattdessen wird dieses UI-Element mit einem Action verbunden, das Entwurfsnachrichten in Apps Script verfasst, die nach Abschluss der Aktion in Gmail geöffnet werden.

// ...

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

Name	Typ	Beschreibung
action	Action	Das Objekt, das die Compose-Aktion angibt, die ausgeführt werden soll, wenn auf dieses Element geklickt wird.
composedEmailType	ComposedEmailType	Ein Enum-Wert, der angibt, ob der zusammengesetzte 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

Name	Typ	Beschreibung
disabled	Boolean	Der deaktivierte Status.

Rückflug

Chip – Dieses Objekt zur Verkettung.

---

setIcon(icon)

Legt das Symbol fest, das als Chip verwendet werden soll.

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

Parameter

Name	Typ	Beschreibung
icon	IconImage	Einer der vordefinierten IconImage-Werte.

Rückflug

Chip – Dieses Objekt zur Verkettung.

---

setLabel(label)

Legt den Titel des Chips fest. Erforderlich.

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

Parameter

Name	Typ	Beschreibung
label	String	Der anzuzeigende Text.

Rückflug

Chip – 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 einer der Werte setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) oder setComposeAction(action, composedEmailType) festgelegt werden.

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

Chip – Dieses Objekt zur Verkettung.

---

setOnClickOpenLinkAction(action)

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

Mit dem Parameter Action muss eine Callback-Funktion angegeben werden, 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 des Links angibt, die ausgeführt werden soll, wenn auf dieses Element geklickt wird.

Rückflug

Chip – 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 bekannt ist und nur geöffnet werden muss. Für ein UI-Objekt kann nur eines der folgenden Attribute 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

Chip – Dieses Objekt zur Verkettung.