Interface: WorkspaceRecordApi

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

Public shape of WorkspaceRecord: a workspace whose documents are exposed as DocumentRecordApi objects.

Properties

createDocument

createDocument: (profileId, folderId?, initialData?) => Promise<DocumentRecordApi>;

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

Parameters

Parameter	Type
profileId	string
folderId?	string
initialData?	DocumentData

Returns

Promise<DocumentRecordApi>

---

createFolder

createFolder: (name, parentId?) => Promise<FolderNode>;

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

Parameters

Parameter	Type
name	string
parentId?	string

Returns

Promise<FolderNode>

---

deleteDocument

deleteDocument: (documentId) => Promise<void>;

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

Parameters

Parameter	Type
documentId	string

Returns

Promise<void>

---

deleteFolderAndMoveContents

deleteFolderAndMoveContents: (folderId) => Promise<void>;

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

Parameters

Parameter	Type
folderId	string

Returns

Promise<void>

---

description?

description?: string;

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

---

documents

documents: DocumentRecordApi[];

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

---

findDuplicateDocument

findDuplicateDocument: (documentData) => DocumentRecordApi | null;

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

Parameters

Parameter	Type
documentData	DocumentData

Returns

DocumentRecordApi | null

---

folders

folders: FolderNode[];

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

---

getDocument

getDocument: (documentId) => DocumentRecordApi | null;

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

Parameters

Parameter	Type
documentId	string

Returns

DocumentRecordApi | null

---

id

readonly id: string;

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

---

importDocument

importDocument: (documentData, options?) => Promise<DocumentRecordApi>;

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

Parameters

Parameter	Type
documentData	DocumentData
options?	{ folderId?: string; profileId?: string; tags?: string[]; title?: string; }
options.folderId?	string
options.profileId?	string
options.tags?	string[]
options.title?	string

Returns

Promise<DocumentRecordApi>

---

name

name: string;

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

---

owner

owner: string;

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

---

profiles

profiles: DocumentProfile[];

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

---

refresh

refresh: () => Promise<WorkspaceRecordApi>;

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

Returns

Promise<WorkspaceRecordApi>

---

save

save: () => Promise<WorkspaceRecordApi>;

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

Returns

Promise<WorkspaceRecordApi>

---

toSnapshot

toSnapshot: () => WorkspaceSnapshot;

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

Returns

WorkspaceSnapshot

---

typeLibrary

typeLibrary: TypeLibrary;

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