core_v2_statusMessage Script API

Methods

CanUpdate

Returns whether accessing user can update a status message

Velocity

#set($booleanResponse = $core_v2_statusMessage.CanUpdate($messageId))

JavaScript

var booleanResponse = core_v2_statusMessage.CanUpdate(messageId);

Parameters

Returns

Create

Create Overload 1

Creates a new status message by the accessing user

Velocity

#set($statusMessageResponse = $core_v2_statusMessage.Create($messageBody))

JavaScript

var statusMessageResponse = core_v2_statusMessage.Create(messageBody);

Parameters

Create Overload 2

Creates a new status message by the accessing user

Velocity

#set($statusMessageResponse = $core_v2_statusMessage.Create($messageBody, "%{ AttachedUrl = $attachedUrlArg, GroupId = $groupIdArg }"))

JavaScript

var statusMessageResponse = core_v2_statusMessage.Create(messageBody, { AttachedUrl: attachedUrlArg, GroupId: groupIdArg });

Parameters

Returns

Delete

Deletes a status message

Velocity

#set($additionalInfoResponse = $core_v2_statusMessage.Delete($messageId))

JavaScript

var additionalInfoResponse = core_v2_statusMessage.Delete(messageId);

Parameters

Returns

Get

Gets a status message

Velocity

#set($statusMessageResponse = $core_v2_statusMessage.Get($messageId))

JavaScript

var statusMessageResponse = core_v2_statusMessage.Get(messageId);

Parameters

Returns

GetCount

Gets the count of status messages by an author.

Velocity

#set($int32Response = $core_v2_statusMessage.GetCount($userId))

JavaScript

var int32Response = core_v2_statusMessage.GetCount(userId);

Parameters

Returns

List

List Overload 1

Lists status messages

Velocity

#set($apiListResponse = $core_v2_statusMessage.List())

JavaScript

var apiListResponse = core_v2_statusMessage.List();

List Overload 2

Lists status messages. Due to performance considerations, the result may not always return the requested PageSize of results, but it is guaranteed to return at least 1 result if any results exist when using an open-ended date range. By default, the method will first query for the last 48 hours, then for the last 96 hours, and then for all time, returning when it finds at least 1 result that matches the other given criteria. It also will not return the TotalItems value. It is recommended to page by StartDate and/or EndDate instead of PageIndex and PageSize.

Velocity

#set($apiListResponse = $core_v2_statusMessage.List("%{ AfterDate = $afterDateArg, BeforeDate = $beforeDateArg, GroupId = $groupIdArg, Include = $includeArg, PageSize = $pageSizeArg, UserId = $userIdArg, Username = $usernameArg }"))

JavaScript

var apiListResponse = core_v2_statusMessage.List({ AfterDate: afterDateArg, BeforeDate: beforeDateArg, GroupId: groupIdArg, Include: includeArg, PageSize: pageSizeArg, UserId: userIdArg, Username: usernameArg });

Parameters

Returns

PreviewAttachment

PreviewAttachment Overload 1

Previews embedded or explicit attachments

Velocity

#set($stringResponse = $core_v2_statusMessage.PreviewAttachment($messageBody))

JavaScript

var stringResponse = core_v2_statusMessage.PreviewAttachment(messageBody);

Parameters

PreviewAttachment Overload 2

Previews embedded or explicit attachments

Velocity

#set($stringResponse = $core_v2_statusMessage.PreviewAttachment($messageBody, "%{ AttachedUrl = $attachedUrlArg, GroupId = $groupIdArg }"))

JavaScript

var stringResponse = core_v2_statusMessage.PreviewAttachment(messageBody, { AttachedUrl: attachedUrlArg, GroupId: groupIdArg });

Parameters

Returns

Update

Updates an existing status message

Velocity

#set($statusMessageResponse = $core_v2_statusMessage.Update($id, $messageBody, "%{ AttachedUrl = $attachedUrlArg, GroupId = $groupIdArg }"))

JavaScript

var statusMessageResponse = core_v2_statusMessage.Update(id, messageBody, { AttachedUrl: attachedUrlArg, GroupId: groupIdArg });

Parameters

Returns