Enum OnClose
OnClose
An enum that specifies what to do when a URL opened through an OpenLink
is closed.
When a link is opened, the client either forgets about it or waits until the window is closed.
The implementation depends on the client platform capabilities. OnClose
may cause OpenAs
to be ignored; if the client platform cannot support both selected values together,
OnClose
takes precedence.
To call an enum, you call its parent class, name, and property. For example,
CardService.OnClose.RELOAD
.
Properties
Property | Type | Description |
NOTHING | Enum | Do nothing on close. Default. |
RELOAD | Enum | Reloads the add-on on when the window closes.
If OpenAs.OVERLAY is also set, then the main card is blocked until the overlay
window is closed and the add-on has finished reloading.
|
Deprecated properties
Property | Type | Description |
RELOAD_ADD_ON | Enum | Reload the add-on on closing the URL. This action differs from RELOAD in that it does
not block the main card while showing an OpenAs.OVERLAY window. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-12-02 UTC.
[null,null,["Last updated 2024-12-02 UTC."],[[["`OnClose` is an enum used within `OpenLink` to specify an action taken when the opened URL is closed by the user."],["It offers options like `NOTHING` (default) and `RELOAD` to reload the add-on upon closing the URL, with `RELOAD` potentially blocking the main card if used with `OpenAs.OVERLAY`."],["Although previously available, the `RELOAD_ADD_ON` option is now deprecated and should not be used in new developments."]]],[]]