Class OverflowMenuItem

OverflowMenuItem

Um OverflowMenuItem com um ícone e um rótulo de texto. Você pode desativar o item de menu quando preciso.

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'));

Métodos

Método	Tipo de retorno	Breve descrição
setAuthorizationAction(action)	OverflowMenuItem	Define uma ação de autorização que abre um URL para o fluxo de autorização quando o objeto é clicado.
setComposeAction(action, composedEmailType)	OverflowMenuItem	Define uma ação que compõe um e-mail de rascunho quando o objeto é clicado.
setDisabled(disabled)	OverflowMenuItem	Define se o item de menu está desativado.
setOnClickAction(action)	OverflowMenuItem	Define uma ação que é executada quando o objeto é clicado.
setOnClickOpenLinkAction(action)	OverflowMenuItem	Define uma ação que abre um URL em uma guia quando o objeto é clicado.
setOpenLink(openLink)	OverflowMenuItem	Define um URL para ser aberto quando o objeto é clicado.
setStartIcon(icon)	OverflowMenuItem	Define o ícone principal do item de menu.
setText(text)	OverflowMenuItem	Define o título do item de menu.

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 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: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType).

// ...

const 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 este elemento for clicado.

Retornar

OverflowMenuItem: este objeto, para encadeamento.

---

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

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

// ...

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.
composedEmailType	ComposedEmailType	Um valor de tipo enumerado que especifica se o rascunho composto é independente ou de resposta.

Retornar

OverflowMenuItem: este objeto, para encadeamento.

---

setDisabled(disabled)

Define se o item de menu está desativado. Um item desativado fica esmaecido e não pode ser clicado.

Parâmetros

Nome	Tipo	Descrição
disabled	Boolean	O estado desativado.

Retornar

OverflowMenuItem: este objeto, para encadeamento.

---

setOnClickAction(action)

Define uma ação que é executada quando o objeto é clicado. Um objeto de interface só pode ter um dos 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.

// ...

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

OverflowMenuItem: 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 de criar o objeto OpenLink. Um objeto de interface só pode ter um dos seguintes valores 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 configurado usando ActionResponseBuilder.setOpenLink(openLink).

// ...

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

OverflowMenuItem: este objeto, para encadeamento.

---

setOpenLink(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 setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType) definidos.

Parâmetros

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

Retornar

OverflowMenuItem: este objeto, para encadeamento.

---

setStartIcon(icon)

Define o ícone principal do item de menu.

Parâmetros

Nome	Tipo	Descrição
icon	IconImage	O ícone a ser mostrado.

Retornar

OverflowMenuItem: este objeto, para encadeamento.

---

setText(text)

Define o título do item de menu. Obrigatório.

Parâmetros

Nome	Tipo	Descrição
text	String	O texto a ser exibido.

Retornar

OverflowMenuItem: este objeto, para encadeamento.