Class DecoratedText

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

MethodeRückgabetypKurzbeschreibung
setAuthorizationAction(action)DecoratedTextLegt eine Autorisierungsaktion fest, durch die eine URL zum Autorisierungsablauf geöffnet wird, wenn das Objekt angeklickt wurde.
setBottomLabel(text)DecoratedTextLegt den Labeltext fest, der als Schlüssel verwendet werden soll, und wird unterhalb des Textinhalts angezeigt.
setButton(button)DecoratedTextLegt den Button fest, der rechts vom Text angezeigt wird.
setComposeAction(action, composedEmailType)DecoratedTextLegt eine Aktion fest, durch die ein E-Mail-Entwurf erstellt wird, wenn auf das Objekt geklickt wird.
setEndIcon(endIcon)DecoratedTextLegt das optionale IconImage fest, das rechts neben dem Inhalt angezeigt wird.
setOnClickAction(action)DecoratedTextLegt eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird.
setOnClickOpenLinkAction(action)DecoratedTextLegt eine Aktion fest, durch die beim Anklicken des Objekts eine URL in einem Tab geöffnet wird.
setOpenLink(openLink)DecoratedTextLegt eine URL fest, die geöffnet werden soll, wenn auf das Objekt geklickt wird.
setStartIcon(startIcon)DecoratedTextLegt das optionale IconImage fest, das vor dem Textinhalt angezeigt werden soll.
setSwitchControl(switchToSet)DecoratedTextLegt den Switch fest, der rechts vom Inhalt angezeigt wird.
setText(text)DecoratedTextLegt den Text fest, der als Wert verwendet werden soll.
setTopLabel(text)DecoratedTextLegt den Labeltext fest, der als Schlüssel verwendet werden soll, und wird über dem Textinhalt angezeigt.
setWrapText(wrapText)DecoratedTextLegt 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

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

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

NameTypBeschreibung
buttonButtonDie 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 type="x-smartling-placeholder">

// ...

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

NameTypBeschreibung
actionActionDas Objekt, das die Zusammensetzungsaktion angibt, die ausgeführt werden soll, wenn dieses Element angeklickt wurde.
composedEmailTypeComposedEmailTypeEin 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

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

NameTypBeschreibung
actionActionAktion, 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

NameTypBeschreibung
actionActionDas 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.


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

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

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

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

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

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

NameTypBeschreibung
wrapTextBooleanWenn true, wird der Text umgebrochen und auf mehreren Zeilen angezeigt. Andernfalls wird der Text abgeschnitten.

Rückflug

DecoratedText: Dieses Objekt zur Verkettung.