Interface: IApplicationLifecycleService

API for working with the application lifecycle

Properties

isActivated

readonlyisActivated: boolean

Indicates whether or not the application has been activated

Methods

activate()

activate(): Promise<void>

Notifies the application and extensions that the Review Interface application has become user-interactive.

This will raise the ReviewInterfaceEventType.Activated event.

Returns

Promise<void>

---

canDeactivate()

canDeactivate(...rest): boolean

Requests that the application become non-interactive

Parameters

• ...rest: any[]

Returns

boolean

True if deactivation was approved and false if deactivation was unapproved IApplicationLifecycleService

---

deactivate()

deactivate(callback?, ...rest?): Promise<boolean>

Invokes the provided callback and then notifies the application and extensions that deactivation occurred.

This will raise the ReviewInterfaceEventType.CanDeactivate and ReviewInterfaceEventType.Deactivated events.

Parameters

• callback?

Optional callback to be invoked after deactivation approval and before the application is deactivated

• ...rest?: any[]

Returns

Promise<boolean>

Promise that resolves to true if the deactivation was approved and false if deactivation was un-approved

---

exitReviewInterface()

exitReviewInterface(...rest): Promise<boolean>

Requests application deactivation, and (if approved) navigates to specified return url or Relativity Document List

Parameters

• ...rest: any[]

Returns

Promise<boolean>

Promise that resolves to true if the user was returned to the Relativity Document List and false if deactivation was un-approved

---

exitToRelativityUrl()

exitToRelativityUrl(url, ...rest): Promise<boolean>

Requests application deactivation, and (if approved) navigates to the url

Parameters

• url: string

URL to navigate to.

• ...rest: any[]

Returns

Promise<boolean>

Promise that resolves to true if the user was returned to the Relativity Document List and false if deactivation was un-approved

---

returnToDocumentList()

returnToDocumentList(...rest): Promise<boolean>

Requests application deactivation, and (if approved) returns the user to the Relativity Document List

Parameters

• ...rest: any[]

Returns

Promise<boolean>

Promise that resolves to true if the user was returned to the Relativity Document List and false if deactivation was un-approved

---

setExitViewerLocation()

setExitViewerLocation(url): void

Sets the Relativity URL to return to when exiting the review interface.

Parameters

• url: string

Returns

void