Class SnapshotSourceModule

Lends

SnapshotSource

Hierarchy

Base
- SnapshotSourceModule

Index

Constructors

Properties

Accessors

Methods

init wrap wrapSync

Constructors

constructor

new SnapshotSourceModule(wire: Transport<EntityType>): SnapshotSourceModule
Parameters
- wire: Transport<EntityType>
Returns SnapshotSourceModule

Inherited from Base.constructor

Properties

wire

wire: Transport<EntityType>

Accessors

me

get me(): Identity
Returns Identity

Inherited from Base.me

Methods

init

init<T>(provider: SnapshotProvider<T>): Promise<void>
Initializes a SnapshotSource with the getSnapshot and applySnapshot methods defined.

Returns

Tutorial
SnapshotSource.init

Static
Type Parameters
- T = any
Parameters
- provider: SnapshotProvider<T>
Returns Promise<void>

wrap

wrap(identity: ApplicationIdentity): Promise<OpenFin.SnapshotSource<any>>
Asynchronously returns a SnapshotSource object that represents the current SnapshotSource.

Returns

Tutorial
SnapshotSource.wrap

Static
Parameters
- identity: ApplicationIdentity
Returns Promise<OpenFin.SnapshotSource<any>>

wrapSync

wrapSync(identity: ApplicationIdentity): OpenFin.SnapshotSource<any>
Synchronously returns a SnapshotSource object that represents the current SnapshotSource.

Returns

Tutorial
SnapshotSource.wrapSync

Static
Parameters
- identity: ApplicationIdentity
Returns OpenFin.SnapshotSource<any>

Generated using TypeDoc