AboutSupportDeveloper GuideVersion 41.131.100.50

Class Frame

An iframe represents an embedded HTML page within a parent HTML page. Because this embedded page has its own DOM and global JS context (which may or may not be linked to that of the parent depending on if it is considered out of the root domain or not), it represents a unique endpoint as an OpenFin connection. Iframes may be generated dynamically, or be present on initial page load and each non-CORS iframe has the OpenFin API injected by default. It is possible to opt into cross-origin iframes having the API by setting api.iframe.crossOriginInjection to true in a window's options. To block all iframes from getting the API injected you can set api.frame.sameOriginInjection to false (see Window Options).

To be able to directly address this context for eventing and messaging purposes, it needs a unique uuid name pairing. For OpenFin applications and windows this is provided via a configuration object in the form of a manifest URL or options object, but there is no configuration object for iframes. Just as a call to window.open outside of our Window API returns a new window with a random GUID assigned for the name, each iframe that has the API injected will be assigned a GUID as its name, the UUID will be the same as the parent window's.

The fin.Frame namespace represents a way to interact with iframes and facilitates the discovery of current context (iframe or main window) as well as the ability to listen for frame-specific events.

Hierarchy

Properties

identity

Accessors

me

Methods

addListener eventNames getInfo getParentWindow listenerCount listeners on once prependListener prependOnceListener removeAllListeners removeListener

Properties

identity

identity: Identity

Accessors

me

  • get me(): Identity

  • Returns Identity

    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.

Methods

addListener

eventNames

  • eventNames(): (string | symbol)[]

  • Returns (string | symbol)[]

getInfo

  • getInfo(): Promise<FrameInfo>

  • Returns a frame info object for the represented frame.

    Returns Promise<FrameInfo>

    Example

    async function getInfo() {
        const frm = await fin.Frame.getCurrent();
        return await frm.getInfo();
    }
    getInfo().then(info => console.log(info)).catch(err => console.log(err));

getParentWindow

  • getParentWindow(): Promise<FrameInfo>

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

    Returns Promise<FrameInfo>

    Remarks

    If the frame is embedded in a view, this will return an invalid stub with empty fields.

    Example

    async function getParentWindow() {
        const frm = await fin.Frame.getCurrent();
        return await frm.getParentWindow();
    }
    getParentWindow().then(winInfo => console.log(winInfo)).catch(err => console.log(err));

listenerCount

  • listenerCount(type): number

  • Parameters

    • type: string | symbol

    Returns number

listeners

  • listeners(type): Function[]

  • Parameters

    • type: string | symbol

    Returns Function[]

on

once

prependListener

prependOnceListener

  • prependOnceListener<EventType>(eventType, listener, options?): Promise<Frame>

  • Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed. The listener is added to the beginning of the listeners array.

    Type Parameters

    • EventType extends "connected" | "disconnected"

    Parameters

    Returns Promise<Frame>

    Remarks

    Event payloads are documented in the OpenFin.Events namespace.

removeAllListeners

  • removeAllListeners(eventType?): Promise<Frame>

  • Removes all listeners, or those of the specified event.

    Parameters

    • OptionaleventType: "connected" | "disconnected"

    Returns Promise<Frame>

removeListener

  • removeListener<EventType>(eventType, listener, options?): Promise<Frame>

  • Remove a listener from the listener array for the specified event.

    Type Parameters

    • EventType extends "connected" | "disconnected"

    Parameters

    Returns Promise<Frame>

    Remarks

    Caution: Calling this method changes the array indices in the listener array behind the listener.

Settings

On This Page

Properties
Accessors
Methods