Class Chip

Chip

Um Chip com um ícone e uma etiqueta de texto. Você pode desativar o chip quando necessário.

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

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

const chip = CardService.newChip()
                 .setLabel('Open Link')
                 .setOpenLink(CardService.newOpenLink().setUrl(
                     'https://www.google.com'));

Métodos

Método	Tipo de retorno	Breve descrição
setAltText(altText)	Chip	Define o texto alternativo do chip para acessibilidade.
setAuthorizationAction(action)	Chip	Define uma ação de autorização que abre um URL para o fluxo de autorização quando o objeto é clicado.
setComposeAction(action, composedEmailType)	Chip	Define uma ação que cria um rascunho de e-mail quando o objeto é clicado.
setDisabled(disabled)	Chip	Define se o chip está desativado.
setIcon(icon)	Chip	Define o ícone a ser usado como chip.
setLabel(label)	Chip	Define o título do chip.
setOnClickAction(action)	Chip	Define uma ação que é executada quando o objeto é clicado.
setOnClickOpenLinkAction(action)	Chip	Define uma ação que abre um URL em uma guia quando o objeto é clicado.
setOpenLink(openLink)	Chip	Define um URL a ser aberto quando o objeto é clicado.

Documentação detalhada

setAltText(altText)

Define o texto alternativo do chip para acessibilidade. Se não for definido, o padrão será o texto exibido no chip.

Parâmetros

Nome	Tipo	Descrição
altText	String	O texto alternativo a ser atribuído a esse chip.

Retornar

Chip: esse 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 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

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

Retornar

Chip: esse 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 criação que é usada para estender a interface de criação. Em vez disso, esse método conecta esse elemento da interface ao Action que escreve 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 criação a ser realizada quando esse elemento é clicado.
composedEmailType	ComposedEmailType	Um valor de enumeração que especifica se o rascunho criado é um rascunho independente ou de resposta.

Retornar

Chip: esse objeto, para encadeamento.

---

setDisabled(disabled)

Define se o chip está desativado. Um chip desativado fica acinzentado e não pode ser clicado.

const chip = CardService.newChip().setLabel('bug Report').setDisabled(true);

Parâmetros

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

Retornar

Chip: esse objeto, para encadeamento.

---

setIcon(icon)

Define o ícone a ser usado como chip.

const chip = CardService.newChip().setIcon(
    CardService.newIconImage().setMaterialIcon(
        CardService.newMaterialIcon().setName('bug_report'),
        ),
);

Parâmetros

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

Retornar

Chip: esse objeto, para encadeamento.

---

setLabel(label)

Define o título do chip. Obrigatório.

const chip = CardService.newChip().setLabel('bug Report');

Parâmetros

Nome	Tipo	Descrição
label	String	O texto a ser exibido.

Retornar

Chip: esse 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 é clicado.

Retornar

Chip: esse 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 link aberto a ser realizada quando esse elemento é clicado.

Retornar

Chip: esse objeto, para encadeamento.

---

setOpenLink(openLink)

Define um URL a 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 OpenLink objeto que descreve o URL a ser aberto.

Retornar

Chip: esse objeto, para encadeamento.