Class NexusClientExtensions

Namespace

Temporalio.Client

Assembly

Temporalio.dll

Client methods for standalone Nexus operations with typed completion callbacks.

public static class NexusClientExtensions

Inheritance

object

NexusClientExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

ExecuteNexusOperationAsync<TOutput>(NexusClient, string, object?, NexusOperationOptions<TOutput>)

Runs a named Nexus operation with typed completion callbacks and waits for its result.

public static Task<TOutput> ExecuteNexusOperationAsync<TOutput>(this NexusClient client, string operationName, object? arg, NexusOperationOptions<TOutput> options)

Parameters

client NexusClient

The Nexus client.

operationName string

The name of the source operation.

arg object

The argument for the source operation.

options NexusOperationOptions<TOutput>

The operation options and completion callbacks.

Returns

Task<TOutput>

The result of the operation.

Type Parameters

TOutput

The type of the operation's result.

Remarks

WARNING: This API is experimental and may change.

ExecuteNexusOperationAsync<TService>(NexusClient<TService>, Expression<Action<TService>>, NexusOperationOptions<NoValue>)

Runs a void-returning Nexus operation with typed completion callbacks and waits for completion.

public static Task ExecuteNexusOperationAsync<TService>(this NexusClient<TService> client, Expression<Action<TService>> operationStartCall, NexusOperationOptions<NoValue> options)

Parameters

client NexusClient<TService>

The Nexus client.

operationStartCall Expression<Action<TService>>

An expression that calls a no-value source operation.

options NexusOperationOptions<NoValue>

The operation options and completion callbacks.

Returns

Task

A task representing completion of the operation.

Type Parameters

TService

The source service interface.

Remarks

WARNING: This API is experimental and may change.

Exceptions

ArgumentException

The expression does not select a registered no-value operation.

ExecuteNexusOperationAsync<TService, TOutput>(NexusClient<TService>, Expression<Func<TService, TOutput>>, NexusOperationOptions<TOutput>)

Runs a Nexus operation with typed completion callbacks and waits for its result.

public static Task<TOutput> ExecuteNexusOperationAsync<TService, TOutput>(this NexusClient<TService> client, Expression<Func<TService, TOutput>> operationStartCall, NexusOperationOptions<TOutput> options)

Parameters

client NexusClient<TService>

The Nexus client.

operationStartCall Expression<Func<TService, TOutput>>

An expression that calls the source operation.

options NexusOperationOptions<TOutput>

The operation options and completion callbacks.

Returns

Task<TOutput>

The result of the operation.

Type Parameters

TService

The source service interface.

TOutput

The type of the operation's result.

Remarks

WARNING: This API is experimental and may change.

StartNexusOperationAsync<TOutput>(NexusClient, string, object?, NexusOperationOptions<TOutput>)

Starts a named Nexus operation with typed completion callbacks.

public static Task<NexusOperationHandle<TOutput>> StartNexusOperationAsync<TOutput>(this NexusClient client, string operationName, object? arg, NexusOperationOptions<TOutput> options)

Parameters

client NexusClient

The Nexus client.

operationName string

The name of the source operation.

arg object

The argument for the source operation.

options NexusOperationOptions<TOutput>

The operation options and completion callbacks.

Returns

Task<NexusOperationHandle<TOutput>>

A handle to the started operation.

Type Parameters

TOutput

The type of the operation's result.

Remarks

WARNING: This API is experimental and may change.

StartNexusOperationAsync<TService>(NexusClient<TService>, Expression<Action<TService>>, NexusOperationOptions<NoValue>)

Starts a void-returning Nexus operation with typed completion callbacks.

public static Task<NexusOperationHandle> StartNexusOperationAsync<TService>(this NexusClient<TService> client, Expression<Action<TService>> operationStartCall, NexusOperationOptions<NoValue> options)

Parameters

client NexusClient<TService>

The Nexus client.

operationStartCall Expression<Action<TService>>

An expression that calls a no-value source operation.

options NexusOperationOptions<NoValue>

The operation options and completion callbacks.

Returns

Task<NexusOperationHandle>

A handle to the started operation.

Type Parameters

TService

The source service interface.

Remarks

WARNING: This API is experimental and may change.

Exceptions

ArgumentException

The expression does not select a registered no-value operation.

StartNexusOperationAsync<TService, TOutput>(NexusClient<TService>, Expression<Func<TService, TOutput>>, NexusOperationOptions<TOutput>)

Starts a Nexus operation with completion callbacks for its result type.

public static Task<NexusOperationHandle<TOutput>> StartNexusOperationAsync<TService, TOutput>(this NexusClient<TService> client, Expression<Func<TService, TOutput>> operationStartCall, NexusOperationOptions<TOutput> options)

Parameters

client NexusClient<TService>

The Nexus client.

operationStartCall Expression<Func<TService, TOutput>>

An expression that calls the source operation.

options NexusOperationOptions<TOutput>

The operation options and completion callbacks.

Returns

Task<NexusOperationHandle<TOutput>>

A handle to the started operation.

Type Parameters

TService

The source service interface.

TOutput

The type of the operation's result.

Remarks

WARNING: This API is experimental and may change.