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. Vous devez définir le contenu textuel et l'une des clés à l'aide de set et de l'une des valeurs Decorated, Decorated, set ou set. Cette classe est destinée à remplacer .
Key
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 |
|---|---|---|
set | Decorated | Définit une action d'autorisation qui ouvre une URL vers le flux d'autorisation lorsqu'un utilisateur clique sur l'objet. |
set | Decorated | Définit le texte de l'étiquette à utiliser comme clé et qui s'affiche sous le contenu textuel. |
set | Decorated | Définit le Button qui s'affiche à droite du texte. |
set | Decorated | Définit une action qui compose un e-mail brouillon lorsque l'utilisateur clique sur l'objet. |
set | Decorated | Définit l'Icon facultatif qui s'affiche à droite du contenu. |
set | Decorated | Définit une action qui s'exécute lorsque l'utilisateur clique sur l'objet. |
set | Decorated | Définit une action qui ouvre une URL dans un onglet lorsqu'un utilisateur clique sur l'objet. |
set | Decorated | Définit une URL à ouvrir lorsque l'utilisateur clique sur l'objet. |
set | Decorated | Définit l'Icon facultatif à afficher avant le contenu textuel. |
set | Decorated | Définit les Switch qui s'affichent à droite du contenu. |
set | Decorated | Définit le texte à utiliser comme valeur. |
set | Decorated | Définit le texte du libellé à utiliser comme clé et qui s'affiche au-dessus du contenu textuel. |
set | Decorated | Indique si le texte de la valeur doit être affiché sur une seule ligne ou sur plusieurs lignes. |
Documentation détaillée
set Authorization Action(action)
Définit une action d'autorisation qui ouvre une URL vers le flux d'autorisation lorsqu'un 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 valeur définie parmi set, set, set, set ou set.
// ... const action = CardService.newAuthorizationAction().setAuthorizationUrl('url'); CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);
Paramètres
| Nom | Type | Description |
|---|---|---|
action | Authorization | Objet qui spécifie l'action d'autorisation à effectuer lorsqu'un utilisateur clique sur cet élément. |
Renvois
Decorated : cet objet, pour le chaînage.
set Bottom Label(text)
Définit le texte de l'étiquette à utiliser comme clé et qui s'affiche sous le contenu textuel.
Paramètres
| Nom | Type | Description |
|---|---|---|
text | String | Texte du libellé. |
Renvois
Decorated : cet objet, pour le chaînage.
set Button(button)
Définit le Button qui s'affiche à droite du texte. Un Decorated ne peut prendre en charge qu'un seul bouton ou un seul bouton bascule.
Paramètres
| Nom | Type | Description |
|---|---|---|
button | Button | Bouton d'ajout. |
Renvois
Decorated : cet objet, pour le chaînage.
set Compose Action(action, composedEmailType)
Définit une action qui compose un e-mail brouillon lorsque l'utilisateur clique sur l'objet. Un objet d'interface utilisateur ne peut avoir qu'une seule valeur parmi set, set, set, set ou set.
Le paramètre Action doit spécifier une fonction de rappel qui renvoie un objet Compose configuré à l'aide de Compose.
// ... 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 cet élément est cliqué. |
composed | Composed | Valeur d'énumération indiquant si le brouillon composé est un brouillon autonome ou de réponse. |
Renvois
Decorated : cet objet, pour le chaînage.
set End Icon(endIcon)
Définit l'Icon facultatif qui s'affiche à droite du contenu. Un Decorated ne peut contenir qu'un seul bouton, un seul bouton bascule ou une seule icône.
Paramètres
| Nom | Type | Description |
|---|---|---|
end | Icon | Icône à ajouter. |
Renvois
Decorated : cet objet, pour le chaînage.
set On Click Action(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 valeur parmi set, set, set, set ou set.
Le paramètre Action doit spécifier une fonction de rappel qui renvoie un objet Action.
// ... 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
Decorated : cet objet, pour le chaînage.
set On Click Open Link Action(action)
Définit une action qui ouvre une URL dans un onglet lorsqu'un utilisateur clique sur l'objet. 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 Open. Un objet d'interface utilisateur ne peut avoir qu'une seule valeur définie parmi set, set, set, set ou set.
Le paramètre Action doit spécifier une fonction de rappel qui renvoie un objet Action configuré à l'aide de Action.
// ... 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 cet élément est cliqué. |
Renvois
Decorated : cet objet, pour le chaînage.
set Open Link(openLink)
Définit une URL à ouvrir lorsque l'utilisateur clique sur l'objet. Utilisez cette fonction lorsque l'URL est déjà connue et qu'elle ne doit être ouverte que. Un objet d'interface utilisateur ne peut avoir qu'une seule valeur parmi set, set, set, set ou set.
Paramètres
| Nom | Type | Description |
|---|---|---|
open | Open | Objet Open décrivant l'URL à ouvrir. |
Renvois
Decorated : cet objet, pour le chaînage.
set Start Icon(startIcon)
Définit l'Icon facultatif à afficher avant le contenu textuel.
Paramètres
| Nom | Type | Description |
|---|---|---|
start | Icon | Icône à afficher. |
Renvois
Decorated : cet objet, pour le chaînage.
set Switch Control(switchToSet)
Définit les Switch qui s'affichent à droite du contenu. Un Decorated ne peut prendre en charge qu'un seul bouton ou un seul bouton-poussoir.
Paramètres
| Nom | Type | Description |
|---|---|---|
switch | Switch | Bouton à ajouter. |
Renvois
Decorated : cet objet, pour le chaînage.
set Text(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
Decorated : cet objet, pour le chaînage.
set Top Label(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
Decorated : cet objet, pour le chaînage.
set Wrap Text(wrapText)
Indique si le texte de la valeur doit être affiché sur une seule ligne ou sur plusieurs lignes.
Paramètres
| Nom | Type | Description |
|---|---|---|
wrap | Boolean | Si la valeur est true, le texte est mis en forme et affiché sur plusieurs lignes. Sinon, le texte est tronqué. |
Renvois
Decorated : cet objet, pour le chaînage.