AboutSupportDeveloper GuideVersion 45.147.100.44

Class _FrameModule

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

Hierarchy

  • Base
    • _FrameModule

Accessors

me

Methods

getCurrent getCurrentSync 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.

Methods

getCurrent

  • getCurrent(): Promise<Frame>

  • Asynchronously returns a reference to the current frame

    Returns Promise<Frame>

    Example

    fin.Frame.getCurrent()
    .then(frm => console.log('current frame'))
    .catch(err => console.log(err));

getCurrentSync

  • getCurrentSync(): Frame

  • Synchronously returns a reference to the current frame

    Returns Frame

    Example

    const frm = fin.Frame.getCurrentSync();
    const info = await frm.getInfo();
    console.log(info);

wrap

  • wrap(identity): Promise<Frame>

  • Asynchronously returns an API handle for the given Frame identity.

    Parameters

    Returns Promise<Frame>

    Remarks

    Wrapping a Frame identity that does not yet exist will not throw an error, and instead returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing for a Frame throughout its entire lifecycle.

    Example

    fin.Frame.wrap({ uuid: 'testFrame', name: 'testFrame' })
    .then(frm => console.log('wrapped frame'))
    .catch(err => console.log(err));

wrapSync

  • wrapSync(identity): Frame

  • Synchronously returns an API handle for the given Frame identity.

    Parameters

    Returns Frame

    Remarks

    Wrapping a Frame identity that does not yet exist will not throw an error, and instead returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing for a Frame throughout its entire lifecycle.

    Example

    const frm = fin.Frame.wrapSync({ uuid: 'testFrame', name: 'testFrame' });
    const info = await frm.getInfo();
    console.log(info);

Settings

On This Page

Accessors
Methods