Class CommandResponseExtensions

Namespace

Kentico.Xperience.Admin.Base

Assembly

Kentico.Xperience.Admin.Base.dll

Extensions for page command response.

public static class CommandResponseExtensions

Inheritance

object

CommandResponseExtensions

Methods

AddErrorMessage<TCommandResponse>(TCommandResponse, string)

Adds an error message to be displayed in the administration.

public static TCommandResponse AddErrorMessage<TCommandResponse>(this TCommandResponse commandResponse, string message) where TCommandResponse : ICommandResponse

Parameters

commandResponse TCommandResponse

Command response returned from page command.

message string

Message text to be displayed.

Returns

TCommandResponse

Type Parameters

TCommandResponse

AddErrorMessage<TCommandResponse>(TCommandResponse, string, bool)

Adds an error message to be displayed in the administration.

public static TCommandResponse AddErrorMessage<TCommandResponse>(this TCommandResponse commandResponse, string message, bool messageAsHtml) where TCommandResponse : ICommandResponse

Parameters

commandResponse TCommandResponse

Command response returned from page command.

message string

Message text to be displayed.

messageAsHtml bool

Indicates whether message contains HTML markup that should be rendered as HTML.

Returns

TCommandResponse

Type Parameters

TCommandResponse

AddInfoMessage<TCommandResponse>(TCommandResponse, string)

Adds an information message to be displayed in the administration.

public static TCommandResponse AddInfoMessage<TCommandResponse>(this TCommandResponse commandResponse, string message) where TCommandResponse : ICommandResponse

Parameters

commandResponse TCommandResponse

Command response returned from page command.

message string

Message text to be displayed.

Returns

TCommandResponse

Type Parameters

TCommandResponse

AddInfoMessage<TCommandResponse>(TCommandResponse, string, bool)

Adds an information message to be displayed in the administration.

public static TCommandResponse AddInfoMessage<TCommandResponse>(this TCommandResponse commandResponse, string message, bool messageAsHtml) where TCommandResponse : ICommandResponse

Parameters

commandResponse TCommandResponse

Command response returned from page command.

message string

Message text to be displayed.

messageAsHtml bool

Indicates whether message contains HTML markup that should be rendered as HTML.

Returns

TCommandResponse

Type Parameters

TCommandResponse

AddMessage<TCommandResponse>(TCommandResponse, string, CommandResponseMessageLevel)

Adds a message to the page command response to be displayed in the administration UI.

public static TCommandResponse AddMessage<TCommandResponse>(this TCommandResponse commandResponse, string message, CommandResponseMessageLevel messageLevel) where TCommandResponse : ICommandResponse

Parameters

commandResponse TCommandResponse

Command response returned from page command.

message string

Message text to be displayed.

messageLevel CommandResponseMessageLevel

Signifies the variant of the displayed message in the UI.

Returns

TCommandResponse

Type Parameters

TCommandResponse

AddMessage<TCommandResponse>(TCommandResponse, string, CommandResponseMessageLevel, bool)

Adds a message to the page command response to be displayed in the administration UI.

public static TCommandResponse AddMessage<TCommandResponse>(this TCommandResponse commandResponse, string message, CommandResponseMessageLevel messageLevel, bool messageAsHtml) where TCommandResponse : ICommandResponse

Parameters

commandResponse TCommandResponse

Command response returned from page command.

message string

Message text to be displayed.

messageLevel CommandResponseMessageLevel

Signifies the variant of the displayed message in the UI.

messageAsHtml bool

Indicates whether message contains HTML markup that should be rendered as HTML.

Returns

TCommandResponse

Type Parameters

TCommandResponse

AddSuccessMessage<TCommandResponse>(TCommandResponse, string)

Adds a success message to be displayed in the administration.

public static TCommandResponse AddSuccessMessage<TCommandResponse>(this TCommandResponse commandResponse, string message) where TCommandResponse : ICommandResponse

Parameters

commandResponse TCommandResponse

Command response returned from page command.

message string

Message text to be displayed.

Returns

TCommandResponse

Type Parameters

TCommandResponse

AddSuccessMessage<TCommandResponse>(TCommandResponse, string, bool)

Adds a success message to be displayed in the administration.

public static TCommandResponse AddSuccessMessage<TCommandResponse>(this TCommandResponse commandResponse, string message, bool messageAsHtml) where TCommandResponse : ICommandResponse

Parameters

commandResponse TCommandResponse

Command response returned from page command.

message string

Message text to be displayed.

messageAsHtml bool

Indicates whether message contains HTML markup that should be rendered as HTML.

Returns

TCommandResponse

Type Parameters

TCommandResponse

AddWarningMessage<TCommandResponse>(TCommandResponse, string)

Adds a warning message to be displayed in the administration.

public static TCommandResponse AddWarningMessage<TCommandResponse>(this TCommandResponse commandResponse, string message) where TCommandResponse : ICommandResponse

Parameters

commandResponse TCommandResponse

Command response returned from page command.

message string

Message text to be displayed.

Returns

TCommandResponse

Type Parameters

TCommandResponse

AddWarningMessage<TCommandResponse>(TCommandResponse, string, bool)

Adds a warning message to be displayed in the administration.

public static TCommandResponse AddWarningMessage<TCommandResponse>(this TCommandResponse commandResponse, string message, bool messageAsHtml) where TCommandResponse : ICommandResponse

Parameters

commandResponse TCommandResponse

Command response returned from page command.

message string

Message text to be displayed.

messageAsHtml bool

Indicates whether message contains HTML markup that should be rendered as HTML.

Returns

TCommandResponse

Type Parameters

TCommandResponse

UseCommand<TCommandResponse>(TCommandResponse, string)

Invokes specified command from the client template.

public static TCommandResponse UseCommand<TCommandResponse>(this TCommandResponse commandResponse, string commandName) where TCommandResponse : ICommandResponse

Parameters

commandResponse TCommandResponse

Command response returned from page command.

commandName string

Name of the command.

Returns

TCommandResponse

Type Parameters

TCommandResponse

See Also

ICommandResponse