Class TextButton

TextButton

Um 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 para complementos do Google Workspace e apps do Google Chat.

const 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 cria um rascunho de e-mail quando o objeto é clicado.
setDisabled(disabled)	TextButton	Define se o botão está desativado.
setIcon(icon)	TextButton	Define um Icon predefinido para mostrar no botão.
setIconUrl(url)	TextButton	Define o URL de uma imagem a ser usada como ícone do botão.
setMaterialIcon(icon)	TextButton	Define o ícone do Material Design.
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 para ser aberto quando o objeto é clicado.
setOverflowMenu(menu)	TextButton	Define um menu pop-up para ser aberto quando o objeto é clicado.
setText(text)	TextButton	Define o texto que aparece 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. Se não for definido, o padrão será o texto que aparece no botão.

Parâmetros

Nome	Tipo	Descrição
altText	String	O texto alternativo a ser atribuído a esse 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. Isso abre o URL em uma nova janela. Quando o usuário termina o fluxo de autorização e volta ao aplicativo, o complemento é recarregado.

Um objeto de interface só pode ter um dos seguintes valores definidos: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType).

// ...

const 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 realizada quando esse elemento é clicado.

Retornar

TextButton: este objeto, para encadeamento.

---

setBackgroundColor(backgroundColor)

Define a cor do plano de fundo do botão TextButtonStyle.FILLED. Se não for definido para um botão TextButtonStyle.FILLED, ele vai usar a cor secundária definida no manifesto do complemento. Esse método não faz nada para 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 cria um rascunho de e-mail quando o objeto é clicado. Um objeto de interface só pode ter um dos seguintes valores definidos: 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 que é usada para estender a interface do Compose. Em vez disso, esse método conecta o elemento da interface a um Action que cria mensagens de rascunho no Apps Script, que são abertas no Gmail quando a ação é concluída.

// ...

const action = CardService.newAction().setFunctionName('composeEmailCallback');
CardService.newTextButton()
    .setText('Compose Email')
    .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT);

// ...

function composeEmailCallback(e) {
  const thread = GmailApp.getThreadById(e.threadId);
  const 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 esse elemento é clicado.
composedEmailType	ComposedEmailType	Um valor de enumeração que especifica se o rascunho composto é um rascunho independente ou de resposta.

Retornar

TextButton: este objeto, para encadeamento.

---

setDisabled(disabled)

Define se o botão está desativado. Um 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.

---

setIcon(icon)

Define um Icon predefinido para mostrar no botão. É preciso usar este ou setIconUrl(url) para definir a imagem do botão.

Parâmetros

Nome	Tipo	Descrição
icon	Icon	Um dos valores Icon predefinidos.

Retornar

TextButton: este objeto, para encadeamento.

---

setIconUrl(url)

Define o URL de uma imagem a ser usada como ícone do botão. Este ou setIcon(icon) precisa ser usado para definir a imagem do botão.

Parâmetros

Nome	Tipo	Descrição
url	String	O endereço URL de uma imagem hospedada a ser usada como ícone do botão.

Retornar

TextButton: este objeto, para encadeamento.

---

setMaterialIcon(icon)

Define o ícone do Material Design.

const textButton = CardService.newTextButton().setMaterialIcon(
    CardService.newMaterialIcon().setName('search'),
);

Parâmetros

Nome	Tipo	Descrição
icon	MaterialIcon	O ícone do Material Design.

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 dos seguintes valores definidos: 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.

// ...

const 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 for 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 interface só pode ter um dos seguintes valores definidos: 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).

// ...

const 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 realizada quando este elemento é clicado.

Retornar

TextButton: este objeto, para encadeamento.

---

setOpenLink(openLink)

Define um URL para ser aberto quando o objeto é clicado. Use essa função quando o URL já for conhecido e só precisar ser aberto. Um objeto de interface só pode ter um dos seguintes valores definidos: 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.

---

setOverflowMenu(menu)

Define um menu pop-up para ser aberto quando o objeto é clicado. Cada item no menu pode especificar uma ação a ser acionada quando clicado. Menus aninhados não são compatíveis, e as ações para itens de menu não devem especificar um menu flutuante.

Disponível para apps do Google Chat. Na prévia para desenvolvedores dos complementos do Google Workspace.

Prévia para desenvolvedores:disponível no Programa de testes para desenvolvedores do Google Workspace, que concede acesso antecipado a determinados recursos.

const overflowMenuItem =
    CardService.newOverflowMenuItem()
        .setStartIcon(
            CardService.newIconImage().setIconUrl(
                'https://www.google.com/images/branding/googleg/1x/googleg_standard_color_64dp.png',
                ),
            )
        .setText('Open Link')
        .setOpenLink(
            CardService.newOpenLink().setUrl('https://www.google.com'));

const overflowMenu =
    CardService.newOverflowMenu().addMenuItem(overflowMenuItem).build();

Parâmetros

Nome	Tipo	Descrição
menu	OverflowMenu	O objeto que especifica o menu flutuante a ser mostrado quando esse elemento é clicado.

Retornar

TextButton: este objeto, para encadeamento.

---

setText(text)

Define o texto que aparece 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 padrão será o botão TextButtonStyle.OUTLINED.

const button =
    CardService.newTextButton()
        .setText('Filled')
        .setTextButtonStyle(CardService.TextButtonStyle.FILLED)
        .setOpenLink(CardService.newOpenLink().setUrl('www.google.com'));

Parâmetros

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

Retornar

TextButton: este objeto, para encadeamento.