Work with status messages
This service is available via and is defined in Telligent.Evolution.Platform.dll
Events
Events.AfterCreate
Handler
void StatusMessageAfterCreateEventHandler(StatusMessageAfterCreateEventArgs e);
Events.AfterDelete
Handler
void StatusMessageAfterDeleteEventHandler(StatusMessageAfterDeleteEventArgs e);
Events.AfterUpdate
Handler
void StatusMessageAfterUpdateEventHandler(StatusMessageAfterUpdateEventArgs e);
Events.BeforeCreate
Handler
void StatusMessageBeforeCreateEventHandler(StatusMessageBeforeCreateEventArgs e);
Events.BeforeDelete
Handler
void StatusMessageBeforeDeleteEventHandler(StatusMessageBeforeDeleteEventArgs e);
Events.BeforeUpdate
Handler
void StatusMessageBeforeUpdateEventHandler(StatusMessageBeforeUpdateEventArgs e);
Events.Render
Handler
void StatusMessageRenderEventHandler(StatusMessageRenderEventArgs e);
Methods
StatusMessage Create(string messageBody, StatusMessagesCreateOptions options = null);
Create StatusMessage
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
messageBody | string | Message body | Required | ||
options | StatusMessagesCreateOptions | Status messages create options | Optional |
Return Type
AdditionalInfo Delete(Guid messageId);
Delete a status message
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
messageId | Guid | The ID of the message you want to delete | Required |
Return Type
StatusMessage Get(Guid messageId);
Get status message with a specific message ID
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
messageId | Guid | Message Id | Required |
Return Type
ApiList<StatusMessage> List(StatusMessagesListOptions options = null);
Get a list of status messages. Paging is done through date ranges instead of a page index. This is partly due to status messages being created so quickly, where going to page index 2 may not give you what you would expect.
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
options | StatusMessagesListOptions | Status messages list get options | Optional |
Return Type
string PreviewAttachment(string messageBody, StatusMessagesPreviewOptions options = null);
Preview attachment
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
messageBody | string | Message body | Required | ||
options | StatusMessagesPreviewOptions | Status messages preview options | Optional |
Return Type
string