Esta página foi traduzida pela API Cloud Translation.

Class DecoratedText

Um widget que mostra texto com decorações opcionais. As possíveis chaves 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 setText(text) e uma destas: DecoratedText, DecoratedText, setTopLabel(text) ou setBottomLabel(text). Essa classe foi criada para substituir KeyValue.

Disponível nos complementos do Google Workspace e nos apps do Google Chat.

var decoratedText = CardService.newDecoratedText()
    .setText("Text")
    .setTopLabel("TopLabel");

var 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 do texto.
`setButton(button)`	`DecoratedText`	Define o `Button` que é exibido à direita do texto.
`setComposeAction(action, composedEmailType)`	`DecoratedText`	Define uma ação que compõe um rascunho de e-mail quando o objeto é clicado.
`setEndIcon(endIcon)`	`DecoratedText`	Define o `IconImage` opcional que é mostrado à 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 que será aberto quando o objeto for clicado.
`setStartIcon(startIcon)`	`DecoratedText`	Define o `IconImage` opcional a ser exibido antes do conteúdo de texto.
`setSwitchControl(switchToSet)`	`DecoratedText`	Define o `Switch` que é exibido à direita do conteúdo.
`setText(text)`	`DecoratedText`	Define o texto a ser usado como o valor.
`setTopLabel(text)`	`DecoratedText`	Define o texto do rótulo a ser usado como a chave e é exibido acima do conteúdo do texto.
`setWrapText(wrapText)`	`DecoratedText`	Define se o texto do valor deve ser exibido em uma única linha ou em várias.

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 será aberto em uma nova janela. Quando o usuário termina o fluxo de autorização e retornar ao aplicativo, o complemento será recarregado.

Um objeto da interface só pode ter um conjunto setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType).

// ...

var 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 tomada quando esse 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 do 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 é exibido à direita do texto. Um DecoratedText pode aceitam apenas um botão ou um interruptor.

Parâmetros

Nome	Tipo	Descrição
`button`	`Button`	Botão a ser adicionado.

Retornar

DecoratedText: este objeto, para encadeamento.

`setComposeAction(action, composedEmailType)`

Define uma ação que compõe um rascunho de e-mail quando o objeto é clicado. Um objeto de interface só pode ter uma destas opções: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action) setAuthorizationAction(action) ou setComposeAction(action, composedEmailType) definido.

O parâmetro Action precisa especificar uma função de callback que retorna um objeto ComposeActionResponse configurado usando ComposeActionResponseBuilder.setGmailDraft(draft).

Observação: esse método não define uma ação de composição que seja usada para estender a interface do Compose. Em vez disso, esse método conecta esse elemento de interface a uma Action, que compõe mensagens de rascunho no Apps Script que são: aberto no Gmail quando a ação for concluída.

// ...

var action = CardService.newAction().setFunctionName('composeEmailCallback');
CardService.newTextButton()
    .setText('Compose Email')
    .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT);

// ...

function composeEmailCallback() {
  var thread = GmailApp.getThreadById(e.threadId);
  var 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 executada quando esse elemento for clicado.
`composedEmailType`	`ComposedEmailType`	Um valor de enumeração que especifica se o rascunho composto é uma independente ou como rascunho de resposta.

Retornar

DecoratedText: este objeto, para encadeamento.

`setEndIcon(endIcon)`

Define o IconImage opcional que é mostrado à direita do conteúdo. Um DecoratedText só pode oferecer suporte a 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 Conjunto setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType).

O parâmetro Action precisa especificar uma função de callback que retorna um objeto ActionResponse.

// ...

var 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

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 O URL precisa ser criado ou quando você precisa realizar outras ações além da criação do objeto OpenLink. Um objeto da interface só pode ter setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType) definido.

O parâmetro Action precisa especificar uma função de callback que retorna um objeto ActionResponse configurado usando ActionResponseBuilder.setOpenLink(openLink).

// ...

var 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 executada quando esse elemento for clicado.

Retornar

DecoratedText: este objeto, para encadeamento.

`setOpenLink(openLink)`

Define um URL que será aberto quando o objeto for clicado. Use essa função quando o URL já estiver conhecidas e só precisam ser abertas. Um objeto da interface só pode ter setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action) e setAuthorizationAction(action). ou setComposeAction(action, composedEmailType) definido.

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 a ser exibido antes do conteúdo de texto.

Parâmetros

Nome	Tipo	Descrição
`startIcon`	`IconImage`	O ícone que será exibido.

Retornar

DecoratedText: este objeto, para encadeamento.

`setSwitchControl(switchToSet)`

Define o Switch que é exibido à direita do conteúdo. Um DecoratedText aceita apenas um botão ou um interruptor.

Parâmetros

Nome	Tipo	Descrição
`switchToSet`	`Switch`	A chave a ser adicionada.

Retornar

DecoratedText: este objeto, para encadeamento.

`setText(text)`

Define o texto a ser usado como o valor. Oferece suporte à formatação HTML básica. Obrigatório.

Parâmetros

Nome	Tipo	Descrição
`text`	`String`	O conteúdo de texto deste widget.

Retornar

DecoratedText: este objeto, para encadeamento.

`setTopLabel(text)`

Define o texto do rótulo a ser usado como a chave e é exibido acima do conteúdo do 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 exibido em uma única linha ou em várias.

Parâmetros

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

Retornar

DecoratedText: este objeto, para encadeamento.