Esta página foi traduzida pela API Cloud Translation.

Class ImageButton

Uma ImageButton com uma imagem.

Disponível nos complementos do Google Workspace e nos apps do Google Chat.

var 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
`setAltText(altText)`	`ImageButton`	Define o texto alternativo do botão de acessibilidade.
`setAuthorizationAction(action)`	`ImageButton`	Define uma ação de autorização que abre um URL para o fluxo de autorização quando o objeto é clicado.
`setComposeAction(action, composedEmailType)`	`ImageButton`	Define uma ação que compõe um rascunho de e-mail quando o objeto é clicado.
`setIcon(icon)`	`ImageButton`	Define um `Icon` predefinido para exibição no botão.
`setIconUrl(url)`	`ImageButton`	Define o URL de uma imagem a ser usada como o ícone desse botão.
`setOnClickAction(action)`	`ImageButton`	Define uma ação que é executada quando o objeto é clicado.
`setOnClickOpenLinkAction(action)`	`ImageButton`	Define uma ação que abre um URL em uma guia quando o objeto é clicado.
`setOpenLink(openLink)`	`ImageButton`	Define um URL que será aberto quando o objeto for clicado.

Documentação detalhada

`setAltText(altText)`

Define o texto alternativo do botão de acessibilidade. Obrigatório.

Parâmetros

Nome	Tipo	Descrição
`altText`	`String`	O texto alternativo a ser atribuído a este botão.

Retornar

ImageButton: este 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 retornar ao aplicativo, o complemento será recarregado.

Um objeto da interface só pode ter um conjunto 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 tomada quando esse elemento for clicado.

Retornar

ImageButton: 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 uma destas opções: 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 retorna um objeto ComposeActionResponse configurado usando ComposeActionResponseBuilder.setGmailDraft(draft).

Observação: esse método não define uma ação de composição que seja usada para estender a interface do Compose. Em vez disso, esse método conecta esse elemento de interface a uma Action, que compõe mensagens de rascunho no Apps Script que são: aberto no Gmail quando a ação for concluída.

// ...

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 for clicado.
`composedEmailType`	`ComposedEmailType`	Um valor de enumeração que especifica se o rascunho composto é uma independente ou como rascunho de resposta.

Retornar

ImageButton: este objeto, para encadeamento.

`setIcon(icon)`

Define um Icon predefinido para exibição no botão. Isto ou setIconUrl(url) deve ser usado para definir a imagem do botão.

Parâmetros

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

Retornar

ImageButton: este objeto, para encadeamento.

`setIconUrl(url)`

Define o URL de uma imagem a ser usada como o ícone desse botão. É necessário que este ou setIcon(icon) seja usada para definir a imagem do botão.

Parâmetros

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

Retornar

ImageButton: este objeto, para encadeamento.

`setOnClickAction(action)`

Define uma ação que é executada quando o objeto é clicado. Um objeto de interface só pode ter um Conjunto setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType).

O parâmetro Action precisa especificar uma função de callback que retorna 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.

Retornar

ImageButton: 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 O URL precisa ser criado ou quando você precisa realizar outras ações além da criação do objeto OpenLink. Um objeto da interface só pode ter 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 retorna 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 executada quando esse elemento for clicado.

Retornar

ImageButton: 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á estiver conhecidas e só precisam ser abertas. Um objeto da interface só pode ter setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action) e setAuthorizationAction(action). ou setComposeAction(action, composedEmailType) definido.

Parâmetros

Nome	Tipo	Descrição
`openLink`	`OpenLink`	Um objeto `OpenLink` que descreve o URL a ser aberto.

Retornar

ImageButton: este objeto, para encadeamento.