Class ActivityHandle

Namespace

Temporalio.Client

Assembly

Temporalio.dll

Handle for a standalone activity to perform actions on.

public record ActivityHandle : IEquatable<ActivityHandle>

Inheritance

object

ActivityHandle

Implements

IEquatable<ActivityHandle>

Derived

ActivityHandle<TResult>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

WARNING: Standalone activities are experimental.

Constructors

ActivityHandle(ITemporalClient, string, string?)

Handle for a standalone activity to perform actions on.

public ActivityHandle(ITemporalClient Client, string Id, string? RunId = null)

Parameters

Client ITemporalClient

Client used for activity handle calls.

Id string

Activity ID.

RunId string

Activity run ID if known.

Remarks

WARNING: Standalone activities are experimental.

Properties

Client

Client used for activity handle calls.

public ITemporalClient Client { get; init; }

Property Value

ITemporalClient

Id

Activity ID.

public string Id { get; init; }

Property Value

string

RunId

Activity run ID if known.

public string? RunId { get; init; }

Property Value

string

Methods

CancelAsync(ActivityCancelOptions?)

Request cancellation of this activity.

public virtual Task CancelAsync(ActivityCancelOptions? options = null)

Parameters

options ActivityCancelOptions

Cancellation options.

Returns

Task

Cancel accepted task.

Remarks

WARNING: Standalone activities are experimental.

Exceptions

RpcException

Server-side error.

DescribeAsync(ActivityDescribeOptions?)

Describe this activity.

public virtual Task<ActivityExecutionDescription> DescribeAsync(ActivityDescribeOptions? options = null)

Parameters

options ActivityDescribeOptions

Extra options.

Returns

Task<ActivityExecutionDescription>

Description for the activity.

Remarks

WARNING: Standalone activities are experimental.

Exceptions

RpcException

Server-side error.

GetResultAsync(RpcOptions?)

Wait for the result of the activity, discarding the return value.

public Task GetResultAsync(RpcOptions? rpcOptions = null)

Parameters

rpcOptions RpcOptions

RPC options.

Returns

Task

Task that completes when the activity completes.

Remarks

WARNING: Standalone activities are experimental.

Exceptions

ActivityFailedException

Exception thrown for unsuccessful activity result.

RpcException

Server-side error.

GetResultAsync<TResult>(RpcOptions?)

Wait for the result of the activity, deserializing into the given type.

public virtual Task<TResult> GetResultAsync<TResult>(RpcOptions? rpcOptions = null)

Parameters

rpcOptions RpcOptions

RPC options.

Returns

Task<TResult>

Result of the activity.

Type Parameters

TResult

Return type to deserialize result into.

Remarks

WARNING: Standalone activities are experimental.

Exceptions

ActivityFailedException

Exception thrown for unsuccessful activity result.

RpcException

Server-side error.

TerminateAsync(ActivityTerminateOptions?)

Terminate this activity.

public virtual Task TerminateAsync(ActivityTerminateOptions? options = null)

Parameters

options ActivityTerminateOptions

Termination options.

Returns

Task

Terminate completed task.

Remarks

WARNING: Standalone activities are experimental.

Exceptions

RpcException

Server-side error.