Class _FrameModule

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.

Asynchronously returns a reference to the current frame

Example

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

Synchronously returns a reference to the current frame

Example

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

Asynchronously returns an API handle for the given Frame identity.

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

Synchronously returns an API handle for the given Frame identity.

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