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 destas opções: DecoratedText
, DecoratedText
, setTopLabel(text)
ou setBottomLabel(text)
. O objetivo dessa classe é substituir
.
KeyValue
Disponível para complementos do Google Workspace e 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 é mostrado à 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 exibido à 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 os IconImage opcionais que vão ser mostrados antes do conteúdo de texto. |
setSwitchControl(switchToSet) | DecoratedText | Define o Switch que é mostrado à 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 mostrado 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 conclui o fluxo de autorização e retorna ao aplicativo, o complemento é recarregado.
Um objeto de interface só pode ter um dos seguintes valores: 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 realizada quando esse elemento é clicado. |
Retorno
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. |
Retorno
DecoratedText
: este objeto para encadeamento.
setButton(button)
Define o Button
que é mostrado à direita do texto. Um DecoratedText
pode
oferecer suporte a apenas um botão ou uma chave.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
button | Button | O botão a ser adicionado. |
Retorno
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 um dos seguintes valores: 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)
.
// ... 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 esse elemento é clicado. |
composedEmailType | ComposedEmailType | Um valor de enumeração que especifica se o rascunho composto é independente ou de resposta. |
Retorno
DecoratedText
: este objeto para encadeamento.
setEndIcon(endIcon)
Define o IconImage
opcional exibido à 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. |
Retorno
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 destes
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
.
// ... 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. |
Retorno
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 da criação do objeto OpenLink
. Um objeto de interface só pode ter um dos seguintes valores: 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 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 a ser realizada quando esse elemento é clicado. |
Retorno
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 interface só pode ter um dos seguintes valores: 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. |
Retorno
DecoratedText
: este objeto para encadeamento.
setStartIcon(startIcon)
Define os IconImage
opcionais que vão ser mostrados antes do conteúdo de texto.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
startIcon | IconImage | O ícone a ser exibido. |
Retorno
DecoratedText
: este objeto para encadeamento.
setSwitchControl(switchToSet)
Define o Switch
que é mostrado à direita do conteúdo. Uma DecoratedText
só pode ser compatível com um botão ou um interruptor.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
switchToSet | Switch | O interruptor a ser adicionado. |
Retorno
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. |
Retorno
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. |
Retorno
DecoratedText
: este objeto para encadeamento.
setWrapText(wrapText)
Define se o texto do valor deve ser mostrado em uma única linha ou em várias.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
wrapText | Boolean | Se for true , o texto será unido e exibido em várias linhas. Caso contrário,
o texto vai ficar truncado. |
Retorno
DecoratedText
: este objeto para encadeamento.