Class DeputyRootSession

constructor

• new DeputyRootSession(session, casePage): DeputyRootSession

• Parameters

  • session: SessionInformation
  • casePage: DeputyCasePage

  Returns DeputyRootSession

casePage

parser

sections

session

ReadonlysessionRequestResponder

ReadonlysessionStopResponder

activateSection

• activateSection(casePage, heading): Promise<boolean>

• Activates a section. This appends the section UI, adds the section to the cache (if not already added), and internally stores the section for a graceful exit.

  Parameters

  • casePage: DeputyCasePage
  • heading: HTMLHeadingElement

  Returns Promise<boolean>

  true if the section was activated successfully

addSectionOverlay

• addSectionOverlay(casePage, heading): void

• Adds the "start working on this section" or "reload page" overlay and button to a given section.

  Parameters

  • casePage: DeputyCasePage
  • heading: HTMLHeadingElement

  Returns void

closeSection

• closeSection(e0, e1): Promise<void>

• Closes a section. This removes the section from both the session data and from the case page cache.

  Parameters

  • e0: DeputyCasePage
  • e1: HTMLHeadingElement

  Returns Promise<void>
• closeSection(e0): Promise<void>

• Closes a section. This removes the section from both the session data and from the case page cache.

  Parameters

  • e0: DeputyContributionSurveySection

  Returns Promise<void>

closeSession

• closeSession(): Promise<void>

• Closes the current session.

  Returns Promise<void>

closeSessionUI

• closeSessionUI(): void

• Closes all active session-related UI components. Done prior to closing a section or reloading the interface.

  Returns void

handleStopRequest

• handleStopRequest(event): Promise<void>

• Handles a session stop request.

  Parameters

  • event: DeputyMessageEvent<DeputySessionStopMessage>

  Returns Promise<void>

initSessionInterface

• initSessionInterface(): Promise<void>

• Initialize interface components for an active session. This will always run in the context of a CCI case page.

  Returns Promise<void>

restartSession

• restartSession(): Promise<void>

• Restarts the section. This rebuilds everything from the ground up, which may be required when there's an edit conflict.

  Returns Promise<void>

sendSessionResponse

• sendSessionResponse(event): void

• Responds to session requests through the Deputy communicator. This prevents two tabs from having the same session opened.

  Parameters

  • event: DeputyMessageEvent<DeputySessionRequestMessage>

  Returns void

StaticcontinueSession

• continueSession(casePage, sectionIds?): Promise<void>

• Continue a session from a DeputyCasePage.

  Parameters

  • casePage: DeputyCasePage

    The case page to continue with
  • OptionalsectionIds: string[]

    The section IDs to load on startup. If not provided, this will be taken from the cache. If provided, this overrides the cache, discarding any sections cached previously.

  Returns Promise<void>

StaticfindFirstLastActiveSection

• findFirstLastActiveSection(casePage): HTMLHeadingElement

• Finds the first last active section that exists on the page. If a last active section that still exists on the page could not be found, null is returned.

  Parameters

  • casePage: DeputyCasePage

    The case page to use

  Returns HTMLHeadingElement

  The last active session's heading element.

StaticinitContinueInterface

• initContinueInterface(casePage): Promise<void>

• Shows the interface for continuing a previous session. This includes the [continue CCI session] notice at the top of each CCI page section heading and a single message box showing when the page was last worked on top of the first CCI heading found.

  Parameters

  • casePage: DeputyCasePage

    The case page to continue with

  Returns Promise<void>

StaticinitEntryInterface

• initEntryInterface(_casePage?): Promise<void>

• Initialize interface components for starting a session. This includes the [start CCI session] notice at the top of each CCI page section heading.

  Parameters

  • Optional_casePage: DeputyCasePage

    The current case page

  Returns Promise<void>

StaticinitOverwriteMessage

• initOverwriteMessage(casePage): Promise<void>

• Shows the interface for overwriting an existing session. The provided action button will close the other section. This does not start a new session; the user must start the session on this page on their own.

  Parameters

  • casePage: DeputyCasePage

    The case page to continue with

  Returns Promise<void>

StaticinitTabActiveInterface

• initTabActiveInterface(_casePage?): Promise<void>

• Shows the interface for an attempted Deputy execution on a different tab than expected. This prevents Deputy from running entirely to avoid loss of progress and desynchronization.

  Parameters

  • Optional_casePage: DeputyCasePage

    The current case page (not the active one)

  Returns Promise<void>

StaticsetSession

• setSession(session): Promise<SessionInformation>

• Sets the current active session information.

  Parameters

  • session: SessionInformation

    The session to save.

  Returns Promise<SessionInformation>

  SessionInformation object if successful, null if not.

StaticstartSession

• startSession(section, _casePage?): Promise<void>

• Starts a Deputy session.

  Parameters

  • section: ArrayOrNot<HTMLHeadingElement>
  • Optional_casePage: DeputyCasePage

  Returns Promise<void>