AboutSupportDeveloper GuideVersion 37.124.81.24

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

Hierarchy

  • Base
    • SnapshotSourceModule

Accessors

Methods

Accessors

  • get me(): Identity
  • Provides access to the OpenFin representation of the current code context (usually a document such as a View or Window), as well as to the current Interop context.

    Useful for debugging in the devtools console, where this will intelligently type itself based on the context in which the devtools panel was opened.

    Returns Identity

Methods

  • 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

    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);
  • Asynchronously returns a SnapshotSource object that represents the current SnapshotSource.

    Parameters

    Returns Promise<SnapshotSource<unknown>>

    Example

    const snapshotSource = await fin.SnapshotSource.wrap(fin.me);
    // Use wrapped instance's getSnapshot method, e.g.:
    const snapshot = await snapshotSource.getSnapshot();
  • Synchronously returns a SnapshotSource object that represents the current SnapshotSource.

    Parameters

    Returns SnapshotSource<unknown>

    Example

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