## ConnectionService **Kind**: global class * [ConnectionService](#ConnectionService) * [new ConnectionService()](#new_ConnectionService_new) * [.start()](#ConnectionService+start) * [.stop()](#ConnectionService+stop) * [.createConnection(ressource, callbackurl)](#ConnectionService+createConnection) ⇒ json * [.deleteConnection(id)](#ConnectionService+deleteConnection) ⇒ Boolean * [.getAllConnections()](#ConnectionService+getAllConnections) ⇒ json * [.getConnection(convId)](#ConnectionService+getConnection) ⇒ json ### new ConnectionService() This module is the basic module for handling connections in Rainbow. The main methods and events proposed in that service allow to: - Create or close a Rainbow connections, - Get all connections or get a connection by its Id - Retrieve all information linked to that connection, ### connectionService.start() Start the connection service. When started, all user connections are retreived **Kind**: instance method of [ConnectionService](#ConnectionService) ### connectionService.stop() Stop connection service. When stoppped, all user connections are closed. **Kind**: instance method of [ConnectionService](#ConnectionService) ### connectionService.createConnection(ressource, callbackurl) ⇒ json Creates a connection givven a ressource name and a callback url **Kind**: instance method of [ConnectionService](#ConnectionService) **Returns**: json - a json data object containning [Connection](../api/Connection) properties | Param | Type | Description | | --- | --- | --- | | ressource | String | the connection ressource name | | callbackurl | String | the webhoock callback url on whitch the events will be received | ### connectionService.deleteConnection(id) ⇒ Boolean Delete a connection givven its Id **Kind**: instance method of [ConnectionService](#ConnectionService) **Returns**: Boolean - true in cas on sucess or throws an exception | Param | Type | | --- | --- | | id | String | ### connectionService.getAllConnections() ⇒ json Get all connection of the connected user **Kind**: instance method of [ConnectionService](#ConnectionService) **Returns**: json - an array list of connection data object containning [Connection](../api/Connection) properties ### connectionService.getConnection(convId) ⇒ json Get a connection data givven its Id **Kind**: instance method of [ConnectionService](#ConnectionService) **Returns**: json - a json data object containning [Connection](../api/Connection) properties | Param | Type | | --- | --- | | convId | String |