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 oben und ein Label darunter. Der Textinhalt und einer der Schlüssel müssen mit setText(text) und entweder DecoratedText, DecoratedText, setTopLabel(text) oder setBottomLabel(text) festgelegt werden. Diese Klasse soll KeyValue ersetzen.

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, mit der eine URL zum Autorisierungsablauf geöffnet wird, wenn auf das Objekt geklickt wird.
`setBottomLabel(text)`	`DecoratedText`	Legt den Labeltext fest, der als Schlüssel verwendet werden soll, und wird unter dem Textinhalt angezeigt.
`setButton(button)`	`DecoratedText`	Legt die `Button` fest, die rechts neben dem Text angezeigt wird.
`setComposeAction(action, composedEmailType)`	`DecoratedText`	Legt eine Aktion fest, die einen E-Mail-Entwurf erstellt, wenn auf das Objekt geklickt wird.
`setEndIcon(endIcon)`	`DecoratedText`	Legt die optionale `IconImage` fest, die 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, mit der eine URL in einem Tab geöffnet wird, wenn auf das Objekt geklickt wird.
`setOpenLink(openLink)`	`DecoratedText`	Legt eine URL fest, die beim Klicken auf das Objekt geöffnet werden soll.
`setStartIcon(startIcon)`	`DecoratedText`	Legt die optionale `IconImage` fest, die 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 werden soll, und wird über dem Textinhalt angezeigt.
`setWrapText(wrapText)`	`DecoratedText`	Legt fest, ob der Werttext in einer oder mehreren Zeilen angezeigt werden soll.

Detaillierte Dokumentation

`setAuthorizationAction(action)`

Legt eine Autorisierungsaktion fest, mit der eine URL zum Autorisierungsablauf geöffnet wird, wenn auf das Objekt geklickt wird. Die URL wird in einem neuen Fenster geöffnet. Wenn der Nutzer den Autorisierungsvorgang abschließt und zur 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 auf dieses Element geklickt wird.

Zurücksenden

DecoratedText: Dieses Objekt zum Verketten.

`setBottomLabel(text)`

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

Parameter

Name	Typ	Beschreibung
`text`	`String`	Labeltext.

Zurücksenden

DecoratedText: Dieses Objekt zum Verketten.

`setButton(button)`

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

Parameter

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

Zurücksenden

DecoratedText: Dieses Objekt zum Verketten.

`setComposeAction(action, composedEmailType)`

Legt eine Aktion fest, die einen E-Mail-Entwurf erstellt, wenn auf das Objekt geklickt wird. Für ein UI-Objekt kann nur 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.

Hinweis: Mit dieser Methode wird keine Zusammensetzungsaktion festgelegt, mit der die Benutzeroberfläche zum Schreiben erweitert wird. Stattdessen wird mit dieser Methode dieses UI-Element mit einem Action verbunden, das E-Mail-Entwürfe in Apps Script erstellt, die nach Abschluss der Aktion in Gmail geöffnet werden.

// ...

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 auf dieses Element geklickt wird.
`composedEmailType`	`ComposedEmailType`	Ein Enum-Wert, der angibt, ob es sich beim erstellten Entwurf um einen eigenständigen oder einen Antwortentwurf handelt.

Zurücksenden

DecoratedText: Dieses Objekt zum Verketten.

`setEndIcon(endIcon)`

Legt die optionale IconImage fest, die 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.

Zurücksenden

DecoratedText: Dieses Objekt zum Verketten.

`setOnClickAction(action)`

Legt eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird. Für ein UI-Objekt kann nur 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.

// ...

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`	Die Aktion, die ausgeführt werden soll, wenn auf dieses Element geklickt wird.

Zurücksenden

DecoratedText: Dieses Objekt zum Verketten.

`setOnClickOpenLinkAction(action)`

Legt eine Aktion fest, mit der eine URL in einem Tab geöffnet wird, wenn auf das Objekt geklickt wird. Verwende diese Funktion, wenn die URL erstellt werden muss oder du zusätzliche Aktionen ausführen musst, um das Objekt OpenLink zu erstellen. Für ein UI-Objekt kann nur setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) oder setComposeAction(action, composedEmailType) festgelegt werden.

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

Parameter

Name	Typ	Beschreibung
`action`	`Action`	Das Objekt, das die offene Linkaktion angibt, die ausgeführt werden soll, wenn auf dieses Element geklickt wird.

Zurücksenden

DecoratedText: Dieses Objekt zum Verketten.

`setOpenLink(openLink)`

Legt eine URL fest, die beim Klicken auf das Objekt geöffnet werden soll. 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 sein.

Parameter

Name	Typ	Beschreibung
`openLink`	`OpenLink`	Ein `OpenLink`-Objekt, das die zu öffnende URL beschreibt.

Zurücksenden

DecoratedText: Dieses Objekt zum Verketten.

`setStartIcon(startIcon)`

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

Parameter

Name	Typ	Beschreibung
`startIcon`	`IconImage`	Das anzuzeigende Symbol.

Zurücksenden

DecoratedText: Dieses Objekt zum Verketten.

`setSwitchControl(switchToSet)`

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

Parameter

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

Zurücksenden

DecoratedText: Dieses Objekt zum Verketten.

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

Zurücksenden

DecoratedText: Dieses Objekt zum Verketten.

`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`	Labeltext.

Zurücksenden

DecoratedText: Dieses Objekt zum Verketten.

`setWrapText(wrapText)`

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

Parameter

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

Zurücksenden

DecoratedText: Dieses Objekt zum Verketten.