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.

Synchronous Methods
Asynchronous Methods

Constructor

new Frame()

Methods

(static) getCurrent() → {Object}

Get a reference to the current frame

Tutorials:
Returns:

Frame object

Type
Object

(static) wrap(uuid, name) → {Object}

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

Parameters:
Name Type Description
uuid string

uuid of the frame you want to wrap
name string

name of the frame you want to wrap
Tutorials:
Returns:

Frame

Type
Object

addEventListener(topic, listener, callbackopt, errorCallbackopt)

Adds a listener to the referenced frame. The events are 'connected' and 'disconnected'

Parameters:
Name Type Attributes Description
topic string

the event to listen for
listener function

call when the event is fired
callback function <optional>

called if the method succeeds.
errorCallback function <optional>

called if the method succeeds fails.
Tutorials:

getInfo(callbackopt, errorCallbackopt) → {fin.desktop.Frame~FrameInfo}

Returns a frame info object for the represented frame

Parameters:
Name Type Attributes Description
callback function <optional>

called if the method succeeds.
errorCallback function <optional>

called if the method fails.
Tutorials:
Returns:
Type
fin.desktop.Frame~FrameInfo

getParentWindow(callbackopt, errorCallbackopt) → {fin.desktop.Frame~FrameInfo}

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

Parameters:
Name Type Attributes Description
callback function <optional>

called if the method succeeds.
errorCallback function <optional>

called if the method succeeds fails.
Tutorials:
Returns:
Type
fin.desktop.Frame~FrameInfo

removeEventListener(callbackopt)

Removes a listener from the referenced frame

Parameters:
Name Type Attributes Description
callback function <optional>

called if the method succeeds.
Tutorials:

Type Definitions

FrameInfo

Information regarding the referenced frame

Type:
  • object
Properties:
Name Type Description
uuid string

Uuid of referenced frame
name string

Name of referenced frame
entityType string

Either 'window', 'iframe', or 'unknown'
parent object

object containing the uuid and name of the parent frame