Global

Methods

# init(config)

This function registers the application and create a new web socket connection

Parameters:

Name	Type	Description
`config`	`Register`

This function is to subscribe dataset

Parameters:

Name	Type	Description
`dataset`	`Subscribe`

Type Definitions

Type: Object

# Register

Properties:

Name	Type	Attributes	Description
`accessToken`	`string`		Authorization Token
`notifHost`	`string`		Domain of notifs
`rtdHost`	`string`		Domain of rtd
`clientType`	`string`		application from where it is initialized
`lostConnectionRecoveryTimeout`	`string`	<optional>	time limit in milliseconds to retry socket connection, default value is 2min
`notifsWelcomeFlag`	`boolean`	<optional>
`welcomeTimeout`	`number`	<optional>

Type: Object

creates a new type named 'Subscribe'

Properties:

Name	Type	Description
`datasetName`	`string`	name of dataset
`update`	`function`	callback function to provide success data
`error`	`function`	callback function to provide error data