Workflow Engine .NET

Assembly: OptimaJet.Workflow.Core

Interface IBulkApi

OptimaJet.Workflow.Core.Runtime.Bulk.IBulkApi

API for executing WorkflowRuntime methods in bulk processing mode.

Namespace: OptimaJet.Workflow.Core.Runtime.Bulk

public interface IBulkApi

Properties

Name
Type
DefaultMaxDegreeOfParallelism #
Int32
Default value for
maxDegreeOfParallelism
parameter of Bulk Api methods.
DefaultThrowOnError #
Boolean
Default value for
throwOnError
parameter of Bulk Api methods.

Methods

Task<Dictionary<Guid, BulkTaskResult<Empty>>> CreateInstanceAsync(IEnumerable<CreateInstanceParams> createInstanceParams, EventHandler<BulkTaskFinalizedEventArgs<Guid, Empty>>? taskFinalizedHandler = null, int? maxDegreeOfParallelism = null, bool? throwOnError = null, CancellationToken cancellationToken = default) #
Executes WorkflowRuntime.CreateInstanceAsync(CreateInstanceParams, CancellationToken) for each of the specified createInstanceParams.

Parameters

Name
Type
Description
createInstanceParams
IEnumerable<CreateInstanceParams>
Collection of CreateInstanceParams for each process instance will be created.
taskFinalizedHandler
EventHandler<Empty>
Event handler invoked upon the completion of each individual task in the entire list. It takes the task's progress and intermediate result as arguments BulkTaskFinalizedEventArgs<TId, TResult>, allowing you to display a progress bar or perform other useful work during the execution of a bulk task.
maxDegreeOfParallelism
Nullable<Int32>
Maximum degree of parallelism that determines the maximum number of concurrently executing tasks in BulkApi methods.
throwOnError
Nullable<Boolean>
When set to true, if at least one task has been processed with an error, after all tasks are completed, an AggregateException will be thrown with a collection of all thrown exceptions.
cancellationToken
CancellationToken
Cancellation Token will be observed during the execution of tasks. If cancellation is requested, new tasks will stop being executed, while the waiting for already launched tasks will continue.

Returns

Type
Description
Task<Empty>
Dictionary with the results of the operation and the final state of each individual task, where the key is CreateInstanceParams.ProcessId.
Task<Dictionary<Guid, BulkTaskResult<Empty>>> CreateInstanceAsync(IEnumerable<Guid> processIds, string schemaCode, EventHandler<BulkTaskFinalizedEventArgs<Guid, Empty>>? taskFinalizedHandler = null, int? maxDegreeOfParallelism = null, bool? throwOnError = null, CancellationToken cancellationToken = default) #
Executes WorkflowRuntime.CreateInstanceAsync(string, Guid, CancellationToken) for each of the specified processIds.

Parameters

Name
Type
Description
processIds
IEnumerable<Guid>
Collection of process ids for each process instance will be created.
schemaCode
String
Schema code for which process instances will be created.
taskFinalizedHandler
EventHandler<Empty>
Event handler invoked upon the completion of each individual task in the entire list. It takes the task's progress and intermediate result as arguments BulkTaskFinalizedEventArgs<TId, TResult>, allowing you to display a progress bar or perform other useful work during the execution of a bulk task.
maxDegreeOfParallelism
Nullable<Int32>
Maximum degree of parallelism that determines the maximum number of concurrently executing tasks in BulkApi methods.
throwOnError
Nullable<Boolean>
When set to true, if at least one task has been processed with an error, after all tasks are completed, an AggregateException will be thrown with a collection of all thrown exceptions.
cancellationToken
CancellationToken
Cancellation Token will be observed during the execution of tasks. If cancellation is requested, new tasks will stop being executed, while the waiting for already launched tasks will continue.

Returns

Type
Description
Task<Empty>
Dictionary with the results of the operation and the final state of each individual task, where the keys are processIds items.
Task<Dictionary<Guid, BulkTaskResult<ProcessInstance>>> GetProcessInstanceAndFillProcessParametersAsync(IEnumerable<Guid> processIds, EventHandler<BulkTaskFinalizedEventArgs<Guid, ProcessInstance>>? taskFinalizedHandler = null, int? maxDegreeOfParallelism = null, bool? throwOnError = null, CancellationToken cancellationToken = default) #
Executes WorkflowRuntime.GetProcessInstanceAndFillProcessParametersAsync(Guid) for each of the specified processIds.

