core_v2_statusMessage Script API

Ben Tiedt — Fri, 23 Apr 2021 19:54:25 GMT

Current Revision posted to API Documentation by Ben Tiedt on 04/23/2021 19:54:25

Enables scripted content fragments to use StatusMessages

Properties
CanUpdate
Create
Delete
Get
GetCount
List
PreviewAttachment
Update

Properties

Name	Access	Type	Description
ContentTypeId	Read	`Guid`	Status messages content type identifier
StoryTypeId	Read	`Guid`	Story Type Id

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

Name	Type	Description	Required	Default	Options
messageId	`Guid`	Message Id	Required

Returns

Boolean

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

Name	Type	Description	Required	Default	Options
messageBody	`String`	Message Body	Required

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

Name	Type	Description	Required
messageBody	`String`	Message Body	Required
options	Options	Set of optional parameters including:	Required
AttachedUrl	`String`	URL to attach to this status message	Optional
GroupId	`String`	Group Id	Optional

Returns

[[StatusMessage Script API Type|StatusMessage]]

Delete

Deletes a status message

Velocity

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

JavaScript

var additionalInfoResponse = core_v2_statusMessage.Delete(messageId);

Parameters

Name	Type	Description	Required	Default	Options
messageId	`Guid`	Message Id	Required

Returns

[[AdditionalInfo Script API Type|AdditionalInfo]]

Get

Gets a status message

Velocity

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

JavaScript

var statusMessageResponse = core_v2_statusMessage.Get(messageId);

Parameters

Name	Type	Description	Required	Default	Options
messageId	`Guid`	Message Id	Required

Returns

[[StatusMessage Script API Type|StatusMessage]]

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

Name	Type	Description	Required	Default	Options
userId	`Int32`	User Id	Required

Returns

Int32

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

Name	Type	Description	Required	Default	Options
options	Options	Set of optional parameters including:	Required
AfterDate	`DateTime`	Retrieve status messages posted after the date specified	Optional
BeforeDate	`DateTime`	Specify BeforeDate to only retrieve activity messages posted from that date and before	Optional
GroupId	`Int32`	Optional to return group messages.	Optional
Include	`String`	Comma-separated list	Optional		following, groups, replies
PageSize	`Int32`	Specify the number of results to return per page.	Optional	20
UserId	`Int32`	Either the UserId or Username is required	Optional
Username	`String`	Either the UserId or Username is required	Optional

Returns

[[ApiList Script API Type|ApiList]] of [[StatusMessage Script API Type|StatusMessage]]

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

Name	Type	Description	Required	Default	Options
messageBody	`String`	Message Body	Required

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

Name	Type	Description	Required
messageBody	`String`	Message Body	Required
options	Options	Set of optional parameters including:	Required
AttachedUrl	`String`	URL to attach to this status message	Optional
GroupId	`String`	Group Id	Optional

Returns

String

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

Name	Type	Description	Required
id	`Guid`	Id	Required
messageBody	`String`	Message Body	Required
options	Options	Set of optional parameters including:	Required
AttachedUrl	`String`	URL to attach to this status message. When null, leaves unchanged. When empty, removes existing.	Optional
GroupId	`String`	Group Id	Optional

Returns

[[StatusMessage Script API Type|StatusMessage]]