Class TextButton

TextButton

Un TextButton con un'etichetta di testo. Puoi impostare il colore di sfondo e disattivare il pulsante quando necessario.

Disponibile per i componenti aggiuntivi di Google Workspace e le app Google Chat.

const textButton = CardService.newTextButton()
                       .setText('Open Link')
                       .setOpenLink(CardService.newOpenLink().setUrl(
                           'https://www.google.com'));

Metodi

Metodo	Tipo restituito	Breve descrizione
setAltText(altText)	TextButton	Imposta il testo alternativo del pulsante per l'accessibilità.
setAuthorizationAction(action)	TextButton	Imposta un'azione di autorizzazione che apre un URL al flusso di autorizzazione quando si fa clic sull'oggetto.
setBackgroundColor(backgroundColor)	TextButton	Imposta il colore di sfondo per il pulsante TextButtonStyle.FILLED.
setComposeAction(action, composedEmailType)	TextButton	Imposta un'azione che compone una bozza di email quando si fa clic sull'oggetto.
setDisabled(disabled)	TextButton	Imposta se il pulsante è disattivato.
setIcon(icon)	TextButton	Imposta un Icon predefinito da visualizzare sul pulsante.
setIconUrl(url)	TextButton	Imposta l'URL di un'immagine da utilizzare come icona di questo pulsante.
setMaterialIcon(icon)	TextButton	Imposta l'icona Material Design.
setOnClickAction(action)	TextButton	Imposta un'azione da eseguire quando si fa clic sull'oggetto.
setOnClickOpenLinkAction(action)	TextButton	Imposta un'azione che apre un URL in una scheda quando si fa clic sull'oggetto.
setOpenLink(openLink)	TextButton	Imposta un URL da aprire quando si fa clic sull'oggetto.
setOverflowMenu(menu)	TextButton	Imposta l'apertura di un menu popup quando si fa clic sull'oggetto.
setText(text)	TextButton	Imposta il testo visualizzato sul pulsante.
setTextButtonStyle(textButtonStyle)	TextButton	Imposta lo stile del pulsante.

Documentazione dettagliata

setAltText(altText)

Imposta il testo alternativo del pulsante per l'accessibilità. Se non viene impostato, il valore predefinito è il testo visualizzato sul pulsante.

Parametri

Nome	Tipo	Descrizione
altText	String	Il testo alternativo da assegnare a questo pulsante.

Indietro

TextButton: 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. Si apre l'URL 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 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 questo elemento viene cliccato.

Indietro

TextButton: questo oggetto, per il concatenamento.

---

setBackgroundColor(backgroundColor)

Imposta il colore di sfondo per il pulsante TextButtonStyle.FILLED. Se non impostato per un pulsante TextButtonStyle.FILLED, il pulsante utilizza il colore secondario definito nel manifest del componente aggiuntivo. Questo metodo è un'operazione no-op per i pulsanti TextButtonStyle.OUTLINED.

Parametri

Nome	Tipo	Descrizione
backgroundColor	String	Il colore nel formato #rgb.

Indietro

TextButton: 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 solo uno dei valori setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType) impostato.

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 che viene utilizzata per estendere la UI di composizione. Questo metodo, invece, collega questo elemento dell'interfaccia utente a un Action che compone bozze di messaggi in Apps Script che vengono aperti in Gmail al termine 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

TextButton: questo oggetto, per il concatenamento.

---

setDisabled(disabled)

Imposta se il pulsante è disattivato. Un pulsante disattivato è visualizzato in grigio e non può essere selezionato.

Parametri

Nome	Tipo	Descrizione
disabled	Boolean	Lo stato disattivato.

Indietro

TextButton: questo oggetto, per il concatenamento.

---

setIcon(icon)

Imposta un Icon predefinito da visualizzare sul pulsante. Per definire l'immagine del pulsante, devi utilizzare questo campo o setIconUrl(url).

Parametri

Nome	Tipo	Descrizione
icon	Icon	Uno dei valori predefiniti di Icon.

Indietro

TextButton: 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, devi utilizzare questo parametro o setIcon(icon).

Parametri

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

Indietro

TextButton: questo oggetto, per il concatenamento.

---

setMaterialIcon(icon)

Imposta l'icona Material Design.

const textButton = CardService.newTextButton().setMaterialIcon(
    CardService.newMaterialIcon().setName('search'),
);

Parametri

Nome	Tipo	Descrizione
icon	MaterialIcon	L'icona Material Design.

Indietro

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

Indietro

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

Indietro

TextButton: 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 solo 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 oggetto OpenLink che descrive l'URL da aprire.

Indietro

TextButton: questo oggetto, per il concatenamento.

---

setOverflowMenu(menu)

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

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

Anteprima per gli sviluppatori: disponibile nell'ambito del Programma Anteprima per 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

TextButton: questo oggetto, per il concatenamento.

---

setText(text)

Imposta il testo visualizzato sul pulsante.

Parametri

Nome	Tipo	Descrizione
text	String	Il testo visualizzato sul pulsante.

Indietro

TextButton: questo oggetto, per il concatenamento.

---

setTextButtonStyle(textButtonStyle)

Imposta lo stile del pulsante. Se non viene impostato, il valore predefinito è il pulsante TextButtonStyle.OUTLINED.

const button =
    CardService.newTextButton()
        .setText('Filled')
        .setTextButtonStyle(CardService.TextButtonStyle.FILLED)
        .setOpenLink(CardService.newOpenLink().setUrl('www.google.com'));

Parametri

Nome	Tipo	Descrizione
textButtonStyle	TextButtonStyle	Lo stile del pulsante.

Indietro

TextButton: questo oggetto, per il concatenamento.