Parameters

Name
Type
Description
processIds
IEnumerable<Guid>
Collection of process ids for which process instance will be obtained.
taskFinalizedHandler
EventHandler<ProcessInstance>
Event handler invoked upon the completion of each individual task in the entire list. It takes the task's progress and intermediate result as arguments BulkTaskFinalizedEventArgs<TId, TResult>, allowing you to display a progress bar or perform other useful work during the execution of a bulk task.
maxDegreeOfParallelism
Nullable<Int32>
Maximum degree of parallelism that determines the maximum number of concurrently executing tasks in BulkApi methods.
throwOnError
Nullable<Boolean>
When set to true, if at least one task has been processed with an error, after all tasks are completed, an AggregateException will be thrown with a collection of all thrown exceptions.
cancellationToken
CancellationToken
Cancellation Token will be observed during the execution of tasks. If cancellation is requested, new tasks will stop being executed, while the waiting for already launched tasks will continue.

Returns

Type
Description
Task<ProcessInstance>
Dictionary with the results of the operation and the final state of each individual task, where the keys are processIds items.
Task<Dictionary<Guid, BulkTaskResult<ProcessInstancesTree>>> GetProcessInstancesTreeAsync(IEnumerable<Guid> rootProcessIds, EventHandler<BulkTaskFinalizedEventArgs<Guid, ProcessInstancesTree>>? taskFinalizedHandler = null, int? maxDegreeOfParallelism = null, bool? throwOnError = null, CancellationToken cancellationToken = default) #
Executes WorkflowRuntime.GetProcessInstancesTreeAsync(Guid, CancellationToken) for each of the specified rootProcessIds.

Parameters

Name
Type
Description
rootProcessIds
IEnumerable<Guid>
Collection of process ids for which process instance tree will be obtained.
taskFinalizedHandler
EventHandler<ProcessInstancesTree>
Event handler invoked upon the completion of each individual task in the entire list. It takes the task's progress and intermediate result as arguments BulkTaskFinalizedEventArgs<TId, TResult>, allowing you to display a progress bar or perform other useful work during the execution of a bulk task.
maxDegreeOfParallelism
Nullable<Int32>
Maximum degree of parallelism that determines the maximum number of concurrently executing tasks in BulkApi methods.
throwOnError
Nullable<Boolean>
When set to true, if at least one task has been processed with an error, after all tasks are completed, an AggregateException will be thrown with a collection of all thrown exceptions.
cancellationToken
CancellationToken
Cancellation Token will be observed during the execution of tasks. If cancellation is requested, new tasks will stop being executed, while the waiting for already launched tasks will continue.

Returns

Type
Description
Task<ProcessInstancesTree>
Dictionary with the results of the operation and the final state of each individual task, where the keys are rootProcessIds items.
Task<Dictionary<Guid, BulkTaskResult<ProcessInstancesTree>>> GetProcessInstancesTreeAsync(IEnumerable<ProcessInstance> processInstances, EventHandler<BulkTaskFinalizedEventArgs<Guid, ProcessInstancesTree>>? taskFinalizedHandler = null, int? maxDegreeOfParallelism = null, bool? throwOnError = null, CancellationToken cancellationToken = default) #
Executes WorkflowRuntime.GetProcessInstancesTreeAsync(ProcessInstance, CancellationToken) for each of the specified processInstances.

Parameters

Name
Type
Description
processInstances
IEnumerable<ProcessInstance>
Collection of process instances for which process instance tree will be obtained.
taskFinalizedHandler
EventHandler<ProcessInstancesTree>
Event handler invoked upon the completion of each individual task in the entire list. It takes the task's progress and intermediate result as arguments BulkTaskFinalizedEventArgs<TId, TResult>, allowing you to display a progress bar or perform other useful work during the execution of a bulk task.
maxDegreeOfParallelism
Nullable<Int32>
Maximum degree of parallelism that determines the maximum number of concurrently executing tasks in BulkApi methods.
throwOnError
Nullable<Boolean>
When set to true, if at least one task has been processed with an error, after all tasks are completed, an AggregateException will be thrown with a collection of all thrown exceptions.
cancellationToken
CancellationToken
Cancellation Token will be observed during the execution of tasks. If cancellation is requested, new tasks will stop being executed, while the waiting for already launched tasks will continue.

