Enables scripted content fragments to use Conversations
Properties
Name | Type | Description | Default | Options |
---|---|---|---|---|
ContentTypeId | Guid | Content type identifier for conversations | ||
Current | Conversation |
Methods
CanStartConversationWith
Identifies whether the accessing user can start a conversation with the provided user.
Usage
#set($booleanResponse = $core_v2_conversation.CanStartConversationWith($userName))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
userName | string | User Name | Required |
Return Type
bool
Create
Creates a new conversation. Obsolete in v.10.0: Subject is no longer used. Use Create(body, usernames) instead.
Usage
#set($conversationResponse = $core_v2_conversation.Create($subject, $body, $usernames))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
subject | string | Subject of the conversation's first message. Obsolete in v.10.0: Subject is no longer saved. | 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
Create
Creates a new conversation
Usage
#set($conversationResponse = $core_v2_conversation.Create($body, $usernames))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
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
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
Get
Gets a conversation
Usage
#set($conversationResponse = $core_v2_conversation.Get($conversationId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
conversationId | Guid | Conversation identifier | Required |
Return Type
Get
Usage
#set($conversationResponse = $core_v2_conversation.Get($usernames))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
usernames | string | Usernames | Required |
Return Type
List
List conversations
Usage
#set($pagedListResponse = $core_v2_conversation.List())
Return Type
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
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 |
ReadCount
Number of read conversations.
Usage
#set($int32Response = $core_v2_conversation.ReadCount())
Return Type
int
UnreadCount
Number of unread conversations.
Usage
#set($int32Response = $core_v2_conversation.UnreadCount())
Return Type
int