Skip to main content

Interface: IAuditableItemStream

Interface describing an auditable item stream.

Extends​

Properties​

id​

id: string

The id of the stream.

dateCreated​

dateCreated: string

The date/time of when the stream was created.

dateModified?​

optional dateModified?: string

The date/time of when the stream was modified.

organizationIdentity?​

optional organizationIdentity?: string

The identity of the organization which controls the stream.

userIdentity?​

optional userIdentity?: string

The identity of the user who created the stream.

proofId?​

optional proofId?: string

The id of the immutable proof for the stream.

numberOfItems?​

optional numberOfItems?: number

How many entries are in the stream.

entries?​

optional entries?: object

Entries in the stream.

type​

type: "ItemList"

itemListElement​

itemListElement: IAuditableItemStreamEntry[]

Overrides​

IAuditableItemStreamBase.entries

verification?​

optional verification?: IImmutableProofVerification

The verification of the stream.

@context​

@context: ["https://schema.org", "https://schema.twindev.org/ais/", "https://schema.twindev.org/common/", ...IJsonLdContextDefinitionElement[]]

JSON-LD Context.

Inherited from​

IAuditableItemStreamBase.@context

type​

type: "AuditableItemStream"

JSON-LD Type.

Inherited from​

IAuditableItemStreamBase.type

annotationObject?​

optional annotationObject?: IJsonLdNodeObject

The object to associate with the entry as JSON-LD.

Inherited from​

IAuditableItemStreamBase.annotationObject

immutableInterval?​

optional immutableInterval?: number

After how many entries do we add immutable checks, defaults to service configured value. A value of 0 will disable immutable checks, 1 will be every item, or any other integer for an interval.

Inherited from​

IAuditableItemStreamBase.immutableInterval

closed?​

optional closed?: boolean

Is the stream closed for entry updates.

Inherited from​

IAuditableItemStreamBase.closed

mode?​

optional mode?: AuditableItemStreamModes

The operation mode for the stream.

Inherited from​

IAuditableItemStreamBase.mode