Um widget que mostra texto com decorações opcionais. As chaves possíveis incluem um ícone, um rótulo
acima e um rótulo abaixo. É necessário definir o conteúdo do texto e uma das chaves usando set e um dos valores Decorated, Decorated, set ou set. Essa classe foi criada para substituir .
Key
Disponível para complementos do Google Workspace e apps do Google Chat.
const decoratedText = CardService.newDecoratedText().setText('Text').setTopLabel('TopLabel'); const multilineDecoratedText = CardService.newDecoratedText() .setText('Text') .setTopLabel('TopLabel') .setWrapText(true) .setBottomLabel('BottomLabel');
Métodos
| Método | Tipo de retorno | Breve descrição |
|---|---|---|
add | Widget | Adiciona a ação de evento que pode ser realizada no widget. |
set | Decorated | Define uma ação de autorização que abre um URL para o fluxo de autorização quando o objeto é clicado. |
set | Decorated | Define o texto do rótulo a ser usado como chave e exibido abaixo do conteúdo de texto. |
set | Decorated | Define o Button que é mostrado à direita do texto. |
set | Decorated | Define uma ação que cria um rascunho de e-mail quando o objeto é clicado. |
set | Decorated | Define o Icon opcional que é mostrado à direita do conteúdo. |
set | Widget | Define o ID exclusivo atribuído que é usado para identificar o widget a ser alterado. |
set | Decorated | Define uma ação que é executada quando o objeto é clicado. |
set | Decorated | Define uma ação que abre um URL em uma guia quando o objeto é clicado. |
set | Decorated | Define um URL para ser aberto quando o objeto é clicado. |
set | Decorated | Define o Icon opcional para exibição antes do conteúdo de texto. |
set | Decorated | Define o Switch que é mostrado à direita do conteúdo. |
set | Decorated | Define o texto a ser usado como valor. |
set | Decorated | Define o texto do rótulo a ser usado como chave e é exibido acima do conteúdo de texto. |
set | Widget | Define a visibilidade do widget. |
set | Decorated | Define se o texto do valor deve ser mostrado em uma ou várias linhas. |
Documentação detalhada
add Event Action(eventAction)
Adiciona a ação de evento que pode ser realizada no widget.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
event | Event | O Event a ser adicionado. |
Retornar
Widget: o objeto para encadeamento.
set Authorization Action(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: set, set, set, set ou set.
// ... const action = CardService.newAuthorizationAction().setAuthorizationUrl('url'); CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
action | Authorization | O objeto que especifica a ação de autorização a ser realizada quando esse elemento é clicado. |
Retornar
Decorated: este objeto, para encadeamento.
set Bottom Label(text)
Define o texto do rótulo a ser usado como chave e exibido abaixo do conteúdo de texto.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
text | String | O texto do rótulo. |
Retornar
Decorated: este objeto, para encadeamento.
set Button(button)
Define o Button que é mostrado à direita do texto. Um Decorated só pode oferecer suporte a um botão ou uma chave.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
button | Button | O botão a ser adicionado. |
Retornar
Decorated: este objeto, para encadeamento.
set Compose Action(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: set, set, set, set ou set.
O parâmetro Action precisa especificar uma função de callback que retorne um objeto Compose configurado usando Compose.
// ... 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. |
composed | Composed | Um valor de enumeração que especifica se o rascunho composto é independente ou uma resposta. |
Retornar
Decorated: este objeto, para encadeamento.
set End Icon(endIcon)
Define o Icon opcional que é mostrado à direita do conteúdo. Um Decorated só pode ter um botão, uma chave ou um ícone.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
end | Icon | O ícone a ser adicionado. |
Retornar
Decorated: este objeto, para encadeamento.
set Id(id)
Define o ID exclusivo atribuído que é usado para identificar o widget a ser alterado. A mutação de widget só é compatível com complementos.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
id | String | O ID do widget, com um limite de 64 caracteres e no formato `[a-zA-Z0-9-]+`. |
Retornar
Widget: este objeto, para encadeamento.
set On Click Action(action)
Define uma ação que é executada quando o objeto é clicado. Um objeto de interface só pode ter um dos seguintes valores definidos: set, set, set, set ou set.
O parâmetro Action precisa especificar uma função de callback que retorne um objeto Action.
// ... 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
Decorated: este objeto, para encadeamento.
set On Click Open Link Action(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 for necessário realizar outras ações além de criar o objeto Open. Um objeto de interface só pode ter um dos seguintes valores definidos: set, set, set, set ou set.
O parâmetro Action precisa especificar uma função de callback que retorne um objeto Action configurado usando Action.
// ... 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
Decorated: este objeto, para encadeamento.
set Open Link(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: set, set, set, set ou set.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
open | Open | Um objeto Open que descreve o URL a ser aberto. |
Retornar
Decorated: este objeto, para encadeamento.
set Start Icon(startIcon)
Define o Icon opcional para exibição antes do conteúdo de texto.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
start | Icon | O ícone a ser exibido. |
Retornar
Decorated: este objeto, para encadeamento.
set Switch Control(switchToSet)
Define o Switch que é mostrado à direita do conteúdo. Um Decorated
só pode ser compatível com um botão ou uma chave.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
switch | Switch | A chave a ser adicionada. |
Retornar
Decorated: este objeto, para encadeamento.
set Text(text)
Define o texto a ser usado como valor. Aceita formatação HTML básica. Obrigatório.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
text | String | O conteúdo de texto deste widget. |
Retornar
Decorated: este objeto, para encadeamento.
set Top Label(text)
Define o texto do rótulo a ser usado como chave e é exibido acima do conteúdo de texto.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
text | String | O texto do rótulo. |
Retornar
Decorated: este objeto, para encadeamento.
set Visibility(visibility)
Define a visibilidade do widget. O valor padrão é "VISIBLE".
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
visibility | Visibility | O Visibility do widget. |
Retornar
Widget: o objeto para encadeamento.
set Wrap Text(wrapText)
Define se o texto do valor deve ser mostrado em uma ou várias linhas.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
wrap | Boolean | Se true, o texto será encapsulado e exibido em várias linhas. Caso contrário, o texto será truncado. |
Retornar
Decorated: este objeto, para encadeamento.