hiro-sdk

HIRO SDK

SDK for HIRO applications.

ctx is instance of HiroGraphOrm. Documentation can be found at hiro-graph-orm docs.

API

Table of Contents

• getState
• getSuspendedApps
• getInstalledApps
• saveState
  • Parameters
• installApp
  • Parameters
• uninstallApp
  • Parameters
• runApp
  • Parameters
• closeApp
  • Parameters
• onClosing
  • Parameters
• onSuspending
  • Parameters
• onEnvironmentChanged
  • Parameters
• initSdk
  • Parameters

getState

Request application state from the HIRO Desktop

Returns Promise<Object>

getSuspendedApps

Ask HIRO Desktop to give list of suspended apps.

Returns Promise<Object>

getInstalledApps

Ask HIRO Desktop to give list of installed apps.

Returns Promise<Object>

saveState

Ask HIRO Desktop to save application state for later usage. Usually, this method is invoke during suspend process.

Parameters

• state Object Application state to save

installApp

Ask HIRO Desktop to install application.

Parameters

• appId string Application id to install

Returns Promise<Object>

uninstallApp

Ask HIRO Desktop to uninstall application.

Parameters

• appId string Application id to uninstall

Returns Promise<Object>

runApp

Ask HIRO Desktop to open/run application.

Parameters

• appId string Application id to run

Returns Promise<Object>

closeApp

Ask HIRO Desktop to close/stop application.

Parameters

• appId string Application id to stop

Returns Promise<Object>

onClosing

Register callback for the CLOSING event

Parameters

• cb Function CLOSING event listener

Returns Function Function to unregister this callback

onSuspending

Register callback for the SUSPENDING event

Parameters

• cb Function SUSPENDING event listener

Returns Function Function to unregister this callback

onEnvironmentChanged

Register callback for the ENVIRONMENT_CHANGED event

Parameters

• cb Function ENVIRONMENT_CHANGED event listener

Returns Function Function to unregister this callback

initSdk

• See: https://www.npmjs.com/package/hiro-graph-orm-mappings
• See: https://github.com/arago/hiro-graph-js/tree/v0.2.8/packages/hiro-graph-client#servlets

Initialize HIRO SDK

Parameters

• config Object SDK configuration (optional, default {})
  • config.mappings Array? ORM mappings There are some mappings provided by default.
  • config.servlets Object? ORM Servlets
  • config.createToken Function? Factory to create token. Default implementation is require('hiro-graph-client').Token But you may want use ReduxToken from the 'hiro-graph-redux'
  • config.authUrl String? Graph Auth URL for dev auth
  • config.graphUrl String? Graph URL for dev auth
  • config.redirectUrl String? Graph Auth Redirect URL for dev auth
  • config.clientId String? Client ID for dev auth
  • config.forceHttp Boolean Force HTTP connection instead of websocket (optional, default true)

Returns Promise<{ready: Function, orm: Context, config: Object, state: Object}> Promise will be resolved with next values:- ready: callback for HIRO Desktop, tells about ready status

• orm: configured ORM
• config: { graphUrl, token, user, org } from the HIRO Desktop
• state: saved application state in case app was suspended