Class ConversationResource

Classes

MessageResource ⇐ GenericResource

The MessageResources class provides methods to access the
attachment objects for a case.

ConversationResource ⇐ GenericResource

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

MessageResource ⇐ GenericResource

The MessageResources class provides methods to access the
attachment objects for a case.

Kind: global class
Extends: GenericResource
Category: Resources

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

• ConversationResource ⇐ GenericResource
  • new ConversationResource(client)
  • .messages(id) ⇒ CaseCommentsResource
  • .getConversationsByObjectId(id) ⇒ Array
  • .createMessage(id, msg) ⇒ object

new ConversationResource(client)

Creates a new instance of the ConversationResource class.

Returns: ConversationResource – An instance of the ConversationResource class.

Param	Type	Description
client	ConnectClient	An instance of the ConnectClient class.

conversationResource.messages(id) ⇒ CaseCommentsResource

Returns an instance of the ConversationMessageResource for a Conversation.

Kind: instance method of ConversationResource
Returns: CaseCommentsResource – An instance of the ConversationMessageResource
for the case.

Param	Type	Description
id	string	The unique identifier of the Conversation.

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.

Param	Type	Description
id	string	The 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.

Param	Type	Description
id	string	The unique identifier of the Conversation object.
msg	string	The text of the message to post.