AboutSupportDeveloper GuideVersion 47.154.100.2
OpenFin JavaScript API
    Preparing search index...

    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

    Index
    identity
    me
    addListener eventNames getInfo getParentWindow listenerCount listeners on once prependListener prependOnceListener removeAllListeners removeListener
    identity: Identity
    • get me(): Identity

      Returns Identity

      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.

    • Returns (string | symbol)[]

    • Returns a frame info object for the represented frame.

      Returns Promise<FrameInfo>

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

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

      Returns Promise<FrameInfo>

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

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

    • Parameters

      • type: string | symbol

      Returns number

    • Parameters

      • type: string | symbol

      Returns Function[]

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

      Parameters

      • OptionaleventType: "connected" | "disconnected"

      Returns Promise<_Frame>

    Settings

    On This Page
    Properties
    Accessors
    Methods