Grille organisée pour afficher une collection d'éléments de grille.
Disponible avec les modules complémentaires Google Workspace et les applications Google Chat
var grid = CardService.newGrid() .setTitle("My Grid") .setNumColumns(2) .addItem(CardService.newGridItem() .setTitle("My item"));
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
addItem(gridItem) | Grid | Ajoute un nouvel élément à la grille. |
setAuthorizationAction(action) | Grid | Définit une action d'autorisation qui ouvre une URL vers le flux d'autorisation lorsque l'utilisateur clique sur l'objet. |
setBorderStyle(borderStyle) | Grid | Définit le style de bordure appliqué à chaque élément de la grille. |
setComposeAction(action, composedEmailType) | Grid | Définit une action qui permet de rédiger un brouillon d'e-mail lorsque l'utilisateur clique sur l'objet. |
setNumColumns(numColumns) | Grid | Nombre de colonnes à afficher dans la grille. |
setOnClickAction(action) | Grid | Définit une action qui s'exécute lorsqu'un utilisateur clique sur l'objet. |
setOnClickOpenLinkAction(action) | Grid | Définit une action qui ouvre une URL dans un onglet lorsque l'utilisateur clique sur l'objet. |
setOpenLink(openLink) | Grid | Définit une URL à ouvrir lors d'un clic sur l'objet. |
setTitle(title) | Grid | Définit le texte du titre de la grille. |
Documentation détaillée
addItem(gridItem)
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 a terminé le flux d'autorisation et retourne dans l'application, le module complémentaire est actualisé.
Un objet d'interface utilisateur ne peut être défini que sur setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
ou setComposeAction(action, composedEmailType)
.
// ... var 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 en cas de clic sur cet élément. |
Renvois
Grid
: objet pour le chaînage.
setBorderStyle(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 |
---|---|---|
borderStyle | BorderStyle | Style de bordure à appliquer. |
Renvois
Grid
: objet pour le chaînage.
setComposeAction(action, composedEmailType)
Définit une action qui permet de rédiger un brouillon d'e-mail lorsque l'utilisateur clique sur l'objet. Un objet d'interface utilisateur ne peut avoir qu'un seul des éléments 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)
.
// ... var action = CardService.newAction().setFunctionName('composeEmailCallback'); CardService.newTextButton() .setText('Compose Email') .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT); // ... function composeEmailCallback() { var thread = GmailApp.getThreadById(e.threadId); var 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 d'énumération qui indique si le brouillon composé est autonome ou en réponse à l'ébauche. |
Renvois
Grid
: objet pour le chaînage.
setNumColumns(numColumns)
Nombre de colonnes à afficher dans la grille. S'il est affiché dans le panneau latéral de droite, vous pouvez afficher une à deux colonnes. La valeur par défaut est 1. Si une boîte de dialogue s'affiche, vous pouvez afficher 2 à 3 colonnes. La valeur par défaut est 2.
Paramètres
Nom | Type | Description |
---|---|---|
numColumns | Integer | Nombre de colonnes. |
Renvois
Grid
: objet pour le chaînage.
setOnClickAction(action)
Définit une action qui s'exécute lorsqu'un utilisateur clique sur l'objet. Un objet d'interface utilisateur ne peut être défini que sur 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
.
// ... var 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 lorsqu'un utilisateur clique sur cet élément. |
Renvois
Grid
: objet pour le chaînage.
setOnClickOpenLinkAction(action)
Définit une action qui ouvre une URL dans un onglet lorsque l'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 la création de l'objet OpenLink
. Un objet d'interface utilisateur ne peut être défini que sur 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)
.
// ... var 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 spécifiant l'action d'ouverture du lien à effectuer en cas de clic sur cet élément. |
Renvois
Grid
: objet pour le chaînage.
setOpenLink(openLink)
Définit une URL à ouvrir lors d'un clic sur l'objet. Utilisez cette fonction lorsque l'URL est déjà connue et ne doit être ouverte que. Un objet d'interface utilisateur ne peut être défini que sur setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
ou setComposeAction(action, composedEmailType)
.
Paramètres
Nom | Type | Description |
---|---|---|
openLink | OpenLink | Un objet OpenLink décrivant l'URL à ouvrir. |
Renvois
Grid
: objet pour le chaînage.
setTitle(title)
Définit le texte du titre de la grille. Le texte doit être une chaîne simple sans mise en forme.
Paramètres
Nom | Type | Description |
---|---|---|
title | String | Texte du titre. |
Renvois
Grid
: objet pour le chaînage.