| | | 1 | | using Elsa.Workflows.Models; |
| | | 2 | | using JetBrains.Annotations; |
| | | 3 | | |
| | | 4 | | namespace Elsa.Workflows.Runtime.Messages; |
| | | 5 | | |
| | | 6 | | /// <summary> |
| | | 7 | | /// A request to run a workflow instance. |
| | | 8 | | /// </summary> |
| | | 9 | | [UsedImplicitly] |
| | | 10 | | public class RunWorkflowInstanceRequest |
| | | 11 | | { |
| | | 12 | | /// <summary> |
| | | 13 | | /// The ID of the activity that triggered the workflow instance, if any. |
| | | 14 | | /// </summary> |
| | 272 | 15 | | public string? TriggerActivityId { get; set; } |
| | | 16 | | |
| | | 17 | | /// <summary> |
| | | 18 | | /// The ID of the bookmark that triggered the workflow instance, if any. |
| | | 19 | | /// </summary> |
| | 220 | 20 | | public string? BookmarkId { get; set; } |
| | | 21 | | |
| | | 22 | | /// <summary> |
| | | 23 | | /// The handle of the activity to schedule, if any. |
| | | 24 | | /// </summary> |
| | 283 | 25 | | public ActivityHandle? ActivityHandle { get; set; } |
| | | 26 | | |
| | | 27 | | /// <summary> |
| | | 28 | | /// Any additional properties to associate with the workflow instance. |
| | | 29 | | /// </summary> |
| | 311 | 30 | | public IDictionary<string, object>? Properties { get; set; } |
| | | 31 | | |
| | | 32 | | /// <summary> |
| | | 33 | | /// The input to the workflow instance, if any. |
| | | 34 | | /// </summary> |
| | 311 | 35 | | public IDictionary<string, object>? Input { get; set; } |
| | | 36 | | |
| | | 37 | | /// <summary> |
| | | 38 | | /// A collection of variables to be used during the execution of a workflow instance. |
| | | 39 | | /// </summary> |
| | 272 | 40 | | public IDictionary<string, object>? Variables { get; set; } |
| | | 41 | | |
| | | 42 | | /// <summary> |
| | | 43 | | /// When set to <c>true</c>, include workflow output in the response. |
| | | 44 | | /// </summary> |
| | 272 | 45 | | public bool IncludeWorkflowOutput { get; set; } |
| | | 46 | | |
| | | 47 | | /// <summary> |
| | | 48 | | /// The ID of the activity execution context that scheduled this workflow execution (for cross-workflow call stack t |
| | | 49 | | /// This is set when a parent workflow invokes this workflow via ExecuteWorkflow or DispatchWorkflow. |
| | | 50 | | /// </summary> |
| | 219 | 51 | | public string? SchedulingActivityExecutionId { get; set; } |
| | | 52 | | |
| | | 53 | | /// <summary> |
| | | 54 | | /// The workflow instance ID of the parent workflow that scheduled this workflow execution. |
| | | 55 | | /// This is set when crossing workflow boundaries. |
| | | 56 | | /// </summary> |
| | 219 | 57 | | public string? SchedulingWorkflowInstanceId { get; set; } |
| | | 58 | | |
| | | 59 | | /// <summary> |
| | | 60 | | /// The call stack depth of the scheduling activity execution context. |
| | | 61 | | /// This is used to calculate the call stack depth when the scheduling context is not present |
| | | 62 | | /// in ActivityExecutionContexts (e.g., for cross-workflow invocations). |
| | | 63 | | /// Should be set to the depth of the scheduling activity (not depth + 1, as the increment is applied automatically) |
| | | 64 | | /// </summary> |
| | 219 | 65 | | public int? SchedulingCallStackDepth { get; set; } |
| | | 66 | | |
| | | 67 | | /// <summary> |
| | | 68 | | /// Represents an empty <see cref="RunWorkflowInstanceRequest"/> object used as a default value. |
| | | 69 | | /// </summary> |
| | 31 | 70 | | public static RunWorkflowInstanceRequest Empty => new(); |
| | | 71 | | } |