Text
avec un libellé de texte Vous pouvez définir la couleur d'arrière-plan et désactiver le bouton si nécessaire.
Disponible pour les modules complémentaires Google Workspace et les applications Google Chat.
const textButton = CardService.newTextButton() .setText('Open Link') .setOpenLink(CardService.newOpenLink().setUrl( 'https://www.google.com'));
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
set | Text | Définit le texte de substitution du bouton à des fins d'accessibilité. |
set | Text | Définit une action d'autorisation qui ouvre une URL vers le flux d'autorisation lorsqu'un utilisateur clique sur l'objet. |
set | Text | Définit la couleur d'arrière-plan du bouton Text . |
set | Text | Définit une action qui compose un e-mail brouillon lorsque l'utilisateur clique sur l'objet. |
set | Text | Définit si le bouton est désactivé. |
set | Text | Définit un Icon prédéfini à afficher sur le bouton. |
set | Text | Définit l'URL d'une image à utiliser comme icône de ce bouton. |
set | Text | Définit l'icône Material Design. |
set | Text | Définit une action qui s'exécute lorsque l'utilisateur clique sur l'objet. |
set | Text | Définit une action qui ouvre une URL dans un onglet lorsqu'un utilisateur clique sur l'objet. |
set | Text | Définit une URL à ouvrir lorsque l'utilisateur clique sur l'objet. |
set | Text | Définit un menu pop-up à ouvrir lorsque l'utilisateur clique sur l'objet. |
set | Text | Définit le texte à afficher sur le bouton. |
set | Text | Définit le style du bouton. |
Documentation détaillée
set Alt Text(altText)
Définit le texte de substitution du bouton à des fins d'accessibilité. Si elle n'est pas définie, la valeur par défaut est le texte affiché sur le bouton.
Paramètres
Nom | Type | Description |
---|---|---|
alt | String | Texte de substitution à attribuer à ce bouton. |
Renvois
Text
: cet objet, pour le chaînage.
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
Text
: cet objet, pour le chaînage.
set Background Color(backgroundColor)
Définit la couleur d'arrière-plan du bouton Text
. Si cette valeur n'est pas définie pour un bouton Text
, le bouton utilise la couleur secondaire définie dans le fichier manifeste du module complémentaire.
Cette méthode n'a aucune action pour les boutons Text
.
Paramètres
Nom | Type | Description |
---|---|---|
background | String | Couleur au format #rgb. |
Renvois
Text
: 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 qui spécifie si le brouillon composé est un brouillon autonome ou une réponse. |
Renvois
Text
: cet objet, pour le chaînage.
set Disabled(disabled)
Définit si le bouton est désactivé. Un bouton désactivé est grisé et ne peut pas être cliqué.
Paramètres
Nom | Type | Description |
---|---|---|
disabled | Boolean | État désactivé. |
Renvois
Text
: cet objet, pour le chaînage.
set Icon(icon)
Définit un Icon
prédéfini à afficher sur le bouton. Vous devez utiliser cette valeur ou set
pour définir l'image du bouton.
Paramètres
Nom | Type | Description |
---|---|---|
icon | Icon | L'une des valeurs Icon prédéfinies. |
Renvois
Text
: cet objet, pour le chaînage.
set Icon Url(url)
Définit l'URL d'une image à utiliser comme icône de ce bouton. Vous devez utiliser cette valeur ou set
pour définir l'image du bouton.
Paramètres
Nom | Type | Description |
---|---|---|
url | String | URL d'une image hébergée à utiliser comme icône de ce bouton. |
Renvois
Text
: cet objet, pour le chaînage.
set Material Icon(icon)
Définit l'icône Material Design.
const textButton = CardService.newTextButton().setMaterialIcon( CardService.newMaterialIcon().setName('search'), );
Paramètres
Nom | Type | Description |
---|---|---|
icon | Material | Icône Material Design. |
Renvois
Text
: 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
Text
: 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
Text
: 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 définie parmi set
, set
, set
, set
ou set
.
Paramètres
Nom | Type | Description |
---|---|---|
open | Open | Objet Open décrivant l'URL à ouvrir. |
Renvois
Text
: 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 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
Nom | Type | Description |
---|---|---|
menu | Overflow | Objet qui spécifie le menu déroulant à afficher lorsque l'utilisateur clique sur cet élément. |
Renvois
Text
: cet objet, pour le chaînage.
set Text(text)
Définit le texte à afficher sur le bouton.
Paramètres
Nom | Type | Description |
---|---|---|
text | String | Texte affiché sur le bouton. |
Renvois
Text
: cet objet, pour le chaînage.
set Text Button Style(textButtonStyle)
Définit le style du bouton. Si elle n'est pas définie, la valeur par défaut est le bouton Text
.
const button = CardService.newTextButton() .setText('Filled') .setTextButtonStyle(CardService.TextButtonStyle.FILLED) .setOpenLink(CardService.newOpenLink().setUrl('www.google.com'));
Paramètres
Nom | Type | Description |
---|---|---|
text | Text | Style du bouton. |
Renvois
Text
: cet objet, pour le chaînage.