Class TextButton

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

Retornar

TextButton: este objeto, para encadeamento.

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 retorna 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

Retornar

TextButton: este objeto, para encadeamento.

Define a cor 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

Retornar

TextButton: este objeto, para encadeamento.

Define uma ação que compõe um e-mail de rascunho quando o objeto é clicado. Um objeto de interface 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 ComposeActionResponse configurado usando ComposeActionResponseBuilder.setGmailDraft(draft).

// ...

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

Retornar

TextButton: este objeto, para encadeamento.

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

Parâmetros

Retornar

TextButton: este objeto, para encadeamento.

Define um Icon predefinido para exibição no botão. É necessário usar esse valor ou setIconUrl(url) para definir a imagem do botão.

Parâmetros

Retornar

TextButton: este objeto, para encadeamento.

Define o URL de uma imagem a ser usada como ícone do botão. É necessário usar este ou setIcon(icon) para definir a imagem do botão.

Parâmetros

Retornar

TextButton: este objeto, para encadeamento.

Define o ícone do Material Design.

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

Parâmetros

Retornar

TextButton: este objeto, para encadeamento.

Define uma ação que é executada quando o objeto é clicado. Um objeto de interface 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.

// ...

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

Retornar

TextButton: este objeto, para encadeamento.

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

Retornar

TextButton: este objeto, para encadeamento.

Define um URL para ser aberto quando o objeto é clicado. Use essa função quando o URL já é conhecido e só precisa ser aberto. Um objeto de interface só pode ter um dos setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType) definidos.

Parâmetros

Retornar

TextButton: este objeto, para encadeamento.

Define um menu pop-up para ser aberto quando o objeto é clicado. Cada item do menu pode especificar uma ação a ser acionada quando clicado. Menus aninhados não são aceitos. As ações para itens de menu não podem especificar um menu flutuante.

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

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

Retornar

TextButton: este objeto, para encadeamento.

Define o texto que aparece no botão.

Parâmetros

Retornar

TextButton: este objeto, para encadeamento.

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

Retornar

TextButton: este objeto, para encadeamento.