Class OpenLink

OpenLink.

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

// 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();

Remarque:Pour actualiser les modules complémentaires après avoir fermé un lien, n'utilisez pas de lien lorsque l'en-tête COOP (Cross-Origin-Opener-Policy) est 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 n'est pas mise à jour.

Méthodes

MéthodeType renvoyéBrève description
setOnClose(onClose)OpenLinkDéfinit le comportement de l'action relative aux URL lorsque la fenêtre ou l'onglet d'URL est fermé.
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 relative aux URL lorsque la fenêtre ou l'onglet d'URL est fermé.

Paramètres

NomTypeDescription
onCloseOnCloseParamètre de fermeture.

Aller-retour

OpenLink : cet objet, pour le chaînage.


setOpenAs(openAs)

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

Paramètres

NomTypeDescription
openAsOpenAsParamètre d'ouverture.

Aller-retour

OpenLink : cet objet, pour le chaînage.


setUrl(url)

Définit l'URL à ouvrir. L'URL doit correspondre à un préfixe ajouté à la liste blanche dans le fichier manifeste.

Paramètres

NomTypeDescription
urlStringURL à ouvrir.

Aller-retour

OpenLink : cet objet, pour le chaînage.