Esta página foi traduzida pela API Cloud Translation.

Class DecoratedText

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 de texto e uma das chaves usando setText(text) e uma das chaves DecoratedText, DecoratedText, setTopLabel(text) ou setBottomLabel(text). Esta classe substitui KeyValue.

Disponível para os apps do Google Workspace Add-ons e 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
`setAuthorizationAction(action)`	`DecoratedText`	Define uma ação de autorização que abre um URL para o fluxo de autorização quando o objeto é clicado.
`setBottomLabel(text)`	`DecoratedText`	Define o texto do rótulo a ser usado como chave e é exibido abaixo do conteúdo de texto.
`setButton(button)`	`DecoratedText`	Define o `Button` que aparece à direita do texto.
`setComposeAction(action, composedEmailType)`	`DecoratedText`	Define uma ação que compõe um e-mail de rascunho quando o objeto é clicado.
`setEndIcon(endIcon)`	`DecoratedText`	Define o `IconImage` opcional que aparece à direita do conteúdo.
`setOnClickAction(action)`	`DecoratedText`	Define uma ação que é executada quando o objeto é clicado.
`setOnClickOpenLinkAction(action)`	`DecoratedText`	Define uma ação que abre um URL em uma guia quando o objeto é clicado.
`setOpenLink(openLink)`	`DecoratedText`	Define um URL para ser aberto quando o objeto é clicado.
`setStartIcon(startIcon)`	`DecoratedText`	Define o `IconImage` opcional para exibição antes do conteúdo de texto.
`setSwitchControl(switchToSet)`	`DecoratedText`	Define o `Switch` que aparece à direita do conteúdo.
`setText(text)`	`DecoratedText`	Define o texto a ser usado como valor.
`setTopLabel(text)`	`DecoratedText`	Define o texto do rótulo a ser usado como chave e é exibido acima do conteúdo de texto.
`setWrapText(wrapText)`	`DecoratedText`	Define se o texto do valor deve ser mostrado em uma ou várias linhas.

Documentação detalhada

`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 for clicado.

Retornar

DecoratedText: este objeto, para encadeamento.

`setBottomLabel(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

DecoratedText: este objeto, para encadeamento.

`setButton(button)`

Define o Button que aparece à direita do texto. Um DecoratedText só pode oferecer suporte a um botão ou chave.

Parâmetros

Nome	Tipo	Descrição
`button`	`Button`	O botão para adicionar.

Retornar

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

DecoratedText: este objeto, para encadeamento.

`setEndIcon(endIcon)`

Define o IconImage opcional que aparece à direita do conteúdo. Um DecoratedText só pode ter um botão, um interruptor ou um ícone.

Parâmetros

Nome	Tipo	Descrição
`endIcon`	`IconImage`	O ícone a ser adicionado.

Retornar

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

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

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

DecoratedText: este objeto, para encadeamento.

`setStartIcon(startIcon)`

Define o IconImage opcional para exibição antes do conteúdo de texto.

Parâmetros

Nome	Tipo	Descrição
`startIcon`	`IconImage`	O ícone a ser mostrado.

Retornar

DecoratedText: este objeto, para encadeamento.

`setSwitchControl(switchToSet)`

Define o Switch que aparece à direita do conteúdo. Um DecoratedText pode ter suporte apenas a um botão ou um interruptor.

Parâmetros

Nome	Tipo	Descrição
`switchToSet`	`Switch`	O interruptor a ser adicionado.

Retornar

DecoratedText: este objeto, para encadeamento.

`setText(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 do widget.

Retornar

DecoratedText: este objeto, para encadeamento.

`setTopLabel(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

DecoratedText: este objeto, para encadeamento.

`setWrapText(wrapText)`

Define se o texto do valor deve ser mostrado em uma ou várias linhas.

Parâmetros

Nome	Tipo	Descrição
`wrapText`	`Boolean`	Se `true`, o texto é quebrado e exibido em várias linhas. Caso contrário, o texto será truncado.

Retornar

DecoratedText: este objeto, para encadeamento.