Class TextButton

Pulsante testo

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

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

Metodi

MetodoTipo restituitoBreve descrizione
setAltText(altText)TextButtonConsente di impostare il testo alternativo del pulsante per l'accessibilità.
setAuthorizationAction(action)TextButtonImposta un'azione di autorizzazione che apre un URL nel flusso di autorizzazione quando viene fatto clic sull'oggetto.
setBackgroundColor(backgroundColor)TextButtonImposta il colore di sfondo per il pulsante TextButtonStyle.FILLED.
setComposeAction(action, composedEmailType)TextButtonImposta un'azione che scrive una bozza dell'email quando un utente fa clic sull'oggetto.
setDisabled(disabled)TextButtonConsente di stabilire se il pulsante deve essere disattivato.
setOnClickAction(action)TextButtonImposta un'azione da eseguire quando viene fatto clic sull'oggetto.
setOnClickOpenLinkAction(action)TextButtonImposta un'azione che apre un URL in una scheda quando l'utente fa clic sull'oggetto.
setOpenLink(openLink)TextButtonImposta un URL da aprire quando viene fatto clic sull'oggetto.
setText(text)TextButtonConsente di impostare il testo da visualizzare sul pulsante.
setTextButtonStyle(textButtonStyle)TextButtonImposta lo stile del pulsante.

Documentazione dettagliata

setAltText(altText)

Consente di impostare il testo alternativo del pulsante per l'accessibilità. Se il criterio non viene configurato, viene utilizzato per impostazione predefinita il testo visualizzato sul pulsante.

Parametri

NomeTipoDescrizione
altTextStringIl testo alternativo da assegnare a questo pulsante.

Andata e ritorno

TextButton: 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

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 aggiuntivo. Questo metodo è autonomo per i pulsanti TextButtonStyle.TEXT.

Parametri

NomeTipoDescrizione
backgroundColorStringIl colore in formato #rgb.

Andata e ritorno

TextButton: 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

TextButton: questo oggetto, per il concatenamento.


setDisabled(disabled)

Consente di stabilire se il pulsante deve essere disattivato. Un pulsante disattivato non è selezionabile e non può essere selezionato.

Parametri

NomeTipoDescrizione
disabledBooleanLo stato disattivato.

Andata e ritorno

TextButton: 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

TextButton: 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

TextButton: 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

TextButton: questo oggetto, per il concatenamento.


setText(text)

Consente di impostare il testo da visualizzare sul pulsante.

Parametri

NomeTipoDescrizione
textStringIl testo che appare sul pulsante.

Andata e ritorno

TextButton: questo oggetto, per il concatenamento.


setTextButtonStyle(textButtonStyle)

Imposta lo stile del pulsante. Se non viene configurato, il valore predefinito è il pulsante TextButtonStyle.TEXT.

Parametri

NomeTipoDescrizione
textButtonStyleTextButtonStyleLo stile del pulsante.

Andata e ritorno

TextButton: questo oggetto, per il concatenamento.