DurableOrchestrationContextBase Interface

Reference

Definition

Namespace:: Microsoft.Azure.WebJobs.Extensions.DurableTask

Assembly:: Microsoft.Azure.WebJobs.Extensions.DurableTask.dll

Package:: Microsoft.Azure.WebJobs.Extensions.DurableTask v2.8.1

Source:: LegacyCompatibility.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Caution

Use IDurableOrchestrationContext instead.

Formerly, the abstract base class for DurableOrchestrationContext. Now obsolete: use IDurableOrchestrationContext instead.

[System.Obsolete("Use IDurableOrchestrationContext instead.")]
public interface DurableOrchestrationContextBase : Microsoft.Azure.WebJobs.Extensions.DurableTask.IDurableOrchestrationContext

[<System.Obsolete("Use IDurableOrchestrationContext instead.")>]
type DurableOrchestrationContextBase = interface
    interface IDurableOrchestrationContext

Public Interface DurableOrchestrationContextBase
Implements IDurableOrchestrationContext

Attributes: ObsoleteAttribute

Implements: IDurableOrchestrationContext

Properties

CurrentUtcDateTime	Gets the current date/time in a way that is safe for use in orchestrations and entity operations. (Inherited from IDurableOrchestrationContext)
InstanceId	Gets the instance ID of the currently executing orchestration. (Inherited from IDurableOrchestrationContext)
IsReplaying	Gets a value indicating whether the orchestration or operation is currently replaying itself. (Inherited from IDurableOrchestrationContext)
Name	Gets the name of the current orchestration function. (Inherited from IDurableOrchestrationContext)
ParentInstanceId	Gets the parent instance ID of the currently executing sub-orchestration. (Inherited from IDurableOrchestrationContext)

Methods

