Class OrderStatusesOverview

Namespace

Kentico.Xperience.Admin.DigitalCommerce.UIPages

Assembly

Kentico.Xperience.Admin.DigitalCommerce.dll

Order status overview page.

[UIPermission("View", null)]
public sealed class OrderStatusesOverview : Page<OrderStatusTemplateClientProperties>, IPage

Inheritance

object

Page<OrderStatusTemplateClientProperties>

OrderStatusesOverview

Implements

IPage

Inherited Members

Page<OrderStatusTemplateClientProperties>.ConfigurePage()

Page<OrderStatusTemplateClientProperties>.ValidatePage()

Extension Methods

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

OrderStatusesOverview(IInfoProvider<OrderInfo>, IInfoProvider<OrderStatusInfo>, IInfoProvider<OrderStatusNotificationInfo>, IInfoProvider<UserRoleInfo>, IFormComponentCommandInvoker, IUIPermissionEvaluator, IEventLogService)

Initializes a new instance of the OrderStatusesOverview class.

public OrderStatusesOverview(IInfoProvider<OrderInfo> orderInfoProvider, IInfoProvider<OrderStatusInfo> orderStatusInfoProvider, IInfoProvider<OrderStatusNotificationInfo> orderStatusNotificationInfoProvider, IInfoProvider<UserRoleInfo> userRoleInfoProvider, IFormComponentCommandInvoker formComponentCommandInvoker, IUIPermissionEvaluator permissionEvaluator, IEventLogService eventLogService)

Parameters

orderInfoProvider IInfoProvider<OrderInfo>

orderStatusInfoProvider IInfoProvider<OrderStatusInfo>

orderStatusNotificationInfoProvider IInfoProvider<OrderStatusNotificationInfo>

userRoleInfoProvider IInfoProvider<UserRoleInfo>

formComponentCommandInvoker IFormComponentCommandInvoker

permissionEvaluator IUIPermissionEvaluator

eventLogService IEventLogService

Methods

ComponentCommand(FormComponentCommandModel, CancellationToken)

Handles the form component command invocation.

[PageCommand]
public Task<object> ComponentCommand(FormComponentCommandModel commandModel, CancellationToken cancellationToken)

Parameters

commandModel FormComponentCommandModel

Form component command arguments.

cancellationToken CancellationToken

Cancellation instruction.

Returns

Task<object>

Returns the form component command result.

ConfigureTemplateProperties(OrderStatusTemplateClientProperties)

Gets the object representing client side template properties.

public override Task<OrderStatusTemplateClientProperties> ConfigureTemplateProperties(OrderStatusTemplateClientProperties properties)

Parameters

properties OrderStatusTemplateClientProperties

Initialized properties object.

Returns

Task<OrderStatusTemplateClientProperties>

CreateNewStatus(CreateStatusCommandArguments, CancellationToken)

Create new order status.

[PageCommand(Permission = "Create")]
public Task<ICommandResponse> CreateNewStatus(CreateStatusCommandArguments arguments, CancellationToken cancellationToken)

Parameters

arguments CreateStatusCommandArguments

cancellationToken CancellationToken

Returns

Task<ICommandResponse>

DeleteStatus(DeleteStatusCommandArgument, CancellationToken)

Delete order status.

[PageCommand(Permission = "Delete")]
public Task<ICommandResponse> DeleteStatus(DeleteStatusCommandArgument arguments, CancellationToken cancellationToken)

Parameters

arguments DeleteStatusCommandArgument

cancellationToken CancellationToken

Returns

Task<ICommandResponse>

FormChange(StatusFormChangeCommandArguments, CancellationToken)

Gets the properties of form components for order statuses component editing a single form field after change of internal notification.

[PageCommand(Permission = "View")]
public Task<ICommandResponse> FormChange(StatusFormChangeCommandArguments arguments, CancellationToken cancellationToken)

Parameters

arguments StatusFormChangeCommandArguments

cancellationToken CancellationToken

Returns

Task<ICommandResponse>

GetEmptyStatus(CancellationToken)

Gets the properties of form components for empty order statuses component editing a single form field.

[PageCommand(Permission = "View")]
public Task<ICommandResponse> GetEmptyStatus(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Returns

Task<ICommandResponse>

GetStatusDetail(GetStatusDetailCommandArguments, CancellationToken)

Gets the properties of form components for the order statuses component editing a single form field.

[PageCommand(Permission = "View")]
public Task<ICommandResponse> GetStatusDetail(GetStatusDetailCommandArguments arguments, CancellationToken cancellationToken)

Parameters

arguments GetStatusDetailCommandArguments

cancellationToken CancellationToken

Returns

Task<ICommandResponse>

GetStatuses(CancellationToken)

Gets collection of all statuses from database.

[PageCommand(Permission = "View")]
public Task<ICommandResponse> GetStatuses(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Returns

Task<ICommandResponse>

MoveStatus(MoveStatusArguments, CancellationToken)

Change order of statuses.

[PageCommand(Permission = "Update")]
public Task<ICommandResponse<bool>> MoveStatus(MoveStatusArguments arguments, CancellationToken cancellationToken)

Parameters

arguments MoveStatusArguments

cancellationToken CancellationToken

Returns

Task<ICommandResponse<bool>>

UpdateStatus(UpdateStatusCommandArguments, CancellationToken)

Update order status data.

[PageCommand(Permission = "Update")]
public Task<ICommandResponse> UpdateStatus(UpdateStatusCommandArguments arguments, CancellationToken cancellationToken)

Parameters

arguments UpdateStatusCommandArguments

cancellationToken CancellationToken

Returns

Task<ICommandResponse>