Enumeration: ApplicationLifecycleEventType

Top-level event types raised by IReviewInterfaceApi

Enumeration Members

Activated

Activated: "activated"

Event raised when the application has been activated and the user can interact with it.

ApiReady

ApiReady: "apiready"

Event raised when the public IReviewInterfaceApi is available for use.

This event is raised during application startup, before the ApplicationLifecycleEventType.Ready event is raised.

CanDeactivate

CanDeactivate: "candeactivate"

Event raised when the application is about to be deactivated.

You can listen to this event to prevent the application from being deactivated. Returning a string from your event handler will prevent application deactivation. Any other return value will allow application deactivation. Note: This event does not guarantee that the ApplicationLifecycleEventType.Deactivated event will be raised.

CanTeardown

CanTeardown: "canteardown"

Event raised when the application is about to be torn down.

You can listen to this event to prevent the application from being torn down. Returning a string from your event handler will prevent application teardown. Any other return value will allow application teardown to occur. Note: This event does not guarantee that the ApplicationLifecycleEventType.Teardown event will be raised.

Deactivated

Deactivated: "deactivated"

Event raised when the application has been deactivated and the user can no longer interact with the application.

Note: The application is still running in the background.

Ready

Ready: "ready"

Event raised when the IViewerService.mainCollection has been bootstrapped and the first document has been loaded into the active IViewerCardInstance.

At this point the active IViewerCardInstance's API can be used and an IQueueItem is being shown to the user. Note: If a navigation is requested before the initial queue item is loaded, this event will be raised before an item is shown to the user.

Teardown

Teardown: "teardown"

Event raised when the application is being torn down.

This event indicates that the application is being stopped. You may perform synchronous HTTP calls in your event handlers to support saving any changes that need to be persisted. Note: Event hander capabilities here are limited by browser restrictions. The behavior that is allowed in your event handlers for this event may change in the future, if web browsers change those restrictions.