Share via


IDurableEntityClient.SignalEntityAsync Method

Definition

Overloads

SignalEntityAsync(EntityId, String, Object, String, String)

Signals an entity to perform an operation.

SignalEntityAsync(EntityId, DateTime, String, Object, String, String)

Signals an entity to perform an operation, at a specified time.

SignalEntityAsync<TEntityInterface>(EntityId, Action<TEntityInterface>)

Signals an entity to perform an operation.

SignalEntityAsync<TEntityInterface>(String, Action<TEntityInterface>)

Signals an entity to perform an operation.

SignalEntityAsync<TEntityInterface>(EntityId, DateTime, Action<TEntityInterface>)

Signals an entity to perform an operation, at a specified time.

SignalEntityAsync<TEntityInterface>(String, DateTime, Action<TEntityInterface>)

Signals an entity to perform an operation, at a specified time.

SignalEntityAsync(EntityId, String, Object, String, String)

Source:
IDurableEntityClient.cs

Signals an entity to perform an operation.

public System.Threading.Tasks.Task SignalEntityAsync (Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityId entityId, string operationName, object operationInput = default, string taskHubName = default, string connectionName = default);
abstract member SignalEntityAsync : Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityId * string * obj * string * string -> System.Threading.Tasks.Task
Public Function SignalEntityAsync (entityId As EntityId, operationName As String, Optional operationInput As Object = Nothing, Optional taskHubName As String = Nothing, Optional connectionName As String = Nothing) As Task

Parameters

entityId
EntityId

The target entity.

operationName
String

The name of the operation.

operationInput
Object

The input for the operation.

taskHubName
String

The TaskHubName of the target entity.

connectionName
String

The name of the connection string associated with taskHubName.

Returns

A task that completes when the message has been reliably enqueued.

Applies to

SignalEntityAsync(EntityId, DateTime, String, Object, String, String)

Source:
IDurableEntityClient.cs

Signals an entity to perform an operation, at a specified time.

public System.Threading.Tasks.Task SignalEntityAsync (Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityId entityId, DateTime scheduledTimeUtc, string operationName, object operationInput = default, string taskHubName = default, string connectionName = default);
abstract member SignalEntityAsync : Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityId * DateTime * string * obj * string * string -> System.Threading.Tasks.Task
Public Function SignalEntityAsync (entityId As EntityId, scheduledTimeUtc As DateTime, operationName As String, Optional operationInput As Object = Nothing, Optional taskHubName As String = Nothing, Optional connectionName As String = Nothing) As Task

Parameters

entityId
EntityId

The target entity.

scheduledTimeUtc
DateTime

The time at which to start the operation.

operationName
String

The name of the operation.

operationInput
Object

The input for the operation.

taskHubName
String

The TaskHubName of the target entity.

connectionName
String

The name of the connection string associated with taskHubName.

Returns

A task that completes when the message has been reliably enqueued.

Applies to

SignalEntityAsync<TEntityInterface>(EntityId, Action<TEntityInterface>)

Source:
IDurableEntityClient.cs

Signals an entity to perform an operation.

public System.Threading.Tasks.Task SignalEntityAsync<TEntityInterface> (Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityId entityId, Action<TEntityInterface> operation);
abstract member SignalEntityAsync : Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityId * Action<'EntityInterface> -> System.Threading.Tasks.Task
Public Function SignalEntityAsync(Of TEntityInterface) (entityId As EntityId, operation As Action(Of TEntityInterface)) As Task

Type Parameters

TEntityInterface

Entity interface.

Parameters

entityId
EntityId

The target entity.

operation
Action<TEntityInterface>

A delegate that performs the desired operation on the entity.

Returns

A task that completes when the message has been reliably enqueued.

Applies to

SignalEntityAsync<TEntityInterface>(String, Action<TEntityInterface>)

Source:
IDurableEntityClient.cs

Signals an entity to perform an operation.

public System.Threading.Tasks.Task SignalEntityAsync<TEntityInterface> (string entityKey, Action<TEntityInterface> operation);
abstract member SignalEntityAsync : string * Action<'EntityInterface> -> System.Threading.Tasks.Task
Public Function SignalEntityAsync(Of TEntityInterface) (entityKey As String, operation As Action(Of TEntityInterface)) As Task

Type Parameters

TEntityInterface

Entity interface.

Parameters

entityKey
String

The target entity key.

operation
Action<TEntityInterface>

A delegate that performs the desired operation on the entity.

Returns

A task that completes when the message has been reliably enqueued.

Applies to

SignalEntityAsync<TEntityInterface>(EntityId, DateTime, Action<TEntityInterface>)

Source:
IDurableEntityClient.cs

Signals an entity to perform an operation, at a specified time.

public System.Threading.Tasks.Task SignalEntityAsync<TEntityInterface> (Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityId entityId, DateTime scheduledTimeUtc, Action<TEntityInterface> operation);
abstract member SignalEntityAsync : Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityId * DateTime * Action<'EntityInterface> -> System.Threading.Tasks.Task
Public Function SignalEntityAsync(Of TEntityInterface) (entityId As EntityId, scheduledTimeUtc As DateTime, operation As Action(Of TEntityInterface)) As Task

Type Parameters

TEntityInterface

Entity interface.

Parameters

entityId
EntityId

The target entity.

scheduledTimeUtc
DateTime

The time at which to start the operation.

operation
Action<TEntityInterface>

A delegate that performs the desired operation on the entity.

Returns

A task that completes when the message has been reliably enqueued.

Applies to

SignalEntityAsync<TEntityInterface>(String, DateTime, Action<TEntityInterface>)

Source:
IDurableEntityClient.cs

Signals an entity to perform an operation, at a specified time.

public System.Threading.Tasks.Task SignalEntityAsync<TEntityInterface> (string entityKey, DateTime scheduledTimeUtc, Action<TEntityInterface> operation);
abstract member SignalEntityAsync : string * DateTime * Action<'EntityInterface> -> System.Threading.Tasks.Task
Public Function SignalEntityAsync(Of TEntityInterface) (entityKey As String, scheduledTimeUtc As DateTime, operation As Action(Of TEntityInterface)) As Task

Type Parameters

TEntityInterface

Entity interface.

Parameters

entityKey
String

The target entity key.

scheduledTimeUtc
DateTime

The time at which to start the operation.

operation
Action<TEntityInterface>

A delegate that performs the desired operation on the entity.

Returns

A task that completes when the message has been reliably enqueued.

Applies to