Class OpenLink

OpenLink

Representa uma ação para abrir um link com algumas opções.

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

// A button that opens as a link in an overlay and
// requires a reload when closed.
var button = CardService.newTextButton()
    .setText("This button opens a link in an overlay window")
    .setOpenLink(CardService.newOpenLink()
        .setUrl("https://www.google.com")
        .setOpenAs(CardService.OpenAs.OVERLAY)
        .setOnClose(CardService.OnClose.RELOAD_ADD_ON));

// An action response that opens a link in full screen and
// requires no action when closed.
var actionResponse = CardService.newActionResponseBuilder()
    .setOpenLink(CardService.newOpenLink()
        .setUrl("https://www.google.com")
        .setOpenAs(CardService.OpenAs.FULL_SIZE)
        .setOnClose(CardService.OnClose.NOTHING))
    .build();

Observação:para recarregar complementos depois de fechar um link, não use um link com o cabeçalho Cross-Origin-Opener-Policy (COOP) ativado. Se a COOP estiver ativada em um link, os complementos não poderão detectar o estado da janela, e o cartão de complementos não será atualizado.

Métodos

MétodoTipo de retornoBreve descrição
setOnClose(onClose)OpenLinkDefine o comportamento da ação de URL quando a janela ou guia do URL é fechada.
setOpenAs(openAs)OpenLinkDefine o comportamento do URL quando ele é aberto.
setUrl(url)OpenLinkDefine o URL a ser aberto.

Documentação detalhada

setOnClose(onClose)

Define o comportamento da ação de URL quando a janela ou guia do URL é fechada.

Parâmetros

NomeTipoDescrição
onCloseOnCloseA configuração de fechamento.

Retorno

OpenLink: este objeto para encadeamento.


setOpenAs(openAs)

Define o comportamento do URL quando ele é aberto.

Parâmetros

NomeTipoDescrição
openAsOpenAsA configuração de abertura.

Retorno

OpenLink: este objeto para encadeamento.


setUrl(url)

Define o URL a ser aberto. O URL precisa corresponder a um prefixo colocado na lista de permissões no manifesto.

Parâmetros

NomeTipoDescrição
urlStringO URL a ser aberto.

Retorno

OpenLink: este objeto para encadeamento.