AboutSupportDeveloper GuideVersion 38.126.83.79

Generated when the layout and all of the its views have been created and can receive API calls.

interface LayoutReadyEvent {
    layoutIdentity: LayoutIdentity;
    name: string;
    topic: "window";
    type: "layout-ready";
    uuid: string;
    views: {
        error?: Error;
        identity: Identity;
        success: boolean;
    }[];
}

Properties

layoutIdentity: LayoutIdentity
name: string
topic: "window"

The "kebab-case" classname of the emitter that raised the event.

Remarks

OpenFin.Frame is represented as iframe.

type: "layout-ready"

The type of event that was raised. Equal to the typename of the event payload in "kebab case".

Remarks

Guaranteed to be unique within each topic, but can be repeated between topics (e.g. WebContentsEvents.CrashedEvent and ApplicationEvents.CrashedEvent).

uuid: string
views: {
    error?: Error;
    identity: Identity;
    success: boolean;
}[]

Type declaration

  • Optional error?: Error
  • identity: Identity
  • success: boolean