Class TextButton

Botão de texto

Uma TextButton com uma etiqueta de texto. Você pode definir a cor do plano de fundo e desativar o botão, quando necessário.

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 para 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 escreve um e-mail de rascunho quando o objeto é clicado.
setDisabled(disabled)	TextButton	Define se o botão está desativado.
setOnClickAction(action)	TextButton	Define uma ação que é executada quando alguém clica no objeto.
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 para acessibilidade. Caso não seja definido, o padrão do texto exibido no botão será o padrão.

Parâmetros

Nome	Tipo	Descrição
altText	String	É o texto alternativo a ser atribuído ao 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 conclui o fluxo de autorização e retorna ao aplicativo, o complemento é recarregado.

Um objeto de IU só pode ter um dos seguintes elementos definidos: 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 executada quando este elemento é clicado.

Retornar

TextButton: este objeto, para encadeamento.

---

setBackgroundColor(backgroundColor)

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

Parâmetros

Nome	Tipo	Descrição
backgroundColor	String	É a cor no formato #navegar.

Retornar

TextButton: este objeto, para encadeamento.

---

setComposeAction(action, composedEmailType)

Define uma ação que escreve um e-mail de rascunho quando o objeto é clicado. Um objeto de IU só pode ter um dos conjuntos setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType).

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

Observação: esse método não define uma ação de composição usada para estender a IU do Compose. Em vez disso, esse método conecta esse elemento da IU a um Action que compõe rascunhos de mensagens no Apps Script que são abertas no Gmail quando a ação é 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 realizada quando o elemento é clicado.
composedEmailType	ComposedEmailType	Um valor de enumeração que especifica se o rascunho composto é um rascunho autônomo ou de resposta.

Retornar

TextButton: este objeto, para encadeamento.

---

setDisabled(disabled)

Define se o botão está desativado. O botão desativado fica 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 alguém clica no objeto. Um objeto de IU só pode ter um dos setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType) definidos.

O parâmetro Action precisa especificar uma função de callback que retorne 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 executada quando este 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 URL precisar ser criado ou quando você precisar realizar outras ações além de criar o objeto OpenLink. Um objeto de IU pode ter apenas um dos conjuntos de setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType).

O parâmetro Action precisa especificar uma função de callback que retorne 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 o link quando esse elemento é 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á for conhecido e só precisar ser aberto. Um objeto de IU pode ter apenas um dos conjuntos de setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType).

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 a política não for definida, o botão TextButtonStyle.TEXT será o padrão.

Parâmetros

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

Retornar

TextButton: este objeto, para encadeamento.