Class ImageButton

ImageButton

Un ImageButton avec une image affichée.

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éthode	Type renvoyé	Brève description
setAltText(altText)	ImageButton	Définit le texte alternatif du bouton pour l'accessibilité.
setAuthorizationAction(action)	ImageButton	Définit une action d'autorisation qui ouvre une URL vers le flux d'autorisation lorsque l'utilisateur clique sur l'objet.
setComposeAction(action, composedEmailType)	ImageButton	Définit une action qui compose un brouillon d'e-mail lorsque l'objet est cliqué.
setIcon(icon)	ImageButton	Définit un Icon prédéfini à afficher sur le bouton.
setIconUrl(url)	ImageButton	Définit l'URL d'une image à utiliser comme icône de ce bouton.
setImageButtonStyle(imageButtonStyle)	ImageButton	Définit le style du bouton.
setMaterialIcon(icon)	ImageButton	Définit l'icône Material Design.
setOnClickAction(action)	ImageButton	Définit une action qui s'exécute lorsque l'utilisateur clique sur l'objet.
setOnClickOpenLinkAction(action)	ImageButton	Définit une action qui ouvre une URL dans un onglet lorsque l'objet est cliqué.
setOpenLink(openLink)	ImageButton	Définit une URL à ouvrir lorsque l'objet est cliqué.
setOverflowMenu(menu)	ImageButton	Définit un menu pop-up à ouvrir lorsque l'objet est cliqué.

Documentation détaillée

setAltText(altText)

Définit le texte alternatif du bouton pour l'accessibilité. Obligatoire.

Paramètres

Nom	Type	Description
altText	String	Texte alternatif à 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 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'interface utilisateur ne peut avoir qu'une seule des valeurs 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

ImageButton : cet objet, pour le chaînage.

---

setComposeAction(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'une seule des valeurs setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType) définie.

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 Compose utilisée pour étendre l'UI Compose. Cette méthode connecte plutôt cet élément d'UI à un Action qui compose 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 composition à effectuer lorsque l'utilisateur clique sur cet élément.
composedEmailType	ComposedEmailType	Valeur enum qui indique 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 option ou setIconUrl(url) pour définir l'image du bouton.

Paramètres

Nom	Type	Description
icon	Icon	L'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 ce paramètre ou setIcon(icon) pour définir l'image du bouton.

Paramètres

Nom	Type	Description
url	String	Adresse URL 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. En preview développeur pour les modules complémentaires Google Workspace.

Version Preview pour les développeurs : disponible dans le cadre du programme Preview développeur Google Workspace, qui permet d'accéder de manière anticipée à certaines fonctionnalités.

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

Paramètres

Nom	Type	Description
imageButtonStyle	ImageButtonStyle	Style 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

Nom	Type	Description
icon	MaterialIcon	Icô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 des valeurs 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

ImageButton : cet objet, pour le chaînage.

---

setOnClickOpenLinkAction(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 OpenLink. Un objet d'UI ne peut avoir qu'une seule des valeurs 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 du lien à effectuer lorsque l'utilisateur clique sur cet élément.

Renvois

ImageButton : cet objet, pour le chaînage.

---

setOpenLink(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'UI ne peut avoir qu'une seule des valeurs setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType) définie.

Paramètres

Nom	Type	Description
openLink	OpenLink	Objet 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'objet est cliqué. Chaque élément du menu peut spécifier une action à déclencher lorsqu'il est sélectionné. 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. En preview développeur pour les modules complémentaires Google Workspace.

Version Preview pour les développeurs : disponible dans le cadre du programme Preview développeur Google Workspace, qui permet d'accéder de manière anticipée à certaines fonctionnalités.

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

Nom	Type	Description
menu	OverflowMenu	Objet qui spécifie le menu débordement à afficher lorsque l'utilisateur clique sur cet élément.

Renvois

ImageButton : cet objet, pour le chaînage.