Class SnapshotSourceModule

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.

Initializes a SnapshotSource with the getSnapshot and applySnapshot methods defined.

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);
Copy

Asynchronously returns a SnapshotSource object that represents the current SnapshotSource.

Example

const snapshotSource = await fin.SnapshotSource.wrap(fin.me);
// Use wrapped instance's getSnapshot method, e.g.:
const snapshot = await snapshotSource.getSnapshot();
Copy

Synchronously returns a SnapshotSource object that represents the current SnapshotSource.

Example

const snapshotSource = fin.SnapshotSource.wrapSync(fin.me);
// Use wrapped instance's getSnapshot method, e.g.:
const snapshot = await snapshotSource.getSnapshot();
Copy