Esta página foi traduzida pela API Cloud Translation.

Class TextButton

Uma TextButton com um rótulo de texto. Você pode definir a cor do plano de fundo e desativar o botão quando necessário.

Disponível nos complementos do Google Workspace e nos apps do Google Chat.

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

Métodos

Método	Tipo de retorno	Breve descrição
`setAltText(altText)`	`TextButton`	Define o texto alternativo do botão de acessibilidade.
`setAuthorizationAction(action)`	`TextButton`	Define uma ação de autorização que abre um URL para o fluxo de autorização quando o objeto é clicado.
`setBackgroundColor(backgroundColor)`	`TextButton`	Define a cor do plano de fundo do botão `TextButtonStyle.FILLED`.
`setComposeAction(action, composedEmailType)`	`TextButton`	Define uma ação que compõe um rascunho de e-mail quando o objeto é clicado.
`setDisabled(disabled)`	`TextButton`	Define se o botão será desativado.
`setOnClickAction(action)`	`TextButton`	Define uma ação que é executada quando o objeto é clicado.
`setOnClickOpenLinkAction(action)`	`TextButton`	Define uma ação que abre um URL em uma guia quando o objeto é clicado.
`setOpenLink(openLink)`	`TextButton`	Define um URL que será aberto quando o objeto for clicado.
`setText(text)`	`TextButton`	Define o texto exibido no botão.
`setTextButtonStyle(textButtonStyle)`	`TextButton`	Define o estilo do botão.

Documentação detalhada

`setAltText(altText)`

Define o texto alternativo do botão de acessibilidade. Se não for definido, o padrão será o texto que será exibido no botão.

Parâmetros

Nome	Tipo	Descrição
`altText`	`String`	O texto alternativo a ser atribuído a este botão.

Retornar

TextButton: este objeto, para encadeamento.

`setAuthorizationAction(action)`

Define uma ação de autorização que abre um URL para o fluxo de autorização quando o objeto é clicado. O URL será aberto em uma nova janela. Quando o usuário termina o fluxo de autorização e retornar ao aplicativo, o complemento será recarregado.

Um objeto da interface só pode ter um conjunto setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType).

// ...

var action = CardService.newAuthorizationAction().setAuthorizationUrl('url');
CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);

Parâmetros

Nome	Tipo	Descrição
`action`	`AuthorizationAction`	O objeto que especifica a ação de autorização a ser tomada quando esse elemento for clicado.

Retornar

TextButton: este objeto, para encadeamento.

`setBackgroundColor(backgroundColor)`

Define a cor do plano de fundo do botão TextButtonStyle.FILLED. Se ela não for definida para um botão TextButtonStyle.FILLED, o botão vai usar a cor secundária definida no manifesto do complemento. Esse método é um ambiente autônomo para os botões TextButtonStyle.OUTLINED.

Parâmetros

Nome	Tipo	Descrição
`backgroundColor`	`String`	A cor no formato #rgb.

Retornar

TextButton: este objeto, para encadeamento.

`setComposeAction(action, composedEmailType)`

Define uma ação que compõe um rascunho de e-mail quando o objeto é clicado. Um objeto de interface só pode ter uma destas opções: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action) setAuthorizationAction(action) ou setComposeAction(action, composedEmailType) definido.

O parâmetro Action precisa especificar uma função de callback que retorna um objeto ComposeActionResponse configurado usando ComposeActionResponseBuilder.setGmailDraft(draft).

Observação: esse método não define uma ação de composição que seja usada para estender a interface do Compose. Em vez disso, esse método conecta esse elemento de interface a uma Action, que compõe mensagens de rascunho no Apps Script que são: aberto no Gmail quando a ação for concluída.

// ...

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();
}

Parâmetros

Nome	Tipo	Descrição
`action`	`Action`	O objeto que especifica a ação de composição a ser executada quando esse elemento for clicado.
`composedEmailType`	`ComposedEmailType`	Um valor de enumeração que especifica se o rascunho composto é uma independente ou como rascunho de resposta.

Retornar

TextButton: este objeto, para encadeamento.

`setDisabled(disabled)`

Define se o botão será desativado. Um botão desativado está esmaecido e não pode ser clicado.

Parâmetros

Nome	Tipo	Descrição
`disabled`	`Boolean`	O estado desativado.

Retornar

TextButton: este objeto, para encadeamento.

`setOnClickAction(action)`

Define uma ação que é executada quando o objeto é clicado. Um objeto de interface só pode ter um Conjunto setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType).

O parâmetro Action precisa especificar uma função de callback que retorna um objeto 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();
}

Parâmetros

Nome	Tipo	Descrição
`action`	`Action`	A ação a ser realizada quando esse elemento é clicado.

Retornar

TextButton: este objeto, para encadeamento.

`setOnClickOpenLinkAction(action)`

Define uma ação que abre um URL em uma guia quando o objeto é clicado. Use essa função quando o O URL precisa ser criado ou quando você precisa realizar outras ações além da criação do objeto OpenLink. Um objeto da interface só pode ter setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType) definido.

O parâmetro Action precisa especificar uma função de callback que retorna um objeto ActionResponse configurado usando 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();
}

Parâmetros

Nome	Tipo	Descrição
`action`	`Action`	O objeto que especifica a ação de abrir link a ser executada quando esse elemento for clicado.

Retornar

TextButton: este objeto, para encadeamento.

`setOpenLink(openLink)`

Define um URL que será aberto quando o objeto for clicado. Use essa função quando o URL já estiver conhecidas e só precisam ser abertas. Um objeto da interface só pode ter setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action) e setAuthorizationAction(action). ou setComposeAction(action, composedEmailType) definido.

Parâmetros

Nome	Tipo	Descrição
`openLink`	`OpenLink`	Um objeto `OpenLink` que descreve o URL a ser aberto.

Retornar

TextButton: este objeto, para encadeamento.

`setText(text)`

Define o texto exibido no botão.

Parâmetros

Nome	Tipo	Descrição
`text`	`String`	O texto que aparece no botão.

Retornar

TextButton: este objeto, para encadeamento.

`setTextButtonStyle(textButtonStyle)`

Define o estilo do botão. Se não for definido, o botão TextButtonStyle.OUTLINED será usado por padrão.

Parâmetros

Nome	Tipo	Descrição
`textButtonStyle`	`TextButtonStyle`	O estilo do botão.

Retornar

TextButton: este objeto, para encadeamento.