Class _FrameModule

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.

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