Interface ITemporalClient

Namespace

Temporalio.Client

Assembly

Temporalio.dll

Interface to a client to Temporal.

public interface ITemporalClient : IWorkerClient

Inherited Members

IWorkerClient.Options

IWorkerClient.BridgeClientProvider

Extension Methods

ITemporalClientExtensions.ExecuteWorkflowAsync(ITemporalClient, string, IReadOnlyCollection<object?>, WorkflowOptions)

ITemporalClientExtensions.ExecuteWorkflowAsync<TWorkflow>(ITemporalClient, Expression<Func<TWorkflow, Task>>, WorkflowOptions)

ITemporalClientExtensions.ExecuteWorkflowAsync<TResult>(ITemporalClient, string, IReadOnlyCollection<object?>, WorkflowOptions)

ITemporalClientExtensions.ExecuteWorkflowAsync<TWorkflow, TResult>(ITemporalClient, Expression<Func<TWorkflow, Task<TResult>>>, WorkflowOptions)

ITemporalClientExtensions.ListWorkflowHistoriesAsync(ITemporalClient, string, WorkflowListOptions?, WorkflowHistoryEventFetchOptions?)

Properties

Connection

Gets the connection associated with this client.

ITemporalConnection Connection { get; }

Property Value

ITemporalConnection

See Also

TemporalClient

OutboundInterceptor

Gets the outbound interceptor in use.

ClientOutboundInterceptor OutboundInterceptor { get; }

Property Value

ClientOutboundInterceptor

See Also

TemporalClient

Methods

CreateScheduleAsync(string, Schedule, ScheduleOptions?)

Create a schedule and return its handle.

Task<ScheduleHandle> CreateScheduleAsync(string scheduleID, Schedule schedule, ScheduleOptions? options = null)

Parameters

scheduleID string

Unique ID for the schedule.

schedule Schedule

Schedule to create.

options ScheduleOptions

Options for creating the schedule.

Returns

Task<ScheduleHandle>

Handle to the created schedule.

Remarks

This can throw ScheduleAlreadyRunningException if the ID already exists.

See Also

TemporalClient

GetAsyncActivityHandle(byte[])

Get a handle to complete an activity asynchronously using its task token.

AsyncActivityHandle GetAsyncActivityHandle(byte[] taskToken)

Parameters

taskToken byte[]

Task token for the activity.

Returns

AsyncActivityHandle

Async activity handle.

See Also

TemporalClient

GetAsyncActivityHandle(string, string, string)

Get a handle to complete an activity asynchronously using its qualified identifiers.

AsyncActivityHandle GetAsyncActivityHandle(string workflowID, string runID, string activityID)

Parameters

workflowID string

ID for the activity's workflow.

runID string

Run ID for the activity's workflow.

activityID string

ID for the activity.

Returns

AsyncActivityHandle

Async activity handle.

See Also

TemporalClient

GetScheduleHandle(string)

Gets the schedule handle for the given ID.

ScheduleHandle GetScheduleHandle(string scheduleID)

Parameters

scheduleID string

Schedule ID to get the handle for.

Returns

ScheduleHandle

Schedule handle.

See Also

TemporalClient

GetWorkflowHandle(string, string?, string?)

Get a workflow handle for an existing workflow with unknown return type.

WorkflowHandle GetWorkflowHandle(string id, string? runID = null, string? firstExecutionRunID = null)

Parameters

id string

ID of the workflow.

runID string

Run ID of the workflow or null for latest.

firstExecutionRunID string

Optional first execution ID used for cancellation and termination.

Returns

WorkflowHandle

Created workflow handle.

See Also

TemporalClient

GetWorkflowHandle<TWorkflow>(string, string?, string?)

Get a workflow handle for an existing workflow with known type.

WorkflowHandle<TWorkflow> GetWorkflowHandle<TWorkflow>(string id, string? runID = null, string? firstExecutionRunID = null)

Parameters

id string

ID of the workflow.

runID string

Run ID of the workflow or null for latest.

firstExecutionRunID string

Optional first execution ID used for cancellation and termination.

Returns

WorkflowHandle<TWorkflow>

Created workflow handle.

Type Parameters

TWorkflow

Workflow class type.

