Enables scripted content fragments to use StatusMessages
Properties
Name | Type | Description | Default | Options |
---|---|---|---|---|
ContentTypeId | Guid | Status messages content type identifier | ||
StoryTypeId | Guid |
Methods
Create
Creates a new status message by the accessing user
Usage
#set($statusMessageResponse = $core_v2_statusMessage.Create($messageBody))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
messageBody | string | Message Body | Required |
Return Type
Create
Creates a new status message by the accessing user
Usage
#set($statusMessageResponse = $core_v2_statusMessage.Create($messageBody, "%{AttachedUrl = $attachedUrlArg, GroupId = $groupIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
messageBody | string | Message Body | Required | ||
AttachedUrl | string | URL to attach to this status message | Optional | ||
GroupId | string | Group Id | Optional |
Return Type
Delete
Deletes a status message
Usage
#set($additionalInfoResponse = $core_v2_statusMessage.Delete($messageId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
messageId | Guid | Message Id | Required |
Return Type
Get
Gets a status message
Usage
#set($statusMessageResponse = $core_v2_statusMessage.Get($messageId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
messageId | Guid | Message Id | Required |
Return Type
List
Lists status messages
Usage
#set($apiListResponse = $core_v2_statusMessage.List())
Return Type
List
Lists status messages
Usage
#set($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 |
---|---|---|---|---|---|
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 | int | Optional to return group messages. | Optional | ||
Include | string | Comma-separated list | Optional | following, groups, replies | |
PageSize | int | Specify the number of results to return per page. | Optional | 20 | |
UserId | int | Either the UserId or Username is required | Optional | ||
Username | string | Either the UserId or Username is required | Optional |
Return Type
PreviewAttachment
Previews embedded or explicit attachments
Usage
#set($stringResponse = $core_v2_statusMessage.PreviewAttachment($messageBody))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
messageBody | string | Message Body | Required |
Return Type
string
PreviewAttachment
Previews embedded or explicit attachments
Usage
#set($stringResponse = $core_v2_statusMessage.PreviewAttachment($messageBody, "%{AttachedUrl = $attachedUrlArg, GroupId = $groupIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
messageBody | string | Message Body | Required | ||
AttachedUrl | string | URL to attach to this status message | Optional | ||
GroupId | string | Group Id | Optional |
Return Type
string