Class DeputyCasePage

document

lastActive

lastActiveSections

nCache

pageId

parsoid

title

wikitext

addActiveSection

• addActiveSection(sectionId): Promise<void>

• Add a section to the list of active sessions. This is used for automatic starting and for one-click continuation of past active sessions.

  Parameters

  • sectionId: string

    The ID of the section to add.

  Returns Promise<void>

bumpActive

• bumpActive(): Promise<void>

• Bumps this page's last active timestamp.

  Returns Promise<void>

deleteFromCache

• deleteFromCache(): Promise<void>

• Deletes the current page from the cache. This is generally not advised, unless the user wishes to forget the case page entirely.

  Returns Promise<void>

findContributionSurveyHeading

• findContributionSurveyHeading(sectionIdentifier, useId?): HTMLHeadingElement

• Find a contribution survey heading by section name.

  Parameters

  • sectionIdentifier: string

    The section identifier to look for, usually the section name unless useId is set to true.
  • useId: boolean = false

    Whether to use the section name instead of the ID

  Returns HTMLHeadingElement

  The <h*> element of the heading.

findContributionSurveyHeadings

• findContributionSurveyHeadings(): HTMLHeadingElement[]

• Finds all contribution survey headings. These are <h*> elements with the content matching the pattern "Pages \d+ to \d+"

  Returns HTMLHeadingElement[]

  The <h*> element of the heading.

findFirstContributionSurveyHeadingElement

• findFirstContributionSurveyHeadingElement(): HTMLHeadingElement

• Finds the first contribution survey heading. This is always an <h*> element with the content matching the pattern "Pages \d+ to \d+"

  Returns HTMLHeadingElement

  The <h*> element of the heading.

getContributionSurveySection

• getContributionSurveySection(sectionHeading): Node[]

• Gets all elements that are part of a contribution survey "section", that is a set of elements including the section heading and all elements succeeding the heading until (and exclusive of) the heading of the next section.

  In other words, YES: === Pages 1 to 2 === YES: * [[Page 1]] YES: * [[Page 2]] YES: NO : === Pages 3 to 4 ===

  Parameters

  • sectionHeading: HTMLElement

    The section heading to work with

  Returns Node[]

  An array of all HTMLElements covered by the section

isCached

• isCached(): Promise<boolean>

• Check if this page is cached.

  Returns Promise<boolean>

isContributionSurveyHeading

• isContributionSurveyHeading(el): el is HTMLHeadingElement

• Checks if a given element is a valid contribution survey heading.

  Parameters

  • el: Node

    The element to check for

  Returns el is HTMLHeadingElement

  true if the given heading is a valid contribution survey heading.

removeActiveSection

• removeActiveSection(sectionId): Promise<void>

• Remove a section from the list of active sections. This will disable autostart for this section.

  Parameters

  • sectionId: string

    ID of the section to remove

  Returns Promise<void>

saveToCache

• saveToCache(): Promise<void>

• Saves the current page to the IDB page cache.

  Returns Promise<void>

Staticbuild

• build(pageId?, title?, document?, parsoid?): Promise<DeputyCasePage>

• Parameters

  • OptionalpageId: number

    The page ID of the case page.
  • Optionaltitle: Title

    The title of the page being accessed
  • Optionaldocument: Document

    The document to be used as a reference.
  • Optionalparsoid: boolean

    Whether this is a Parsoid document or not.

  Returns Promise<DeputyCasePage>