Esta página foi traduzida pela API Cloud Translation.

Class DecoratedText

(link em inglês)

Um widget que exibe 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 de texto e uma das chaves usando setText(text) e uma das DecoratedText, DecoratedText, setTopLabel(text) ou setBottomLabel(text). Esta classe se destina a substituir KeyValue.

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 da etiqueta a ser usado como a 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 escreve um e-mail de rascunho quando o objeto é clicado.
`setEndIcon(endIcon)`	`DecoratedText`	Define o `IconImage` opcional que é exibido à direita do conteúdo.
`setOnClickAction(action)`	`DecoratedText`	Define uma ação que é executada quando alguém clica no objeto.
`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 a `IconImage` opcional a ser exibida 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 da etiqueta a ser usado como a chave e é exibido acima do conteúdo do texto.
`setWrapText(wrapText)`	`DecoratedText`	Define se o texto de valor deve ser exibido em uma única linha ou em 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 será aberto em uma nova janela. Quando o usuário conclui o fluxo de autorização e retorna ao aplicativo, o complemento é recarregado.

Um objeto de IU só pode ter um dos seguintes elementos definidos: 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 executada quando este elemento é clicado.

Retornar

DecoratedText: este objeto, para encadeamento.

`setBottomLabel(text)`

Define o texto da etiqueta a ser usado como a 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 ser compatível apenas com um botão ou um interruptor.

Parâmetros

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

Retornar

DecoratedText: este objeto, para encadeamento.

`setComposeAction(action, composedEmailType)`

Define uma ação que escreve um e-mail de rascunho quando o objeto é clicado. Um objeto de IU só pode ter um dos conjuntos 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 composição usada para estender a IU do Compose. Em vez disso, esse método conecta esse elemento da IU a um Action que compõe rascunhos de mensagens no Apps Script que são abertas no Gmail quando a ação é 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 realizada quando o elemento é clicado.
`composedEmailType`	`ComposedEmailType`	Um valor de enumeração que especifica se o rascunho composto é um rascunho autônomo ou de resposta.

Retornar

DecoratedText: este objeto, para encadeamento.

`setEndIcon(endIcon)`

Define o IconImage opcional que é exibido à direita do conteúdo. Um DecoratedText pode ter suporte apenas para 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 alguém clica no objeto. Um objeto de IU 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.

// ...

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 executada quando este 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 URL precisar ser criado ou quando você precisar realizar outras ações além de criar o objeto OpenLink. Um objeto de IU pode ter apenas um dos conjuntos de 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).

// ...

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 o link quando esse elemento é 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á for conhecido e só precisar ser aberto. Um objeto de IU pode ter apenas um dos conjuntos de setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType).

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

Parâmetros

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

Retornar

DecoratedText: este objeto, para encadeamento.

`setSwitchControl(switchToSet)`

Define o Switch que é exibido à direita do conteúdo. Um DecoratedText é compatível apenas com 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. Compatível com formatação HTML básica. Obrigatório.

Parâmetros

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

Retornar

DecoratedText: este objeto, para encadeamento.

`setTopLabel(text)`

Define o texto da etiqueta 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 de valor deve ser exibido em uma única linha ou em várias linhas.

Parâmetros

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

Retornar

DecoratedText: este objeto, para encadeamento.