Class ImageButton

ImageButton

Un ImageButton con un'immagine visualizzata.

Disponibile per i componenti aggiuntivi di Google Workspace e le app 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"));

Metodi

MetodoTipo restituitoBreve descrizione
setAltText(altText)ImageButtonImposta il testo alternativo del pulsante per l'accessibilità.
setAuthorizationAction(action)ImageButtonImposta un'azione di autorizzazione che apre un URL al flusso di autorizzazione quando l'oggetto viene selezionato.
setComposeAction(action, composedEmailType)ImageButtonImposta un'azione che compone una bozza di email quando l'utente fa clic sull'oggetto.
setIcon(icon)ImageButtonConsente di impostare un valore Icon predefinito da visualizzare sul pulsante.
setIconUrl(url)ImageButtonConsente di impostare l'URL di un'immagine da utilizzare come icona di questo pulsante.
setOnClickAction(action)ImageButtonImposta un'azione che viene eseguita quando l'utente fa clic sull'oggetto.
setOnClickOpenLinkAction(action)ImageButtonConsente di impostare un'azione che consente di aprire un URL in una scheda quando l'utente fa clic sull'oggetto.
setOpenLink(openLink)ImageButtonImposta un URL da aprire quando l'utente fa clic sull'oggetto.

Documentazione dettagliata

setAltText(altText)

Imposta il testo alternativo del pulsante per l'accessibilità. Obbligatorio.

Parametri

NomeTipoDescrizione
altTextStringIl testo alternativo da assegnare a questo pulsante.

Invio

ImageButton: oggetto per il collegamento.


setAuthorizationAction(action)

Imposta un'azione di autorizzazione che apre un URL al flusso di autorizzazione quando l'oggetto viene selezionato. L'URL viene aperto in una nuova finestra. Quando l'utente termina il flusso di autorizzazione all'applicazione, il componente aggiuntivo si ricarica.

Per un oggetto UI può essere impostato un solo elemento tra setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType).

// ...

var action = CardService.newAuthorizationAction().setAuthorizationUrl('url');
CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);

Parametri

NomeTipoDescrizione
actionAuthorizationActionL'oggetto che specifica l'azione di autorizzazione da eseguire quando questo elemento viene selezionato.

Invio

ImageButton: oggetto per il collegamento.


setComposeAction(action, composedEmailType)

Imposta un'azione che compone una bozza di email quando l'utente fa clic sull'oggetto. Un oggetto UI può solo avere uno dei seguenti: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType) impostati.

Il parametro Action deve specificare una funzione di callback che restituisca un oggetto ComposeActionResponse configurato utilizzando 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();
}

Parametri

NomeTipoDescrizione
actionActionL'oggetto che specifica l'azione di scrittura da eseguire quando questo elemento viene selezionato.
composedEmailTypeComposedEmailTypeUn valore enum che specifica se la bozza composta è un indipendente o una bozza di risposta.

Invio

ImageButton: oggetto per il collegamento.


setIcon(icon)

Consente di impostare un valore Icon predefinito da visualizzare sul pulsante. Questo o setIconUrl(url) deve essere utilizzato per definire l'immagine del pulsante.

Parametri

NomeTipoDescrizione
iconIconUno dei valori Icon predefiniti.

Invio

ImageButton: oggetto per il collegamento.


setIconUrl(url)

Consente di impostare l'URL di un'immagine da utilizzare come icona di questo pulsante. Questo o setIcon(icon) deve essere utilizzata per definire l'immagine del pulsante.

Parametri

NomeTipoDescrizione
urlStringL'indirizzo URL di un'immagine ospitata da utilizzare come icona di questo pulsante.

Invio

ImageButton: oggetto per il collegamento.


setOnClickAction(action)

Imposta un'azione che viene eseguita quando l'utente fa clic sull'oggetto. Un oggetto UI può avere solo uno dei seguenti Impostazione setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType) impostata.

Il parametro Action deve specificare una funzione di callback che restituisca un oggetto 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();
}

Parametri

NomeTipoDescrizione
actionActionL'azione da eseguire quando l'utente fa clic su questo elemento.

Invio

ImageButton: oggetto per il collegamento.


setOnClickOpenLinkAction(action)

Consente di impostare un'azione che consente di aprire un URL in una scheda quando l'utente fa clic sull'oggetto. Utilizza questa funzione quando È necessario creare l'URL o quando devi eseguire altre azioni oltre alla creazione dell'oggetto OpenLink. Un oggetto UI può avere solo uno tra setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType) impostato.

Il parametro Action deve specificare una funzione di callback che restituisca un oggetto ActionResponse configurato utilizzando 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();
}

Parametri

NomeTipoDescrizione
actionActionL'oggetto che specifica l'azione di apertura link da eseguire quando questo elemento è selezionato.

Invio

ImageButton: oggetto per il collegamento.


Imposta un URL da aprire quando l'utente fa clic sull'oggetto. Utilizza questa funzione quando l'URL è già noto e deve solo essere aperto. Un oggetto UI può avere solo uno tra setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType) impostato.

Parametri

NomeTipoDescrizione
openLinkOpenLinkUn oggetto OpenLink che descrive l'URL da aprire.

Invio

ImageButton: oggetto per il collegamento.