Uma TextButton
com uma etiqueta de texto. Você pode definir a cor do plano de fundo e desativar o botão
quando necessário.
var textButton = CardService.newTextButton() .setText("Open Link") .setOpenLink(CardService.newOpenLink() .setUrl("https://www.google.com"));
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
setAltText(altText) | TextButton | Define o texto alternativo do botão para acessibilidade. |
setAuthorizationAction(action) | TextButton | Define uma ação de autorização que abre um URL para o fluxo de autorização quando o objeto é clicado. |
setBackgroundColor(backgroundColor) | TextButton | Define a cor do plano de fundo do botão TextButtonStyle.FILLED . |
setComposeAction(action, composedEmailType) | TextButton | Define uma ação que compõe um rascunho de e-mail quando o objeto é clicado. |
setDisabled(disabled) | TextButton | Define se o botão será desativado. |
setOnClickAction(action) | TextButton | Define uma ação que é executada quando o objeto é clicado. |
setOnClickOpenLinkAction(action) | TextButton | Define uma ação que abre um URL em uma guia quando o objeto é clicado. |
setOpenLink(openLink) | TextButton | Define um URL a ser aberto quando o objeto for clicado. |
setText(text) | TextButton | Define o texto mostrado no botão. |
setTextButtonStyle(textButtonStyle) | TextButton | Define o estilo do botão. |
Documentação detalhada
setAltText(altText)
Define o texto alternativo do botão para acessibilidade. Se ela não for definida, o padrão será o texto exibido no botão.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
altText | String | O texto alternativo a atribuir a este botão. |
Retorno
TextButton
: esse objeto para encadeamento.
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 retorna ao aplicativo, o complemento é recarregado.
Um objeto de interface só pode ter setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
ou setComposeAction(action, composedEmailType)
definido.
// ... 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
TextButton
: esse objeto para encadeamento.
setBackgroundColor(backgroundColor)
Define a cor do plano de fundo do botão TextButtonStyle.FILLED
. Se não for definido para um botão TextButtonStyle.FILLED
, ele usará a cor secundária definida no manifesto do complemento.
Esse método é um ambiente autônomo para botões TextButtonStyle.TEXT
.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
backgroundColor | String | A cor no formato #rgb. |
Retorno
TextButton
: esse 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 itens 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)
.
// ... 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 é clicado. |
composedEmailType | ComposedEmailType | Um valor de enumeração que especifica se o rascunho composto é um rascunho autônomo ou de resposta. |
Retorno
TextButton
: esse objeto para encadeamento.
setDisabled(disabled)
Define se o botão será desativado. Um botão desativado está esmaecido e não pode ser clicado.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
disabled | Boolean | O estado desativado. |
Retorno
TextButton
: esse objeto para encadeamento.
setOnClickAction(action)
Define uma ação que é executada quando o objeto é clicado. Um objeto da interface só pode ter um dos
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
TextButton
: esse 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 itens 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
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 realizada quando esse elemento é clicado. |
Retorno
TextButton
: esse objeto para encadeamento.
setOpenLink(openLink)
Define um URL a 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
TextButton
: esse objeto para encadeamento.
setText(text)
Define o texto mostrado no botão.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
text | String | O texto que aparece no botão. |
Retorno
TextButton
: esse objeto para encadeamento.
setTextButtonStyle(textButtonStyle)
Define o estilo do botão. Se não for definido, o padrão será o botão TextButtonStyle.TEXT
.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
textButtonStyle | TextButtonStyle | Estilo do botão. |
Retorno
TextButton
: esse objeto para encadeamento.