Returns

Type
Description
Task<ProcessInstancesTree>
Dictionary with the results of the operation and the final state of each individual task, where the key is the ProcessInstance.ProcessId.
Task<Dictionary<Guid, BulkTaskResult<List<WorkflowCommand>>>> GetAvailableCommandsAsync(IEnumerable<ProcessInstance> processInstances, IEnumerable<string> identityIds, string? commandNameFilter = null, string? mainIdentityId = null, CultureInfo? culture = null, bool conditionCheck = false, EventHandler<BulkTaskFinalizedEventArgs<Guid, List<WorkflowCommand>>>? taskFinalizedHandler = null, int? maxDegreeOfParallelism = null, bool? throwOnError = null, CancellationToken cancellationToken = default) #
Executes WorkflowRuntime.GetAvailableCommandsAsync(ProcessInstance, IEnumerable<string>, string, string, CultureInfo, bool, CancellationToken) for each of the specified processInstances.

Parameters

Name
Type
Description
processInstances
IEnumerable<ProcessInstance>
Collection of process instances for which the search for available commands will be performed.
identityIds
IEnumerable<String>
List of user IDs for which the initial commands list is formed.
commandNameFilter
String
Selects only the specified command if not null.
mainIdentityId
String
User ID for priority checking of rules.
culture
CultureInfo
Culture to localize command and command parameter names.
conditionCheck
Boolean
If true, commands with failed condition checks will be excluded.
taskFinalizedHandler
EventHandler<WorkflowCommand>
Event handler invoked upon the completion of each individual task in the entire list. It takes the task's progress and intermediate result as arguments BulkTaskFinalizedEventArgs<TId, TResult>, allowing you to display a progress bar or perform other useful work during the execution of a bulk task.
maxDegreeOfParallelism
Nullable<Int32>
Maximum degree of parallelism that determines the maximum number of concurrently executing tasks in BulkApi methods.
throwOnError
Nullable<Boolean>
When set to true, if at least one task has been processed with an error, after all tasks are completed, an AggregateException will be thrown with a collection of all thrown exceptions.
cancellationToken
CancellationToken
Cancellation Token will be observed during the execution of tasks. If cancellation is requested, new tasks will stop being executed, while the waiting for already launched tasks will continue.

Returns

Type
Description
Task<WorkflowCommand>
Dictionary with the results of the operation and the final state of each individual task, where the key is the ProcessInstance.ProcessId.
Task<Dictionary<Guid, BulkTaskResult<List<WorkflowCommand>>>> GetAvailableCommandsAsync(IEnumerable<ProcessInstance> processInstances, string identityId, EventHandler<BulkTaskFinalizedEventArgs<Guid, List<WorkflowCommand>>>? taskFinalizedHandler = null, int? maxDegreeOfParallelism = null, bool? throwOnError = null, CancellationToken cancellationToken = default) #
Executes WorkflowRuntime.GetAvailableCommandsAsync(ProcessInstance, IEnumerable<string>, string, string, CultureInfo, bool, CancellationToken) for each of the specified processInstances.

Parameters

Name
Type
Description
processInstances
IEnumerable<ProcessInstance>
Collection of process instances for which the search for available commands will be performed.
identityId
String
User IDs for whom the initial commands list is formed.
taskFinalizedHandler
EventHandler<WorkflowCommand>
Event handler invoked upon the completion of each individual task in the entire list. It takes the task's progress and intermediate result as arguments BulkTaskFinalizedEventArgs<TId, TResult>, allowing you to display a progress bar or perform other useful work during the execution of a bulk task.
maxDegreeOfParallelism
Nullable<Int32>
Maximum degree of parallelism that determines the maximum number of concurrently executing tasks in BulkApi methods.
throwOnError
Nullable<Boolean>
When set to true, if at least one task has been processed with an error, after all tasks are completed, an AggregateException will be thrown with a collection of all thrown exceptions.
cancellationToken
CancellationToken
Cancellation Token will be observed during the execution of tasks. If cancellation is requested, new tasks will stop being executed, while the waiting for already launched tasks will continue.

