AboutSupportDeveloper GuideVersion 47.154.100.2
OpenFin JavaScript API
    Preparing search index...

    Class _FrameModule

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

    Hierarchy

    • Base
      • _FrameModule
    Index
    me
    getCurrent getCurrentSync wrap wrapSync
    • get me(): Identity

      Returns Identity

      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.

    • Asynchronously returns a reference to the current frame

      Returns Promise<_Frame>

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

    • Synchronously returns a reference to the current frame

      Returns _Frame

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

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

      Parameters

      Returns Promise<_Frame>

      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.

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

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

      Parameters

      Returns _Frame

      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.

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

    Settings

    On This Page
    Accessors
    Methods