Élément ImageButton
avec une image affichée.
Disponible pour les modules complémentaires Google Workspace et les applications Google Chat.
var 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'objet est sur lesquels l'utilisateur a cliqué. |
setComposeAction(action, composedEmailType) | ImageButton | Définit une action qui compose un brouillon d'e-mail lorsqu'un utilisateur clique sur l'objet. |
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. |
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'utilisateur clique sur l'objet. |
setOpenLink(openLink) | ImageButton | Définit une URL à ouvrir lorsque l'utilisateur clique sur l'objet. |
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
: objet utilisé pour le chaînage.
setAuthorizationAction(action)
Définit une action d'autorisation qui ouvre une URL vers le flux d'autorisation lorsque l'objet est sur lesquels l'utilisateur a cliqué. L'URL s'ouvre dans une nouvelle fenêtre. Lorsque l'utilisateur a terminé le flux d'autorisation et revient à l'application, le module complémentaire est actualisé.
Un objet d'UI ne peut être défini que sur setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
ou setComposeAction(action, composedEmailType)
.
// ... var action = CardService.newAuthorizationAction().setAuthorizationUrl('url'); CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);
Paramètres
Nom | Type | Description |
---|---|---|
action | AuthorizationAction | L'objet qui spécifie l'action d'autorisation à effectuer lorsque cet élément est sur lesquels l'utilisateur a cliqué. |
Renvois
ImageButton
: objet utilisé pour le chaînage.
setComposeAction(action, composedEmailType)
Définit une action qui compose un brouillon d'e-mail lorsqu'un utilisateur clique sur l'objet. Un objet UI ne peut
avoir l'une des valeurs suivantes : setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
,
setAuthorizationAction(action)
ou setComposeAction(action, composedEmailType)
défini.
Le paramètre Action
doit spécifier une fonction de rappel qui renvoie un objet ComposeActionResponse
configuré à l'aide de ComposeActionResponseBuilder.setGmailDraft(draft)
.
<ph type="x-smartling-placeholder">
// ... var action = CardService.newAction().setFunctionName('composeEmailCallback'); CardService.newTextButton() .setText('Compose Email') .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT); // ... function composeEmailCallback() { var thread = GmailApp.getThreadById(e.threadId); var draft = thread.createDraftReply('This is a reply'); return CardService.newComposeActionResponseBuilder() .setGmailDraft(draft) .build(); }
Paramètres
Nom | Type | Description |
---|---|---|
action | Action | L'objet qui spécifie l'action de composition à effectuer lorsque cet élément est sur lesquels l'utilisateur a cliqué. |
composedEmailType | ComposedEmailType | Valeur d'énumération qui spécifie si le brouillon composé est un seul ou en tant que brouillon de réponse. |
Renvois
ImageButton
: objet utilisé pour le chaînage.
setIcon(icon)
Définit un Icon
prédéfini à afficher sur le bouton. Ceci ou setIconUrl(url)
doit être utilisé pour définir l'image du bouton.
Paramètres
Nom | Type | Description |
---|---|---|
icon | Icon | L'une des valeurs Icon prédéfinies. |
Renvois
ImageButton
: objet utilisé pour le chaînage.
setIconUrl(url)
Définit l'URL d'une image à utiliser comme icône de ce bouton. Cette valeur ou setIcon(icon)
doit être
utilisée 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
: objet utilisé pour le chaînage.
setOnClickAction(action)
Définit une action qui s'exécute lorsque l'utilisateur clique sur l'objet. Un objet d'UI ne peut être associé qu'à l'une des valeurs
setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
ou setComposeAction(action, composedEmailType)
définis.
Le paramètre Action
doit spécifier une fonction de rappel qui renvoie un objet ActionResponse
.
// ... var 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
: objet utilisé pour le chaînage.
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'UI ne peut contenir que l'un des éléments suivants : setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
ou
setComposeAction(action, composedEmailType)
défini.
Le paramètre Action
doit spécifier une fonction de rappel qui renvoie un objet ActionResponse
configuré à l'aide de ActionResponseBuilder.setOpenLink(openLink)
.
// ... var 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 de lien ouvert à effectuer lorsque cet élément est sur lesquels l'utilisateur a cliqué. |
Renvois
ImageButton
: objet utilisé pour le chaînage.
setOpenLink(openLink)
Définit une URL à ouvrir lorsque l'utilisateur clique sur l'objet. Utilisez cette fonction lorsque l'URL est déjà
connues et ne doivent
qu’être ouvertes. Un objet d'UI ne peut être associé qu'à l'une des valeurs suivantes : setOpenLink(openLink)
,
setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
ou setComposeAction(action, composedEmailType)
définis.
Paramètres
Nom | Type | Description |
---|---|---|
openLink | OpenLink | Un objet OpenLink décrivant l'URL à ouvrir. |
Renvois
ImageButton
: objet utilisé pour le chaînage.