core_v2_conversation Script API

Ben Tiedt — Wed, 20 Nov 2019 14:53:05 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/20/2019 14:53:05

Enables scripted content fragments to use Conversations

Properties
CanStartConversationWith
Create
Delete
Get
List
MarkAsRead
MarkAsUnread
ReadCount
UnreadCount

Properties

Name	Access	Type	Description
ContentTypeId	Read	`Guid`	Content type identifier for conversations
Current	Read	`[[Conversation Script API Type\|Conversation]]`	Current

Methods

CanStartConversationWith

Identifies whether the accessing user can start a conversation with the provided user.

Velocity

#set($booleanResponse = $core_v2_conversation.CanStartConversationWith($userName))

JavaScript

var booleanResponse = core_v2_conversation.CanStartConversationWith(userName);

Parameters

Name	Type	Description	Required	Default	Options
userName	`String`	User Name	Required

Returns

Boolean

Create

Create Overload 1

Creates a new conversation. Obsolete in v.10.0: Subject is no longer used. Use Create(body, usernames) instead.

Velocity

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

JavaScript

var conversationResponse = core_v2_conversation.Create(subject, body, usernames);

Parameters

Name	Type	Description	Required
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

Create Overload 2

Creates a new conversation

Velocity

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

JavaScript

var 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

Returns

[[Conversation Script API Type|Conversation]]

Delete

Delete a conversation

Velocity

#set($additionalInfoResponse = $core_v2_conversation.Delete($id))

JavaScript

var additionalInfoResponse = core_v2_conversation.Delete(id);

Parameters

Name	Type	Description	Required	Default	Options
id	`Guid`	Id conversation to delete	Required

Returns

[[AdditionalInfo Script API Type|AdditionalInfo]]

Get

Get Overload 1

Gets a conversation

Velocity

#set($conversationResponse = $core_v2_conversation.Get($conversationId))

JavaScript

var conversationResponse = core_v2_conversation.Get(conversationId);

Parameters

Name	Type	Description	Required	Default	Options
conversationId	`Guid`	Conversation identifier	Required

Get Overload 2

Velocity

#set($conversationResponse = $core_v2_conversation.Get($usernames))

JavaScript

var conversationResponse = core_v2_conversation.Get(usernames);

Parameters

Name	Type	Description	Required	Default	Options
usernames	`String`	Usernames	Required

Returns

[[Conversation Script API Type|Conversation]]

List

List Overload 1

List conversations

Velocity

#set($pagedListResponse = $core_v2_conversation.List())

JavaScript

var pagedListResponse = core_v2_conversation.List();

List Overload 2

List conversations

Velocity

#set($pagedListResponse = $core_v2_conversation.List("%{ PageIndex = $pageIndexArg, PageSize = $pageSizeArg, ReadStatus = $readStatusArg }"))

JavaScript

var pagedListResponse = core_v2_conversation.List({ PageIndex: pageIndexArg, PageSize: pageSizeArg, ReadStatus: readStatusArg });

Parameters

Name	Type	Description	Required	Default	Options
PageIndex	`Int32`	Specify the page number of paged results to return. Zero-based index.	Optional	0
PageSize	`Int32`	Specify the number of results to return per page.	Optional	20
ReadStatus	`String`	Read Status	Optional	NotSet	NotSet, Read, Unread

Returns

[[PagedList Script API Type|PagedList]] of [[Conversation Script API Type|Conversation]]

MarkAsRead

Mark a conversation as read

Velocity

$core_v2_conversation.MarkAsRead($id)

JavaScript

core_v2_conversation.MarkAsRead(id);

Parameters

Name	Type	Description	Required	Default	Options
id	`Guid`	Id conversation to mark as read	Required

Returns

Nothing

MarkAsUnread

Mark a conversation as unread

Velocity

$core_v2_conversation.MarkAsUnread($id)

JavaScript

core_v2_conversation.MarkAsUnread(id);

Parameters

Name	Type	Description	Required	Default	Options
id	`Guid`	Id conversation to mark as unread	Required

Returns

Nothing

ReadCount

Number of read conversations.

Velocity

#set($int32Response = $core_v2_conversation.ReadCount())

JavaScript

var int32Response = core_v2_conversation.ReadCount();

Returns

Int32

UnreadCount

Number of unread conversations.

Velocity

#set($int32Response = $core_v2_conversation.UnreadCount())

JavaScript

var int32Response = core_v2_conversation.UnreadCount();

Returns

Int32