AboutSupportDeveloper GuideVersion 36.122.80.10

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

Hierarchy

  • Base
    • _FrameModule

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

  • 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));
  • Synchronously returns a reference to the current frame

    Returns Frame

    Example

    const frm = fin.Frame.getCurrentSync();
    const info = await frm.getInfo();
    console.log(info);
  • Asynchronously returns a reference to the specified frame. The frame does not have to exist

    Parameters

    • identity: Identity

      the identity of the frame you want to wrap

    Returns Promise<Frame>

    Example

    fin.Frame.wrap({ uuid: 'testFrame', name: 'testFrame' })
    .then(frm => console.log('wrapped frame'))
    .catch(err => console.log(err));
  • Synchronously returns a reference to the specified frame. The frame does not have to exist

    Parameters

    • identity: Identity

      the identity of the frame you want to wrap

    Returns Frame

    Example

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