Ein Widget, das Text mit optionalen Verzierungen anzeigt. Mögliche Schlüssel sind ein Symbol, ein Label oben und ein Label unten. Sie müssen den Textinhalt und einen der Schlüssel mit set
und einem der Werte Decorated
, Decorated
, set
oder set
festlegen. Diese Klasse soll
ersetzen.
Key
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 |
---|---|---|
set | Decorated | Hiermit wird eine Autorisierungsaktion festgelegt, durch die beim Klicken auf das Objekt eine URL zum Autorisierungsvorgang geöffnet wird. |
set | Decorated | Hier legen Sie den Labeltext fest, der als Schlüssel verwendet werden soll. Er wird unter dem Textinhalt angezeigt. |
set | Decorated | Hiermit wird das Button festgelegt, das rechts neben dem Text angezeigt wird. |
set | Decorated | Hier legen Sie eine Aktion fest, durch die ein E-Mail-Entwurf erstellt wird, wenn auf das Objekt geklickt wird. |
set | Decorated | Hiermit wird das optionale Icon festgelegt, das rechts neben den Inhalten angezeigt wird. |
set | Decorated | Hier legen Sie eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird. |
set | Decorated | Hiermit wird eine Aktion festgelegt, durch die eine URL in einem Tab geöffnet wird, wenn auf das Objekt geklickt wird. |
set | Decorated | Hier wird eine URL festgelegt, die geöffnet werden soll, wenn auf das Objekt geklickt wird. |
set | Decorated | Legt das optionale Icon fest, das vor dem Textinhalt angezeigt werden soll. |
set | Decorated | Hiermit wird das Switch festgelegt, das rechts neben dem Inhalt angezeigt wird. |
set | Decorated | Hier legen Sie den Text fest, der als Wert verwendet werden soll. |
set | Decorated | Hier legen Sie den Labeltext fest, der als Schlüssel verwendet werden soll. Er wird über dem Textinhalt angezeigt. |
set | Decorated | Hiermit wird festgelegt, ob der Werttext in einer oder mehreren Zeilen angezeigt werden soll. |
Detaillierte Dokumentation
set Authorization Action(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: set
, set
, set
, set
oder set
.
// ... const action = CardService.newAuthorizationAction().setAuthorizationUrl('url'); CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);
Parameter
Name | Typ | Beschreibung |
---|---|---|
action | Authorization | Das Objekt, das die Autorisierungsaktion angibt, die ausgeführt werden soll, wenn auf dieses Element geklickt wird. |
Rückflug
Decorated
– dieses Objekt, zur Verkettung
set Bottom Label(text)
Hier legen Sie den Labeltext fest, der als Schlüssel verwendet werden soll. Er wird unter dem Textinhalt angezeigt.
Parameter
Name | Typ | Beschreibung |
---|---|---|
text | String | Der Labeltext. |
Rückflug
Decorated
– dieses Objekt, zur Verkettung
set Button(button)
Hiermit wird das Button
festgelegt, das rechts neben dem Text angezeigt wird. Ein Decorated
kann nur eine Taste oder einen Schalter unterstützen.
Parameter
Name | Typ | Beschreibung |
---|---|---|
button | Button | Die Schaltfläche, die hinzugefügt werden soll. |
Rückflug
Decorated
– dieses Objekt, zur Verkettung
set Compose Action(action, composedEmailType)
Hier legen Sie 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: set
, set
, set
, set
oder set
.
Der Parameter Action
muss eine Callback-Funktion angeben, die ein mit Compose
konfiguriertes Compose
-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
Name | Typ | Beschreibung |
---|---|---|
action | Action | Das Objekt, das die Aktion angibt, die ausgeführt werden soll, wenn auf dieses Element geklickt wird. |
composed | Composed | Ein enum-Wert, der angibt, ob der verfasste Entwurf ein eigenständiger Entwurf oder ein Antwortentwurf ist. |
Rückflug
Decorated
– dieses Objekt, zur Verkettung
set End Icon(endIcon)
Hiermit wird das optionale Icon
festgelegt, das rechts neben den Inhalten angezeigt wird. Ein Decorated
kann nur eine Taste, einen Schalter oder ein Symbol unterstützen.
Parameter
Name | Typ | Beschreibung |
---|---|---|
end | Icon | Das hinzuzufügende Symbol. |
Rückflug
Decorated
– dieses Objekt, zur Verkettung
set On Click Action(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: set
, set
, set
, set
oder set
.
Der Parameter Action
muss eine Callback-Funktion angeben, die ein Action
-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
Decorated
– dieses Objekt, zur Verkettung
set On Click Open Link Action(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 Open
-Objekts noch andere Aktionen ausführen müssen. Für ein UI-Objekt kann nur einer der folgenden Werte festgelegt werden: set
, set
, set
, set
oder set
.
Der Parameter Action
muss eine Callback-Funktion angeben, die ein mit Action
konfiguriertes Action
-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 eines Links angibt, die ausgeführt werden soll, wenn auf dieses Element geklickt wird. |
Rückflug
Decorated
– dieses Objekt, zur Verkettung
set Open Link(openLink)
Hier 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: set
, set
, set
, set
oder set
.
Parameter
Name | Typ | Beschreibung |
---|---|---|
open | Open | Ein Open -Objekt, das die zu öffnende URL beschreibt. |
Rückflug
Decorated
– dieses Objekt, zur Verkettung
set Start Icon(startIcon)
Legt das optionale Icon
fest, das vor dem Textinhalt angezeigt werden soll.
Parameter
Name | Typ | Beschreibung |
---|---|---|
start | Icon | Das anzuzeigende Symbol. |
Rückflug
Decorated
– dieses Objekt, zur Verkettung
set Switch Control(switchToSet)
Hiermit wird das Switch
festgelegt, das rechts neben dem Inhalt angezeigt wird. Ein Decorated
kann nur eine Taste oder einen Schalter unterstützen.
Parameter
Name | Typ | Beschreibung |
---|---|---|
switch | Switch | Der hinzuzufügende Schalter. |
Rückflug
Decorated
– dieses Objekt, zur Verkettung
set Text(text)
Hier legen Sie den Text fest, der als Wert verwendet werden soll. Unterstützt die einfache HTML-Formatierung. Erforderlich.
Parameter
Name | Typ | Beschreibung |
---|---|---|
text | String | Der Textinhalt für dieses Widget. |
Rückflug
Decorated
– dieses Objekt, zur Verkettung
set Top Label(text)
Hier legen Sie den Labeltext fest, der als Schlüssel verwendet werden soll. Er wird über dem Textinhalt angezeigt.
Parameter
Name | Typ | Beschreibung |
---|---|---|
text | String | Der Labeltext. |
Rückflug
Decorated
– dieses Objekt, zur Verkettung
set Wrap Text(wrapText)
Hiermit wird festgelegt, ob der Werttext in einer oder mehreren Zeilen angezeigt werden soll.
Parameter
Name | Typ | Beschreibung |
---|---|---|
wrap | Boolean | Bei true wird der Text umgebrochen und auf mehreren Zeilen angezeigt. Andernfalls wird der Text abgeschnitten. |
Rückflug
Decorated
– dieses Objekt, zur Verkettung