Questa pagina è stata tradotta dall'API Cloud Translation.

Class ImageButton

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

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

Nome	Tipo	Descrizione
`altText`	`String`	Il 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

Nome	Tipo	Descrizione
`action`	`AuthorizationAction`	Oggetto 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).

Nota: questo metodo non imposta un'azione di scrittura che venga utilizzata per estendere l'interfaccia utente di scrittura. Questo metodo collega invece questo elemento UI a un Action che compone bozze di messaggi in Apps Script che vengono aperti in Gmail al termine dell'azione.

// ...

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

Nome	Tipo	Descrizione
`action`	`Action`	L'oggetto che specifica l'azione di scrittura da eseguire quando viene fatto clic su questo elemento.
`composedEmailType`	`ComposedEmailType`	Un 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

Nome	Tipo	Descrizione
`icon`	`Icon`	Uno 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

Nome	Tipo	Descrizione
`url`	`String`	L'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

Nome	Tipo	Descrizione
`action`	`Action`	L'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

Nome	Tipo	Descrizione
`action`	`Action`	L'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.

`setOpenLink(openLink)`

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

Nome	Tipo	Descrizione
`openLink`	`OpenLink`	Un oggetto `OpenLink` che descrive l'URL da aprire.

Andata e ritorno

ImageButton: questo oggetto, per il concatenamento.