Class default

constructor

• new default(channelManager: default): default

  Construct a new instance

  Parameters

  • channelManager: default

    The channel manager instance

  Returns default

channelManager

onUpdated

Static ReadonlychannelId

addDocument

• addDocument(
      document: ArrayBuffer,
      mimeType: string,
      documentName: string,
      channelId?: string,
      channelOwner?: null | SHA256IdHash<Person>,
  ): 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>

blobHashToArrayBuffer

• blobHashToArrayBuffer(oneObject: DocumentInfo_1_1_0): 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

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.

documentsIterator

• documentsIterator(
      queryOptions?: QueryOptions,
  ): AsyncIterableIterator<ObjectData<DocumentInfo_1_1_0>>

  returns iterator for DocumentInfo_1_1_0

  Parameters

  • OptionalqueryOptions: QueryOptions

  Returns AsyncIterableIterator<ObjectData<DocumentInfo_1_1_0>>

getDocumentById

• getDocumentById(id: string): 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.

init

• init(): Promise<void>

  Initialize this instance

  This must be done after the one instance was initialized.

  Returns Promise<void>

shutdown

• shutdown(): Promise<void>

  Shutdown module

  Returns Promise<void>