Class OpenLink

OpenLink

Stellt eine Aktion zum Öffnen eines Links mit einigen Optionen dar.

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

Hinweis: Wenn Sie Add-ons nach dem Schließen eines Links aktualisieren möchten, verwenden Sie keinen Link mit aktiviertem COOP-Header (Cross-Origin-Opener-Policy). Wenn COOP in einem Link aktiviert ist, können Add-ons den Fensterstatus nicht erkennen und die Add-on-Karte wird nicht aktualisiert.

Methoden

MethodeRückgabetypKurzbeschreibung
setOnClose(onClose)OpenLinkLegt das Verhalten der URL-Aktion fest, wenn das URL-Fenster oder der Tab geschlossen wird.
setOpenAs(openAs)OpenLinkHiermit wird das Verhalten der URL beim Öffnen festgelegt.
setUrl(url)OpenLinkLegt die URL fest, die geöffnet werden soll.

Detaillierte Dokumentation

setOnClose(onClose)

Legt das Verhalten der URL-Aktion fest, wenn das URL-Fenster oder der Tab geschlossen wird.

Parameter

NameTypBeschreibung
onCloseOnCloseDie Einstellung zum Schließen

Rückflug

OpenLink: dieses Objekt für die Verkettung.


setOpenAs(openAs)

Hiermit wird das Verhalten der URL beim Öffnen festgelegt.

Parameter

NameTypBeschreibung
openAsOpenAsDie Öffnungseinstellung.

Rückflug

OpenLink: dieses Objekt für die Verkettung.


setUrl(url)

Legt die URL fest, die geöffnet werden soll. Die URL muss mit einem Präfix übereinstimmen, das im Manifest auf die Zulassungsliste gesetzt wurde.

Parameter

NameTypBeschreibung
urlStringDie URL, die geöffnet werden soll.

Rückflug

OpenLink: dieses Objekt für die Verkettung.