Enum OnClose

  • 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.
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

PropertyTypeDescription
NOTHINGEnumDo nothing on close. Default.
RELOADEnumReloads 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.