ImageButton
avec une image affichée.
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'utilisateur clique sur l'objet. |
setComposeAction(action, composedEmailType) | ImageButton | Définit une action qui compose un brouillon lors d'un clic 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 l'URL à ouvrir en cas de clic 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. |
Aller-retour
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. Une fois que l'utilisateur a terminé le flux d'autorisation et revient à l'application, le module complémentaire s'actualise.
Vous ne pouvez définir qu'un seul des éléments suivants : 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 | Objet spécifiant l'action d'autorisation à effectuer lorsque l'utilisateur clique sur cet élément. |
Aller-retour
ImageButton
: cet objet, pour le chaînage
setComposeAction(action, composedEmailType)
Définit une action qui compose un brouillon lors d'un clic sur l'objet. Vous ne pouvez définir qu'un seul des éléments setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
ou setComposeAction(action, composedEmailType)
pour un objet d'interface utilisateur.
Le paramètre Action
doit spécifier une fonction de rappel qui renvoie un objet ComposeActionResponse
configuré à l'aide de ComposeActionResponseBuilder.setGmailDraft(draft)
.
// ... 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 | Objet spécifiant l'action de composition à effectuer lorsque l'utilisateur clique sur cet élément. |
composedEmailType | ComposedEmailType | Valeur d'énumération qui indique si le brouillon composé est un brouillon autonome ou de réponse. |
Aller-retour
ImageButton
: cet objet, pour le chaînage
setIcon(icon)
Définit un Icon
prédéfini à afficher sur le bouton. Vous devez utiliser setIconUrl(url)
ou définir l'image du bouton.
Paramètres
Nom | Type | Description |
---|---|---|
icon | Icon | Une des valeurs prédéfinies de Icon . |
Aller-retour
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 soit setIcon(icon)
, soit cette image 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. |
Aller-retour
ImageButton
: cet objet, pour le chaînage
setOnClickAction(action)
Définit une action qui s'exécute lorsque l'utilisateur clique sur l'objet. Vous ne pouvez définir qu'un seul élément 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
.
// ... 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. |
Aller-retour
ImageButton
: cet objet, 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 la création de l'objet OpenLink
. Vous ne pouvez définir qu'un seul objet 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)
.
// ... 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 spécifiant l'action d'ouverture du lien à effectuer lorsque l'utilisateur clique sur cet élément. |
Aller-retour
ImageButton
: cet objet, pour le chaînage
setOpenLink(openLink)
Définit l'URL à ouvrir en cas de clic sur l'objet. Utilisez cette fonction lorsque l'URL est déjà connue et qu'elle doit seulement être ouverte. Vous ne pouvez définir qu'un seul objet setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
ou setComposeAction(action, composedEmailType)
.
Paramètres
Nom | Type | Description |
---|---|---|
openLink | OpenLink | Un objet OpenLink décrivant l'URL à ouvrir. |
Aller-retour
ImageButton
: cet objet, pour le chaînage