Interface: DocumentRecordApi

Defined in: application/services/records/active-record-contracts.ts:67

Public shape of DocumentRecord: a document bound to its workspace and services.

Properties

data

data: DocumentData;

Defined in: application/services/records/active-record-contracts.ts:71

---

exportHtml

exportHtml: (options?) => Promise<string>;

Defined in: application/services/records/active-record-contracts.ts:79

Parameters

Parameter	Type
options?	any

Returns

Promise<string>

---

exportJsonLd

exportJsonLd: (options?) => Promise<object>;

Defined in: application/services/records/active-record-contracts.ts:81

Parameters

Parameter	Type
options?	any

Returns

Promise<object>

---

exportMarkdown

exportMarkdown: (options?) => Promise<string>;

Defined in: application/services/records/active-record-contracts.ts:78

Parameters

Parameter	Type
options?	any

Returns

Promise<string>

---

exportPdfBlob

exportPdfBlob: (options?) => Promise<Blob>;

Defined in: application/services/records/active-record-contracts.ts:80

Parameters

Parameter	Type
options?	any

Returns

Promise<Blob>

---

getQAScore

getQAScore: () => Promise<number>;

Defined in: application/services/records/active-record-contracts.ts:77

Returns

Promise<number>

---

id

readonly id: string;

Defined in: application/services/records/active-record-contracts.ts:68

---

patchByPath

patchByPath: (path, value) => Promise<DocumentRecordApi>;

Defined in: application/services/records/active-record-contracts.ts:75

Parameters

Parameter	Type
path	(string | number)[]
value	any

Returns

Promise<DocumentRecordApi>

---

profileId

readonly profileId: string;

Defined in: application/services/records/active-record-contracts.ts:70

---

refresh

refresh: () => Promise<DocumentRecordApi>;

Defined in: application/services/records/active-record-contracts.ts:73

Returns

Promise<DocumentRecordApi>

---

setField

setField: (fieldPath, value) => Promise<DocumentRecordApi>;

Defined in: application/services/records/active-record-contracts.ts:74

Parameters

Parameter	Type
fieldPath	string
value	FieldValue[]

Returns

Promise<DocumentRecordApi>

---

title?

title?: string;

Defined in: application/services/records/active-record-contracts.ts:72

---

toInstance

toInstance: () => DocumentInstance;

Defined in: application/services/records/active-record-contracts.ts:82

Returns

DocumentInstance

---

validate

validate: () => Promise<ValidationResult>;

Defined in: application/services/records/active-record-contracts.ts:76

Returns

Promise<ValidationResult>

---

workspaceId

readonly workspaceId: string;

Defined in: application/services/records/active-record-contracts.ts:69