Returns

Type
Description
Task<WorkflowCommand>
Dictionary with the results of the operation and the final state of each individual task, where the key is the ProcessInstance.ProcessId.
Task<Dictionary<Guid, BulkTaskResult<List<WorkflowCommand>>>> GetAvailableCommandsAsync(IEnumerable<Guid> processIds, IEnumerable<string> identityIds, string? commandNameFilter = null, string? mainIdentityId = null, CultureInfo? culture = null, bool conditionCheck = false, EventHandler<BulkTaskFinalizedEventArgs<Guid, List<WorkflowCommand>>>? taskFinalizedHandler = null, int? maxDegreeOfParallelism = null, bool? throwOnError = null, CancellationToken cancellationToken = default) #
Executes WorkflowRuntime.GetAvailableCommandsAsync(Guid, IEnumerable<string>, string, string, CultureInfo, bool, CancellationToken) for each of the specified processIds.

Parameters

Name
Type
Description
processIds
IEnumerable<Guid>
Collection of process ids for which the search for available commands will be performed.
identityIds
IEnumerable<String>
List of user IDs for which the initial commands list is formed.
commandNameFilter
String
Selects only the specified command if not null.
mainIdentityId
String
User ID for priority checking of rules.
culture
CultureInfo
Culture to localize command and command parameter names.
conditionCheck
Boolean
If true, commands with failed condition checks will be excluded.
taskFinalizedHandler
EventHandler<WorkflowCommand>
Event handler invoked upon the completion of each individual task in the entire list. It takes the task's progress and intermediate result as arguments BulkTaskFinalizedEventArgs<TId, TResult>, allowing you to display a progress bar or perform other useful work during the execution of a bulk task.
maxDegreeOfParallelism
Nullable<Int32>
Maximum degree of parallelism that determines the maximum number of concurrently executing tasks in BulkApi methods.
throwOnError
Nullable<Boolean>
When set to true, if at least one task has been processed with an error, after all tasks are completed, an AggregateException will be thrown with a collection of all thrown exceptions.
cancellationToken
CancellationToken
Cancellation Token will be observed during the execution of tasks. If cancellation is requested, new tasks will stop being executed, while the waiting for already launched tasks will continue.

Returns

Type
Description
Task<WorkflowCommand>
Dictionary with the results of the operation and the final state of each individual task, where the keys are processIds items.
Task<Dictionary<Guid, BulkTaskResult<List<WorkflowCommand>>>> GetAvailableCommandsAsync(IEnumerable<Guid> processIds, string identityId, EventHandler<BulkTaskFinalizedEventArgs<Guid, List<WorkflowCommand>>>? taskFinalizedHandler = null, int? maxDegreeOfParallelism = null, bool? throwOnError = null, CancellationToken cancellationToken = default) #
Executes WorkflowRuntime.GetAvailableCommandsAsync(Guid, IEnumerable<string>, string, string, CultureInfo, bool, CancellationToken) for each of the specified processIds.

Parameters

Name
Type
Description
processIds
IEnumerable<Guid>
Collection of process ids for which the search for available commands will be performed.
identityId
String
User IDs for whom the initial commands list is formed.
taskFinalizedHandler
EventHandler<WorkflowCommand>
Event handler invoked upon the completion of each individual task in the entire list. It takes the task's progress and intermediate result as arguments BulkTaskFinalizedEventArgs<TId, TResult>, allowing you to display a progress bar or perform other useful work during the execution of a bulk task.
maxDegreeOfParallelism
Nullable<Int32>
Maximum degree of parallelism that determines the maximum number of concurrently executing tasks in BulkApi methods.
throwOnError
Nullable<Boolean>
When set to true, if at least one task has been processed with an error, after all tasks are completed, an AggregateException will be thrown with a collection of all thrown exceptions.
cancellationToken
CancellationToken
Cancellation Token will be observed during the execution of tasks. If cancellation is requested, new tasks will stop being executed, while the waiting for already launched tasks will continue.

