Enables scripted content fragments to use ConversationMessages
Properties
Name | Type | Description | Default | Options |
---|---|---|---|---|
ContentTypeId | Guid | The content type for conversation messages | ||
NotificationTypeId | Guid | The default notification type id for conversation messagees |
Methods
Create
Creates a new conversation
Usage
#set($conversationMessageResponse = $core_v2_conversationMessage.Create($conversationId, $body))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
conversationId | Guid | Id of the conversation | Required | ||
body | string | Body of the conversation | Required |
Return Type
Create
Creates a new conversation message
Usage
#set($conversationMessageResponse = $core_v2_conversationMessage.Create($conversationId, $body, "%{Subject = $subjectArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
conversationId | Guid | Id of the conversation | Required | ||
body | string | Body of the message | Required | ||
Subject | string | Subject of the message. Obsolete in v10.0: Subject is no longer used. | Optional |
Return Type
Delete
Delete a conversation message
Usage
#set($additionalInfoResponse = $core_v2_conversationMessage.Delete($conversationId, $id))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
conversationId | Guid | Id of the parent conversation | Required | ||
id | Guid | Id of the conversation message | Required |
Return Type
Get
Get a conversation message
Usage
#set($conversationMessageResponse = $core_v2_conversationMessage.Get($id))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
id | Guid | Id | Required |
Return Type
List
List conversation messages for a conversation
Usage
#set($pagedListResponse = $core_v2_conversationMessage.List($conversationId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
conversationId | Guid | Id of a conversation | Required |
Return Type
PagedList<ConversationMessage>
List
List conversation messages for a conversation
Usage
#set($pagedListResponse = $core_v2_conversationMessage.List($conversationId, "%{EndDate = $endDateArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, SortOrder = $sortOrderArg, StartDate = $startDateArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
conversationId | Guid | Id of a conversation | Required | ||
EndDate | DateTime | Requires messages be older than this date | Optional | ||
PageIndex | int | Zero-based | Optional | 0 | |
PageSize | int | Amount of messages to return per page | Optional | 20 | |
SortOrder | string | Ascending or Descending | Optional | Ascending | Ascending, Descending |
StartDate | DateTime | Requires messages be newer than this date | Optional |
Return Type
PagedList<ConversationMessage>
Search
List conversation messages for a conversation
Usage
#set($pagedListResponse = $core_v2_conversationMessage.Search("%{PageIndex = $pageIndexArg, PageSize = $pageSizeArg, Query = $queryArg, SortBy = $sortByArg, SortOrder = $sortOrderArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
PageIndex | int | Zero-based | Optional | 0 | |
PageSize | int | Amount of messages to return per page | Optional | 20 | |
Query | string | Text to search. Required. | Optional | ||
SortBy | string | Specify how results are sorted | Optional | score | date, score |
SortOrder | string | Specify what order results are sorted | Optional | desc | asc, ascending, desc, descending |