See Also

TemporalClient

GetWorkflowHandle<TWorkflow, TResult>(string, string?, string?)

Get a workflow handle for an existing workflow with known type and return type.

WorkflowHandle<TWorkflow, TResult> GetWorkflowHandle<TWorkflow, TResult>(string id, string? runID = null, string? firstExecutionRunID = null)

Parameters

id string

ID of the workflow.

runID string

Run ID of the workflow or null for latest.

firstExecutionRunID string

Optional first execution ID used for cancellation and termination.

Returns

WorkflowHandle<TWorkflow, TResult>

Created workflow handle.

Type Parameters

TWorkflow

Workflow class type.

TResult

Result type of the workflow.

See Also

TemporalClient

ListSchedulesAsync(ScheduleListOptions?)

List schedules.

IAsyncEnumerable<ScheduleListDescription> ListSchedulesAsync(ScheduleListOptions? options = null)

Parameters

options ScheduleListOptions

Options for the list call.

Returns

IAsyncEnumerable<ScheduleListDescription>

Async enumerator for the schedules.

See Also

TemporalClient

ListWorkflowsAsync(string, WorkflowListOptions?)

List workflows with the given query.

IAsyncEnumerable<WorkflowExecution> ListWorkflowsAsync(string query, WorkflowListOptions? options = null)

Parameters

query string

Query to use for filtering.

options WorkflowListOptions

Options for the list call.

Returns

IAsyncEnumerable<WorkflowExecution>

Async enumerator for the workflows.

See Also

TemporalClient

StartWorkflowAsync(string, IReadOnlyCollection<object?>, WorkflowOptions)

Start a workflow by name.

Task<WorkflowHandle> StartWorkflowAsync(string workflow, IReadOnlyCollection<object?> args, WorkflowOptions options)

Parameters

workflow string

Workflow type name.

args IReadOnlyCollection<object>

Arguments for the workflow.

options WorkflowOptions

Start workflow options. ID and TaskQueue are required.

Returns

Task<WorkflowHandle>

Workflow handle for the started workflow.

Exceptions

ArgumentException

Invalid options.

WorkflowAlreadyStartedException

Workflow was already started according to ID reuse policy.

RpcException

Server-side error.

See Also

TemporalClient

StartWorkflowAsync<TWorkflow>(Expression<Func<TWorkflow, Task>>, WorkflowOptions)

Start a workflow via lambda invoking the run method.

Task<WorkflowHandle<TWorkflow>> StartWorkflowAsync<TWorkflow>(Expression<Func<TWorkflow, Task>> workflowRunCall, WorkflowOptions options)

Parameters

workflowRunCall Expression<Func<TWorkflow, Task>>

Invocation of workflow run method with no result.

options WorkflowOptions

Start workflow options. ID and TaskQueue are required.

Returns

Task<WorkflowHandle<TWorkflow>>

Workflow handle for the started workflow.

Type Parameters

TWorkflow

Workflow class type.

Exceptions

ArgumentException

Invalid run call or options.

WorkflowAlreadyStartedException

Workflow was already started according to ID reuse policy.

RpcException

Server-side error.

See Also

TemporalClient

StartWorkflowAsync<TWorkflow, TResult>(Expression<Func<TWorkflow, Task<TResult>>>, WorkflowOptions)

Start a workflow via lambda invoking the run method.

Task<WorkflowHandle<TWorkflow, TResult>> StartWorkflowAsync<TWorkflow, TResult>(Expression<Func<TWorkflow, Task<TResult>>> workflowRunCall, WorkflowOptions options)

Parameters

workflowRunCall Expression<Func<TWorkflow, Task<TResult>>>

Invocation of workflow run method with a result.

options WorkflowOptions

Start workflow options. ID and TaskQueue are required.

Returns

Task<WorkflowHandle<TWorkflow, TResult>>

Workflow handle for the started workflow.

Type Parameters

TWorkflow

Workflow class type.

TResult

Workflow result type.

Exceptions

ArgumentException

Invalid run call or options.

WorkflowAlreadyStartedException

Workflow was already started according to ID reuse policy.

RpcException

Server-side error.

See Also

TemporalClient

See Also

TemporalClient