Returns

Type
Description
Task<WorkflowCommand>
Dictionary with the results of the operation and the final state of each individual task, where the keys are processIds items.
Task<Dictionary<Guid, BulkTaskResult<List<WorkflowCommand>>>> GetAvailableCommandsAsync(IEnumerable<Guid> processIds, string identityId, CultureInfo culture, EventHandler<BulkTaskFinalizedEventArgs<Guid, List<WorkflowCommand>>>? taskFinalizedHandler = null, int? maxDegreeOfParallelism = null, bool? throwOnError = null, CancellationToken cancellationToken = default) #
Executes WorkflowRuntime.GetAvailableCommandsAsync(Guid, IEnumerable<string>, string, string, CultureInfo, bool, CancellationToken) for each of the specified processIds.

Parameters

Name
Type
Description
processIds
IEnumerable<Guid>
Collection of process ids for which the search for available commands will be performed.
identityId
String
User IDs for whom the initial commands list is formed.
culture
CultureInfo
Culture to localize command and command parameter names.
taskFinalizedHandler
EventHandler<WorkflowCommand>
Event handler invoked upon the completion of each individual task in the entire list. It takes the task's progress and intermediate result as arguments BulkTaskFinalizedEventArgs<TId, TResult>, allowing you to display a progress bar or perform other useful work during the execution of a bulk task.
maxDegreeOfParallelism
Nullable<Int32>
Maximum degree of parallelism that determines the maximum number of concurrently executing tasks in BulkApi methods.
throwOnError
Nullable<Boolean>
When set to true, if at least one task has been processed with an error, after all tasks are completed, an AggregateException will be thrown with a collection of all thrown exceptions.
cancellationToken
CancellationToken
Cancellation Token will be observed during the execution of tasks. If cancellation is requested, new tasks will stop being executed, while the waiting for already launched tasks will continue.

Returns

Type
Description
Task<WorkflowCommand>
Dictionary with the results of the operation and the final state of each individual task, where the keys are processIds items.
Task<Dictionary<Guid, BulkTaskResult<CommandExecutionResult>>> ExecuteCommandAsync(IEnumerable<WorkflowCommand> commands, string identityId, string impersonatedIdentityId, bool checkRestrictions = false, EventHandler<BulkTaskFinalizedEventArgs<Guid, CommandExecutionResult>>? taskFinalizedHandler = null, int? maxDegreeOfParallelism = null, bool? throwOnError = null, CancellationToken cancellationToken = default) #
Executes WorkflowRuntime.ExecuteCommandAsync(WorkflowCommand, string, string, CancellationToken, bool) for each of the specified commands commands.

Parameters

Name
Type
Description
commands
IEnumerable<WorkflowCommand>
A collection of commands for which the command execution will be performed.
identityId
String
The user ID that initiates the command execution.
impersonatedIdentityId
String
The user ID on whose behalf the command is executed (impersonation).
checkRestrictions
Boolean
If set to true, actor restriction check will be performed for every transition.
taskFinalizedHandler
EventHandler<CommandExecutionResult>
Event handler invoked upon the completion of each individual task in the entire list. It takes the task's progress and intermediate result as arguments BulkTaskFinalizedEventArgs<TId, TResult>, allowing you to display a progress bar or perform other useful work during the execution of a bulk task.
maxDegreeOfParallelism
Nullable<Int32>
Maximum degree of parallelism that determines the maximum number of concurrently executing tasks in BulkApi methods.
throwOnError
Nullable<Boolean>
When set to true, if at least one task has been processed with an error, after all tasks are completed, an AggregateException will be thrown with a collection of all thrown exceptions.
cancellationToken
CancellationToken
Cancellation Token will be observed during the execution of tasks. If cancellation is requested, new tasks will stop being executed, while the waiting for already launched tasks will continue.

Returns

