Class: Frame

Frame

Represents a way to interact with iframes. Facilitates discovery of current context (iframe or main window) as well as the ability to listen for frame-specific events.

Constructor

new Frame()

Methods

(static) getCurrent() → {Promise.<_Frame>}

Asynchronously returns a reference to the current frame

Tutorials:
Returns:
Type
Promise.<_Frame>

(static) getCurrentSync() → {_Frame}

Synchronously returns a reference to the current frame

Tutorials:
Returns:
Type
_Frame

(static) wrap(identity) → {Promise.<_Frame>}

Asynchronously returns a reference to the specified frame. The frame does not have to exist

Parameters:
Name Type Description
identity Identity

the identity of the frame you want to wrap

Tutorials:
Returns:
Type
Promise.<_Frame>

(static) wrapSync(identity) → {_Frame}

Synchronously returns a reference to the specified frame. The frame does not have to exist

Parameters:
Name Type Description
identity Identity

the identity of the frame you want to wrap

Tutorials:
Returns:
Type
_Frame

getInfo() → {Promise.<FrameInfo>}

Returns a frame info object for the represented frame

Tutorials:
Returns:
Type
Promise.<FrameInfo>

getParentWindow() → {Promise.<FrameInfo>}

Returns a frame info object representing the window that the referenced iframe is currently embedded in

Tutorials:
Returns:
Type
Promise.<FrameInfo>