Methods
Create
Creates a new conversation
Usage
#set($conversationResponse = $core_v2_conversation.Create($subject, $body, $usernames))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| subject | string | Subject of the conversatioin's first message | Required | | |
| body | string | Body of the conversation's first message | Required | | |
| usernames | string | One or more usernames to include in the conversation (comma separated). | Required | | |
Return Type
Conversation
Delete
Delete a conversation
Usage
#set($additionalInfoResponse = $core_v2_conversation.Delete($id))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| id | Guid | Id conversation to delete | Required | | |
Return Type
AdditionalInfo
List
List conversations
Usage
#set($pagedListResponse = $core_v2_conversation.List())
Return Type
PagedList<Conversation>
List
List conversations
Usage
#set($pagedListResponse = $core_v2_conversation.List("%{PageIndex = $pageIndexArg, PageSize = $pageSizeArg, ReadStatus = $readStatusArg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| PageIndex | int | Specify the page number of paged results to return. Zero-based index. | Optional | 0 | |
| PageSize | int | Specify the number of results to return per page. | Optional | 20 | |
| ReadStatus | string | Read Status | Optional | NotSet | NotSet, Read, Unread |
Return Type
PagedList<Conversation>
MarkAsRead
Mark a conversation as read
Usage
$core_v2_conversation.MarkAsRead($id)
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| id | Guid | Id conversation to mark as read | Required | | |
MarkAsUnread
Mark a conversation as unread
Usage
$core_v2_conversation.MarkAsUnread($id)
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| id | Guid | Id conversation to mark as unread | Required | | |