Class ImageButton

Bouton Image

ImageButton sur lequel est affichée une image

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

const imageButton =
    CardService.newImageButton()
        .setAltText('An image button with an airplane icon.')
        .setIcon(CardService.Icon.AIRPLANE)
        .setOpenLink(CardService.newOpenLink().setUrl('https://airplane.com'));

Méthodes

MéthodeType renvoyéBrève description
setAltText(altText)ImageButtonDéfinit le texte de substitution du bouton à des fins d'accessibilité.
setAuthorizationAction(action)ImageButtonDéfinit une action d'autorisation qui ouvre une URL vers le flux d'autorisation lorsqu'un utilisateur clique sur l'objet.
setComposeAction(action, composedEmailType)ImageButtonDéfinit une action qui compose un e-mail brouillon lorsque l'utilisateur clique sur l'objet.
setIcon(icon)ImageButtonDéfinit un Icon prédéfini à afficher sur le bouton.
setIconUrl(url)ImageButtonDéfinit l'URL d'une image à utiliser comme icône de ce bouton.
setImageButtonStyle(imageButtonStyle)ImageButtonDéfinit le style du bouton.
setMaterialIcon(icon)ImageButtonDéfinit l'icône Material Design.
setOnClickAction(action)ImageButtonDéfinit une action qui s'exécute lorsque l'utilisateur clique sur l'objet.
setOnClickOpenLinkAction(action)ImageButtonDéfinit une action qui ouvre une URL dans un onglet lorsqu'un utilisateur clique sur l'objet.
setOpenLink(openLink)ImageButtonDéfinit une URL à ouvrir lorsque l'utilisateur clique sur l'objet.
setOverflowMenu(menu)ImageButtonDéfinit un menu pop-up à ouvrir lorsque l'utilisateur clique sur l'objet.

Documentation détaillée

setAltText(altText)

Définit le texte de substitution du bouton à des fins d'accessibilité. Obligatoire.

Paramètres

NomTypeDescription
altTextStringTexte de substitution à attribuer à ce bouton.

Renvois

ImageButton : cet objet, pour le chaînage.

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

ImageButton : 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 qui spécifie si le brouillon composé est un brouillon autonome ou de réponse.

Renvois

ImageButton : cet objet, pour le chaînage.

setIcon(icon)

Définit un Icon prédéfini à afficher sur le bouton. Vous devez utiliser cette valeur ou setIconUrl(url) pour définir l'image du bouton.

Paramètres

NomTypeDescription
iconIconL'une des valeurs Icon prédéfinies.

Renvois

ImageButton : cet objet, pour le chaînage.

setIconUrl(url)

Définit l'URL d'une image à utiliser comme icône de ce bouton. Vous devez utiliser cette valeur ou setIcon(icon) pour définir l'image du bouton.

Paramètres

NomTypeDescription
urlStringURL d'une image hébergée à utiliser comme icône de ce bouton.

Renvois

ImageButton : cet objet, pour le chaînage.

setImageButtonStyle(imageButtonStyle)

Définit le style du bouton. Si cette valeur n'est pas définie, le bouton ImageButtonStyle.BORDERLESS est utilisé par défaut.

Disponible pour les applications Google Chat. Disponible en version Preview développeur pour les modules complémentaires Google Workspace. 

const imageButton = CardService.newImageButton().setImageButtonStyle(
    CardService.ImageButtonStyle.BORDERLESS,
);

Paramètres

NomTypeDescription
imageButtonStyleImageButtonStyleStyle du bouton.

Renvois

ImageButton : cet objet, pour le chaînage.

setMaterialIcon(icon)

Définit l'icône Material Design. 

const imageButton = CardService.newImageButton().setMaterialIcon(
    CardService.newMaterialIcon().setName('search'),
);

Paramètres

NomTypeDescription
iconMaterialIconIcône Material Design.

Renvois

ImageButton : 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

ImageButton : 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

ImageButton : 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

ImageButton : 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 pour les applications Google Chat. Disponible en version Preview développeur 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

ImageButton : cet objet, pour le chaînage.