Class DecoratedText

DecoratedText

Ein Widget, in dem Text mit optionalen Dekorationen angezeigt wird. Mögliche Schlüssel sind ein Symbol, ein Label darüber und ein Label darunter. Das Festlegen des Textinhalts und eines der Schlüssel ist mit setText(text) und einem der folgenden Werte erforderlich: DecoratedText, DecoratedText, setTopLabel(text) oder setBottomLabel(text). Diese Klasse soll KeyValue ersetzen.

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

const decoratedText =
    CardService.newDecoratedText().setText('Text').setTopLabel('TopLabel');

const multilineDecoratedText = CardService.newDecoratedText()
                                   .setText('Text')
                                   .setTopLabel('TopLabel')
                                   .setWrapText(true)
                                   .setBottomLabel('BottomLabel');

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
addEventAction(eventAction)	Widget	Fügt die Ereignisaktion hinzu, die für das Widget ausgeführt werden kann.
setAuthorizationAction(action)	DecoratedText	Legt eine Autorisierungsaktion fest, die beim Klicken auf das Objekt eine URL für den Autorisierungsablauf öffnet.
setBottomLabel(text)	DecoratedText	Legt den Labeltext fest, der als Schlüssel verwendet und unter dem Textinhalt angezeigt wird.
setButton(button)	DecoratedText	Legt das Button fest, das rechts neben dem Text angezeigt wird.
setComposeAction(action, composedEmailType)	DecoratedText	Legt eine Aktion fest, mit der beim Klicken auf das Objekt eine E‑Mail-Nachricht erstellt wird.
setEndIcon(endIcon)	DecoratedText	Legt das optionale IconImage fest, das rechts neben dem Inhalt angezeigt wird.
setId(id)	Widget	Legt die eindeutige ID fest, die zum Identifizieren des zu ändernden Widgets verwendet wird.
setOnClickAction(action)	DecoratedText	Legt eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird.
setOnClickOpenLinkAction(action)	DecoratedText	Legt eine Aktion fest, mit der beim Klicken auf das Objekt eine URL auf einem Tab geöffnet wird.
setOpenLink(openLink)	DecoratedText	Legt eine URL fest, die geöffnet werden soll, wenn auf das Objekt geklickt wird.
setStartIcon(startIcon)	DecoratedText	Legt das optionale IconImage fest, das vor dem Textinhalt angezeigt werden soll.
setSwitchControl(switchToSet)	DecoratedText	Legt die Switch fest, die rechts neben dem Inhalt angezeigt wird.
setText(text)	DecoratedText	Legt den Text fest, der als Wert verwendet werden soll.
setTopLabel(text)	DecoratedText	Legt den Labeltext fest, der als Schlüssel verwendet und über dem Textinhalt angezeigt wird.
setVisibility(visibility)	Widget	Legt die Sichtbarkeit des Widgets fest.
setWrapText(wrapText)	DecoratedText	Legt fest, ob der Werttext in einer oder mehreren Zeilen angezeigt werden soll.

Detaillierte Dokumentation

addEventAction(eventAction)

Fügt die Ereignisaktion hinzu, die für das Widget ausgeführt werden kann.

Parameter

Name	Typ	Beschreibung
eventAction	EventAction	Die hinzuzufügende EventAction.

Rückflug

Widget – Das Objekt für die 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

DecoratedText – Dieses Objekt zur Verkettung.

---

setBottomLabel(text)

Legt den Labeltext fest, der als Schlüssel verwendet und unter dem Textinhalt angezeigt wird.

Parameter

Name	Typ	Beschreibung
text	String	Der Labeltext.

Rückflug

DecoratedText – Dieses Objekt zur Verkettung.

---

setButton(button)

Legt das Button fest, das rechts neben dem Text angezeigt wird. Eine DecoratedText kann nur eine Taste oder einen Schalter unterstützen.

Parameter

Name	Typ	Beschreibung
button	Button	Die hinzuzufügende Schaltfläche.

Rückflug

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

DecoratedText – Dieses Objekt zur Verkettung.

---

setEndIcon(endIcon)

Legt das optionale IconImage fest, das rechts neben dem Inhalt angezeigt wird. Ein DecoratedText kann nur eine Schaltfläche, einen Schalter oder ein Symbol unterstützen.

Parameter

Name	Typ	Beschreibung
endIcon	IconImage	Das hinzuzufügende Symbol.

Rückflug

DecoratedText – Dieses Objekt zur Verkettung.

---

setId(id)

Legt die eindeutige ID fest, die zum Identifizieren des zu ändernden Widgets verwendet wird. Die Mutation von Widgets wird nur in Add-ons unterstützt.

Parameter

Name	Typ	Beschreibung
id	String	Die ID des Widgets mit einem Limit von 64 Zeichen und im Format „[a-zA-Z0-9-]+“.

Rückflug

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

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

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

DecoratedText – Dieses Objekt zur Verkettung.

---

setStartIcon(startIcon)

Legt das optionale IconImage fest, das vor dem Textinhalt angezeigt werden soll.

Parameter

Name	Typ	Beschreibung
startIcon	IconImage	Das anzuzeigende Symbol.

Rückflug

DecoratedText – Dieses Objekt zur Verkettung.

---

setSwitchControl(switchToSet)

Legt die Switch fest, die rechts neben dem Inhalt angezeigt wird. Ein DecoratedText kann nur eine Schaltfläche oder einen Schalter unterstützen.

Parameter

Name	Typ	Beschreibung
switchToSet	Switch	Der hinzuzufügende Schalter.

Rückflug

DecoratedText – Dieses Objekt zur Verkettung.

---

setText(text)

Legt den Text fest, der als Wert verwendet werden soll. Unterstützt einfache HTML-Formatierung. Erforderlich.

Parameter

Name	Typ	Beschreibung
text	String	Der Textinhalt für dieses Widget.

Rückflug

DecoratedText – Dieses Objekt zur Verkettung.

---

setTopLabel(text)

Legt den Labeltext fest, der als Schlüssel verwendet und über dem Textinhalt angezeigt wird.

Parameter

Name	Typ	Beschreibung
text	String	Der Labeltext.

Rückflug

DecoratedText – Dieses Objekt zur Verkettung.

---

setVisibility(visibility)

Legt die Sichtbarkeit des Widgets fest. Der Standardwert ist „VISIBLE“.

Parameter

Name	Typ	Beschreibung
visibility	Visibility	Die Visibility des Widgets.

Rückflug

Widget – Das Objekt für die Verkettung.

---

setWrapText(wrapText)

Legt fest, ob der Werttext in einer oder mehreren Zeilen angezeigt werden soll.

Parameter

Name	Typ	Beschreibung
wrapText	Boolean	Wenn true, wird der Text umgebrochen und in mehreren Zeilen angezeigt. Andernfalls wird der Text gekürzt.

Rückflug

DecoratedText – Dieses Objekt zur Verkettung.