Class DecoratedText

DecoratedText

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 du texte 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éthode	Type renvoyé	Brève description
addEventAction(eventAction)	Widget	Ajoute l'action d'événement pouvant être effectuée sur le widget.
setAuthorizationAction(action)	DecoratedText	Définit une action d'autorisation qui ouvre une URL vers le flux d'autorisation lorsque l'utilisateur clique sur l'objet.
setBottomLabel(text)	DecoratedText	Définit le texte du libellé à utiliser comme clé et l'affiche sous le contenu textuel.
setButton(button)	DecoratedText	Définit le Button qui s'affiche à droite du texte.
setComposeAction(action, composedEmailType)	DecoratedText	Définit une action qui compose un brouillon d'e-mail lorsque l'objet est cliqué.
setEndIcon(endIcon)	DecoratedText	Définit le IconImage facultatif qui s'affiche à droite du contenu.
setId(id)	Widget	Définit l'ID unique attribué qui est utilisé pour identifier le widget à modifier.
setOnClickAction(action)	DecoratedText	Définit une action qui s'exécute lorsque l'utilisateur clique sur l'objet.
setOnClickOpenLinkAction(action)	DecoratedText	Définit une action qui ouvre une URL dans un onglet lorsque l'objet est cliqué.
setOpenLink(openLink)	DecoratedText	Définit une URL à ouvrir lorsque l'objet est cliqué.
setStartIcon(startIcon)	DecoratedText	Définit le IconImage facultatif à afficher avant le contenu textuel.
setSwitchControl(switchToSet)	DecoratedText	Définit le Switch qui s'affiche à droite du contenu.
setText(text)	DecoratedText	Définit le texte à utiliser comme valeur.
setTopLabel(text)	DecoratedText	Définit le texte du libellé à utiliser comme clé et qui s'affiche au-dessus du contenu textuel.
setVisibility(visibility)	Widget	Définit la visibilité du widget.
setWrapText(wrapText)	DecoratedText	Indique 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 pouvant être effectuée sur le widget.

Paramètres

Nom	Type	Description
eventAction	EventAction	EventAction à 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'interface utilisateur 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

Nom	Type	Description
action	AuthorizationAction	Objet 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

Nom	Type	Description
text	String	Texte 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

Nom	Type	Description
button	Button	Bouton à 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'une seule des valeurs setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType) définie.

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

Remarque : Cette méthode ne définit pas d'action Compose utilisée pour étendre l'UI Compose. Cette méthode connecte plutôt cet élément d'UI à un Action qui compose des brouillons de messages dans Apps Script, lesquels sont ouverts dans Gmail une fois l'action terminée.

// ...

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

Nom	Type	Description
action	Action	Objet qui spécifie l'action de composition à effectuer lorsque l'utilisateur clique sur cet élément.
composedEmailType	ComposedEmailType	Valeur 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 commutateur ou une seule icône.

Paramètres

Nom	Type	Description
endIcon	IconImage	Icô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

Nom	Type	Description
id	String	ID 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'utilisateur clique sur l'objet. 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.

// ...

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

Nom	Type	Description
action	Action	Action à 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'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 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

Nom	Type	Description
action	Action	Objet 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.

---

setOpenLink(openLink)

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'UI ne peut avoir qu'une seule des valeurs setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType) définie.

Paramètres

Nom	Type	Description
openLink	OpenLink	Objet 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

Nom	Type	Description
startIcon	IconImage	Icô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

Nom	Type	Description
switchToSet	Switch	Le commutateur à 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

Nom	Type	Description
text	String	Contenu textuel de ce widget.

Renvois

DecoratedText : cet objet, pour le chaînage.

---

setTopLabel(text)

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

Paramètres

Nom	Type	Description
text	String	Texte 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

Nom	Type	Description
visibility	Visibility	Le 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

Nom	Type	Description
wrapText	Boolean	Si 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.