## ConversationService **Kind**: global class * [ConversationService](#ConversationService) * [new ConversationService()](#new_ConversationService_new) * [.start()](#ConversationService+start) * [.stop()](#ConversationService+stop) * [.setConversationChatState(cvId, state)](#ConversationService+setConversationChatState) ⇒ Boolean * [.createConversation(peerType, peerId)](#ConversationService+createConversation) ⇒ json * [.createUserConversation(userId)](#ConversationService+createUserConversation) ⇒ json * [.createBotConversation(botId)](#ConversationService+createBotConversation) ⇒ json * [.createBubbleConversation(roomId)](#ConversationService+createBubbleConversation) ⇒ json * [.deleteConversation(convId)](#ConversationService+deleteConversation) ⇒ json * [.getAllConversations()](#ConversationService+getAllConversations) * [.getConversation(convId)](#ConversationService+getConversation) ⇒ json ### new ConversationService() This module is the basic module for handling conversations in Rainbow. In Rainbow, conversations are the way to get in touch with someone or something (i.e. a Rainbow contact, a external phone number, a connected thing, ...) so a conversation is the "long tail" of communication between you and someone or something else like a bubble. A Rainbow conversation by default supports sending and receiving Instant Messages with a single recipient (one-to-one conversation) or with several persons in bubble. The main methods and events proposed in that service allow to: - Create or close a Rainbow conversation (one-to-one of bubble), - Get all conversations or get a conversation by Id - Retrieve all information linked to that conversation ### conversationService.start() Start the conversation service. All conversations are retrieved at startup. **Kind**: instance method of [ConversationService](#ConversationService) ### conversationService.stop() Stop conversation service. When stopped, all conversation are closed. **Kind**: instance method of [ConversationService](#ConversationService) ### conversationService.setConversationChatState(cvId, state) ⇒ Boolean set a conversation chat state **Kind**: instance method of [ConversationService](#ConversationService) **Returns**: Boolean - true if chat state set or throws an exception | Param | Type | Description | | --- | --- | --- | | cvId | String | | | state | String | the conversation state. | ### conversationService.createConversation(peerType, peerId) ⇒ json Creates conversation givven a connection ID, a peer type ( bot,user, buble) and a peer ID **Kind**: instance method of [ConversationService](#ConversationService) **Returns**: json - a json data object containning [Conversation](../api/Conversation) properties | Param | Type | Description | | --- | --- | --- | | peerType | String | the peer type ['bot','user', 'room'] | | peerId | String | the peer Id | ### conversationService.createUserConversation(userId) ⇒ json Creates a conversation with a user **Kind**: instance method of [ConversationService](#ConversationService) **Returns**: json - a json data object containning [Conversation](../api/Conversation) properties | Param | Type | Description | | --- | --- | --- | | userId | String | the user ID | ### conversationService.createBotConversation(botId) ⇒ json Creates a conversation with a bot **Kind**: instance method of [ConversationService](#ConversationService) **Returns**: json - a json data object containning [Conversation](../api/Conversation) properties | Param | Type | Description | | --- | --- | --- | | botId | String | the bot Id | ### conversationService.createBubbleConversation(roomId) ⇒ json Create a chat room conversation **Kind**: instance method of [ConversationService](#ConversationService) **Returns**: json - a json data object containning [Conversation](../api/Conversation) properties | Param | Type | Description | | --- | --- | --- | | roomId | String | the room Id | ### conversationService.deleteConversation(convId) ⇒ json Deletes a conversation givven its Id **Kind**: instance method of [ConversationService](#ConversationService) **Returns**: json - json data object representing a conversation | Param | Type | Description | | --- | --- | --- | | convId | String | the conversation Id | ### conversationService.getAllConversations() Get all conversation for the current connexion {json} a json list of [Conversation](../api/Conversation) object data properties **Kind**: instance method of [ConversationService](#ConversationService) ### conversationService.getConversation(convId) ⇒ json Get a conversation data givven its Id **Kind**: instance method of [ConversationService](#ConversationService) **Returns**: json - a json data object containning [Conversation](../api/Conversation) properties | Param | Type | | --- | --- | | convId | String |