Kaizen
Browse modulesFormsforms/serverClasses

Class: FormSubmissionWithVersion

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

Extends

Constructors

Constructor

new FormSubmissionWithVersion(input: {
  submission: {
     allowUserEditingOverride: boolean;
     createdAt: Date;
     createdBy: string | null;
     currentVersionId: string | null;
     deletedAt: Date | null;
     deletedBy: string | null;
     id: string;
     submittedAt: Date;
     updatedAt: Date;
     updatedBy: string | null;
     userId: string;
  };
  version: {
     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[];
  };
}): FormSubmissionWithVersion;

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

Parameters

ParameterType
input{ submission: { allowUserEditingOverride: boolean; createdAt: Date; createdBy: string | null; currentVersionId: string | null; deletedAt: Date | null; deletedBy: string | null; id: string; submittedAt: Date; updatedAt: Date; updatedBy: string | null; userId: string; }; version: { 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[]; }; }
input.submission{ allowUserEditingOverride: boolean; createdAt: Date; createdBy: string | null; currentVersionId: string | null; deletedAt: Date | null; deletedBy: string | null; id: string; submittedAt: Date; updatedAt: Date; updatedBy: string | null; userId: string; }
input.submission.allowUserEditingOverrideboolean
input.submission.createdAtDate
input.submission.createdBystring | null
input.submission.currentVersionIdstring | null
input.submission.deletedAtDate | null
input.submission.deletedBystring | null
input.submission.idstring
input.submission.submittedAtDate
input.submission.updatedAtDate
input.submission.updatedBystring | null
input.submission.userIdstring
input.version{ 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[]; }
input.version.changeReasonstring | null
input.version.createdAtDate
input.version.createdBystring | null
input.version.currentStepKeystring | null
input.version.dataJsonValue
input.version.deletedAtDate | null
input.version.deletedBystring | null
input.version.formSchemaVersionIdstring
input.version.formSubmissionIdstring
input.version.idstring
input.version.isCompleteboolean
input.version.lastActivityAtDate
input.version.versionNumbernumber
input.version.visitedStepKeysstring[]

Returns

FormSubmissionWithVersion

Overrides

FormSubmission.constructor

Properties

record

readonly record: {
  allowUserEditingOverride: boolean;
  createdAt: Date;
  createdBy: string | null;
  currentVersionId: string | null;
  deletedAt: Date | null;
  deletedBy: string | null;
  id: string;
  submittedAt: Date;
  updatedAt: Date;
  updatedBy: string | null;
  userId: string;
};

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

allowUserEditingOverride

allowUserEditingOverride: boolean;

createdAt

createdAt: Date;

createdBy

createdBy: string | null;

currentVersionId

currentVersionId: string | null;

deletedAt

deletedAt: Date | null;

deletedBy

deletedBy: string | null;

id

id: string;

submittedAt

submittedAt: Date;

updatedAt

updatedAt: Date;

updatedBy

updatedBy: string | null;

userId

userId: string;

Inherited from

FormSubmission.record


version

readonly version: FormSubmissionVersion;

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

Accessors

allowUserEditingOverride

Get Signature

get allowUserEditingOverride(): boolean;

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

Returns

boolean

Inherited from

FormSubmission.allowUserEditingOverride


createdAt

Get Signature

get createdAt(): Date;

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

Returns

Date

Inherited from

FormSubmission.createdAt


createdBy

Get Signature

get createdBy(): string | null;

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

Returns

string | null

Inherited from

FormSubmission.createdBy


currentVersion

Get Signature

get currentVersion(): FormSubmissionVersion;

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

Returns

FormSubmissionVersion


currentVersionId

Get Signature

get currentVersionId(): string | null;

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

Returns

string | null

Inherited from

FormSubmission.currentVersionId


formSchemaVersionId

Get Signature

get formSchemaVersionId(): string;

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

Returns

string


