Class DecoratedText

Textedécoré

Widget qui affiche du texte avec des décorations facultatives. Les clés possibles incluent une icône, un libellé au-dessus et un libellé en dessous. Il est obligatoire de définir le contenu textuel et l'une des clés à l'aide de setText(text) et de l'une des clés DecoratedText, DecoratedText, setTopLabel(text) ou setBottomLabel(text). Cette classe est destinée à remplacer KeyValue.

Disponible pour les modules complémentaires Google Workspace et les applications Google Chat.

const decoratedText =
    CardService.newDecoratedText().setText('Text').setTopLabel('TopLabel');

const multilineDecoratedText = CardService.newDecoratedText()
                                   .setText('Text')
                                   .setTopLabel('TopLabel')
                                   .setWrapText(true)
                                   .setBottomLabel('BottomLabel');

Méthodes

MéthodeType renvoyéBrève description
addEventAction(eventAction)WidgetAjoute l'action d'événement qui peut être effectuée sur le widget.
setAuthorizationAction(action)DecoratedTextDéfinit une action d'autorisation qui ouvre une URL vers le flux d'autorisation lorsque l'utilisateur clique sur l'objet.
setBottomLabel(text)DecoratedTextDéfinit le texte du libellé à utiliser comme clé et l'affiche sous le contenu textuel.
setButton(button)DecoratedTextDéfinit le Button qui s'affiche à droite du texte.
setComposeAction(action, composedEmailType)DecoratedTextDéfinit une action qui compose un brouillon d'e-mail lorsque l'objet est cliqué.
setEndIcon(endIcon)DecoratedTextDéfinit le IconImage facultatif qui s'affiche à droite du contenu.
setId(id)WidgetDéfinit l'ID unique attribué qui est utilisé pour identifier le widget à modifier.
setOnClickAction(action)DecoratedTextDéfinit une action qui s'exécute lorsque l'objet est cliqué.
setOnClickOpenLinkAction(action)DecoratedTextDéfinit une action qui ouvre une URL dans un onglet lorsque l'objet est cliqué.
setOpenLink(openLink)DecoratedTextDéfinit une URL à ouvrir lorsque l'objet est cliqué.
setStartIcon(startIcon)DecoratedTextDéfinit le IconImage facultatif à afficher avant le contenu textuel.
setSwitchControl(switchToSet)DecoratedTextDéfinit le Switch qui s'affiche à droite du contenu.
setText(text)DecoratedTextDéfinit le texte à utiliser comme valeur.
setTopLabel(text)DecoratedTextDéfinit le texte du libellé à utiliser comme clé et s'affiche au-dessus du contenu textuel.
setVisibility(visibility)WidgetDéfinit la visibilité du widget.
setWrapText(wrapText)DecoratedTextIndique si le texte de la valeur doit être affiché sur une ou plusieurs lignes.

Documentation détaillée

addEventAction(eventAction)

Ajoute l'action d'événement qui peut être effectuée sur le widget.

Paramètres

NomTypeDescription
eventActionEventActionEventAction à ajouter.

Renvois

Widget : objet pour le chaînage.


setAuthorizationAction(action)

Définit une action d'autorisation qui ouvre une URL vers le flux d'autorisation lorsque l'utilisateur clique sur l'objet. L'URL s'ouvre dans une nouvelle fenêtre. Lorsque l'utilisateur termine le flux d'autorisation et revient à l'application, le module complémentaire se recharge.

Un objet d'UI ne peut avoir qu'une seule des valeurs setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType).

// ...

const action = CardService.newAuthorizationAction().setAuthorizationUrl('url');
CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);

Paramètres

NomTypeDescription
actionAuthorizationActionObjet qui spécifie l'action d'autorisation à effectuer lorsque l'utilisateur clique sur cet élément.

Renvois

DecoratedText : cet objet, pour le chaînage.


setBottomLabel(text)

Définit le texte du libellé à utiliser comme clé et l'affiche sous le contenu textuel.

Paramètres

NomTypeDescription
textStringTexte du libellé.

Renvois

DecoratedText : cet objet, pour le chaînage.


setButton(button)

Définit le Button qui s'affiche à droite du texte. Un DecoratedText ne peut prendre en charge qu'un seul bouton ou un seul commutateur.

Paramètres

NomTypeDescription
buttonButtonBouton à ajouter.

Renvois

DecoratedText : cet objet, pour le chaînage.


setComposeAction(action, composedEmailType)

Définit une action qui compose un brouillon d'e-mail lorsque l'objet est cliqué. Un objet d'interface utilisateur ne peut avoir qu'un seul des attributs setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType) défini.

