Enables scripted content fragments to use Conversations

Properties

NameTypeDescriptionDefaultOptions
CurrentConversation

Methods

Create

Creates a new conversation

Usage

#set($conversationResponse = $core_v2_conversation.Create($subject, $body, $usernames))

Parameters

NameTypeDescriptionRequiredDefaultOptions
subjectstringSubject of the conversatioin's first messageRequired
bodystringBody of the conversation's first messageRequired
usernamesstringOne 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

NameTypeDescriptionRequiredDefaultOptions
idGuidId conversation to deleteRequired

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

NameTypeDescriptionRequiredDefaultOptions
PageIndexintSpecify the page number of paged results to return. Zero-based index.Optional0
PageSizeintSpecify the number of results to return per page. Optional20
ReadStatusstringRead StatusOptionalNotSetNotSet, Read, Unread

Return Type

PagedList<Conversation>

MarkAsRead

Mark a conversation as read

Usage

$core_v2_conversation.MarkAsRead($id)

Parameters

NameTypeDescriptionRequiredDefaultOptions
idGuidId conversation to mark as readRequired

MarkAsUnread

Mark a conversation as unread

Usage

$core_v2_conversation.MarkAsUnread($id)

Parameters

NameTypeDescriptionRequiredDefaultOptions
idGuidId conversation to mark as unreadRequired