Interface DeputyPageStatusResponseMessage

Response to DeputyPageStatusRequestMessage. Contains the current page status and the revision status (if requested).

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

Properties

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

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.

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

An echo of the requested revision ID. Only enabled if the revision parameter was supplied in the request.

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).

type

type: "pageStatusResponse"

Settings

Member Visibility

On This Page

Properties