hasCurrentVersion

Get Signature

get hasCurrentVersion(): boolean;

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

Returns

boolean

Inherited from

FormSubmission.hasCurrentVersion


id

Get Signature

get id(): string;

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

Returns

string

Inherited from

FormSubmission.id


isDeleted

Get Signature

get isDeleted(): boolean;

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

Returns

boolean

Inherited from

FormSubmission.isDeleted


submissionData

Get Signature

get submissionData(): FormDataRecord;

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

Returns

FormDataRecord


submittedAt

Get Signature

get submittedAt(): Date;

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

Returns

Date

Inherited from

FormSubmission.submittedAt


updatedAt

Get Signature

get updatedAt(): Date;

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

Returns

Date

Inherited from

FormSubmission.updatedAt


updatedBy

Get Signature

get updatedBy(): string | null;

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

Returns

string | null

Inherited from

FormSubmission.updatedBy


userId

Get Signature

get userId(): string;

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

Returns

string

Inherited from

FormSubmission.userId

Methods

toJSON()

toJSON(): {
  allowUserEditingOverride: boolean;
  createdAt: Date;
  createdBy: string | null;
  currentVersionId: string | null;
  id: string;
  isDeleted: boolean;
  submittedAt: Date;
  updatedAt: Date;
  updatedBy: string | null;
  userId: string;
  version: {
     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:434

Returns

{
  allowUserEditingOverride: boolean;
  createdAt: Date;
  createdBy: string | null;
  currentVersionId: string | null;
  id: string;
  isDeleted: boolean;
  submittedAt: Date;
  updatedAt: Date;
  updatedBy: string | null;
  userId: string;
  version: {
     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[];
  };
}
allowUserEditingOverride
allowUserEditingOverride: boolean;
createdAt
createdAt: Date;
createdBy
createdBy: string | null;
currentVersionId
currentVersionId: string | null;
id
id: string;
isDeleted
isDeleted: boolean;
submittedAt
submittedAt: Date;
updatedAt
updatedAt: Date;
updatedBy
updatedBy: string | null;
userId
userId: string;
version
version: {
  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[];
};
version.changeReason
changeReason: string | null;
version.createdAt
createdAt: Date;
version.createdBy
createdBy: string | null;
version.currentStepKey
currentStepKey: string | null;
version.data
data: FormDataRecord;
version.formSchemaVersionId
formSchemaVersionId: string;
version.formSubmissionId
formSubmissionId: string;
version.id
id: string;
version.isComplete
isComplete: boolean;
version.lastActivityAt
lastActivityAt: Date;
version.versionNumber
versionNumber: number;
version.visitedStepKeys
visitedStepKeys: string[];

Overrides

FormSubmission.toJSON


toRaw()

toRaw(): {
  allowUserEditingOverride: boolean;
  createdAt: Date;
  createdBy: string | null;
  currentVersionId: string | null;
  deletedAt: Date | null;
  deletedBy: string | null;
  id: string;
  submittedAt: Date;
  updatedAt: Date;
  updatedBy: string | null;
  userId: string;
};

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

Returns

{
  allowUserEditingOverride: boolean;
  createdAt: Date;
  createdBy: string | null;
  currentVersionId: string | null;
  deletedAt: Date | null;
  deletedBy: string | null;
  id: string;
  submittedAt: Date;
  updatedAt: Date;
  updatedBy: string | null;
  userId: string;
}
allowUserEditingOverride
allowUserEditingOverride: boolean;
createdAt
createdAt: Date;
createdBy
createdBy: string | null;
currentVersionId
currentVersionId: string | null;
deletedAt
deletedAt: Date | null;
deletedBy
deletedBy: string | null;
id
id: string;
submittedAt
submittedAt: Date;
updatedAt
updatedAt: Date;
updatedBy
updatedBy: string | null;
userId
userId: string;

Inherited from

FormSubmission.toRaw

On this page