Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Document

Hierarchy

  • Document

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Document(client: HttpClient, pod: Readonly<PODModel & { creator: string; details: DocumentDetails; originatingJob?: JobId; owner: string; size: number }>): Document

  • Parameters

    • client: HttpClient
    • pod: Readonly<PODModel & { creator: string; details: DocumentDetails; originatingJob?: JobId; owner: string; size: number }>

    Returns Document

Properties

Private #client

#client: HttpClient

Readonly createdAt

createdAt: Date

The number of seconds since the Unix epoch when this model was created

Readonly creator

creator: IdentityId

Readonly details

details: DocumentDetails

Readonly id

id: DocumentId

The model's unique ID.

Optional Readonly originatingJob

originatingJob: JobId

Additional, optional information about the document.

Readonly owner

owner: IdentityId

Readonly size

size: number

Methods

delete

  • delete(): Promise<void>

  • Returns Promise<void>

download

  • Downloads the private data referenced by the document if the authorized identity has been granted access.

    Returns Download

    the decrypted data as a pipeable stream and AsyncIterable

history

  • history(filter?: Partial<{ accessor: IdentityId; after: Date; before: Date }> & Partial<{ pageSize: number; pageToken: string }>): Promise<Page<AccessEvent>>

  • Parameters

    • Optional filter: Partial<{ accessor: IdentityId; after: Date; before: Date }> & Partial<{ pageSize: number; pageToken: string }>

    Returns Promise<Page<AccessEvent>>

update

Generated using TypeDoc