Class OpenLink

Ouvrir le lien

Représente une action permettant d'ouvrir un lien avec certaines options.

Disponible pour les modules complémentaires Google Workspace et les applications Google Chat.

// A button that opens as a link in an overlay and
// requires a reload when closed.
const 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.
const actionResponse = CardService.newActionResponseBuilder()
                           .setOpenLink(
                               CardService.newOpenLink()
                                   .setUrl('https://www.google.com')
                                   .setOpenAs(CardService.OpenAs.FULL_SIZE)
                                   .setOnClose(CardService.OnClose.NOTHING),
                               )
                           .build();

Remarque : Pour recharger les modules complémentaires après avoir fermé un lien, n'utilisez pas de lien avec l'en-tête Cross-Origin-Opener-Policy (COOP) activé. Si COOP est activé dans un lien, les modules complémentaires ne peuvent pas détecter l'état de la fenêtre et la fiche du module complémentaire ne se met pas à jour.

Méthodes

MéthodeType renvoyéBrève description
setOnClose(onClose)OpenLinkDéfinit le comportement de l'action d'URL lorsque la fenêtre ou l'onglet de l'URL sont fermés.
setOpenAs(openAs)OpenLinkDéfinit le comportement de l'URL lorsqu'elle est ouverte.
setUrl(url)OpenLinkDéfinit l'URL à ouvrir.

Documentation détaillée

setOnClose(onClose)

Définit le comportement de l'action d'URL lorsque la fenêtre ou l'onglet de l'URL sont fermés.

Paramètres

NomTypeDescription
onCloseOnCloseLe paramètre de clôture.

Renvois

OpenLink : cet objet, pour le chaînage.


setOpenAs(openAs)

Définit le comportement de l'URL lorsqu'elle est ouverte.

Paramètres

NomTypeDescription
openAsOpenAsLe paramètre d'ouverture.

Renvois

OpenLink : cet objet, pour le chaînage.


setUrl(url)

Définit l'URL à ouvrir. L'URL doit correspondre à un préfixe dans la liste d'autorisation du fichier manifeste.

Paramètres

NomTypeDescription
urlStringURL à ouvrir.

Renvois

OpenLink : cet objet, pour le chaînage.