Ein Widget, das Text mit optionalen Dekorationen anzeigt. Mögliche Schlüssel sind ein Symbol, ein Label oben und ein Label darunter. Das Festlegen des Textinhalts und eines der Schlüssel ist mit setText(text)
und entweder mit DecoratedText
, DecoratedText
, setTopLabel(text)
oder setBottomLabel(text)
erforderlich. Diese Klasse soll
ersetzen.
KeyValue
Verfügbar für Google Workspace-Add-ons und Google Chat-Apps.
var decoratedText = CardService.newDecoratedText() .setText("Text") .setTopLabel("TopLabel"); var multilineDecoratedText = CardService.newDecoratedText() .setText("Text") .setTopLabel("TopLabel") .setWrapText(true) .setBottomLabel("BottomLabel");
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
setAuthorizationAction(action) | DecoratedText | Legt eine Autorisierungsaktion fest, die beim Anklicken des Objekts eine URL zum Autorisierungsablauf öffnet. |
setBottomLabel(text) | DecoratedText | Legt den Labeltext fest, der als Schlüssel verwendet werden soll. Er wird unter dem Textinhalt angezeigt. |
setButton(button) | DecoratedText | Legt das Button fest, das rechts neben dem Text angezeigt wird. |
setComposeAction(action, composedEmailType) | DecoratedText | Legt eine Aktion fest, mit der ein E-Mail-Entwurf erstellt wird, wenn auf das Objekt geklickt wird. |
setEndIcon(endIcon) | DecoratedText | Legt den optionalen IconImage fest, der rechts neben dem Inhalt angezeigt 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, bei der eine URL in einem Tab geöffnet wird, wenn auf das Objekt geklickt wird. |
setOpenLink(openLink) | DecoratedText | Legt eine URL fest, die geöffnet wird, wenn auf das Objekt geklickt wird. |
setStartIcon(startIcon) | DecoratedText | Legt das optionale IconImage -Element fest, das vor dem Textinhalt angezeigt wird. |
setSwitchControl(switchToSet) | DecoratedText | Legt das Switch fest, das 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 werden soll. Er wird über dem Textinhalt angezeigt. |
setWrapText(wrapText) | DecoratedText | Legt fest, ob der Werttext in einer einzelnen Zeile oder in mehreren Zeilen angezeigt werden soll. |
Detaillierte Dokumentation
setAuthorizationAction(action)
Legt eine Autorisierungsaktion fest, die beim Anklicken des Objekts eine URL zum Autorisierungsablauf öffnet. Dadurch wird die URL in einem neuen Fenster geöffnet. Wenn der Nutzer den Autorisierungsvorgang abgeschlossen und zur Anwendung zurückkehrt, wird das Add-on neu geladen.
Für ein UI-Objekt kann entweder 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);
Parameters
Name | Typ | Beschreibung |
---|---|---|
action | AuthorizationAction | Das Objekt, das die Autorisierungsaktion angibt, die beim Klicken auf dieses Element ausgeführt werden soll. |
Return
DecoratedText
: Dieses Objekt zur Verkettung.
setBottomLabel(text)
Legt den Labeltext fest, der als Schlüssel verwendet werden soll. Er wird unter dem Textinhalt angezeigt.
Parameters
Name | Typ | Beschreibung |
---|---|---|
text | String | Der Labeltext. |
Return
DecoratedText
: Dieses Objekt zur Verkettung.
setButton(button)
Legt das Button
fest, das rechts neben dem Text angezeigt wird. Ein DecoratedText
kann nur eine Schaltfläche oder einen Schalter unterstützen.
Parameters
Name | Typ | Beschreibung |
---|---|---|
button | Button | Die Schaltfläche, die hinzugefügt werden soll. |
Return
DecoratedText
: Dieses Objekt zur Verkettung.
setComposeAction(action, composedEmailType)
Legt eine Aktion fest, mit der ein E-Mail-Entwurf erstellt wird, wenn auf das Objekt geklickt wird. Für ein UI-Objekt kann nur entweder 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(); }
Parameters
Name | Typ | Beschreibung |
---|---|---|
action | Action | Objekt, das die Schreibaktion angibt, die ausgeführt werden soll, wenn auf dieses Element geklickt wird. |
composedEmailType | ComposedEmailType | Ein ENUM-Wert, der angibt, ob der erstellte Entwurf ein eigenständiger oder Antwortentwurf ist. |
Return
DecoratedText
: Dieses Objekt zur Verkettung.
setEndIcon(endIcon)
Legt den optionalen IconImage
fest, der rechts neben dem Inhalt angezeigt wird. Ein DecoratedText
unterstützt nur eine Taste, einen Schalter oder ein Symbol.
Parameters
Name | Typ | Beschreibung |
---|---|---|
endIcon | IconImage | Das Symbol, das hinzugefügt werden soll. |
Return
DecoratedText
: 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 entweder setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
oder setComposeAction(action, composedEmailType)
festgelegt sein.
Der Action
-Parameter 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(); }
Parameters
Name | Typ | Beschreibung |
---|---|---|
action | Action | Die auszuführende Aktion, wenn auf dieses Element geklickt wird. |
Return
DecoratedText
: Dieses Objekt zur Verkettung.
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 OpenLink
-Objekt weitere Aktionen ausführen müssen. Für ein UI-Objekt kann nur entweder 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(); }
Parameters
Name | Typ | Beschreibung |
---|---|---|
action | Action | Das Objekt, das die Aktion zum Öffnen eines Links angibt, die beim Klicken auf dieses Element ausgeführt werden soll. |
Return
DecoratedText
: Dieses Objekt zur Verkettung.
setOpenLink(openLink)
Legt eine URL fest, die geöffnet wird, 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 entweder setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
oder setComposeAction(action, composedEmailType)
festgelegt sein.
Parameters
Name | Typ | Beschreibung |
---|---|---|
openLink | OpenLink | Ein OpenLink -Objekt, das die zu öffnende URL beschreibt. |
Return
DecoratedText
: Dieses Objekt zur Verkettung.
setStartIcon(startIcon)
Legt das optionale IconImage
-Element fest, das vor dem Textinhalt angezeigt wird.
Parameters
Name | Typ | Beschreibung |
---|---|---|
startIcon | IconImage | Das anzuzeigende Symbol. |
Return
DecoratedText
: Dieses Objekt zur Verkettung.
setSwitchControl(switchToSet)
Legt das Switch
fest, das rechts neben dem Inhalt angezeigt wird. Ein DecoratedText
kann nur eine Schaltfläche oder einen Schalter unterstützen.
Parameters
Name | Typ | Beschreibung |
---|---|---|
switchToSet | Switch | Der hinzuzufügende Schalter. |
Return
DecoratedText
: Dieses Objekt zur Verkettung.
setText(text)
Legt den Text fest, der als Wert verwendet werden soll. Unterstützt einfache HTML-Formatierung Erforderlich.
Parameters
Name | Typ | Beschreibung |
---|---|---|
text | String | Der Textinhalt für dieses Widget. |
Return
DecoratedText
: Dieses Objekt zur Verkettung.
setTopLabel(text)
Legt den Labeltext fest, der als Schlüssel verwendet werden soll. Er wird über dem Textinhalt angezeigt.
Parameters
Name | Typ | Beschreibung |
---|---|---|
text | String | Der Labeltext. |
Return
DecoratedText
: Dieses Objekt zur Verkettung.
setWrapText(wrapText)
Legt fest, ob der Werttext in einer einzelnen Zeile oder in mehreren Zeilen angezeigt werden soll.
Parameters
Name | Typ | Beschreibung |
---|---|---|
wrapText | Boolean | Bei true wird der Text umgebrochen und in mehreren Zeilen angezeigt. Andernfalls wird der Text abgeschnitten. |
Return
DecoratedText
: Dieses Objekt zur Verkettung.