Table of Contents

Interface IFlowVariableService

Namespace
CMS.Plugin.FlowManagement.Abstractions
Assembly
CMS.Plugin.FlowManagement.Abstractions.dll

流程变量服务

public interface IFlowVariableService

Methods

ReadValueAsync(Activity, IReadOnlyList<string>, int, int, Guid?)

Reads the value asynchronous.

Task<IReadOnlyDictionary<string, IVariableValue?>> ReadValueAsync(Activity currentActivity, IReadOnlyList<string> varNames, int readRetryCount = 0, int readRetryDelay = 0, Guid? traceId = null)

Parameters

currentActivity Activity
varNames IReadOnlyList<string>

The variable names.

readRetryCount int

The read retry count.

readRetryDelay int

The read retry delay.

traceId Guid?

The trace identifier.

Returns

Task<IReadOnlyDictionary<string, IVariableValue>>

ReadValueAsync(Activity, string, int, int, Guid?)

Reads the value asynchronous.

Task<IVariableValue?> ReadValueAsync(Activity currentActivity, string varName, int readRetryCount = 0, int readRetryDelay = 0, Guid? traceId = null)

Parameters

currentActivity Activity
varName string

Name of the variable.

readRetryCount int

The read retry count.

readRetryDelay int

The read retry delay.

traceId Guid?

The trace identifier.

Returns

Task<IVariableValue>

ReadValueAsync(IReadOnlyList<string>, int, int, Guid?)

Reads the value asynchronous.

Task<IReadOnlyDictionary<string, IVariableValue?>> ReadValueAsync(IReadOnlyList<string> varNames, int readRetryCount = 0, int readRetryDelay = 0, Guid? traceId = null)

Parameters

varNames IReadOnlyList<string>

The variable names.

readRetryCount int

The read retry count.

readRetryDelay int

The read retry delay.

traceId Guid?

The trace identifier.

Returns

Task<IReadOnlyDictionary<string, IVariableValue>>

ReadValueAsync(string, int, int, Guid?)

Reads the value asynchronous.

Task<IVariableValue?> ReadValueAsync(string varName, int readRetryCount = 0, int readRetryDelay = 0, Guid? traceId = null)

Parameters

varName string

Name of the variable.

readRetryCount int

The read retry count.

readRetryDelay int

The read retry delay.

traceId Guid?

The trace identifier.

Returns

Task<IVariableValue>

WriteValueAsync(Activity, Dictionary<string, object?>, int, int, Guid?)

Writes the value asynchronous.

Task WriteValueAsync(Activity currentActivity, Dictionary<string, object?> valueMaps, int writeRetryCount = 0, int writeRetryDelay = 0, Guid? traceId = null)

Parameters

currentActivity Activity

The current activity.

valueMaps Dictionary<string, object>

The value maps.

writeRetryCount int

The write retry count.

writeRetryDelay int

The write retry delay.

traceId Guid?

The trace identifier.

Returns

Task

WriteValueAsync(Activity, Dictionary<string, object?>, CancellationToken, int, int, Guid?)

Writes the value asynchronous.

Task WriteValueAsync(Activity currentActivity, Dictionary<string, object?> valueMaps, CancellationToken cancellationToken, int writeRetryCount = 0, int writeRetryDelay = 0, Guid? traceId = null)

Parameters

currentActivity Activity

The current activity.

valueMaps Dictionary<string, object>

The value maps.

cancellationToken CancellationToken

The cancellation token.

writeRetryCount int

The write retry count.

writeRetryDelay int

The write retry delay.

traceId Guid?

The trace identifier.

Returns

Task

WriteValueAsync(Activity, string, object, CancellationToken, int, int, Guid?)

Writes the value asynchronous.

Task<bool> WriteValueAsync(Activity currentActivity, string varName, object varValue, CancellationToken cancellationToken, int writeRetryCount = 0, int writeRetryDelay = 0, Guid? traceId = null)

Parameters

currentActivity Activity

The current activity.

varName string

Name of the variable.

varValue object

The variable value.

cancellationToken CancellationToken

The cancellation token.

writeRetryCount int

The write retry count.

writeRetryDelay int

The write retry delay.

traceId Guid?

The trace identifier.

Returns

Task<bool>

WriteValueAsync(Dictionary<string, object?>, int, int, Guid?)

Writes the value asynchronous.

Task WriteValueAsync(Dictionary<string, object?> valueMaps, int writeRetryCount = 0, int writeRetryDelay = 0, Guid? traceId = null)

Parameters

valueMaps Dictionary<string, object>

The value maps.

writeRetryCount int

The write retry count.

writeRetryDelay int

The write retry delay.

traceId Guid?

The trace identifier.

Returns

Task

WriteValueAsync(string, object, CancellationToken, int, int, Guid?)

Writes the value asynchronous.

Task<bool> WriteValueAsync(string varName, object varValue, CancellationToken cancellationToken, int writeRetryCount = 0, int writeRetryDelay = 0, Guid? traceId = null)

Parameters

varName string

Name of the variable.

varValue object

The variable value.

cancellationToken CancellationToken

The cancellation token.

writeRetryCount int

The write retry count.

writeRetryDelay int

The write retry delay.

traceId Guid?

The trace identifier.

Returns

Task<bool>

WriteValueWithResultAsync(Activity, Dictionary<string, object?>, int, int, Guid?)

Writes the value asynchronous.

Task<bool> WriteValueWithResultAsync(Activity currentActivity, Dictionary<string, object?> valueMaps, int writeRetryCount = 0, int writeRetryDelay = 0, Guid? traceId = null)

Parameters

currentActivity Activity

The current activity.

valueMaps Dictionary<string, object>

The value maps.

writeRetryCount int

The write retry count.

writeRetryDelay int

The write retry delay.

traceId Guid?

The trace identifier.

Returns

Task<bool>

WriteValueWithResultAsync(Activity, Dictionary<string, object?>, CancellationToken, int, int, Guid?)

Writes the value asynchronous.

Task<bool> WriteValueWithResultAsync(Activity currentActivity, Dictionary<string, object?> valueMaps, CancellationToken cancellationToken, int writeRetryCount = 0, int writeRetryDelay = 0, Guid? traceId = null)

Parameters

currentActivity Activity

The current activity.

valueMaps Dictionary<string, object>

The value maps.

cancellationToken CancellationToken

The cancellation token.

writeRetryCount int

The write retry count.

writeRetryDelay int

The write retry delay.

traceId Guid?

The trace identifier.

Returns

Task<bool>

WriteValueWithResultAsync(Dictionary<string, object?>, int, int, Guid?)

Writes the value asynchronous.

Task<bool> WriteValueWithResultAsync(Dictionary<string, object?> valueMaps, int writeRetryCount = 0, int writeRetryDelay = 0, Guid? traceId = null)

Parameters

valueMaps Dictionary<string, object>

The value maps.

writeRetryCount int

The write retry count.

writeRetryDelay int

The write retry delay.

traceId Guid?

The trace identifier.

Returns

Task<bool>

WriteValueWithResultAsync(Dictionary<string, object?>, CancellationToken, int, int, Guid?)

Writes the value asynchronous.

Task<bool> WriteValueWithResultAsync(Dictionary<string, object?> valueMaps, CancellationToken cancellationToken, int writeRetryCount = 0, int writeRetryDelay = 0, Guid? traceId = null)

Parameters

valueMaps Dictionary<string, object>

The value maps.

cancellationToken CancellationToken

The cancellation token.

writeRetryCount int

The write retry count.

writeRetryDelay int

The write retry delay.

traceId Guid?

The trace identifier.

Returns

Task<bool>