core_v2_conversation Script API

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

Returns

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

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

Returns

Delete

Delete/hide a conversation. The conversation will be deleted when all participants delete or leave the conversation. If any participant replies, all participants who deleted the conversation will see the full conversation again.

Velocity

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

JavaScript

var additionalInfoResponse = core_v2_conversation.Delete(id);

Parameters

Returns

Get

Get Overload 1

Gets a conversation

Velocity

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

JavaScript

var conversationResponse = core_v2_conversation.Get(conversationId);

Parameters

Get Overload 2

Velocity

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

JavaScript

var conversationResponse = core_v2_conversation.Get(usernames);

Parameters

Returns

HasLeft

Identifies if a participant has left the conversation.

Velocity

#set($booleanResponse = $core_v2_conversation.HasLeft($id, $userId))

JavaScript

var booleanResponse = core_v2_conversation.HasLeft(id, userId);

Parameters

Returns

Leave

Leave a conversation. The conversation will be deleted when all participants delete or leave the conversation. If any participant replies, participants who have left will not be reactivated in the conversation but can be reactivated manually by other participants.

Velocity

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

JavaScript

var additionalInfoResponse = core_v2_conversation.Leave(id);

Parameters

Returns

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

Returns

MarkAsRead

Mark a conversation as read

Velocity

$core_v2_conversation.MarkAsRead($id)

JavaScript

core_v2_conversation.MarkAsRead(id);

Parameters

Returns

MarkAsUnread

Mark a conversation as unread

Velocity

$core_v2_conversation.MarkAsUnread($id)

JavaScript

core_v2_conversation.MarkAsUnread(id);

Parameters

Returns

ReadCount

Number of read conversations.

Velocity

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

JavaScript

var int32Response = core_v2_conversation.ReadCount();

Returns

Restore

Restore a participant who has left the conversation. If the requestor can start a conversation with the requested user and the user had previously left the conversation, the requested user will be restored in the conversation.

Velocity

#set($additionalInfoResponse = $core_v2_conversation.Restore($id, $userId))

JavaScript

var additionalInfoResponse = core_v2_conversation.Restore(id, userId);

Parameters

Returns

UnreadCount

Number of unread conversations.

Velocity

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

JavaScript

var int32Response = core_v2_conversation.UnreadCount();

Returns