Um Image
com uma imagem exibida.
Disponível para os apps do Google Workspace Add-ons e do Google Chat.
const imageButton = CardService.newImageButton() .setAltText('An image button with an airplane icon.') .setIcon(CardService.Icon.AIRPLANE) .setOpenLink(CardService.newOpenLink().setUrl('https://airplane.com'));
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
set | Image | Define o texto alternativo do botão para acessibilidade. |
set | Image | Define uma ação de autorização que abre um URL para o fluxo de autorização quando o objeto é clicado. |
set | Image | Define uma ação que compõe um e-mail de rascunho quando o objeto é clicado. |
set | Image | Define um Icon predefinido para exibição no botão. |
set | Image | Define o URL de uma imagem a ser usada como ícone do botão. |
set | Image | Define o estilo do botão. |
set | Image | Define o ícone do Material Design. |
set | Image | Define uma ação que é executada quando o objeto é clicado. |
set | Image | Define uma ação que abre um URL em uma guia quando o objeto é clicado. |
set | Image | Define um URL para ser aberto quando o objeto é clicado. |
set | Image | Define um menu pop-up para ser aberto quando o objeto é clicado. |
Documentação detalhada
set Alt Text(altText)
Define o texto alternativo do botão para acessibilidade. Obrigatório.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
alt | String | O texto alternativo a ser atribuído a este botão. |
Retornar
Image
: este objeto, para encadeamento.
set Authorization Action(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
Image
: este objeto, para encadeamento.
set Compose Action(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
Image
: este objeto, para encadeamento.
set Icon(icon)
Define um Icon
predefinido para exibição no botão. É necessário usar esse valor ou set
para definir a imagem do botão.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
icon | Icon | Um dos valores predefinidos de Icon . |
Retornar
Image
: este objeto, para encadeamento.
set Icon Url(url)
Define o URL de uma imagem a ser usada como ícone do botão. É necessário usar este ou set
para definir a imagem do botão.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
url | String | O endereço URL de uma imagem hospedada para usar como ícone do botão. |
Retornar
Image
: este objeto, para encadeamento.
set Image Button Style(imageButtonStyle)
Define o estilo do botão. Se não for definido, o padrão será o botão Image
.
Disponível apenas para apps do Google Chat. Não disponível para complementos do Google Workspace.
const imageButton = CardService.newImageButton().setImageButtonStyle( CardService.ImageButtonStyle.BORDERLESS, );
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
image | Image | O estilo do botão. |
Retornar
Image
: este objeto, para encadeamento.
set Material Icon(icon)
Define o ícone do Material Design.
const imageButton = CardService.newImageButton().setMaterialIcon( CardService.newMaterialIcon().setName('search'), );
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
icon | Material | O ícone do Material Design. |
Retornar
Image
: este objeto, para encadeamento.
set On Click Action(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
Image
: este objeto, para encadeamento.
set On Click Open Link Action(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
Image
: este objeto, para encadeamento.
set Open Link(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
Nome | Tipo | Descrição |
---|---|---|
open | Open | Um objeto Open que descreve o URL a ser aberto. |
Retornar
Image
: este objeto, para encadeamento.
set Overflow Menu(menu)
Define um menu pop-up para ser aberto quando o objeto é clicado. Cada item do menu pode especificar uma ação a ser acionada quando clicado. Menus aninhados não são aceitos. As ações para itens de menu não podem especificar um menu flutuante.
Disponível apenas para apps do Google Chat. Não disponível para complementos do Google Workspace.
const overflowMenuItem = CardService.newOverflowMenuItem() .setStartIcon( CardService.newIconImage().setIconUrl( 'https://www.google.com/images/branding/googleg/1x/googleg_standard_color_64dp.png', ), ) .setText('Open Link') .setOpenLink( CardService.newOpenLink().setUrl('https://www.google.com')); const overflowMenu = CardService.newOverflowMenu().addMenuItem(overflowMenuItem).build();
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
menu | Overflow | O objeto que especifica o menu flutuante a ser mostrado quando esse elemento é clicado. |
Retornar
Image
: este objeto, para encadeamento.