OpenFin C++ Adapter 1.1.0

Loading...
Searching...
No Matches
OpenFinAdapterApi::Runtime Class Reference

Represents a connection to the OpenFin runtime. More...

#include <OpenFinAdapter.h>

Public Member Functions

bool isConnected () const
 Gets whether the runtime is connected.
 
string getRuntimeId ()
 Gets the runtime ID.
 
RuntimeOptions getRuntimeOptions ()
 Gets the Runtime options.
 
future< void > connectAsync ()
 Initialises and connects to the runtime.
 
future< void > disconnectAsync ()
 Disconnects from the runtime.
 
shared_ptr< ChannelsgetChannels ()
 Gets the Channels object.
 
shared_ptr< DesktopSystemgetDesktopSystem ()
 Gets the Desktop System API object.
 
void subscribeDisconnected (const function< void()> &listener)
 Registers a listener function that will be called when the adapter disconnects.
 
void unsubscribeDisconnected (const function< void()> &listener)
 Unregisters a listener function such that it will no longer be called when the adapter disconnects.
 

Detailed Description

Represents a connection to the OpenFin runtime.

Member Function Documentation

◆ connectAsync()

future< void > OpenFinAdapterApi::Runtime::connectAsync ( )

Initialises and connects to the runtime.

Returns
The async future

◆ disconnectAsync()

future< void > OpenFinAdapterApi::Runtime::disconnectAsync ( )

Disconnects from the runtime.

Returns
The async future

◆ getChannels()

shared_ptr< Channels > OpenFinAdapterApi::Runtime::getChannels ( )

Gets the Channels object.

Returns
The Channels object

◆ getDesktopSystem()

shared_ptr< DesktopSystem > OpenFinAdapterApi::Runtime::getDesktopSystem ( )

Gets the Desktop System API object.

Returns
The DesktopSystem object

◆ isConnected()

bool OpenFinAdapterApi::Runtime::isConnected ( ) const

Gets whether the runtime is connected.

Returns
Whether the runtime is connected

◆ subscribeDisconnected()

void OpenFinAdapterApi::Runtime::subscribeDisconnected ( const function< void()> & listener)

Registers a listener function that will be called when the adapter disconnects.

Parameters
listenerA listener

◆ unsubscribeDisconnected()

void OpenFinAdapterApi::Runtime::unsubscribeDisconnected ( const function< void()> & listener)

Unregisters a listener function such that it will no longer be called when the adapter disconnects.

Parameters
listenerThe listener

The documentation for this class was generated from the following file: