Interface IWorkflowClient
Starts and inspects workflow instances (ARCHITECTURE.md §6).
public interface IWorkflowClient
Methods
- GetDataAsync<TData>(WorkflowInstanceId, CancellationToken)
Reads an instance's current data document, or null if there is no such instance.
- RecoverCompensationAsync(WorkflowInstanceId, CompensationRecovery, CancellationToken)
Moves an unwind that a failed compensation left suspended (§11.30).
- SignalAsync(string, string, string?, CancellationToken)
Delivers a signal whose payload is already JSON — the escape hatch for webhooks and senders outside this process (§11.5).
- SignalAsync<TPayload>(string, string, TPayload, CancellationToken)
Delivers a typed signal to whichever instance is waiting on
nameandcorrelationId, and returns whether one was.
- StartAsync<TData>(string, int, TData, CancellationToken)
Starts an instance pinned to a specific version, for a caller that must not drift onto a newer definition mid-rollout.
- StartAsync<TData>(string, TData, CancellationToken)
Starts an instance of the latest registered version of
definitionId.