Un ImageButton
con un'immagine visualizzata.
Disponibile per i componenti aggiuntivi di Google Workspace e le app Google Chat.
const imageButton = CardService.newImageButton() .setAltText('An image button with an airplane icon.') .setIcon(CardService.Icon.AIRPLANE) .setOpenLink(CardService.newOpenLink().setUrl('https://airplane.com'));
Metodi
Metodo | Tipo restituito | Breve descrizione |
---|---|---|
setAltText(altText) | ImageButton | Imposta il testo alternativo del pulsante per l'accessibilità. |
setAuthorizationAction(action) | ImageButton | Imposta un'azione di autorizzazione che apre un URL al flusso di autorizzazione quando viene fatto clic sull'oggetto. |
setComposeAction(action, composedEmailType) | ImageButton | Imposta un'azione che compone una bozza di email quando l'utente fa clic sull'oggetto. |
setIcon(icon) | ImageButton | Imposta un Icon predefinito da visualizzare sul pulsante. |
setIconUrl(url) | ImageButton | Imposta l'URL di un'immagine da utilizzare come icona di questo pulsante. |
setImageButtonStyle(imageButtonStyle) | ImageButton | Imposta lo stile del pulsante. |
setMaterialIcon(icon) | ImageButton | Imposta l'icona Material Design. |
setOnClickAction(action) | ImageButton | Imposta un'azione da eseguire quando si fa clic sull'oggetto. |
setOnClickOpenLinkAction(action) | ImageButton | Imposta un'azione che apre un URL in una scheda quando viene fatto clic sull'oggetto. |
setOpenLink(openLink) | ImageButton | Imposta un URL da aprire quando si fa clic sull'oggetto. |
setOverflowMenu(menu) | ImageButton | Imposta un menu popup da aprire quando si fa clic sull'oggetto. |
Documentazione dettagliata
setAltText(altText)
Imposta il testo alternativo del pulsante per l'accessibilità. Obbligatorio.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
altText | String | Il testo alternativo da assegnare a questo pulsante. |
Invio
ImageButton
: questo oggetto, per l'accodamento.
setAuthorizationAction(action)
Imposta un'azione di autorizzazione che apre un URL per il flusso di autorizzazione quando si fa clic sull'oggetto. L'URL viene aperto in una nuova finestra. Quando l'utente completa il flusso di autorizzazione e torna all'applicazione, il componente aggiuntivo viene ricaricato.
Per un oggetto UI può essere impostato un solo elemento tra setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
o setComposeAction(action, composedEmailType)
.
// ... const action = CardService.newAuthorizationAction().setAuthorizationUrl('url'); CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);
Parametri
Nome | Tipo | Descrizione |
---|---|---|
action | AuthorizationAction | L'oggetto che specifica l'azione di autorizzazione da eseguire quando viene fatto clic su questo elemento. |
Invio
ImageButton
: questo oggetto, per l'accodamento.
setComposeAction(action, composedEmailType)
Imposta un'azione che compone una bozza di email quando l'utente fa clic sull'oggetto. Un oggetto dell'interfaccia utente può avere impostato solo uno tra setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
,
setAuthorizationAction(action)
o setComposeAction(action, composedEmailType)
.
Il parametro Action
deve specificare una funzione di callback che restituisce un oggetto ComposeActionResponse
configurato utilizzando ComposeActionResponseBuilder.setGmailDraft(draft)
.
// ... const action = CardService.newAction().setFunctionName('composeEmailCallback'); CardService.newTextButton() .setText('Compose Email') .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT); // ... function composeEmailCallback() { const thread = GmailApp.getThreadById(e.threadId); const draft = thread.createDraftReply('This is a reply'); return CardService.newComposeActionResponseBuilder() .setGmailDraft(draft) .build(); }
Parametri
Nome | Tipo | Descrizione |
---|---|---|
action | Action | L'oggetto che specifica l'azione di composizione da eseguire quando viene fatto clic su questo elemento. |
composedEmailType | ComposedEmailType | Un valore enum che specifica se la bozza composta è una bozza autonoma o una bozza di risposta. |
Invio
ImageButton
: questo oggetto, per l'accodamento.
setIcon(icon)
Consente di impostare un valore Icon
predefinito da visualizzare sul pulsante. Per definire l'immagine del pulsante, è necessario utilizzare questo valore o setIconUrl(url)
.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
icon | Icon | Uno dei valori Icon predefiniti. |
Invio
ImageButton
: questo oggetto, per l'accodamento.
setIconUrl(url)
Imposta l'URL di un'immagine da utilizzare come icona di questo pulsante. Per definire l'immagine del pulsante, deve essere utilizzato questo valore o setIcon(icon)
.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
url | String | L'indirizzo URL di un'immagine ospitata da utilizzare come icona di questo pulsante. |
Invio
ImageButton
: questo oggetto, per l'accodamento.
setImageButtonStyle(imageButtonStyle)
Imposta lo stile del pulsante. Se non viene configurato, viene usato il pulsante ImageButtonStyle.BORDERLESS
per impostazione predefinita.
Disponibile solo per le app Google Chat. Non disponibile per i componenti aggiuntivi di Google Workspace.
const imageButton = CardService.newImageButton().setImageButtonStyle( CardService.ImageButtonStyle.BORDERLESS, );
Parametri
Nome | Tipo | Descrizione |
---|---|---|
imageButtonStyle | ImageButtonStyle | Lo stile del pulsante. |
Invio
ImageButton
: questo oggetto, per l'accodamento.
setMaterialIcon(icon)
Imposta l'icona Material Design.
const imageButton = CardService.newImageButton().setMaterialIcon( CardService.newMaterialIcon().setName('search'), );
Parametri
Nome | Tipo | Descrizione |
---|---|---|
icon | MaterialIcon | L'icona Material Design. |
Invio
ImageButton
: questo oggetto, per l'accodamento.
setOnClickAction(action)
Imposta un'azione da eseguire quando si fa clic sull'oggetto. Un oggetto dell'interfaccia utente può avere impostato solo uno tra setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
o setComposeAction(action, composedEmailType)
.
Il parametro Action
deve specificare una funzione di callback che restituisce un oggetto 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(); }
Parametri
Nome | Tipo | Descrizione |
---|---|---|
action | Action | L'azione da eseguire quando l'utente fa clic su questo elemento. |
Invio
ImageButton
: questo oggetto, per l'accodamento.
setOnClickOpenLinkAction(action)
Imposta un'azione che apre un URL in una scheda quando viene fatto clic sull'oggetto. Utilizza questa funzione quando è necessario creare l'URL o quando devi intraprendere altre azioni oltre alla creazione dell'oggetto OpenLink
. Un oggetto dell'interfaccia utente può avere impostato solo uno tra setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
o
setComposeAction(action, composedEmailType)
.
Il parametro Action
deve specificare una funzione di callback che restituisce un oggetto ActionResponse
configurato utilizzando 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(); }
Parametri
Nome | Tipo | Descrizione |
---|---|---|
action | Action | L'oggetto che specifica l'azione di apertura link da eseguire quando si fa clic su questo elemento. |
Invio
ImageButton
: oggetto per il collegamento.
setOpenLink(openLink)
Imposta un URL da aprire quando si fa clic sull'oggetto. Utilizza questa funzione quando l'URL è già conosciuto e deve solo essere aperto. Un oggetto dell'interfaccia utente può avere impostato solo uno tra setOpenLink(openLink)
,
setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
o setComposeAction(action, composedEmailType)
.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
openLink | OpenLink | Un oggetto OpenLink che descrive l'URL da aprire. |
Invio
ImageButton
: questo oggetto, per l'accodamento.
setOverflowMenu(menu)
Imposta un menu popup da aprire quando si fa clic sull'oggetto. Per ogni voce del menu puoi specificare un'azione da attivare quando viene fatto clic. I menu nidificati non sono supportati, le azioni per le voci di menu non devono specificare un menu extra.
Disponibile solo per le app Google Chat. Non disponibile per i componenti aggiuntivi di 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();
Parametri
Nome | Tipo | Descrizione |
---|---|---|
menu | OverflowMenu | L'oggetto che specifica il menu extra da visualizzare quando viene fatto clic su questo elemento. |
Invio
ImageButton
: questo oggetto, per l'accodamento.