Esta página foi traduzida pela API Cloud Translation.

Class ImageButton

Um ImageButton com uma imagem.

Disponível para complementos do Google Workspace e 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 para 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 para acessibilidade. Obrigatório.

Parâmetros

Nome	Tipo	Descrição
`altText`	`String`	O texto alternativo a atribuir a este botão.

Retorno

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 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

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 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).

Observação: esse método não define uma ação de composição usada para estender a interface do Compose. Em vez disso, esse método conecta esse elemento da interface a uma Action que compõe mensagens de rascunho no Apps Script que são abertas no Gmail quando a ação é 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 realizada quando esse elemento é clicado.
`composedEmailType`	`ComposedEmailType`	Um valor de enumeração que especifica se o rascunho composto é independente ou de resposta.

Retorno

ImageButton: este objeto para encadeamento.

`setIcon(icon)`

Define um Icon predefinido para exibição no botão. Use esse ou setIconUrl(url) para definir a imagem do botão.

Parâmetros

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

Retorno

ImageButton: este objeto para encadeamento.

`setIconUrl(url)`

Define o URL de uma imagem a ser usada como o ícone desse botão. Use esse ou setIcon(icon) para definir a imagem do botão.

Parâmetros

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

Retorno

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 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

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 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

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á 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

ImageButton: este objeto para encadeamento.