Diese Seite wurde von der Cloud Translation API übersetzt.

Class DecoratedText

Ein Widget, das Text mit optionalen Verzierungen anzeigt. Mögliche Schlüssel sind ein Symbol, ein Label darüber und ein Label darunter. Sie müssen den Textinhalt und einen der Schlüssel mit setText(text) und einem der Werte DecoratedText, DecoratedText, setTopLabel(text) oder setBottomLabel(text) festlegen. 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
`setAuthorizationAction(action)`	`DecoratedText`	Legt eine Autorisierungsaktion fest, durch die beim Anklicken des Objekts eine URL zum Autorisierungsablauf geöffnet wird.
`setBottomLabel(text)`	`DecoratedText`	Hier legen Sie den Labeltext fest, der als Schlüssel verwendet werden soll. Er wird unter dem Textinhalt angezeigt.
`setButton(button)`	`DecoratedText`	Hiermit wird das `Button` festgelegt, das rechts neben dem Text angezeigt wird.
`setComposeAction(action, composedEmailType)`	`DecoratedText`	Legt eine Aktion fest, durch die ein E-Mail-Entwurf erstellt wird, wenn auf das Objekt geklickt wird.
`setEndIcon(endIcon)`	`DecoratedText`	Legt das optionale `IconImage` fest, das rechts neben dem Inhalt angezeigt wird.
`setOnClickAction(action)`	`DecoratedText`	Hier legen Sie eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird.
`setOnClickOpenLinkAction(action)`	`DecoratedText`	Hiermit wird eine Aktion festgelegt, durch die eine URL in einem Tab geöffnet wird, wenn auf das Objekt geklickt 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`	Hiermit wird das `Switch` festgelegt, das rechts neben dem Inhalt angezeigt wird.
`setText(text)`	`DecoratedText`	Hier legen Sie den Text fest, der als Wert verwendet werden soll.
`setTopLabel(text)`	`DecoratedText`	Hier legen Sie den Labeltext fest, der als Schlüssel verwendet werden soll. Er wird über dem Textinhalt angezeigt.
`setWrapText(wrapText)`	`DecoratedText`	Hiermit wird festgelegt, ob der Werttext in einer oder mehreren Zeilen angezeigt werden soll.

Detaillierte Dokumentation

`setAuthorizationAction(action)`

Legt eine Autorisierungsaktion fest, durch die beim Anklicken des Objekts eine URL zum Autorisierungsablauf 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

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)`

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

DecoratedText: Dieses Objekt zur Verkettung.

`setButton(button)`

Hiermit wird das Button festgelegt, das rechts neben dem Text angezeigt wird. Ein DecoratedText 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

DecoratedText: Dieses Objekt zur Verkettung.

`setComposeAction(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: 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.

Hinweis: Mit dieser Methode wird keine Compose-Aktion festgelegt, die zum Erweitern der Compose-Benutzeroberfläche verwendet wird. Stattdessen wird dieses UI-Element mit einer Action verknüpft, die in Apps Script Entwurfsnachrichten 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() {
  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.
`composedEmailType`	`ComposedEmailType`	Ein Enum-Wert, der angibt, ob der verfasste 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 Taste, einen Schalter oder ein Symbol unterstützen.

Parameter

Name	Typ	Beschreibung
`endIcon`	`IconImage`	Das hinzuzufügende Symbol.

Rückflug

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

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)`

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

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

DecoratedText – dieses Objekt, zur Verkettung

`setOpenLink(openLink)`

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

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)`

Hiermit wird das Switch festgelegt, das rechts neben dem Inhalt angezeigt wird. Ein DecoratedText kann nur eine Taste oder einen Schalter unterstützen.

Parameter

Name	Typ	Beschreibung
`switchToSet`	`Switch`	Der Schalter, der hinzugefügt werden soll.

Rückflug

DecoratedText: Dieses Objekt zur Verkettung.

`setText(text)`

Legt 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

DecoratedText – dieses Objekt, zur Verkettung

`setTopLabel(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

DecoratedText – dieses Objekt, zur Verkettung

`setWrapText(wrapText)`

Hiermit wird festgelegt, ob der Werttext in einer oder mehreren Zeilen angezeigt werden soll.

Parameter

Name	Typ	Beschreibung
`wrapText`	`Boolean`	Bei `true` wird der Text umgebrochen und auf mehreren Zeilen angezeigt. Andernfalls wird der Text abgeschnitten.

Rückflug

DecoratedText: Dieses Objekt zur Verkettung.