Kaizen
Browse modulesFormsforms/serverClasses

Class: FormSubmissionVersion

Defined in: server/forms/models.ts:320

Constructors

Constructor

new FormSubmissionVersion(record: {
  changeReason: string | null;
  createdAt: Date;
  createdBy: string | null;
  currentStepKey: string | null;
  data: JsonValue;
  deletedAt: Date | null;
  deletedBy: string | null;
  formSchemaVersionId: string;
  formSubmissionId: string;
  id: string;
  isComplete: boolean;
  lastActivityAt: Date;
  versionNumber: number;
  visitedStepKeys: string[];
}): FormSubmissionVersion;

Defined in: server/forms/models.ts:323

Parameters

ParameterType
record{ changeReason: string | null; createdAt: Date; createdBy: string | null; currentStepKey: string | null; data: JsonValue; deletedAt: Date | null; deletedBy: string | null; formSchemaVersionId: string; formSubmissionId: string; id: string; isComplete: boolean; lastActivityAt: Date; versionNumber: number; visitedStepKeys: string[]; }
record.changeReasonstring | null
record.createdAtDate
record.createdBystring | null
record.currentStepKeystring | null
record.dataJsonValue
record.deletedAtDate | null
record.deletedBystring | null
record.formSchemaVersionIdstring
record.formSubmissionIdstring
record.idstring
record.isCompleteboolean
record.lastActivityAtDate
record.versionNumbernumber
record.visitedStepKeysstring[]

Returns

FormSubmissionVersion

Properties

record

readonly record: {
  changeReason: string | null;
  createdAt: Date;
  createdBy: string | null;
  currentStepKey: string | null;
  data: JsonValue;
  deletedAt: Date | null;
  deletedBy: string | null;
  formSchemaVersionId: string;
  formSubmissionId: string;
  id: string;
  isComplete: boolean;
  lastActivityAt: Date;
  versionNumber: number;
  visitedStepKeys: string[];
};

Defined in: server/forms/models.ts:321

changeReason

changeReason: string | null;

createdAt

createdAt: Date;

createdBy

createdBy: string | null;

currentStepKey

currentStepKey: string | null;

data

data: JsonValue;

deletedAt

deletedAt: Date | null;

deletedBy

deletedBy: string | null;

formSchemaVersionId

formSchemaVersionId: string;

formSubmissionId

formSubmissionId: string;

id

id: string;

isComplete

isComplete: boolean;

lastActivityAt

lastActivityAt: Date;

versionNumber

versionNumber: number;

visitedStepKeys

visitedStepKeys: string[];

Accessors

changeReason

Get Signature

get changeReason(): string | null;

Defined in: server/forms/models.ts:377

Returns

string | null


createdAt

Get Signature

get createdAt(): Date;

Defined in: server/forms/models.ts:381

Returns

Date


createdBy

Get Signature

get createdBy(): string | null;

Defined in: server/forms/models.ts:385

Returns

string | null


currentStepKey

Get Signature

get currentStepKey(): string | null;

Defined in: server/forms/models.ts:361

The step the user is currently on. null once isComplete is true, and null for single-page (non-multi-step) submissions.

Returns

string | null


data

Get Signature

get data(): FormDataRecord;

Defined in: server/forms/models.ts:343

Returns

FormDataRecord


formSchemaVersionId

Get Signature

get formSchemaVersionId(): string;

Defined in: server/forms/models.ts:339

Returns

string


formSubmissionId

Get Signature

get formSubmissionId(): string;

Defined in: server/forms/models.ts:331

Returns

string


id

Get Signature

get id(): string;

Defined in: server/forms/models.ts:327

Returns

string


isComplete

Get Signature

get isComplete(): boolean;

Defined in: server/forms/models.ts:369

true once the submission has been finalized through submitDraft or finalizeSinglePage. Draft rows have isComplete: false.

Returns

boolean


lastActivityAt

Get Signature

get lastActivityAt(): Date;

Defined in: server/forms/models.ts:373

Returns

Date


versionNumber

Get Signature

get versionNumber(): number;

Defined in: server/forms/models.ts:335

Returns

number


visitedStepKeys

Get Signature

get visitedStepKeys(): string[];

Defined in: server/forms/models.ts:353

Step keys the user has navigated through, in order. Empty for single-page submissions. Drift-protected: advanceStep only appends a key the first time it's visited; back-then-forward navigation doesn't pile up duplicates.

Returns

string[]

Methods

toJSON()

toJSON(): {
  changeReason: string | null;
  createdAt: Date;
  createdBy: string | null;
  currentStepKey: string | null;
  data: FormDataRecord;
  formSchemaVersionId: string;
  formSubmissionId: string;
  id: string;
  isComplete: boolean;
  lastActivityAt: Date;
  versionNumber: number;
  visitedStepKeys: string[];
};

Defined in: server/forms/models.ts:393

Returns

{
  changeReason: string | null;
  createdAt: Date;
  createdBy: string | null;
  currentStepKey: string | null;
  data: FormDataRecord;
  formSchemaVersionId: string;
  formSubmissionId: string;
  id: string;
  isComplete: boolean;
  lastActivityAt: Date;
  versionNumber: number;
  visitedStepKeys: string[];
}
changeReason
changeReason: string | null;
createdAt
createdAt: Date;
createdBy
createdBy: string | null;
currentStepKey
currentStepKey: string | null;
data
data: FormDataRecord;
formSchemaVersionId
formSchemaVersionId: string;
formSubmissionId
formSubmissionId: string;
id
id: string;
isComplete
isComplete: boolean;
lastActivityAt
lastActivityAt: Date;
versionNumber
versionNumber: number;
visitedStepKeys
visitedStepKeys: string[];

toRaw()

toRaw(): {
  changeReason: string | null;
  createdAt: Date;
  createdBy: string | null;
  currentStepKey: string | null;
  data: JsonValue;
  deletedAt: Date | null;
  deletedBy: string | null;
  formSchemaVersionId: string;
  formSubmissionId: string;
  id: string;
  isComplete: boolean;
  lastActivityAt: Date;
  versionNumber: number;
  visitedStepKeys: string[];
};

Defined in: server/forms/models.ts:389

Returns

{
  changeReason: string | null;
  createdAt: Date;
  createdBy: string | null;
  currentStepKey: string | null;
  data: JsonValue;
  deletedAt: Date | null;
  deletedBy: string | null;
  formSchemaVersionId: string;
  formSubmissionId: string;
  id: string;
  isComplete: boolean;
  lastActivityAt: Date;
  versionNumber: number;
  visitedStepKeys: string[];
}
changeReason
changeReason: string | null;
createdAt
createdAt: Date;
createdBy
createdBy: string | null;
currentStepKey
currentStepKey: string | null;
data
data: JsonValue;
deletedAt
deletedAt: Date | null;
deletedBy
deletedBy: string | null;
formSchemaVersionId
formSchemaVersionId: string;
formSubmissionId
formSubmissionId: string;
id
id: string;
isComplete
isComplete: boolean;
lastActivityAt
lastActivityAt: Date;
versionNumber
versionNumber: number;
visitedStepKeys
visitedStepKeys: string[];

On this page