Classe de base pour tous les boutons.
Disponible pour les modules complémentaires Google Workspace et les applications Google Chat.
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
set | Button | Définit une action d'autorisation qui ouvre une URL vers le flux d'autorisation lorsqu'un utilisateur clique sur l'objet. |
set | Button | Définit une action qui compose un e-mail brouillon lorsque l'utilisateur clique sur l'objet. |
set | Button | Définit une action qui s'exécute lorsque l'utilisateur clique sur l'objet. |
set | Button | Définit une action qui ouvre une URL dans un onglet lorsqu'un utilisateur clique sur l'objet. |
set | Button | Définit une URL à ouvrir lorsque l'utilisateur clique sur l'objet. |
set | Button | Définit un menu pop-up à ouvrir lorsque l'utilisateur clique sur l'objet. |
Documentation détaillée
set Authorization Action(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 set
, set
, set
, set
ou set
.
// ... const action = CardService.newAuthorizationAction().setAuthorizationUrl('url'); CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);
Paramètres
Nom | Type | Description |
---|---|---|
action | Authorization | Objet qui spécifie l'action d'autorisation à effectuer lorsqu'un utilisateur clique sur cet élément. |
Renvois
Button
: cet objet, pour le chaînage.
set Compose Action(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 set
, set
, set
, set
ou set
.
Le paramètre Action
doit spécifier une fonction de rappel qui renvoie un objet Compose
configuré à l'aide de Compose
.
// ... 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 cet élément est cliqué. |
composed | Composed | Valeur d'énumération indiquant si le brouillon composé est un brouillon autonome ou de réponse. |
Renvois
Button
: cet objet, pour le chaînage.
set On Click Action(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 set
, set
, set
, set
ou set
.
Le paramètre Action
doit spécifier une fonction de rappel qui renvoie un objet Action
.
// ... 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
Button
: cet objet, pour le chaînage.
set On Click Open Link Action(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 Open
. Un objet d'interface utilisateur ne peut avoir qu'une seule valeur définie parmi set
, set
, set
, set
ou set
.
Le paramètre Action
doit spécifier une fonction de rappel qui renvoie un objet Action
configuré à l'aide de Action
.
// ... 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 cet élément est cliqué. |
Renvois
Button
: cet objet, pour le chaînage.
set Open Link(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 ne doit être ouverte que. Un objet d'interface utilisateur ne peut avoir qu'une seule valeur parmi set
, set
, set
, set
ou set
.
Paramètres
Nom | Type | Description |
---|---|---|
open | Open | Objet Open décrivant l'URL à ouvrir. |
Renvois
Button
: cet objet, pour le chaînage.
set Overflow Menu(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
Nom | Type | Description |
---|---|---|
menu | Overflow | Objet qui spécifie le menu déroulant à afficher lorsque l'utilisateur clique sur cet élément. |
Renvois
Button
: cet objet, pour le chaînage.