IUserRenderableMessage
is defined in the Telligent.Evolution.Extensibility.Version1
namespace of Telligent.Evolution.Platform.dll
Definition
interface IUserRenderableMessage : IPlugin { string Description { get; } HttpStatusCode HttpStatusCode { get; } Guid Id { get; } string Name { get; } string GetMessageBodyHtml(UserRenderableMessageRenderOptions options); string GetMessageNameHtml(UserRenderableMessageRenderOptions options); string GetMessageText(UserRenderableMessageTextRenderOptions options); }
Properties
Name | Type | Description | Default | Options |
---|---|---|---|---|
Description | string | The description of the message type | ||
HttpStatusCode | HttpStatusCode | The status code that should be returned for the message. | ||
Id | Guid | A Guid that represents the type of the exception. This value is set by the developer. | ||
Name | string | The name of the message type |
Methods
string GetMessageBodyHtml(UserRenderableMessageRenderOptions options);
Returns the HTML description of the message.
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
options | UserRenderableMessageRenderOptions | Options | Required |
Return Type
string
string GetMessageNameHtml(UserRenderableMessageRenderOptions options);
Returns the HTML title of the message.
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
options | UserRenderableMessageRenderOptions | Options | Required |
Return Type
string
string GetMessageText(UserRenderableMessageTextRenderOptions options);
Returns the Text description of the message.
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
options | UserRenderableMessageTextRenderOptions | Options | Required |
Return Type
string