Class DecoratedText

DekorierterText

Ein Widget, das Text mit optionalen Verzierungen anzeigt. Mögliche Schlüssel sind ein Symbol, ein Label oben und ein Label unten. 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

MethodeRückgabetypKurzbeschreibung
setAuthorizationAction(action)DecoratedTextHiermit wird eine Autorisierungsaktion festgelegt, durch die beim Klicken auf das Objekt eine URL zum Autorisierungsvorgang geöffnet wird.
setBottomLabel(text)DecoratedTextHier legen Sie den Labeltext fest, der als Schlüssel verwendet werden soll. Er wird unter dem Textinhalt angezeigt.
setButton(button)DecoratedTextHiermit wird das Button festgelegt, das rechts neben dem Text angezeigt wird.
setComposeAction(action, composedEmailType)DecoratedTextHier legen Sie eine Aktion fest, durch die ein E-Mail-Entwurf erstellt wird, wenn auf das Objekt geklickt wird.
setEndIcon(endIcon)DecoratedTextHiermit wird das optionale IconImage festgelegt, das rechts neben den Inhalten angezeigt wird.
setOnClickAction(action)DecoratedTextHier legen Sie eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird.
setOnClickOpenLinkAction(action)DecoratedTextHiermit wird eine Aktion festgelegt, durch die eine URL in einem Tab geöffnet wird, wenn auf das Objekt geklickt wird.
setOpenLink(openLink)DecoratedTextHier wird eine URL festgelegt, 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)DecoratedTextHiermit wird das Switch festgelegt, das rechts neben dem Inhalt angezeigt wird.
setText(text)DecoratedTextHier legen Sie den Text fest, der als Wert verwendet werden soll.
setTopLabel(text)DecoratedTextHier legen Sie den Labeltext fest, der als Schlüssel verwendet werden soll. Er wird über dem Textinhalt angezeigt.
setWrapText(wrapText)DecoratedTextHiermit wird festgelegt, ob der Werttext in einer oder mehreren Zeilen angezeigt werden soll.

Detaillierte Dokumentation

setAuthorizationAction(action)

Hiermit wird eine Autorisierungsaktion festgelegt, durch die beim Klicken auf das Objekt eine URL zum Autorisierungsvorgang 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

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

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

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

// ...

const action = CardService.newAction().setFunctionName('composeEmailCallback');
CardService.newTextButton()
    .setText('Compose Email')
    .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT);

// ...

function composeEmailCallback(e) {
  const thread = GmailApp.getThreadById(e.threadId);
  const draft = thread.createDraftReply('This is a reply');
  return CardService.newComposeActionResponseBuilder()
      .setGmailDraft(draft)
      .build();
}

Parameter

NameTypBeschreibung
actionActionDas Objekt, das die Aktion angibt, die ausgeführt werden soll, wenn auf dieses Element geklickt wird.
composedEmailTypeComposedEmailTypeEin 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)

Hiermit wird das optionale IconImage festgelegt, das rechts neben den Inhalten angezeigt wird. Ein DecoratedText kann nur eine Taste, einen Schalter oder ein Symbol unterstützen.

Parameter

NameTypBeschreibung
endIconIconImageDas hinzuzufügende Symbol.

Rückflug

DecoratedText – dieses Objekt, zur Verkettung


setOnClickAction(action)

Hier legen Sie 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

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

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


Hier 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 einer der folgenden Werte festgelegt werden: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) oder setComposeAction(action, composedEmailType).

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)

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

Parameter

NameTypBeschreibung
switchToSetSwitchDer hinzuzufügende Schalter.

Rückflug

DecoratedText – dieses Objekt, zur Verkettung


setText(text)

Hier legen Sie den Text fest, der als Wert verwendet werden soll. Unterstützt die einfache HTML-Formatierung. Erforderlich.

Parameter

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

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

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

Rückflug

DecoratedText – dieses Objekt, zur Verkettung