Enables scripted content fragments to use StatusMessages
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
JavaScript
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
JavaScript
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
JavaScript
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 |
Returns
Delete
Deletes a status message
Velocity
JavaScript
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
messageId | Guid | Message Id | Required |
Returns
Get
Gets a status message
Velocity
JavaScript
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
messageId | Guid | Message Id | Required |
Returns
GetCount
Gets the count of status messages by an author.
Velocity
JavaScript
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
userId | Int32 | User Id | Required |
Returns
Int32
List
List Overload 1
Lists status messages
Velocity
JavaScript
List Overload 2
Lists status messages
Velocity
JavaScript
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 | 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
PreviewAttachment
PreviewAttachment Overload 1
Previews embedded or explicit attachments
Velocity
JavaScript
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
messageBody | String | Message Body | Required |
PreviewAttachment Overload 2
Previews embedded or explicit attachments
Velocity
JavaScript
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 |
Returns
String
Update
Updates an existing status message
Velocity
JavaScript
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
id | Guid | Id | Required | ||
messageBody | String | Message Body | Required | ||
AttachedUrl | String | URL to attach to this status message. When null, leaves unchanged. When empty, removes existing. | Optional | ||
GroupId | String | Group Id | Optional |