Class default

This model implements the possibility of adding a document into a journal and keeping track of the list of the documents.

Hierarchy (view full)

Model
- default

Index

Constructors

Properties

channelManager onUpdated state channelId

Methods

addDocument blobHashToArrayBuffer documents documentsIterator getDocumentById init shutdown

Constructors

constructor

new default(channelManager): default
Construct a new instance
Parameters
- channelManager: default
  The channel manager instance
Returns default
Overrides Model.constructor
- Defined in models/DocumentModel.ts:36

Properties

channelManager

channelManager: default

onUpdated

onUpdated: OEvent<((timeOfEarliestChange: Date) => void)> = ...

state

state: StateMachine<"Uninitialised" | "Initialised", "shutdown" | "init">

`Static` `Readonly`channelId

channelId: "document" = 'document'

Methods

addDocument

addDocument(document, mimeType, documentName, channelId?, channelOwner?): Promise<void>
Create a new reference to a document.
Parameters
- document: ArrayBuffer
  The document.
- mimeType: string
- documentName: string
- channelId: string = DocumentModel.channelId
  The default is DocumentModel.channelId
- OptionalchannelOwner: null | SHA256IdHash<Person>
Returns Promise<void>
- Defined in models/DocumentModel.ts:76

blobHashToArrayBuffer

blobHashToArrayBuffer(oneObject): Promise<ArrayBuffer>
Convert from one representation to model representation.
Parameters
- oneObject: DocumentInfo_1_1_0
  the one object
Returns Promise<ArrayBuffer>
The corresponding model object
- Defined in models/DocumentModel.ts:207

documents

documents(): Promise<ObjectData<DocumentInfo_1_1_0>[]>
Getting all the documents stored in ONE.

Returns Promise<ObjectData<DocumentInfo_1_1_0>[]>
an array of documents.
- Defined in models/DocumentModel.ts:103

documentsIterator

documentsIterator(queryOptions?): AsyncIterableIterator<ObjectData<DocumentInfo_1_1_0>>
returns iterator for DocumentInfo_1_1_0
Parameters
- OptionalqueryOptions: QueryOptions
Returns AsyncIterableIterator<ObjectData<DocumentInfo_1_1_0>>
- Defined in models/DocumentModel.ts:134

getDocumentById

getDocumentById(id): Promise<ObjectData<DocumentInfo_1_1_0>>
Getting a document with a specific id.
Parameters
- id: string
  the id of the document.
Returns Promise<ObjectData<DocumentInfo_1_1_0>>
the document.
- Defined in models/DocumentModel.ts:169

init

init(): Promise<void>
Initialize this instance

This must be done after the one instance was initialized.

Returns Promise<void>
- Defined in models/DocumentModel.ts:46

shutdown

shutdown(): Promise<void>
Shutdown module

Returns Promise<void>
Overrides Model.shutdown
- Defined in models/DocumentModel.ts:58