Obsoleto. Essa classe foi descontinuada e não deve ser usada em novos scripts.
Esta classe foi descontinuada. Em vez disso, use Decorated
.
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
set |
| Define uma ação de autorização que abre um URL para o fluxo de autorização quando o objeto é clicado. |
set |
| Define uma ação que compõe um e-mail de rascunho quando o objeto é clicado. |
set |
| Define uma ação que é executada quando o objeto é clicado. |
set |
| Define uma ação que abre um URL em uma guia quando o objeto é clicado. |
set |
| Define um URL para ser aberto quando o objeto é clicado. |
Métodos obsoletos
Método | Tipo de retorno | Breve descrição |
---|---|---|
|
| Define o texto do rótulo a ser usado como chave. |
|
| Define o Button que aparece à direita do contexto. |
|
| Define o texto a ser usado como valor. |
|
| Define o ícone a ser usado como chave. |
|
| Define o texto alternativo do ícone. |
|
| Define o URL do ícone a ser usado como chave. |
|
| Define se o texto do valor deve ser mostrado em uma ou várias linhas. |
|
| Define o Switch que aparece à direita do conteúdo. |
|
| 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: 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 este elemento for clicado. |
Retornar
: este objeto, para encadeamento.Key
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 set
, set
, set
,
set
ou set
definidos.
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 este elemento é clicado. |
composed | Composed | Um valor de tipo enumerado que especifica se o rascunho composto é independente ou de resposta. |
Retornar
: este objeto, para encadeamento.Key
setOnClickAction(action)
Define uma ação que é executada quando o objeto é clicado. Um objeto de interface só pode ter um dos
set
, set
, set
, set
ou set
definidos.
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
: este objeto, para encadeamento.Key
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 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 for clicado. |
Retornar
: este objeto, para encadeamento.Key
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 set
,
set
, set
, set
ou set
definidos.
Parâmetros
Retornar
: este objeto, para encadeamento.Key
Métodos obsoletos
setBottomLabel(text)
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
: este objeto, para encadeamento.Key
setButton(button)
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
só pode
ter um botão, um interruptor ou um ícone.Key
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
button | Button | O botão para adicionar. |
Retornar
: este objeto, para encadeamento.Key
setContent(text)
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
: este objeto, para encadeamento.Key
setIcon(icon)
setIcon(icon)
setIconAltText(altText)
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 |
---|---|---|
alt | String | O texto alternativo do ícone. |
Retornar
: este objeto, para encadeamento.Key
setIconUrl(url)
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
: este objeto, para encadeamento.Key
setMultiline(multiline)
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
: este objeto, para encadeamento.Key
setSwitch(switchToSet)
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
só pode
ter um botão, um interruptor ou um ícone.Key
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
switch | Switch | O interruptor a ser adicionado. |
Retornar
: este objeto, para encadeamento.Key
setTopLabel(text)
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
: este objeto, para encadeamento.Key