Class WorkflowSteps

Namespace

Kentico.Xperience.Admin.Base.UIPages

Assembly

Kentico.Xperience.Admin.Base.dll

Workflow steps page.

public sealed class WorkflowSteps : Page<WorkflowStepsTemplateClientProperties>, IPage

Inheritance

object

Page<WorkflowStepsTemplateClientProperties>

WorkflowSteps

Implements

IPage

Inherited Members

Page<WorkflowStepsTemplateClientProperties>.ConfigurePage()

Page<WorkflowStepsTemplateClientProperties>.ValidatePage()

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

WorkflowSteps(IInfoProvider<ContentWorkflowStepInfo>, IEventLogService, IUIPermissionEvaluator, IWorkflowUsageTracker, IFormDataBinder)

Creates a new instance of WorkflowSteps.

public WorkflowSteps(IInfoProvider<ContentWorkflowStepInfo> workflowStepProvider, IEventLogService eventLogService, IUIPermissionEvaluator permissionEvaluator, IWorkflowUsageTracker workflowUsageTracker, IFormDataBinder formDataBinder)

Parameters

workflowStepProvider IInfoProvider<ContentWorkflowStepInfo>

eventLogService IEventLogService

permissionEvaluator IUIPermissionEvaluator

workflowUsageTracker IWorkflowUsageTracker

formDataBinder IFormDataBinder

Fields

SLUG

URL slug of the page.

public const string SLUG = "steps"

Field Value

string

Properties

WorkflowId

Identifier of the workflow the steps belong to.

[PageParameter(typeof(IntPageModelBinder))]
public int WorkflowId { get; set; }

Property Value

int

Methods

ComponentCommand(FormComponentCommandModel, CancellationToken)

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

Parameters

commandModel FormComponentCommandModel

cancellationToken CancellationToken

Returns

Task<object>

ConfigureTemplateProperties(WorkflowStepsTemplateClientProperties)

Gets the object representing client side template properties.

public override Task<WorkflowStepsTemplateClientProperties> ConfigureTemplateProperties(WorkflowStepsTemplateClientProperties properties)

Parameters

properties WorkflowStepsTemplateClientProperties

Initialized properties object.

Returns

Task<WorkflowStepsTemplateClientProperties>

CreateStep(CreateStepCommandArguments)

Creates a new workflow step.

[PageCommand(Permission = "Update")]
public Task<ICommandResponse<UpdateStepCommandResult>> CreateStep(CreateStepCommandArguments arguments)

Parameters

arguments CreateStepCommandArguments

Command arguments.

Returns

Task<ICommandResponse<UpdateStepCommandResult>>

CreateStepFormChange(FormChangeCommandArguments, CancellationToken)

Handles the create step form change command. The command is invoked whenever visibility conditions of the form need to be reevaluated to re-render the form.

[PageCommand(Permission = "Update")]
public Task<ICommandResponse<FormChangeResult>> CreateStepFormChange(FormChangeCommandArguments args, CancellationToken cancellationToken)

Parameters

args FormChangeCommandArguments

Form change arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse<FormChangeResult>>

DeleteStep(DeleteStepCommandArguments)

Deletes the workflow step specified by arguments.

[PageCommand(Permission = "Update")]
public Task<ICommandResponse> DeleteStep(DeleteStepCommandArguments arguments)

Parameters

arguments DeleteStepCommandArguments

Command arguments.

Returns

Task<ICommandResponse>

EditStepFormChange(EditStepFormChangeCommandArguments, CancellationToken)

Handles the edit step form change command. The command is invoked whenever visibility conditions of the form need to be reevaluated to re-render the form.

[PageCommand(Permission = "Update")]
public Task<ICommandResponse<FormChangeResult>> EditStepFormChange(EditStepFormChangeCommandArguments args, CancellationToken cancellationToken)

Parameters

args EditStepFormChangeCommandArguments

Form change arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse<FormChangeResult>>

GetEmptyForm()

Returns an empty step create form.

[PageCommand(Permission = "Update")]
public Task<ICommandResponse<WorkflowStepForm>> GetEmptyForm()

Returns

Task<ICommandResponse<WorkflowStepForm>>

GetStepDetail(GetStepDetailArguments, CancellationToken)

Gets the properties of form components for the Form.tsx component.

[PageCommand(Permission = "View")]
public Task<ICommandResponse<WorkflowStepForm>> GetStepDetail(GetStepDetailArguments args, CancellationToken cancellationToken = default)

Parameters

args GetStepDetailArguments

Command arguments.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse<WorkflowStepForm>>

GetSteps(CancellationToken)

Returns steps data for displaying collapsed bar items.

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

Parameters

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ICommandResponse<GetStepsCommandResult>>

MoveStep(MoveStepCommandArguments)

Moves the workflow step.

[PageCommand(Permission = "Update")]
public Task<ICommandResponse<bool>> MoveStep(MoveStepCommandArguments arguments)

Parameters

arguments MoveStepCommandArguments

Command arguments.

Returns

Task<ICommandResponse<bool>>

UpdateStep(UpdateStepCommandArguments)

Updates the workflow step specified by args.

[PageCommand(Permission = "Update")]
public Task<ICommandResponse<UpdateStepCommandResult>> UpdateStep(UpdateStepCommandArguments args)

Parameters

args UpdateStepCommandArguments

Update step command arguments.

Returns

Task<ICommandResponse<UpdateStepCommandResult>>

Exceptions

InvalidOperationException

Throws when StepId doesn't represent any valid workflow step.