Grille organisée permettant d'afficher une collection d'éléments de grille.
Disponible pour les modules complémentaires Google Workspace et les applications Google Chat.
const grid = CardService.newGrid().setTitle('My Grid').setNumColumns(2).addItem( CardService.newGridItem().setTitle('My item'));
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. |
add | Grid | Ajoute un élément de grille à la grille. |
set | Grid | Définit une action d'autorisation qui ouvre une URL vers le flux d'autorisation lorsque l'utilisateur clique sur l'objet. |
set | Grid | Définit le style de bordure appliqué à chaque élément de la grille. |
set | Grid | Définit une action qui compose un brouillon d'e-mail lorsque l'objet est cliqué. |
set | Widget | Définit l'ID unique attribué qui est utilisé pour identifier le widget à modifier. |
set | Grid | Nombre de colonnes à afficher dans la grille. |
set | Grid | Définit une action qui s'exécute lorsque l'objet est cliqué. |
set | Grid | Définit une action qui ouvre une URL dans un onglet lorsque l'objet est cliqué. |
set | Grid | Définit une URL à ouvrir lorsque l'objet est cliqué. |
set | Grid | Définit le texte du titre de la grille. |
set | Widget | Définit la visibilité du widget. |
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.
add Item(gridItem)
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
Grid : cet objet, pour le chaînage.
set Border Style(borderStyle)
Définit le style de bordure appliqué à chaque élément de la grille. La valeur par défaut est NO_BORDER.
Paramètres
| Nom | Type | Description |
|---|---|---|
border | Border | Style de bordure à appliquer. |
Renvois
Grid : 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
Grid : 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 Num Columns(numColumns)
Nombre de colonnes à afficher dans la grille. Si elle s'affiche dans le panneau de droite, vous pouvez afficher une ou deux colonnes (la valeur par défaut est 1). Si elle est affichée dans une boîte de dialogue, vous pouvez afficher deux ou trois colonnes. La valeur par défaut est de deux colonnes.
Paramètres
| Nom | Type | Description |
|---|---|---|
num | Integer | Nombre de colonnes. |
Renvois
Grid : 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
Grid : 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
Grid : 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
Grid : cet objet, pour le chaînage.
set Title(title)
Définit le texte du titre de la grille. Le texte doit être une chaîne brute sans mise en forme.
Paramètres
| Nom | Type | Description |
|---|---|---|
title | String | Texte du titre. |
Renvois
Grid : 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.