Class SnapshotSourceModule

Static namespace for OpenFin API methods that interact with the SnapshotSource class, available under fin.SnapshotSource.

Hierarchy

Base
- SnapshotSourceModule

Index

Accessors

Methods

init wrap wrapSync

Accessors

me

get me(): Identity

Returns Identity

Deprecated
me should only be accessed from the fin global (FinApi.me); access through entity classes is not guaranteed to behave sensibly in all calling contexts.

Inherited from Base.me

Methods

init

init<Snapshot = unknown>(provider: SnapshotProvider<Snapshot>): Promise<void>
Initializes a SnapshotSource with the getSnapshot and applySnapshot methods defined.
Type Parameters
- Snapshot = unknown
  Implementation-defined shape of an application snapshot. Allows custom snapshot implementations for legacy applications to define their own snapshot format.
Parameters
- provider: SnapshotProvider<Snapshot>
Returns Promise<void>
Example
```
const snapshotProvider = {
    async getSnapshot() {
      const bounds = await fin.me.getBounds();
      return bounds;
     },
    async applySnapshot(snapshot) {
      await fin.me.setBounds(snapshot);
      return undefined;
    }
}

await fin.SnapshotSource.init(snapshotProvider);
```

wrap

wrap(
identity: ApplicationIdentity,
): Promise<SnapshotSource.SnapshotSource<unknown>>
Asynchronously returns a SnapshotSource object that represents the current SnapshotSource.
Parameters
- identity: ApplicationIdentity
Returns Promise<SnapshotSource.SnapshotSource<unknown>>
Example
```
const snapshotSource = await fin.SnapshotSource.wrap(fin.me);
// Use wrapped instance's getSnapshot method, e.g.:
const snapshot = await snapshotSource.getSnapshot();
```

wrapSync

wrapSync(identity: ApplicationIdentity): SnapshotSource.SnapshotSource
Synchronously returns a SnapshotSource object that represents the current SnapshotSource.
Parameters
- identity: ApplicationIdentity
Returns SnapshotSource.SnapshotSource
Example
```
const snapshotSource = fin.SnapshotSource.wrapSync(fin.me);
// Use wrapped instance's getSnapshot method, e.g.:
const snapshot = await snapshotSource.getSnapshot();
```