Class Grid

Grid

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
addEventAction(eventAction)	Widget	Ajoute l'action d'événement qui peut être effectuée sur le widget.
addItem(gridItem)	Grid	Ajoute un élément de grille à 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 grille.
setComposeAction(action, composedEmailType)	Grid	Définit une action qui rédige un brouillon d'e-mail lorsque l'utilisateur clique sur l'objet.
setId(id)	Widget	Définit l'ID unique attribué qui est utilisé pour identifier le widget à modifier.
setNumColumns(numColumns)	Grid	Nombre de colonnes à afficher dans la grille.
setOnClickAction(action)	Grid	Définit une action qui s'exécute lorsque l'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 lorsque l'utilisateur clique sur l'objet.
setTitle(title)	Grid	Définit le texte du titre de la grille.
setVisibility(visibility)	Widget	Définit la visibilité du widget.

Documentation détaillée

addEventAction(eventAction)

Ajoute l'action d'événement qui peut être effectuée sur le widget.

Paramètres

Nom	Type	Description
eventAction	EventAction	Le EventAction à ajouter.

Renvois

Widget : objet, pour le chaînage.

---

addItem(gridItem)

Ajoute un élément de grille à la grille.

Paramètres

Nom	Type	Description
gridItem	GridItem	Élément de grille à ajouter.

Renvois

Grid : cet 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 seul des éléments suivants peut être défini pour un objet d'interface utilisateur : 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

Grid : cet objet, pour le chaînage.

---

setBorderStyle(borderStyle)

Définit le style de bordure appliqué à chaque élément de grille. La valeur par défaut est NO_BORDER.

Paramètres

Nom	Type	Description
borderStyle	BorderStyle	Style de bordure à appliquer.

Renvois

Grid : cet objet, pour le chaînage.

---

setComposeAction(action, composedEmailType)

Définit une action qui rédige un brouillon d'e-mail lorsque l'utilisateur clique sur l'objet. Un seul des éléments suivants peut être défini pour un objet d'interface utilisateur : 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 ComposeActionResponse configuré à l'aide de ComposeActionResponseBuilder.setGmailDraft(draft).

Remarque : Cette méthode ne définit pas d'action de rédaction utilisée pour étendre l'interface utilisateur de rédaction. Elle connecte plutôt cet élément d'interface utilisateur à un Action qui rédige 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 rédaction à effectuer lorsque l'utilisateur clique sur cet élément.
composedEmailType	ComposedEmailType	Valeur d'énumération qui indique si le brouillon rédigé est un brouillon autonome ou une réponse.

Renvois

Grid : cet objet, pour le chaînage.

---

setId(id)

Définit l'ID unique attribué qui est utilisé pour identifier le widget à modifier. La modification des widgets n'est possible 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.

---

setNumColumns(numColumns)

Nombre de colonnes à afficher dans la grille. Si la grille s'affiche dans le panneau latéral droit, vous pouvez afficher une ou deux colonnes. La valeur par défaut est 1. Si la grille s'affiche dans une boîte de dialogue, vous pouvez afficher deux ou trois colonnes. La valeur par défaut est 2.

Paramètres

Nom	Type	Description
numColumns	Integer	Nombre de colonnes.

Renvois

Grid : cet objet, pour le chaînage.

---

setOnClickAction(action)

Définit une action qui s'exécute lorsque l'utilisateur clique sur l'objet. Un seul des éléments suivants peut être défini pour un objet d'interface utilisateur : 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

Grid : cet 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 créer l'objet OpenLink. Un seul des éléments suivants peut être défini pour un objet d'interface utilisateur : 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 de lien à effectuer lorsque l'utilisateur clique sur cet élément.

Renvois

Grid : cet objet, pour le chaînage.

---

setOpenLink(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 doit uniquement être ouverte. Un seul des éléments suivants peut être défini pour un objet d'interface utilisateur : setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType).

Paramètres

Nom	Type	Description
openLink	OpenLink	Objet OpenLink décrivant l'URL à ouvrir.

Renvois

Grid : cet 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 : 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	Visibility du widget.

Renvois

Widget : objet, pour le chaînage.