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 set et de l'une des clés 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 |
|---|---|---|
add | Widget | Ajoute l'action d'événement qui peut être effectuée sur le widget. |
set | Decorated | Définit une action d'autorisation qui ouvre une URL vers le flux d'autorisation lorsque l'utilisateur clique sur l'objet. |
set | Decorated | Définit le texte du libellé à utiliser comme clé et l'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 brouillon d'e-mail lorsque l'objet est cliqué. |
set | Decorated | Définit le Icon facultatif qui s'affiche à droite du contenu. |
set | Widget | Définit l'ID unique attribué qui est utilisé pour identifier le widget à modifier. |
set | Decorated | Définit une action qui s'exécute lorsque l'objet est cliqué. |
set | Decorated | Définit une action qui ouvre une URL dans un onglet lorsque l'objet est cliqué. |
set | Decorated | Définit une URL à ouvrir lorsque l'objet est cliqué. |
set | Decorated | Définit le Icon facultatif à afficher avant le contenu textuel. |
set | Decorated | Définit le Switch qui s'affiche à droite du contenu. |
set | Decorated | Définit le texte à utiliser comme valeur. |
set | Decorated | Définit le texte du libellé à utiliser comme clé et s'affiche au-dessus du contenu textuel. |
set | Widget | Définit la visibilité du widget. |
set | Decorated | Indique si le texte de la valeur doit être affiché sur une ou plusieurs lignes. |
Documentation détaillée
add Event Action(eventAction)
Ajoute l'action d'événement qui peut être effectuée sur le widget.
Paramètres
| Nom | Type | Description |
|---|---|---|
event | Event | Event à ajouter. |
Renvois
Widget : objet pour le chaînage.
set Authorization Action(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 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 lorsque l'utilisateur clique sur cet élément. |
Renvois
Decorated : cet objet, pour le chaînage.
set Bottom Label(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
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 commutateur.
Paramètres
| Nom | Type | Description |
|---|---|---|
button | Button | Bouton à ajouter. |
Renvois
Decorated : cet objet, pour le chaînage.
set Compose Action(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 set, set, set, set ou set défini.
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 enum qui indique 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 le 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 Id(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.
set On Click Action(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 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 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 Open. Un objet d'interface utilisateur ne peut avoir qu'une seule des valeurs 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 l'utilisateur clique sur cet élément. |
Renvois
Decorated : cet objet, pour le chaînage.
set Open Link(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'interface utilisateur ne peut avoir qu'une seule des valeurs 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 le 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 le Switch qui s'affiche à droite du contenu. Un Decorated ne peut prendre en charge qu'un seul bouton ou un seul commutateur.
Paramètres
| Nom | Type | Description |
|---|---|---|
switch | Switch | Bascule à 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 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 Visibility(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.
set Wrap Text(wrapText)
Indique si le texte de la valeur doit être affiché sur une ou plusieurs lignes.
Paramètres
| Nom | Type | Description |
|---|---|---|
wrap | Boolean | Si la valeur est true, le texte est renvoyé à la ligne et affiché sur plusieurs lignes. Sinon, le texte est tronqué. |
Renvois
Decorated : cet objet, pour le chaînage.