Le paramètre Action doit spécifier une fonction de rappel qui renvoie un objet ComposeActionResponse configuré à l'aide de ComposeActionResponseBuilder.setGmailDraft(draft).

// ...

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

Paramètres

NomTypeDescription
actionActionObjet qui spécifie l'action de composition à effectuer lorsque cet élément est cliqué.
composedEmailTypeComposedEmailTypeValeur enum qui indique si le brouillon composé est un brouillon autonome ou de réponse.

Renvois

DecoratedText : cet objet, pour le chaînage.


setEndIcon(endIcon)

Définit le IconImage facultatif qui s'affiche à droite du contenu. Un DecoratedText ne peut contenir qu'un seul bouton, un seul bouton bascule ou une seule icône.

Paramètres

NomTypeDescription
endIconIconImageIcône à ajouter.

Renvois

DecoratedText : cet objet, pour le chaînage.


setId(id)

Définit l'ID unique attribué qui est utilisé pour identifier le widget à modifier. La mutation de widget n'est disponible que dans les modules complémentaires.

Paramètres

NomTypeDescription
idStringID du widget, limité à 64 caractères et au format `[a-zA-Z0-9-]+`.

Renvois

Widget : cet objet, pour le chaînage.


setOnClickAction(action)

Définit une action qui s'exécute lorsque l'objet est cliqué. Un objet d'UI ne peut avoir qu'une seule des valeurs setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType).

Le paramètre Action doit spécifier une fonction de rappel qui renvoie un objet ActionResponse.

// ...

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

Paramètres

NomTypeDescription
actionActionAction à effectuer lorsque l'utilisateur clique sur cet élément.

Renvois

DecoratedText : cet objet, pour le chaînage.


setOnClickOpenLinkAction(action)

Définit une action qui ouvre une URL dans un onglet lorsque l'objet est cliqué. Utilisez cette fonction lorsque l'URL doit être créée ou lorsque vous devez effectuer d'autres actions en plus de créer l'objet OpenLink. Un objet d'interface utilisateur ne peut avoir qu'une seule des valeurs setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType).

Le paramètre Action doit spécifier une fonction de rappel qui renvoie un objet ActionResponse configuré à l'aide de ActionResponseBuilder.setOpenLink(openLink).

// ...

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

Paramètres

NomTypeDescription
actionActionObjet qui spécifie l'action d'ouverture du lien à effectuer lorsque l'utilisateur clique sur cet élément.

Renvois

DecoratedText : cet objet, pour le chaînage.


Définit une URL à ouvrir lorsque l'objet est cliqué. Utilisez cette fonction lorsque l'URL est déjà connue et qu'elle doit uniquement être ouverte. Un objet d'interface utilisateur ne peut avoir qu'une seule des valeurs setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType).

Paramètres

NomTypeDescription
openLinkOpenLinkObjet OpenLink décrivant l'URL à ouvrir.

Renvois

DecoratedText : cet objet, pour le chaînage.


setStartIcon(startIcon)

Définit le IconImage facultatif à afficher avant le contenu textuel.

Paramètres

NomTypeDescription
startIconIconImageIcône à afficher.

Renvois

DecoratedText : cet objet, pour le chaînage.


setSwitchControl(switchToSet)

Définit le Switch qui s'affiche à droite du contenu. Un DecoratedText ne peut prendre en charge qu'un seul bouton ou un seul commutateur.

Paramètres

NomTypeDescription
switchToSetSwitchBascule à ajouter.

Renvois

DecoratedText : cet objet, pour le chaînage.


setText(text)

Définit le texte à utiliser comme valeur. Compatible avec la mise en forme HTML de base. Obligatoire.

Paramètres

NomTypeDescription
textStringContenu textuel de ce widget.

Renvois

DecoratedText : cet objet, pour le chaînage.


setTopLabel(text)

Définit le texte du libellé à utiliser comme clé et s'affiche au-dessus du contenu textuel.

Paramètres

NomTypeDescription
textStringTexte du libellé.

Renvois

DecoratedText : cet objet, pour le chaînage.


setVisibility(visibility)

Définit la visibilité du widget. La valeur par défaut est "VISIBLE".

Paramètres

NomTypeDescription
visibilityVisibilityLe Visibility du widget.

Renvois

Widget : objet pour le chaînage.


setWrapText(wrapText)

Indique si le texte de la valeur doit être affiché sur une ou plusieurs lignes.

Paramètres

NomTypeDescription
wrapTextBooleanSi la valeur est true, le texte est renvoyé à la ligne et affiché sur plusieurs lignes. Sinon, le texte est tronqué.

Renvois

DecoratedText : cet objet, pour le chaînage.