Interface DeputyPageToolbarOptions

interface DeputyPageToolbarOptions {
    caseId: number;
    caseTitle: string;
    enabledStatuses: ContributionSurveyRowStatus[];
    forceRevision?: boolean;
    nextRevision: number | false;
    revision?: number;
    revisionStatus?: boolean;
    rowType: "detailed" | "pageonly";
    status: ContributionSurveyRowStatus;
    title: string;
}

Hierarchy

Properties

caseId caseTitle enabledStatuses forceRevision? nextRevision revision? revisionStatus? rowType status title

Properties

caseId

caseId: number

The ID of this case.

caseTitle

caseTitle: string

The title of the case. This can be used later to build a DeputyCase.

enabledStatuses

enabledStatuses: ContributionSurveyRowStatus[]

A list of the enabled statuses for this page on the case page.

OptionalforceRevision

forceRevision?: boolean

Whether to force showing the "revision" section even without a revision. This is used post-render, when the toolbar is already in the DOM, and the use switches away to a different diff that is not in the scope of the page. Tools will be accessible, but the revision completion checkbox will not be shown.

nextRevision

nextRevision: number | false

The first unassessed revision of the page. Returns false if all revisions for the page have been assessed.

Optionalrevision

revision?: number

The revision to use. Helpful when overriding the revision being previewed, such as when the revision that the case targets is on the left side of the page.

OptionalrevisionStatus

revisionStatus?: boolean

The status of the revision on the case page. Only enabled if the revision parameter was supplied in the request.

rowType

rowType: "detailed" | "pageonly"
  • detailed refers to a row with both page and revision information.
  • pageonly refers to a row with only a page and no revision information.

status

status: ContributionSurveyRowStatus

The currently-selected status of this page on the case page.

title

title: string

The title of the page requested. This is used in situations where the page title is different from the title in the row (such as in moved or histmerged pages).

Settings

Member Visibility

On This Page

Properties