Class OverflowMenuItem

OverflowMenuItem

Un OverflowMenuItem avec une icône et un libellé de texte. Vous pouvez désactiver l'élément de menu si nécessaire.

Disponible pour les applications Google Chat. En preview développeur pour les modules complémentaires Google Workspace.

Preview développeur : disponible dans le cadre du programme Preview développeur Google Workspace, qui permet d'accéder en avant-première à 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'));

Méthodes

Méthode	Type renvoyé	Brève description
setAuthorizationAction(action)	OverflowMenuItem	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)	OverflowMenuItem	Définit une action qui rédige un brouillon d'e-mail lorsque l'utilisateur clique sur l'objet.
setDisabled(disabled)	OverflowMenuItem	Indique si l'élément de menu est désactivé.
setOnClickAction(action)	OverflowMenuItem	Définit une action qui s'exécute lorsque l'utilisateur clique sur l'objet.
setOnClickOpenLinkAction(action)	OverflowMenuItem	Définit une action qui ouvre une URL dans un onglet lorsque l'utilisateur clique sur l'objet.
setOpenLink(openLink)	OverflowMenuItem	Définit une URL à ouvrir lorsque l'utilisateur clique sur l'objet.
setStartIcon(icon)	OverflowMenuItem	Définit l'icône de début de l'élément de menu.
setText(text)	OverflowMenuItem	Définit le titre de l'élément de menu.

Documentation détaillée

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'un seul des éléments suivants : 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

OverflowMenuItem : cet objet, pour l'association en chaîne.

---

setComposeAction(action, composedEmailType)

Définit une action qui rédige 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 suivants : 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 associe 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 de réponse.

Renvois

OverflowMenuItem : cet objet, pour l'association en chaîne.

---

setDisabled(disabled)

Indique si l'élément de menu est désactivé. Un élément désactivé est grisé et ne peut pas être cliqué.

Paramètres

Nom	Type	Description
disabled	Boolean	État désactivé.

Renvois

OverflowMenuItem : cet objet, pour l'association en chaîne.

---

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'un seul des éléments suivants : 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

OverflowMenuItem : cet objet, pour l'association en chaîne.

---

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 objet d'interface utilisateur ne peut avoir qu'un seul des éléments suivants : 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

OverflowMenuItem : cet objet, pour l'association en chaîne.

---

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 objet d'interface utilisateur ne peut avoir qu'un seul des éléments suivants : 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

OverflowMenuItem : cet objet, pour l'association en chaîne.

---

setStartIcon(icon)

Définit l'icône de début de l'élément de menu.

Paramètres

Nom	Type	Description
icon	IconImage	Icône à afficher.

Renvois

OverflowMenuItem : cet objet, pour l'association en chaîne.

---

setText(text)

Définit le titre de l'élément de menu. Obligatoire.

Paramètres

Nom	Type	Description
text	String	Texte à afficher.

Renvois

OverflowMenuItem : cet objet, pour l'association en chaîne.