Esta página foi traduzida pela API Cloud Translation.

Class KeyValue

Obsoleto. Essa classe foi descontinuada e não deve ser usada em novos scripts.

Esta classe foi descontinuada. Em vez disso, use DecoratedText.

Métodos

Método	Tipo de retorno	Breve descrição
`setAuthorizationAction(action)`	`KeyValue`	Define uma ação de autorização que abre um URL para o fluxo de autorização quando o objeto é clicado.
`setComposeAction(action, composedEmailType)`	`KeyValue`	Define uma ação que compõe um e-mail de rascunho quando o objeto é clicado.
`setOnClickAction(action)`	`KeyValue`	Define uma ação que é executada quando o objeto é clicado.
`setOnClickOpenLinkAction(action)`	`KeyValue`	Define uma ação que abre um URL em uma guia quando o objeto é clicado.
`setOpenLink(openLink)`	`KeyValue`	Define um URL para ser aberto quando o objeto é clicado.

Métodos obsoletos

Método	Tipo de retorno	Breve descrição
`setBottomLabel(text)`	`KeyValue`	Define o texto do rótulo a ser usado como chave.
`setButton(button)`	`KeyValue`	Define o `Button` que aparece à direita do contexto.
`setContent(text)`	`KeyValue`	Define o texto a ser usado como valor.
`setIcon(icon)`	`KeyValue`	Define o ícone a ser usado como chave.
`setIconAltText(altText)`	`KeyValue`	Define o texto alternativo do ícone.
`setIconUrl(url)`	`KeyValue`	Define o URL do ícone a ser usado como chave.
`setMultiline(multiline)`	`KeyValue`	Define se o texto do valor deve ser mostrado em uma ou várias linhas.
`setSwitch(switchToSet)`	`KeyValue`	Define o `Switch` que aparece à direita do conteúdo.
`setTopLabel(text)`	`KeyValue`	Define o texto do rótulo a ser usado como chave.

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

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

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

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

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

KeyValue: este objeto, para encadeamento.

Métodos obsoletos

`setBottomLabel(text)`

Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

Define o texto do rótulo a ser usado como chave. É exibido abaixo do conteúdo de texto.

Parâmetros

Nome	Tipo	Descrição
`text`	`String`	O texto do rótulo. Observação: ele não oferece suporte à formatação HTML básica.

Retornar

KeyValue: este objeto, para encadeamento.

`setButton(button)`

Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

Define o Button que aparece à direita do contexto. Um KeyValue só pode ter um botão, um interruptor ou um ícone.

Parâmetros

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

Retornar

KeyValue: este objeto, para encadeamento.

`setContent(text)`

Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

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

KeyValue: este objeto, para encadeamento.

`setIcon(icon)`

Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

Define o ícone a ser usado como chave.

Parâmetros

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

Retornar

KeyValue: este objeto, para encadeamento.

`setIconAltText(altText)`

Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

Define o texto alternativo do ícone.

Parâmetros

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

Retornar

KeyValue: este objeto, para encadeamento.

`setIconUrl(url)`

Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

Define o URL do ícone a ser usado como chave.

Parâmetros

Nome	Tipo	Descrição
`url`	`String`	O endereço URL de uma imagem hospedada para usar como ícone.

Retornar

KeyValue: este objeto, para encadeamento.

`setMultiline(multiline)`

Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

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

Parâmetros

Nome	Tipo	Descrição
`multiline`	`Boolean`	A configuração de várias linhas.

Retornar

KeyValue: este objeto, para encadeamento.

`setSwitch(switchToSet)`

Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

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

Parâmetros

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

Retornar

KeyValue: este objeto, para encadeamento.

`setTopLabel(text)`

Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

Define o texto do rótulo a ser usado como chave. É exibido acima do conteúdo de texto.

Parâmetros

Nome	Tipo	Descrição
`text`	`String`	O texto do rótulo. Observação: ele não oferece suporte à formatação HTML básica.

Retornar

KeyValue: este objeto, para encadeamento.