Class ImageButton

ImageButton

Un ImageButton con un'immagine visualizzata.

Disponibile per i componenti aggiuntivi di Google Workspace e le app di 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 si fa clic sull'oggetto.
setComposeAction(action, composedEmailType)	ImageButton	Imposta un'azione che compone una bozza di email quando si 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 si fa 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.

Indietro

ImageButton : questo oggetto, per il concatenamento.

---

setAuthorizationAction(action)

Imposta un'azione di autorizzazione che apre un URL al 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.

Un oggetto UI può avere impostato solo uno dei seguenti valori: 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 intraprendere quando si fa clic su questo elemento.

Indietro

ImageButton : questo oggetto, per il concatenamento.

---

setComposeAction(action, composedEmailType)

Imposta un'azione che compone una bozza di email quando si fa clic sull'oggetto. Un oggetto UI può avere impostato 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 ComposeActionResponse configurato utilizzando ComposeActionResponseBuilder.setGmailDraft(draft).

Nota: questo metodo non imposta un'azione di composizione utilizzata per estendere l'interfaccia utente di composizione. Questo metodo collega invece questo elemento dell'interfaccia utente a un'Action che compone i messaggi in bozza in Apps Script che vengono aperti in Gmail al completamento dell'azione.

// ...

const action = CardService.newAction().setFunctionName('composeEmailCallback');
CardService.newTextButton()
    .setText('Compose Email')
    .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT);

// ...

function composeEmailCallback(e) {
  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 intraprendere quando si fa clic su questo elemento.
composedEmailType	ComposedEmailType	Un valore enum che specifica se la bozza composta è una bozza autonoma o di risposta.

Indietro

ImageButton : questo oggetto, per il concatenamento.

---

setIcon(icon)

Imposta un Icon predefinito da visualizzare sul pulsante. Per definire l'immagine del pulsante è necessario utilizzare questo metodo o setIconUrl(url).

Parametri

Nome	Tipo	Descrizione
icon	Icon	Uno dei valori Icon predefiniti.

Indietro

ImageButton : questo oggetto, per il concatenamento.

---

setIconUrl(url)

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

Parametri

Nome	Tipo	Descrizione
url	String	L'indirizzo URL di un'immagine ospitata da utilizzare come icona di questo pulsante.

Indietro

ImageButton : questo oggetto, per il concatenamento.

---

setImageButtonStyle(imageButtonStyle)

Imposta lo stile del pulsante. Se non è impostato, il valore predefinito è il pulsante ImageButtonStyle.BORDERLESS.

Disponibile per le app di Google Chat. In anteprima per sviluppatori per i componenti aggiuntivi di Google Workspace.

Anteprima per gli sviluppatori: disponibile nell'ambito del Programma Anteprima per gli sviluppatori di Google Workspace, che concede l'accesso in anteprima a determinate funzionalità.

const imageButton = CardService.newImageButton().setImageButtonStyle(
    CardService.ImageButtonStyle.BORDERLESS,
);

Parametri

Nome	Tipo	Descrizione
imageButtonStyle	ImageButtonStyle	Lo stile del pulsante.

Indietro

ImageButton : questo oggetto, per il concatenamento.

---

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.

Indietro

ImageButton : questo oggetto, per il concatenamento.

---

setOnClickAction(action)

Imposta un'azione da eseguire quando si fa clic sull'oggetto. Un oggetto UI può avere impostato 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.

// ...

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 intraprendere quando si fa clic su questo elemento.

Indietro

ImageButton : questo oggetto, per il concatenamento.

---

setOnClickOpenLinkAction(action)

Imposta un'azione che apre un URL in una scheda quando si fa clic sull'oggetto. Utilizza questa funzione quando l'URL deve essere creato o quando devi intraprendere altre azioni oltre alla creazione dell'oggetto OpenLink. Un oggetto UI può avere impostato 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 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 del link da intraprendere quando si fa clic su questo elemento.

Indietro

ImageButton : questo oggetto, per il concatenamento.

---

setOpenLink(openLink)

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

Parametri

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

Indietro

ImageButton : questo oggetto, per il concatenamento.

---

setOverflowMenu(menu)

Imposta un menu popup da aprire quando si fa clic sull'oggetto. Ogni elemento del menu può specificare un'azione da attivare quando si fa clic. I menu nidificati non sono supportati, le azioni per le voci di menu non devono specificare un menu extra.

Disponibile per le app di Google Chat. In anteprima per sviluppatori per i componenti aggiuntivi di Google Workspace.

Anteprima per gli sviluppatori: disponibile nell'ambito del Programma Anteprima per gli sviluppatori di Google Workspace, che concede l'accesso in anteprima a determinate funzionalità.

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 si fa clic su questo elemento.

Indietro

ImageButton : questo oggetto, per il concatenamento.