Type
Description
Task<CommandExecutionResult>
Dictionary with the results of the operation and the final state of each individual task, where the key is the WorkflowCommand.ProcessId.
Task<Dictionary<Guid, BulkTaskResult<CommandExecutionResult>>> ExecuteCommandWithRestrictionCheckAsync(IEnumerable<WorkflowCommand> commands, string identityId, string impersonatedIdentityId, EventHandler<BulkTaskFinalizedEventArgs<Guid, CommandExecutionResult>>? taskFinalizedHandler = null, int? maxDegreeOfParallelism = null, bool? throwOnError = null, CancellationToken cancellationToken = default) #
Executes WorkflowRuntime.ExecuteCommandWithRestrictionCheckAsync(WorkflowCommand, string, string, CancellationToken) for each of the specified commands commands.

Parameters

Name
Type
Description
commands
IEnumerable<WorkflowCommand>
A collection of commands for which the command execution will be performed.
identityId
String
The user ID that initiates the command execution.
impersonatedIdentityId
String
The user ID on whose behalf the command is executed (impersonation).
taskFinalizedHandler
EventHandler<CommandExecutionResult>
Event handler invoked upon the completion of each individual task in the entire list. It takes the task's progress and intermediate result as arguments BulkTaskFinalizedEventArgs<TId, TResult>, allowing you to display a progress bar or perform other useful work during the execution of a bulk task.
maxDegreeOfParallelism
Nullable<Int32>
Maximum degree of parallelism that determines the maximum number of concurrently executing tasks in BulkApi methods.
throwOnError
Nullable<Boolean>
When set to true, if at least one task has been processed with an error, after all tasks are completed, an AggregateException will be thrown with a collection of all thrown exceptions.
cancellationToken
CancellationToken
Cancellation Token will be observed during the execution of tasks. If cancellation is requested, new tasks will stop being executed, while the waiting for already launched tasks will continue.

Returns

Type
Description
Task<CommandExecutionResult>
Dictionary with the results of the operation and the final state of each individual task, where the key is the WorkflowCommand.ProcessId.
Task<Dictionary<Guid, BulkTaskResult<Empty>>> UpdateSchemeIfObsoleteAsync(List<Guid> processIds, bool ignoreAutoSchemeUpdate, EventHandler<BulkTaskFinalizedEventArgs<Guid, Empty>>? taskFinalizedHandler = null, int? maxDegreeOfParallelism = null, bool? throwOnError = null, CancellationToken cancellationToken = default) #
Executes WorkflowRuntime.UpdateSchemeIfObsoleteAsync(Guid, bool) for each of the specified processIds.

Parameters

Name
Type
Description
processIds
List<Guid>
Collection of process ids for which scheme update will be performed.
ignoreAutoSchemeUpdate
Boolean
If set to true, the attribute of the Activity — IsAutoScheme update will be ignored.
taskFinalizedHandler
EventHandler<Empty>
Event handler invoked upon the completion of each individual task in the entire list. It takes the task's progress and intermediate result as arguments BulkTaskFinalizedEventArgs<TId, TResult>, allowing you to display a progress bar or perform other useful work during the execution of a bulk task.
maxDegreeOfParallelism
Nullable<Int32>
Maximum degree of parallelism that determines the maximum number of concurrently executing tasks in BulkApi methods.
throwOnError
Nullable<Boolean>
When set to true, if at least one task has been processed with an error, after all tasks are completed, an AggregateException will be thrown with a collection of all thrown exceptions.
cancellationToken
CancellationToken
Cancellation Token will be observed during the execution of tasks. If cancellation is requested, new tasks will stop being executed, while the waiting for already launched tasks will continue.

Returns

Type
Description
Task<Empty>
Dictionary with the results of the operation and the final state of each individual task, where the keys are processIds items.
Task<Dictionary<Guid, BulkTaskResult<Empty>>> UpdateSchemeIfObsoleteAsync(List<Guid> processIds, EventHandler<BulkTaskFinalizedEventArgs<Guid, Empty>>? taskFinalizedHandler = null, int? maxDegreeOfParallelism = null, bool? throwOnError = null, CancellationToken cancellationToken = default) #
Executes WorkflowRuntime.UpdateSchemeIfObsoleteAsync(Guid) for each of the specified processIds.

