Esta página foi traduzida pela API Cloud Translation.

Class Chip

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

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

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 ícone 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 compõe um e-mail de rascunho quando o objeto é clicado.
`setDisabled(disabled)`	`Chip`	Define se o ícone está desativado.
`setIcon(icon)`	`Chip`	Define o ícone a ser usado como o ícone.
`setLabel(label)`	`Chip`	Define o título do ícone.
`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 para ser aberto quando o objeto é clicado.

Documentação detalhada

`setAltText(altText)`

Define o texto alternativo do ícone para acessibilidade. Se não for definido, o padrão será o texto que aparece no chip.

Parâmetros

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

Retornar

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

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

Retornar

Chip: este objeto, para encadeamento.

`setComposeAction(action, composedEmailType)`

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

Observação: esse método não define uma ação de composição que é usada para ampliar a interface do Compose. Em vez disso, ele conecta esse elemento da interface a um Action que compõe mensagens de rascunho no Apps Script e 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 este elemento é clicado.
`composedEmailType`	`ComposedEmailType`	Um valor de tipo enumerado que especifica se o rascunho composto é independente ou de resposta.

Retornar

Chip: este objeto, para encadeamento.

`setDisabled(disabled)`

Define se o chip está desativado. Um ícone desativado fica esmaecido 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: este objeto, para encadeamento.

`setIcon(icon)`

Define o ícone a ser usado como o ícone.

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

Parâmetros

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

Retornar

Chip: este objeto, para encadeamento.

`setLabel(label)`

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

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

Parâmetros

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

Retornar

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

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

Retornar

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

Retornar

Chip: este objeto, para encadeamento.

`setOpenLink(openLink)`

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

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

Retornar

Chip: este objeto, para encadeamento.