Diese Seite wurde von der Cloud Translation API übersetzt.

Class DecoratedText

Ein Widget, das Text mit optionalen Dekorationen anzeigt. Mögliche Tasten sind Symbole, Beschriftungen und darunter ein Label. Sie müssen den Textinhalt und einen der Schlüssel mit setText(text) und mit 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.

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, durch die eine URL zum Autorisierungsablauf geöffnet wird, wenn das Objekt angeklickt wurde.
`setBottomLabel(text)`	`DecoratedText`	Legt den Labeltext fest, der als Schlüssel verwendet werden soll, und wird unterhalb des Textinhalts angezeigt.
`setButton(button)`	`DecoratedText`	Legt den `Button` fest, der rechts vom 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`	Legt eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird.
`setOnClickOpenLinkAction(action)`	`DecoratedText`	Legt eine Aktion fest, durch die beim Anklicken des Objekts eine URL in 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 den `Switch` fest, der rechts vom 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, und wird über dem Textinhalt angezeigt.
`setWrapText(wrapText)`	`DecoratedText`	Legt fest, ob der Werttext in einer oder in mehreren Zeilen angezeigt werden soll.

Detaillierte Dokumentation

`setAuthorizationAction(action)`

Legt eine Autorisierungsaktion fest, durch die eine URL zum Autorisierungsablauf geöffnet wird, wenn das Objekt angeklickt wurde. Daraufhin wird die URL in einem neuen Fenster geöffnet. Wenn der Nutzer den Autorisierungsvorgang abgeschlossen hat und an die Anwendung zurückkehrt, wird das Add-on neu geladen.

Für ein UI-Objekt kann nur setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) oder setComposeAction(action, composedEmailType) festgelegt werden.

// ...

var 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 dieses Element angeklickt wurde.

Rückflug

DecoratedText: Dieses Objekt zur Verkettung.

`setBottomLabel(text)`

Legt den Labeltext fest, der als Schlüssel verwendet werden soll, und wird unterhalb des Textinhalts angezeigt.

Parameter

Name	Typ	Beschreibung
`text`	`String`	Der Labeltext.

Rückflug

DecoratedText: Dieses Objekt zur Verkettung.

`setButton(button)`

Legt den Button fest, der rechts vom Text angezeigt wird. Ein DecoratedText kann nur eine Taste oder einen Schalter.

Parameter

Name	Typ	Beschreibung
`button`	`Button`	Die Schaltfläche, die hinzugefügt werden soll.

Rückflug

DecoratedText: Dieses Objekt zur Verkettung.

`setComposeAction(action, composedEmailType)`

Legt eine Aktion fest, durch die ein E-Mail-Entwurf erstellt wird, wenn auf das Objekt geklickt wird. Ein UI-Objekt kann nur haben einen der folgenden Werte: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) oder setComposeAction(action, composedEmailType) festgelegt.

Der Action-Parameter muss eine Callback-Funktion angeben, die ein ComposeActionResponse-Objekt zurückgibt, das mit ComposeActionResponseBuilder.setGmailDraft(draft) konfiguriert wurde.

</ph> Hinweis: Mit dieser Methode wird keine compose-Aktion festgelegt, die zum Erweitern der Benutzeroberfläche zum Schreiben. Stattdessen verbindet diese Methode dieses UI-Element mit einem Action, das in Apps Script Nachrichtenentwürfe verfasst, die nach Abschluss der Aktion in Gmail geöffnet.

// ...

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();
}

Parameter

Name	Typ	Beschreibung
`action`	`Action`	Das Objekt, das die Zusammensetzungsaktion angibt, die ausgeführt werden soll, wenn dieses Element angeklickt wurde.
`composedEmailType`	`ComposedEmailType`	Ein Enum-Wert, der angibt, ob der zusammengestellte Entwurf ein als eigenständiger Entwurf oder als Antwortentwurf.

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.

`setOnClickAction(action)`

Legt eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird. Ein UI-Objekt kann nur eines der folgenden Elemente haben: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) oder setComposeAction(action, composedEmailType) festgelegt.

Der Parameter Action 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();
}

Parameter

Name	Typ	Beschreibung
`action`	`Action`	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, durch die beim Anklicken des Objekts eine URL in einem Tab geöffnet wird. Verwenden Sie diese Funktion, wenn das Die URL muss erstellt werden oder wenn Sie zusätzlich zum Erstellen des OpenLink-Objekts weitere Aktionen ausführen müssen. Ein UI-Objekt kann nur setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) oder setComposeAction(action, composedEmailType) festgelegt.

Der Action-Parameter muss eine Callback-Funktion angeben, die ein ActionResponse-Objekt zurückgibt, das mit ActionResponseBuilder.setOpenLink(openLink) konfiguriert wurde.

// ...

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();
}

Parameter

Name	Typ	Beschreibung
`action`	`Action`	Das Objekt, das die Aktion zum Öffnen von Links angibt, die ausgeführt werden soll, wenn dieses Element angeklickt wurde.

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 und muss nur geöffnet werden. Ein UI-Objekt kann nur einen der folgenden Werte haben: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) oder setComposeAction(action, composedEmailType) festgelegt.

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 den Switch fest, der rechts vom Inhalt angezeigt wird. Ein DecoratedText 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 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 werden soll, und wird über dem Textinhalt angezeigt.

Parameter

Name	Typ	Beschreibung
`text`	`String`	Der Labeltext.

Rückflug

DecoratedText: Dieses Objekt zur Verkettung.

`setWrapText(wrapText)`

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

Parameter

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

Rückflug

DecoratedText: Dieses Objekt zur Verkettung.