Class ImageButton

Pulsante immagine

Un ImageButton con un'immagine visualizzata.

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)ImageButtonConsente di impostare il testo alternativo del pulsante per l'accessibilità.
setAuthorizationAction(action)ImageButtonImposta un'azione di autorizzazione che apre un URL nel flusso di autorizzazione quando viene fatto clic sull'oggetto.
setComposeAction(action, composedEmailType)ImageButtonImposta un'azione che scrive una bozza dell'email quando un utente fa clic sull'oggetto.
setIcon(icon)ImageButtonConsente di impostare un elemento Icon predefinito da visualizzare sul pulsante.
setIconUrl(url)ImageButtonImposta l'URL di un'immagine da utilizzare come icona di questo pulsante.
setOnClickAction(action)ImageButtonImposta un'azione da eseguire quando viene fatto clic sull'oggetto.
setOnClickOpenLinkAction(action)ImageButtonImposta un'azione che apre un URL in una scheda quando l'utente fa clic sull'oggetto.
setOpenLink(openLink)ImageButtonImposta un URL da aprire quando viene fatto clic sull'oggetto.

Documentazione dettagliata

setAltText(altText)

Consente di impostare il testo alternativo del pulsante per l'accessibilità. Obbligatorio.

Parametri

NomeTipoDescrizione
altTextStringIl testo alternativo da assegnare a questo pulsante.

Andata e ritorno

ImageButton: questo oggetto, per il concatenamento.


setAuthorizationAction(action)

Imposta un'azione di autorizzazione che apre un URL nel flusso di autorizzazione quando viene fatto clic sull'oggetto. L'URL viene aperto in una nuova finestra. Quando l'utente termina il flusso dell'autorizzazione e torna all'applicazione, il componente aggiuntivo viene ricaricato.

Un oggetto UI può avere solo setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType) impostati.

// ...

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

Parametri

NomeTipoDescrizione
actionAuthorizationActionOggetto che specifica l'azione di autorizzazione da eseguire quando viene fatto clic su questo elemento.

Andata e ritorno

ImageButton: questo oggetto, per il concatenamento.


setComposeAction(action, composedEmailType)

Imposta un'azione che scrive una bozza dell'email quando un utente fa clic sull'oggetto. Un oggetto UI può avere solo setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType) impostati.

Il parametro Action deve specificare una funzione di callback che restituisce 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 viene fatto clic su questo elemento.
composedEmailTypeComposedEmailTypeUn valore di enumerazione che specifica se la bozza composta è una bozza autonoma o una bozza di risposta.

Andata e ritorno

ImageButton: questo oggetto, per il concatenamento.


setIcon(icon)

Consente di impostare un elemento Icon predefinito da visualizzare sul pulsante. È necessario utilizzare questo elemento (setIconUrl(url)) per definire l'immagine del pulsante.

Parametri

NomeTipoDescrizione
iconIconUno dei valori Icon predefiniti.

Andata e ritorno

ImageButton: questo oggetto, per il concatenamento.


setIconUrl(url)

Imposta l'URL di un'immagine da utilizzare come icona di questo pulsante. È necessario utilizzare questo o setIcon(icon) per definire l'immagine del pulsante.

Parametri

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

Andata e ritorno

ImageButton: questo oggetto, per il concatenamento.


setOnClickAction(action)

Imposta un'azione da eseguire quando viene fatto clic sull'oggetto. Un oggetto UI può avere solo uno dei seguenti valori: 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.

// ...

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 viene fatto clic su questo elemento.

Andata e ritorno

ImageButton: questo oggetto, per il concatenamento.


setOnClickOpenLinkAction(action)

Imposta un'azione che apre un URL in una scheda quando l'utente fa clic sull'oggetto. Utilizza questa funzione quando devi creare l'URL o devi eseguire altre azioni aggiuntive per creare l'oggetto OpenLink. Un oggetto UI può avere solo setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType) impostati.

Il parametro Action deve specificare una funzione di callback che restituisce 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 link aperto da intraprendere quando viene fatto clic su questo elemento.

Andata e ritorno

ImageButton: questo oggetto, per il concatenamento.


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

Parametri

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

Andata e ritorno

ImageButton: questo oggetto, per il concatenamento.