StatusMessages In-Process API Service

Ben Tiedt — Tue, 19 Nov 2019 20:04:41 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/19/2019 20:04:41

Work with status messages

This service is available via Telligent.Evolution.Extensibility.Apis.Get<Telligent.Evolution.Extensibility.Api.Version1.IStatusMessages>() and is defined in Telligent.Evolution.Platform.dll

Events

Events.AfterCreate

Handler

void StatusMessageAfterCreateEventHandler([[StatusMessageAfterCreateEventArgs In-Process API Event Argument|StatusMessageAfterCreateEventArgs]] e);

Events.AfterDelete

Handler

void StatusMessageAfterDeleteEventHandler([[StatusMessageAfterDeleteEventArgs In-Process API Event Argument|StatusMessageAfterDeleteEventArgs]] e);

Events.AfterUpdate

Handler

void StatusMessageAfterUpdateEventHandler([[StatusMessageAfterUpdateEventArgs In-Process API Event Argument|StatusMessageAfterUpdateEventArgs]] e);

Events.BeforeCreate

Handler

void StatusMessageBeforeCreateEventHandler([[StatusMessageBeforeCreateEventArgs In-Process API Event Argument|StatusMessageBeforeCreateEventArgs]] e);

Events.BeforeDelete

Handler

void StatusMessageBeforeDeleteEventHandler([[StatusMessageBeforeDeleteEventArgs In-Process API Event Argument|StatusMessageBeforeDeleteEventArgs]] e);

Events.BeforeUpdate

Handler

void StatusMessageBeforeUpdateEventHandler([[StatusMessageBeforeUpdateEventArgs In-Process API Event Argument|StatusMessageBeforeUpdateEventArgs]] e);

Events.Render

Handler

void StatusMessageRenderEventHandler([[StatusMessageRenderEventArgs In-Process API Event Argument|StatusMessageRenderEventArgs]] e);

Properties

Name	Type	Description	Default	Options
ContentTypeId	`Guid`	Content type Id

Methods

bool CanUpdate(Guid id);

Returns whether the accessing user can update a StatusMessage

Parameters

Name	Type	Description	Required	Default	Options
id	`Guid`	StatusMessage Id	Required

Return Type

bool

StatusMessage Create(string messageBody, StatusMessagesCreateOptions options = null);

Create StatusMessage

Parameters

Name	Type	Description	Required	Default	Options
messageBody	`string`	Message body	Required
options	`[[StatusMessagesCreateOptions In-Process API Supplementary Type\|StatusMessagesCreateOptions]]`	Status messages create options	Optional

Return Type

[[StatusMessage In-Process API Supplementary Type|StatusMessage]]

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

[[AdditionalInfo In-Process API Supplementary Type|AdditionalInfo]]

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

[[StatusMessage In-Process API Supplementary Type|StatusMessage]]

int GetCount(int userId);

Gets a count of status messages for an author.

Parameters

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

Return Type

int

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 In-Process API Supplementary Type\|StatusMessagesListOptions]]`	Status messages list get options	Optional

Return Type

[[ApiList(T) In-Process API Supplementary Type|ApiList]]<[[StatusMessage In-Process API Supplementary Type|StatusMessage]]>

string PreviewAttachment(string messageBody, StatusMessagesPreviewOptions options = null);

Preview attachment

Parameters

Name	Type	Description	Required	Default	Options
messageBody	`string`	Message body	Required
options	`[[StatusMessagesPreviewOptions In-Process API Supplementary Type\|StatusMessagesPreviewOptions]]`	Status messages preview options	Optional

Return Type

string

StatusMessage Update(Guid id, string messageBody, StatusMessagesUpdateOptions options = null);

Update StatusMessage

Parameters

Name	Type	Description	Required
id	`Guid`	Id	Required
messageBody	`string`	Message body	Required
options	`[[StatusMessagesUpdateOptions In-Process API Supplementary Type\|StatusMessagesUpdateOptions]]`	Status messages update options	Optional

Return Type

[[StatusMessage In-Process API Supplementary Type|StatusMessage]]