Class ConversationResource

Updated: March 5, 2020
Contents

ConversationResource ⇐ GenericResource

The ConversationResource class provides methods to access the conversations
endpoint of the Cloud Blue Connect API.

Kind: global class
Extends: GenericResource
Category: Resources

new ConversationResource(client)

Creates a new instance of the ConversationResource class.

Returns: ConversationResource – An instance of the ConversationResource class.

ParamTypeDescription
clientConnectClientAn instance of the ConnectClient class.

conversationResource.getConversationsByObjectId(id) ⇒ Array

Returns a list of conversations attached to the business object specified by its id.

Kind: instance method of ConversationResource
Returns: Array – A list of conversations attached to a business object.

ParamTypeDescription
idstringThe unique id of the business object attached to a conversation.

conversationResource.createMessage(id, msg) ⇒ object

Add a message to a Conversation object.

Kind: instance method of ConversationResource
Returns: object – The newly created Message object.

ParamTypeDescription
idstringThe unique identifier of the Conversation object.
msgstringThe text of the message to post.
Is this page helpful?
Translate with Google
Copied to clipboard