TaskOrchestrationContext Class

Definition

Namespace:

Microsoft.DurableTask

Assembly:

Microsoft.DurableTask.Abstractions.dll

Package:

Microsoft.DurableTask.Abstractions v1.0.0

Context object used by orchestrators to perform actions such as scheduling tasks, durable timers, waiting for external events, and for getting basic information about the current orchestration.

public abstract class TaskOrchestrationContext

type TaskOrchestrationContext = class

Public MustInherit Class TaskOrchestrationContext

Inheritance

Object

TaskOrchestrationContext

Constructors

TaskOrchestrationContext()

Properties

CurrentUtcDateTime	Gets the current orchestration time in UTC.
InstanceId	Gets the unique ID of the current orchestration instance.
IsReplaying	Gets a value indicating whether the orchestrator is currently replaying a previous execution.
LoggerFactory	Gets the logger factory for this context.
Name	Gets the name of the task orchestration.
Parent	Gets the parent instance or null if there is no parent orchestration.

Methods

CallActivityAsync(TaskName, Object, TaskOptions)	Asynchronously invokes an activity by name and with the specified input value.
CallActivityAsync(TaskName, TaskOptions)	Asynchronously invokes an activity by name and with the specified input value.
CallActivityAsync<TResult>(TaskName, Object, TaskOptions)	Asynchronously invokes an activity by name and with the specified input value.
CallActivityAsync<TResult>(TaskName, TaskOptions)	Asynchronously invokes an activity by name and with the specified input value.
CallSubOrchestratorAsync(TaskName, Object, TaskOptions)	Executes a named sub-orchestrator.
CallSubOrchestratorAsync(TaskName, TaskOptions)	Executes a named sub-orchestrator and returns the result.
CallSubOrchestratorAsync<TResult>(TaskName, Object, TaskOptions)	Executes a named sub-orchestrator and returns the result.
CallSubOrchestratorAsync<TResult>(TaskName, TaskOptions)	Executes a named sub-orchestrator and returns the result.
ContinueAsNew(Object, Boolean)	Restarts the orchestration with a new input and clears its history.
CreateReplaySafeLogger(String)	Returns an instance of ILogger that is replay-safe, meaning that the logger only writes logs when the orchestrator is not replaying previous history.
CreateReplaySafeLogger(Type)	Returns an instance of ILogger that is replay-safe, meaning that the logger only writes logs when the orchestrator is not replaying previous history.
CreateReplaySafeLogger<T>()	Returns an instance of ILogger that is replay-safe, meaning that the logger only writes logs when the orchestrator is not replaying previous history.
CreateTimer(DateTime, CancellationToken)	Creates a durable timer that expires at a set date and time.
CreateTimer(TimeSpan, CancellationToken)	Creates a durable timer that expires after the specified delay.
GetInput<T>()	Gets the deserialized input of the orchestrator.
NewGuid()	Creates a new GUID that is safe for replay within an orchestration or operation.
SendEvent(String, String, Object)	Raises an external event for the specified orchestration instance.
SetCustomStatus(Object)	Assigns a custom status value to the current orchestration.
WaitForExternalEvent<T>(String, CancellationToken)	Waits for an event to be raised with name eventName and returns the event data.
WaitForExternalEvent<T>(String, TimeSpan)	Waits for an event to be raised with name eventName and returns the event data.