Parameters

Name
Type
Description
processIds
List<Guid>
Collection of process ids for which scheme update will be performed.
taskFinalizedHandler
EventHandler<Empty>
Event handler invoked upon the completion of each individual task in the entire list. It takes the task's progress and intermediate result as arguments BulkTaskFinalizedEventArgs<TId, TResult>, allowing you to display a progress bar or perform other useful work during the execution of a bulk task.
maxDegreeOfParallelism
Nullable<Int32>
Maximum degree of parallelism that determines the maximum number of concurrently executing tasks in BulkApi methods.
throwOnError
Nullable<Boolean>
When set to true, if at least one task has been processed with an error, after all tasks are completed, an AggregateException will be thrown with a collection of all thrown exceptions.
cancellationToken
CancellationToken
Cancellation Token will be observed during the execution of tasks. If cancellation is requested, new tasks will stop being executed, while the waiting for already launched tasks will continue.

Returns

Type
Description
Task<Empty>
Dictionary with the results of the operation and the final state of each individual task, where the keys are processIds items.
Task<Dictionary<Guid, BulkTaskResult<Empty>>> DeleteInstanceAsync(List<Guid> processIds, EventHandler<BulkTaskFinalizedEventArgs<Guid, Empty>>? taskFinalizedHandler = null, int? maxDegreeOfParallelism = null, bool? throwOnError = null, CancellationToken cancellationToken = default) #
Executes WorkflowRuntime.DeleteInstanceAsync(Guid) for each of the specified processIds.

Parameters

Name
Type
Description
processIds
List<Guid>
Collection of process IDs for which the process instance will be deleted.
taskFinalizedHandler
EventHandler<Empty>
Event handler invoked upon the completion of each individual task in the entire list. It takes the task's progress and intermediate result as arguments BulkTaskFinalizedEventArgs<TId, TResult>, allowing you to display a progress bar or perform other useful work during the execution of a bulk task.
maxDegreeOfParallelism
Nullable<Int32>
Maximum degree of parallelism that determines the maximum number of concurrently executing tasks in BulkApi methods.
throwOnError
Nullable<Boolean>
When set to true, if at least one task has been processed with an error, after all tasks are completed, an AggregateException will be thrown with a collection of all thrown exceptions.
cancellationToken
CancellationToken
Cancellation Token will be observed during the execution of tasks. If cancellation is requested, new tasks will stop being executed, while the waiting for already launched tasks will continue.

Returns

Type
Description
Task<Empty>
Dictionary with the results of the operation and the final state of each individual task, where the keys are processIds items.
Task<Dictionary<Guid, BulkTaskResult<bool>>> IsProcessExistsAsync(List<Guid> processIds, EventHandler<BulkTaskFinalizedEventArgs<Guid, bool>>? taskFinalizedHandler = null, int? maxDegreeOfParallelism = null, bool? throwOnError = null, CancellationToken cancellationToken = default) #
Executes WorkflowRuntime.IsProcessExistsAsync(Guid) for each of the specified processIds.

Parameters

Name
Type
Description
processIds
List<Guid>
Collection of process ids to be checked for existence.
taskFinalizedHandler
EventHandler<Boolean>
Event handler invoked upon the completion of each individual task in the entire list. It takes the task's progress and intermediate result as arguments BulkTaskFinalizedEventArgs<TId, TResult>, allowing you to display a progress bar or perform other useful work during the execution of a bulk task.
maxDegreeOfParallelism
Nullable<Int32>
Maximum degree of parallelism that determines the maximum number of concurrently executing tasks in BulkApi methods.
throwOnError
Nullable<Boolean>
When set to true, if at least one task has been processed with an error, after all tasks are completed, an AggregateException will be thrown with a collection of all thrown exceptions.
cancellationToken
CancellationToken
Cancellation Token will be observed during the execution of tasks. If cancellation is requested, new tasks will stop being executed, while the waiting for already launched tasks will continue.

Returns

Type
Description
Task<Boolean>
Dictionary with the results of the operation and the final state of each individual task, where the keys are processIds items.