Class SnapshotSource<T>

Enables configuring a SnapshotSource with custom getSnapshot and applySnapshot methods.

Namespace

Type Parameters

T = any

Hierarchy

Base
- SnapshotSource

Index

Constructors

Properties

Accessors

Methods

applySnapshot getSnapshot ready

Constructors

constructor

new SnapshotSource<T>(wire: Transport<EntityType>, id: ApplicationIdentity): OpenFin.SnapshotSource<T>
Type Parameters
- T = any
Parameters
- wire: Transport<EntityType>
- id: ApplicationIdentity
Returns OpenFin.SnapshotSource<T>

Overrides Base.constructor

Properties

wire

wire: Transport<EntityType>

Accessors

identity

get identity(): ApplicationIdentity
Returns ApplicationIdentity

me

get me(): Identity
Returns Identity

Inherited from Base.me

Methods

applySnapshot

applySnapshot(snapshot: T): Promise<void>
Call the SnapshotSource's applySnapshot method defined by SnapshotSource#init init.

Returns
Parameters
- snapshot: T
Returns Promise<void>

getSnapshot

getSnapshot(): Promise<T>
Call the SnapshotSource's getSnapshot method defined by SnapshotSource#init init.

Returns

Returns Promise<T>

ready

ready(): Promise<void>
Method to determine if the SnapshotSource has been initialized.

Use when the parent application is starting up to ensure the SnapshotSource is able to accept and apply a snapshot using the applySnapshot method.

Returns

Tutorial
SnapshotSource.ready

Returns Promise<void>

Generated using TypeDoc