Search

Search something to see results

LeavePageHandler

Provides generic handling of data retrieval before users leave the page.

Index

Constructors

Types.LeavePageHandler.constructor

Methods

Types.LeavePageHandler.communicateUnloadFlagTypes.LeavePageHandler.executeRemainingCallbacksTypes.LeavePageHandler.initTypes.LeavePageHandler.isUnloadedTypes.LeavePageHandler.onLeavePageTypes.LeavePageHandler.registerUnloadCommunicationTypes.LeavePageHandler.triggerLeavePage

Constructors

new LeavePageHandler(): LeavePageHandler

Returns LeavePageHandler

Methods

communicateUnloadFlag(value: boolean): void

Triggers communication of unload phase to the service worker if the value has changed.

Parameters

  • value: boolean

Returns void

executeRemainingCallbacks(unloadType: UnloadType): void

Executes the remaining callbacks.

Parameters

Returns void

init(): void

Initialises all event listeners related to the user leaving the current page.

Returns void

isUnloaded(): boolean

Indicates whether the current page was unloaded because the user left.

Returns boolean

onLeavePage(callback: Function): void

A trigger function to execute a callback when the user leaves the page.

Parameters

Returns void

registerUnloadCommunication(): void

Registers the different unload event listeners in the capture phase to early communicate the unload flag to the service worker via POST message.

Returns void

triggerLeavePage(unloadType: UnloadType): void

Checks whether remaining data is available to send out before the user leaves.

Parameters

Returns void