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 quando 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`	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 l'oggetto viene selezionato.
`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 l'utente fa clic sull'oggetto.
`setDisabled(disabled)`	`TextButton`	Consente di impostare se il pulsante è disattivato.
`setOnClickAction(action)`	`TextButton`	Imposta un'azione che viene eseguita quando l'utente fa clic sull'oggetto.
`setOnClickOpenLinkAction(action)`	`TextButton`	Consente di impostare un'azione che consente di aprire un URL in una scheda quando l'utente fa clic sull'oggetto.
`setOpenLink(openLink)`	`TextButton`	Imposta un URL da aprire quando l'utente fa 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)`

Imposta il testo alternativo del pulsante per l'accessibilità. Se non viene configurato, viene utilizzato per impostazione predefinita il testo sul pulsante.

Parametri

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

Invio

TextButton: oggetto per il collegamento.

`setAuthorizationAction(action)`

Imposta un'azione di autorizzazione che apre un URL al flusso di autorizzazione quando l'oggetto viene selezionato. L'URL viene aperto in una nuova finestra. Quando l'utente termina il flusso di autorizzazione all'applicazione, il componente aggiuntivo si ricarica.

Per un oggetto UI può essere impostato un solo elemento 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 questo elemento viene selezionato.

Invio

TextButton: oggetto per il collegamento.

`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 è autonomo per i pulsanti TextButtonStyle.OUTLINED.

Parametri

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

Invio

TextButton: oggetto per il collegamento.

`setComposeAction(action, composedEmailType)`

Imposta un'azione che compone una bozza di email quando l'utente fa clic sull'oggetto. Un oggetto UI può solo avere uno dei seguenti: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType) impostati.

Il parametro Action deve specificare una funzione di callback che restituisca un oggetto ComposeActionResponse configurato utilizzando ComposeActionResponseBuilder.setGmailDraft(draft).

Nota: questo metodo non imposta un'azione di composizione che sia utilizzato per estendere l'interfaccia utente di scrittura. Piuttosto, questo metodo collega questo elemento dell'interfaccia utente a un Action che compone bozze di messaggi in Apps Script che sono aperto in Gmail al completamento 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 questo elemento viene selezionato.
`composedEmailType`	`ComposedEmailType`	Un valore enum che specifica se la bozza composta è un indipendente o una bozza di risposta.

Invio

TextButton: oggetto per il collegamento.

`setDisabled(disabled)`

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

Parametri

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

Invio

TextButton: oggetto per il collegamento.

`setOnClickAction(action)`

Imposta un'azione che viene eseguita quando l'utente fa clic sull'oggetto. Un oggetto UI può avere solo uno dei seguenti Impostazione setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType) impostata.

Il parametro Action deve specificare una funzione di callback che restituisca 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 l'utente fa clic su questo elemento.

Invio

TextButton: oggetto per il collegamento.

`setOnClickOpenLinkAction(action)`

Consente di impostare un'azione che consente di aprire un URL in una scheda quando l'utente fa clic sull'oggetto. Utilizza questa funzione quando È necessario creare l'URL o quando devi eseguire altre azioni oltre alla creazione dell'oggetto OpenLink. 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 restituisca 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 questo elemento è selezionato.

Invio

TextButton: oggetto per il collegamento.

`setOpenLink(openLink)`

Imposta un URL da aprire quando l'utente fa clic sull'oggetto. Utilizza questa funzione quando l'URL è già noto e deve solo essere 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.

Invio

TextButton: oggetto per il collegamento.

`setText(text)`

Imposta il testo che viene visualizzato sul pulsante.

Parametri

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

Invio

TextButton: oggetto per il collegamento.

`setTextButtonStyle(textButtonStyle)`

Imposta lo stile del pulsante. Se non viene configurato, viene usato il pulsante TextButtonStyle.OUTLINED per impostazione predefinita.

Parametri

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

Invio

TextButton: oggetto per il collegamento.