Class Button

Button

Classe de base pour tous les boutons.

Disponible pour les modules complémentaires Google Workspace et les applications Google Chat.

Méthodes

MéthodeType renvoyéBrève description
setAuthorizationAction(action)ButtonDéfinit une action d'autorisation qui ouvre une URL vers le flux d'autorisation lorsqu'un utilisateur clique sur l'objet.
setComposeAction(action, composedEmailType)ButtonDéfinit une action qui compose un e-mail brouillon lorsque l'utilisateur clique sur l'objet.
setOnClickAction(action)ButtonDéfinit une action qui s'exécute lorsque l'utilisateur clique sur l'objet.
setOnClickOpenLinkAction(action)ButtonDéfinit une action qui ouvre une URL dans un onglet lorsqu'un utilisateur clique sur l'objet.
setOpenLink(openLink)ButtonDéfinit une URL à ouvrir lorsque l'utilisateur clique sur l'objet.
setOverflowMenu(menu)ButtonDéfinit un menu pop-up à ouvrir lorsque l'utilisateur clique sur l'objet.

Documentation détaillée

setAuthorizationAction(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 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

NomTypeDescription
actionAuthorizationActionObjet qui spécifie l'action d'autorisation à effectuer lorsqu'un utilisateur clique sur cet élément.

Renvois

Button : cet objet, pour le chaînage.


setComposeAction(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 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).

// ...

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

NomTypeDescription
actionActionObjet qui spécifie l'action de composition à effectuer lorsque cet élément est cliqué.
composedEmailTypeComposedEmailTypeValeur d'énumération indiquant si le brouillon composé est un brouillon autonome ou de réponse.

Renvois

Button : cet objet, pour le chaînage.


setOnClickAction(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 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

NomTypeDescription
actionActionAction à effectuer lorsque l'utilisateur clique sur cet élément.

Renvois

Button : cet objet, pour le chaînage.


setOnClickOpenLinkAction(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 OpenLink. Un objet d'interface utilisateur ne peut avoir qu'une seule valeur définie parmi 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

NomTypeDescription
actionActionObjet qui spécifie l'action d'ouverture du lien à effectuer lorsque cet élément est cliqué.

Renvois

Button : cet objet, pour le chaînage.


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 setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType).

Paramètres

NomTypeDescription
openLinkOpenLinkObjet OpenLink décrivant l'URL à ouvrir.

Renvois

Button : cet objet, pour le chaînage.


setOverflowMenu(menu)

Définit un menu pop-up à ouvrir lorsque l'utilisateur clique sur l'objet. Chaque élément du menu peut spécifier une action à déclencher lorsqu'il est cliqué. Les menus imbriqués ne sont pas acceptés. Les actions pour les éléments de menu ne doivent pas spécifier de menu à développer.

Disponible uniquement pour les applications Google Chat. Non disponible pour les modules complémentaires Google Workspace.

const overflowMenuItem =
    CardService.newOverflowMenuItem()
        .setStartIcon(
            CardService.newIconImage().setIconUrl(
                'https://www.google.com/images/branding/googleg/1x/googleg_standard_color_64dp.png',
                ),
            )
        .setText('Open Link')
        .setOpenLink(
            CardService.newOpenLink().setUrl('https://www.google.com'));

const overflowMenu =
    CardService.newOverflowMenu().addMenuItem(overflowMenuItem).build();

Paramètres

NomTypeDescription
menuOverflowMenuObjet qui spécifie le menu déroulant à afficher lorsque l'utilisateur clique sur cet élément.

Renvois

Button : cet objet, pour le chaînage.