Class TextButton

TestoPulsante

Un TextButton con un'etichetta di testo. Se necessario, puoi impostare il colore di sfondo e disattivare il pulsante.

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 per il 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 viene fatto clic sull'oggetto.
setOpenLink(openLink)	TextButton	Imposta un URL da aprire quando si fa clic sull'oggetto.
setOverflowMenu(menu)	TextButton	Imposta un menu popup da aprire 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 è impostato, viene utilizzato il testo visualizzato sul pulsante.

Parametri

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

Invio

TextButton: questo oggetto, per l'accodamento.

---

setAuthorizationAction(action)

Imposta un'azione di autorizzazione che apre un URL per il flusso di autorizzazione quando si fa clic sull'oggetto. L'URL si apre in una nuova finestra. Quando l'utente completa il flusso di autorizzazione e ritorna all'applicazione, il componente aggiuntivo viene ricaricato.

Un oggetto dell'interfaccia utente può avere impostato solo uno tra 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 eseguire quando viene fatto clic su questo elemento.

Invio

TextButton: questo oggetto, per l'accodamento.

---

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 no-op per i pulsanti TextButtonStyle.OUTLINED.

Parametri

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

Invio

TextButton: questo oggetto, per l'accodamento.

---

setComposeAction(action, composedEmailType)

Imposta un'azione che compone una bozza di email quando si fa clic sull'oggetto. Un oggetto dell'interfaccia utente 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 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 questo elemento dell'interfaccia utente a un Action che compone bozze di messaggi in Apps Script che vengono aperte 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 eseguire quando viene fatto clic su questo elemento.
composedEmailType	ComposedEmailType	Un valore enumerato che specifica se la bozza composta è indipendente o una bozza di risposta.

Invio

TextButton: questo oggetto, per l'accodamento.

---

setDisabled(disabled)

Imposta se il pulsante è disattivato. Un pulsante disattivato non è selezionabile e non è possibile fare clic su di esso.

Parametri

Nome	Tipo	Descrizione
disabled	Boolean	Lo stato disattivato.

Invio

TextButton: questo oggetto, per l'accodamento.

---

setIcon(icon)

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

Parametri

Nome	Tipo	Descrizione
icon	Icon	Uno dei valori Icon predefiniti.

Invio

TextButton: questo oggetto, per l'accodamento.

---

setIconUrl(url)

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

Parametri

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

Invio

TextButton: questo oggetto, per l'accodamento.

---

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.

Invio

TextButton: questo oggetto, per l'accodamento.

---

setOnClickAction(action)

Imposta un'azione da eseguire quando si fa clic sull'oggetto. Un oggetto dell'interfaccia utente 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 viene fatto clic su questo elemento.

Invio

TextButton: questo oggetto, per l'accodamento.

---

setOnClickOpenLinkAction(action)

Imposta un'azione che apre un URL in una scheda quando viene fatto clic sull'oggetto. Utilizza questa funzione quando è necessario creare l'URL o quando devi intraprendere altre azioni oltre alla creazione dell'oggetto OpenLink. Un oggetto dell'interfaccia utente 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 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 viene fatto clic su questo elemento.

Invio

TextButton: questo oggetto, per l'accodamento.

---

setOpenLink(openLink)

Imposta un URL da aprire quando si fa clic sull'oggetto. Utilizza questa funzione quando l'URL è già conosciuto e deve solo essere aperto. Un oggetto dell'interfaccia utente può avere impostato solo uno tra 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.

Invio

TextButton: questo oggetto, per l'accodamento.

---

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 viene fatto clic. I menu nidificati non sono supportati, le azioni per le voci di menu non devono specificare un menu extra.

Disponibile solo per le app Google Chat. Non disponibile per i componenti aggiuntivi di Google Workspace.

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.

Invio

TextButton: questo oggetto, per l'accodamento.

---

setText(text)

Imposta il testo visualizzato sul pulsante.

Parametri

Nome	Tipo	Descrizione
text	String	Il testo visualizzato sul pulsante.

Invio

TextButton: questo oggetto, per l'accodamento.

---

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.

Invio

TextButton: questo oggetto, per l'accodamento.