CallActivityAsync(String, Object)	Schedules an activity function named `functionName` for execution. (Inherited from IDurableOrchestrationContext)
CallActivityAsync<TResult>(String, Object)	Schedules an activity function named `functionName` for execution. (Inherited from IDurableOrchestrationContext)
CallActivityWithRetryAsync(String, RetryOptions, Object)	Schedules an activity function named `functionName` for execution with retry options. (Inherited from IDurableOrchestrationContext)
CallActivityWithRetryAsync<TResult>(String, RetryOptions, Object)	Schedules an activity function named `functionName` for execution with retry options. (Inherited from IDurableOrchestrationContext)
CallEntityAsync(EntityId, String)	Calls an operation on an entity and waits for it to complete. (Inherited from IDurableOrchestrationContext)
CallEntityAsync(EntityId, String, Object)	Calls an operation on an entity, passing an argument, and waits for it to complete. (Inherited from IDurableOrchestrationContext)
CallEntityAsync<TResult>(EntityId, String)	Calls an operation on an entity and returns the result asynchronously. (Inherited from IDurableOrchestrationContext)
CallEntityAsync<TResult>(EntityId, String, Object)	Calls an operation on an entity, passing an argument, and returns the result asynchronously. (Inherited from IDurableOrchestrationContext)
CallHttpAsync(DurableHttpRequest)	Makes an HTTP call using the information in the DurableHttpRequest. (Inherited from IDurableOrchestrationContext)
CallHttpAsync(HttpMethod, Uri, String, HttpRetryOptions)	Makes an HTTP call to the specified uri. (Inherited from IDurableOrchestrationContext)
CallSubOrchestratorAsync(String, Object)	Schedules an orchestrator function named `functionName` for execution. (Inherited from IDurableOrchestrationContext)
CallSubOrchestratorAsync(String, String, Object)	Schedules an orchestrator function named `functionName` for execution. (Inherited from IDurableOrchestrationContext)
CallSubOrchestratorAsync<TResult>(String, Object)	Schedules an orchestrator function named `functionName` for execution. (Inherited from IDurableOrchestrationContext)
CallSubOrchestratorAsync<TResult>(String, String, Object)	Schedules an orchestration function named `functionName` for execution. (Inherited from IDurableOrchestrationContext)
CallSubOrchestratorWithRetryAsync(String, RetryOptions, Object)	Schedules an orchestrator function named `functionName` for execution with retry options. (Inherited from IDurableOrchestrationContext)
CallSubOrchestratorWithRetryAsync(String, RetryOptions, String, Object)	Schedules an orchestrator function named `functionName` for execution with retry options. (Inherited from IDurableOrchestrationContext)
CallSubOrchestratorWithRetryAsync<TResult>(String, RetryOptions, Object)	Schedules an orchestrator function named `functionName` for execution with retry options. (Inherited from IDurableOrchestrationContext)
CallSubOrchestratorWithRetryAsync<TResult>(String, RetryOptions, String, Object)	Schedules an orchestrator function named `functionName` for execution with retry options. (Inherited from IDurableOrchestrationContext)
ContinueAsNew(Object, Boolean)	Restarts the orchestration by clearing its history. (Inherited from IDurableOrchestrationContext)
CreateEntityProxy<TEntityInterface>(EntityId)	Create an entity proxy. (Inherited from IDurableOrchestrationContext)
CreateEntityProxy<TEntityInterface>(String)	Create an entity proxy. (Inherited from IDurableOrchestrationContext)
CreateTimer(DateTime, CancellationToken)	Creates a durable timer that expires at a specified time. (Inherited from IDurableOrchestrationContext)
CreateTimer<T>(DateTime, T, CancellationToken)	Creates a durable timer that expires at a specified time. (Inherited from IDurableOrchestrationContext)
GetInput<TInput>()	Gets the input of the current orchestrator function as a deserialized value. (Inherited from IDurableOrchestrationContext)
IsLocked(IReadOnlyList<EntityId>)	Determines whether the current context is locked, and if so, what locks are currently owned. (Inherited from IDurableOrchestrationContext)
LockAsync(EntityId[])	Acquires one or more locks, for the specified entities. (Inherited from IDurableOrchestrationContext)
NewGuid()	Creates a new GUID that is safe for replay within an orchestration or operation. (Inherited from IDurableOrchestrationContext)
SetCustomStatus(Object)	Sets the JSON-serializeable status of the current orchestrator function. (Inherited from IDurableOrchestrationContext)
SetOutput(Object)	Sets the output for the current orchestration. (Inherited from IDurableOrchestrationContext)
SignalEntity(EntityId, DateTime, String, Object)	Signals an operation to be performed by an entity at a specified time. Any result or exception is ignored (fire and forget). (Inherited from IDurableOrchestrationContext)
SignalEntity(EntityId, String, Object)	Signals an entity to perform an operation, without waiting for a response. Any result or exception is ignored (fire and forget). (Inherited from IDurableOrchestrationContext)
StartNewOrchestration(String, Object, String)	Schedules a orchestration function named `functionName` for execution./>. Any result or exception is ignored (fire and forget). (Inherited from IDurableOrchestrationContext)
WaitForExternalEvent(String)	Waits asynchronously for an event to be raised with name `name`. (Inherited from IDurableOrchestrationContext)
WaitForExternalEvent(String, TimeSpan, CancellationToken)	Waits asynchronously for an event to be raised with name `name`. (Inherited from IDurableOrchestrationContext)
WaitForExternalEvent<T>(String)	Waits asynchronously for an event to be raised with name `name` and returns the event data. (Inherited from IDurableOrchestrationContext)
WaitForExternalEvent<T>(String, TimeSpan, CancellationToken)	Waits asynchronously for an event to be raised with name `name` and returns the event data. (Inherited from IDurableOrchestrationContext)
WaitForExternalEvent<T>(String, TimeSpan, T, CancellationToken)	Waits asynchronously for an event to be raised with name `name` and returns the event data. (Inherited from IDurableOrchestrationContext)

Extension Methods

CreateReplaySafeLogger(IDurableOrchestrationContext, ILogger)

Returns an instance of ILogger that is replay safe, ensuring the logger logs only when the orchestrator is not replaying that line of code.

Applies to