Questa pagina è stata tradotta dall'API Cloud Translation.

Class TextButton

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

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

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

Metodi

Metodo	Tipo restituito	Breve descrizione
`setAltText(altText)`	`TextButton`	Consente di impostare 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 viene fatto clic sull'oggetto.
`setBackgroundColor(backgroundColor)`	`TextButton`	Imposta il colore di sfondo per il pulsante `TextButtonStyle.FILLED`.
`setComposeAction(action, composedEmailType)`	`TextButton`	Imposta un'azione che scrive una bozza di email quando viene fatto clic sull'oggetto.
`setDisabled(disabled)`	`TextButton`	Consente di impostare se il pulsante è disabilitato.
`setOnClickAction(action)`	`TextButton`	Imposta un'azione che viene eseguita 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 viene fatto clic sull'oggetto.
`setText(text)`	`TextButton`	Imposta il testo che viene visualizzato sul pulsante.
`setTextButtonStyle(textButtonStyle)`	`TextButton`	Imposta 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, per impostazione predefinita viene visualizzato il testo sul pulsante.

Parametri

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

Ritorni

TextButton: questo oggetto per il concatenamento.

`setAuthorizationAction(action)`

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

Per un oggetto UI è possibile impostare solo uno tra setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType).

// ...

var 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.

Ritorni

TextButton: questo oggetto per il concatenamento.

`setBackgroundColor(backgroundColor)`

Imposta il colore di sfondo per il pulsante TextButtonStyle.FILLED. Se non viene configurato per un pulsante TextButtonStyle.FILLED, il pulsante utilizza il colore secondario definito nel manifest del componente aggiuntivo. Questo metodo è automatico per i pulsanti TextButtonStyle.OUTLINED.

Parametri

Nome	Tipo	Descrizione
`backgroundColor`	`String`	Il colore in formato #gsuite.

Ritorni

TextButton: questo oggetto per il concatenamento.

`setComposeAction(action, composedEmailType)`

Imposta un'azione che scrive una bozza di email quando viene fatto clic sull'oggetto. Per un oggetto UI è possibile impostare 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 scrittura utilizzata per estendere la UI di scrittura. Questo metodo, invece, collega questo elemento UI a un Action che compone le bozze dei messaggi in Apps Script che vengono aperte 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 enum che specifica se la bozza composta è una bozza autonoma o di risposta.

Ritorni

TextButton: questo oggetto per il concatenamento.

`setDisabled(disabled)`

Consente di impostare se il pulsante è disabilitato. Un pulsante disattivato è visualizzato in grigio e non può essere selezionato.

Parametri

Nome	Tipo	Descrizione
`disabled`	`Boolean`	Lo stato disattivato.

Ritorni

TextButton: questo oggetto per il concatenamento.

`setOnClickAction(action)`

Imposta un'azione che viene eseguita quando si fa clic sull'oggetto. Un oggetto UI può avere solo uno tra 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 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.

Ritorni

TextButton: questo oggetto per il concatenamento.

`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 eseguire altre azioni in aggiunta alla creazione dell'oggetto OpenLink. Per un oggetto UI è possibile impostare un solo elemento 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).

// ...

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 apertura link da eseguire quando viene fatto clic su questo elemento.

Ritorni

TextButton: questo oggetto per il concatenamento.

`setOpenLink(openLink)`

Imposta un URL da aprire quando viene fatto clic sull'oggetto. Usa questa funzione quando l'URL è già noto e deve essere solo aperto. Un oggetto UI può avere solo uno tra setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType) impostato.

Parametri

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

Ritorni

TextButton: questo oggetto per il concatenamento.

`setText(text)`

Imposta il testo che viene visualizzato sul pulsante.

Parametri

Nome	Tipo	Descrizione
`text`	`String`	Il testo visualizzato sul pulsante.

Ritorni

TextButton: questo oggetto per il concatenamento.

`setTextButtonStyle(textButtonStyle)`

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

Parametri

Nome	Tipo	Descrizione
`textButtonStyle`	`TextButtonStyle`	Lo stile del pulsante.

Ritorni

TextButton: questo oggetto per il concatenamento.