Class PlatformModule

Lends

Platform

Hierarchy

  • Base
    • PlatformModule

Constructors

constructor

Properties

Layout wire

Accessors

me

Methods

getCurrent getCurrentSync init start startFromManifest wrap wrapSync

Constructors

constructor

Properties

Layout

Layout: LayoutModule

wire

wire: Transport<EntityType>

Accessors

me

Methods

getCurrent

  • Asynchronously returns a Platform object that represents the current platform.

    Returns

    Tutorial

    Platform.getCurrent

    Static

    Returns Promise<OpenFin.Platform>

getCurrentSync

  • Synchronously returns a Platform object that represents the current platform.

    Returns

    Tutorial

    Platform.getCurrentSync

    Static

    Returns OpenFin.Platform

init

  • Experimental

    Initializes a Platform. Must be called from the Provider when using a custom provider.

    Returns

    Tutorial

    Platform.init

    Static

    Parameters

    • Optional options: InitPlatformOptions

      platform options including a callback function that can be used to extend or replace default Provider behavior.

    Returns Promise<void>

start

  • Creates and starts a Platform and returns a wrapped and running Platform instance. The wrapped Platform methods can be used to launch content into the platform. Promise will reject if the platform is already running.

    Returns

    Tutorial

    Platform.start

    Static

    Parameters

    Returns Promise<OpenFin.Platform>

startFromManifest

  • Retrieves platforms's manifest and returns a wrapped and running Platform. If there is a snapshot in the manifest, it will be launched into the platform.

    Returns

    Tutorial

    Platform.startFromManifest

    Static

    Parameters

    • manifestUrl: string

      The URL of platform's manifest.

    • Optional opts: RvmLaunchOptions

      Parameters that the RVM will use.

    Returns Promise<OpenFin.Platform>

wrap

wrapSync

Settings

Member Visibility

Theme

Generated using TypeDoc