Class DeputyPageSession

constructor

• new DeputyPageSession(): DeputyPageSession

• Returns DeputyPageSession

ReadonlysessionCloseHandler

toolbar

appendToolbar

• appendToolbar(data): Promise<DeputyPageToolbar>

• Creates the Deputy page toolbar and appends it to the DOM.

  Parameters

  • data: DeputyPageToolbarOptions

    Data for constructing the toolbar

  Returns Promise<DeputyPageToolbar>

close

• close(): void

• Cleanup toolbar, remove event listeners, and remove from DOM.

  Returns void

init

• init(data): void

• Parameters

  • data: DeputyPageStatusResponseMessage

  Returns void

initInterface

• initInterface(data): Promise<void>

• Initialize the interface.

  Parameters

  • data: DeputyPageStatusResponseMessage

  Returns Promise<void>

onSessionClosed

• onSessionClosed(): void

• Handler for when a session is closed.

  Returns void

StaticgetPageDetails

• getPageDetails(revision?, title?, timeout?): Promise<DeputyPageStatusResponseMessage>

• Attempts to grab page details from a session. If a session does not exist, this will return null.

  Parameters

  • revision: number = ...

    The revision of the page to get information for. If the page is being viewed normally (not in a diff or permanent link), then this value should be set to null. This ensures that a generic toolbar is used instead of the revision-specific toolbar.
  • title: Title = window.deputy.currentPage

    The title of the page to get information for. Defaults to current.
  • timeout: number = 500

    Timeout for the page detail request.

  Returns Promise<DeputyPageStatusResponseMessage>