Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IApplicationLifecycleService

API for working with the application lifecycle

Hierarchy

  • IApplicationLifecycleService

Index

Properties

isActivated

isActivated: 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: any[]): boolean
  • Requests that the application become non-interactive

    memberof

    IApplicationLifecycleService

    Parameters

    • Rest ...rest: any[]

    Returns boolean

    True if deactivation was approved adn false if deactivation was unapproved

deactivate

  • deactivate(callback?: function, ...rest: any[]): 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

    • Optional callback: function

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

        • (): void
        • Returns void

    • Rest ...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: any[]): void
  • Requests application deactivation, and (if approved) navigates to specified return url or Relativity Document List

    Parameters

    • Rest ...rest: any[]

    Returns void

    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: string, ...rest: any[]): Promise<boolean>
  • Requests application deactivation, and (if approved) navigates to the url

    Parameters

    • url: string

      URL to navigate to.

    • Rest ...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: any[]): Promise<boolean>
  • Requests application deactivation, and (if approved) returns the user to the Relativity Document List

    Parameters

    • Rest ...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: string): void
  • Sets the Relativity URL to return to when exiting the review interface.

    Parameters

    • url: string

    Returns void