• API Documentation
Search Results for

    Show / Hide Table of Contents
    • Temporalio
      • IPayloadCodec
      • Refs
      • Refs.IProxy
      • Refs.ProxiedAttribute
      • SearchAttributeCollection
      • SearchAttributeCollection.Builder
      • SearchAttributeKey
    • Temporalio.Activities
      • ActivityAttribute
      • ActivityCancelReason
      • ActivityContext
      • ActivityDefinition
      • CompleteAsyncException
    • Temporalio.Api.Batch.V1
      • BatchOperationCancellation
      • BatchOperationDeletion
      • BatchOperationInfo
      • BatchOperationSignal
      • BatchOperationTermination
      • MessageReflection
    • Temporalio.Api.Command.V1
      • AcceptWorkflowUpdateCommandAttributes
      • CancelTimerCommandAttributes
      • CancelWorkflowExecutionCommandAttributes
      • Command
      • Command.AttributesOneofCase
      • CompleteWorkflowExecutionCommandAttributes
      • CompleteWorkflowUpdateCommandAttributes
      • ContinueAsNewWorkflowExecutionCommandAttributes
      • FailWorkflowExecutionCommandAttributes
      • MessageReflection
      • ModifyWorkflowPropertiesCommandAttributes
      • RecordMarkerCommandAttributes
      • RejectWorkflowUpdateCommandAttributes
      • RequestCancelActivityTaskCommandAttributes
      • RequestCancelExternalWorkflowExecutionCommandAttributes
      • ScheduleActivityTaskCommandAttributes
      • SignalExternalWorkflowExecutionCommandAttributes
      • StartChildWorkflowExecutionCommandAttributes
      • StartTimerCommandAttributes
      • UpsertWorkflowSearchAttributesCommandAttributes
    • Temporalio.Api.Common.V1
      • ActivityType
      • DataBlob
      • GrpcStatus
      • GrpcStatusReflection
      • Header
      • Memo
      • MessageReflection
      • Payload
      • Payloads
      • RetryPolicy
      • SearchAttributes
      • WorkflowExecution
      • WorkflowType
    • Temporalio.Api.Dependencies.Gogoproto
      • GogoExtensions
      • GogoReflection
    • Temporalio.Api.Enums.V1
      • ArchivalState
      • BatchOperationReflection
      • BatchOperationState
      • BatchOperationType
      • CancelExternalWorkflowExecutionFailedCause
      • CommandType
      • CommandTypeReflection
      • CommonReflection
      • ContinueAsNewInitiator
      • EncodingType
      • EventType
      • EventTypeReflection
      • FailedCauseReflection
      • HistoryEventFilterType
      • IndexedValueType
      • InteractionType
      • InteractionTypeReflection
      • NamespaceReflection
      • NamespaceState
      • ParentClosePolicy
      • PendingActivityState
      • PendingWorkflowTaskState
      • QueryReflection
      • QueryRejectCondition
      • QueryResultType
      • ReplicationState
      • ResetReapplyType
      • ResetReflection
      • ResourceExhaustedCause
      • RetryState
      • ScheduleOverlapPolicy
      • ScheduleReflection
      • Severity
      • SignalExternalWorkflowExecutionFailedCause
      • StartChildWorkflowExecutionFailedCause
      • TaskQueueKind
      • TaskQueueReflection
      • TaskQueueType
      • TimeoutType
      • UpdateReflection
      • WorkflowExecutionStatus
      • WorkflowIdReusePolicy
      • WorkflowReflection
      • WorkflowTaskFailedCause
      • WorkflowUpdateResultAccessStyle
    • Temporalio.Api.ErrorDetails.V1
      • CancellationAlreadyRequestedFailure
      • ClientVersionNotSupportedFailure
      • MessageReflection
      • NamespaceAlreadyExistsFailure
      • NamespaceInvalidStateFailure
      • NamespaceNotActiveFailure
      • NamespaceNotFoundFailure
      • NotFoundFailure
      • PermissionDeniedFailure
      • QueryFailedFailure
      • ResourceExhaustedFailure
      • ServerVersionNotSupportedFailure
      • SystemWorkflowFailure
      • WorkflowExecutionAlreadyStartedFailure
      • WorkflowNotReadyFailure
    • Temporalio.Api.Failure.V1
      • ActivityFailureInfo
      • ApplicationFailureInfo
      • CanceledFailureInfo
      • ChildWorkflowExecutionFailureInfo
      • Failure
      • Failure.FailureInfoOneofCase
      • MessageReflection
      • ResetWorkflowFailureInfo
      • ServerFailureInfo
      • TerminatedFailureInfo
      • TimeoutFailureInfo
    • Temporalio.Api.Filter.V1
      • MessageReflection
      • StartTimeFilter
      • StatusFilter
      • WorkflowExecutionFilter
      • WorkflowTypeFilter
    • Temporalio.Api.History.V1
      • ActivityPropertiesModifiedExternallyEventAttributes
      • ActivityTaskCanceledEventAttributes
      • ActivityTaskCancelRequestedEventAttributes
      • ActivityTaskCompletedEventAttributes
      • ActivityTaskFailedEventAttributes
      • ActivityTaskScheduledEventAttributes
      • ActivityTaskStartedEventAttributes
      • ActivityTaskTimedOutEventAttributes
      • ChildWorkflowExecutionCanceledEventAttributes
      • ChildWorkflowExecutionCompletedEventAttributes
      • ChildWorkflowExecutionFailedEventAttributes
      • ChildWorkflowExecutionStartedEventAttributes
      • ChildWorkflowExecutionTerminatedEventAttributes
      • ChildWorkflowExecutionTimedOutEventAttributes
      • ExternalWorkflowExecutionCancelRequestedEventAttributes
      • ExternalWorkflowExecutionSignaledEventAttributes
      • History
      • HistoryEvent
      • HistoryEvent.AttributesOneofCase
      • MarkerRecordedEventAttributes
      • MessageReflection
      • RequestCancelExternalWorkflowExecutionFailedEventAttributes
      • RequestCancelExternalWorkflowExecutionInitiatedEventAttributes
      • SignalExternalWorkflowExecutionFailedEventAttributes
      • SignalExternalWorkflowExecutionInitiatedEventAttributes
      • StartChildWorkflowExecutionFailedEventAttributes
      • StartChildWorkflowExecutionInitiatedEventAttributes
      • TimerCanceledEventAttributes
      • TimerFiredEventAttributes
      • TimerStartedEventAttributes
      • UpsertWorkflowSearchAttributesEventAttributes
      • WorkflowExecutionCanceledEventAttributes
      • WorkflowExecutionCancelRequestedEventAttributes
      • WorkflowExecutionCompletedEventAttributes
      • WorkflowExecutionContinuedAsNewEventAttributes
      • WorkflowExecutionFailedEventAttributes
      • WorkflowExecutionSignaledEventAttributes
      • WorkflowExecutionStartedEventAttributes
      • WorkflowExecutionTerminatedEventAttributes
      • WorkflowExecutionTimedOutEventAttributes
      • WorkflowPropertiesModifiedEventAttributes
      • WorkflowPropertiesModifiedExternallyEventAttributes
      • WorkflowTaskCompletedEventAttributes
      • WorkflowTaskFailedEventAttributes
      • WorkflowTaskScheduledEventAttributes
      • WorkflowTaskStartedEventAttributes
      • WorkflowTaskTimedOutEventAttributes
      • WorkflowUpdateAcceptedEventAttributes
      • WorkflowUpdateCompletedEventAttributes
      • WorkflowUpdateRejectedEventAttributes
    • Temporalio.Api.Interaction.V1
      • Input
      • Invocation
      • MessageReflection
      • Meta
      • Output
      • Output.ResultOneofCase
    • Temporalio.Api.Namespace.V1
      • BadBinaries
      • BadBinaryInfo
      • MessageReflection
      • NamespaceConfig
      • NamespaceFilter
      • NamespaceInfo
      • UpdateNamespaceInfo
    • Temporalio.Api.OperatorService.V1
      • AddOrUpdateRemoteClusterRequest
      • AddOrUpdateRemoteClusterResponse
      • AddSearchAttributesRequest
      • AddSearchAttributesResponse
      • ClusterMetadata
      • DeleteNamespaceRequest
      • DeleteNamespaceResponse
      • ListClustersRequest
      • ListClustersResponse
      • ListSearchAttributesRequest
      • ListSearchAttributesResponse
      • RemoveRemoteClusterRequest
      • RemoveRemoteClusterResponse
      • RemoveSearchAttributesRequest
      • RemoveSearchAttributesResponse
      • RequestResponseReflection
      • ServiceReflection
    • Temporalio.Api.Query.V1
      • MessageReflection
      • QueryRejected
      • WorkflowQuery
      • WorkflowQueryResult
    • Temporalio.Api.Replication.V1
      • ClusterReplicationConfig
      • FailoverStatus
      • MessageReflection
      • NamespaceReplicationConfig
    • Temporalio.Api.Schedule.V1
      • BackfillRequest
      • CalendarSpec
      • IntervalSpec
      • MessageReflection
      • Range
      • Schedule
      • ScheduleAction
      • ScheduleAction.ActionOneofCase
      • ScheduleActionResult
      • ScheduleInfo
      • ScheduleListEntry
      • ScheduleListInfo
      • SchedulePatch
      • SchedulePolicies
      • ScheduleSpec
      • ScheduleState
      • StructuredCalendarSpec
      • TriggerImmediatelyRequest
    • Temporalio.Api.TaskQueue.V1
      • MessageReflection
      • PollerInfo
      • StickyExecutionAttributes
      • TaskIdBlock
      • TaskQueue
      • TaskQueueMetadata
      • TaskQueuePartitionMetadata
      • TaskQueueStatus
      • VersionId
      • VersionIdNode
    • Temporalio.Api.TestService.V1
      • GetCurrentTimeResponse
      • LockTimeSkippingRequest
      • LockTimeSkippingResponse
      • RequestResponseReflection
      • ServiceReflection
      • SleepRequest
      • SleepResponse
      • SleepUntilRequest
      • UnlockTimeSkippingRequest
      • UnlockTimeSkippingResponse
    • Temporalio.Api.Version.V1
      • Alert
      • MessageReflection
      • ReleaseInfo
      • VersionInfo
    • Temporalio.Api.Workflow.V1
      • MessageReflection
      • NewWorkflowExecutionInfo
      • PendingActivityInfo
      • PendingChildExecutionInfo
      • PendingWorkflowTaskInfo
      • ResetPointInfo
      • ResetPoints
      • WorkflowExecutionConfig
      • WorkflowExecutionInfo
    • Temporalio.Api.WorkflowService.V1
      • CountWorkflowExecutionsRequest
      • CountWorkflowExecutionsResponse
      • CreateScheduleRequest
      • CreateScheduleResponse
      • DeleteScheduleRequest
      • DeleteScheduleResponse
      • DeleteWorkflowExecutionRequest
      • DeleteWorkflowExecutionResponse
      • DeprecateNamespaceRequest
      • DeprecateNamespaceResponse
      • DescribeBatchOperationRequest
      • DescribeBatchOperationResponse
      • DescribeNamespaceRequest
      • DescribeNamespaceResponse
      • DescribeScheduleRequest
      • DescribeScheduleResponse
      • DescribeTaskQueueRequest
      • DescribeTaskQueueResponse
      • DescribeWorkflowExecutionRequest
      • DescribeWorkflowExecutionResponse
      • GetClusterInfoRequest
      • GetClusterInfoResponse
      • GetSearchAttributesRequest
      • GetSearchAttributesResponse
      • GetSystemInfoRequest
      • GetSystemInfoResponse
      • GetSystemInfoResponse.Types
      • GetSystemInfoResponse.Types.Capabilities
      • GetWorkerBuildIdOrderingRequest
      • GetWorkerBuildIdOrderingResponse
      • GetWorkflowExecutionHistoryRequest
      • GetWorkflowExecutionHistoryResponse
      • GetWorkflowExecutionHistoryReverseRequest
      • GetWorkflowExecutionHistoryReverseResponse
      • ListArchivedWorkflowExecutionsRequest
      • ListArchivedWorkflowExecutionsResponse
      • ListBatchOperationsRequest
      • ListBatchOperationsResponse
      • ListClosedWorkflowExecutionsRequest
      • ListClosedWorkflowExecutionsRequest.FiltersOneofCase
      • ListClosedWorkflowExecutionsResponse
      • ListNamespacesRequest
      • ListNamespacesResponse
      • ListOpenWorkflowExecutionsRequest
      • ListOpenWorkflowExecutionsRequest.FiltersOneofCase
      • ListOpenWorkflowExecutionsResponse
      • ListScheduleMatchingTimesRequest
      • ListScheduleMatchingTimesResponse
      • ListSchedulesRequest
      • ListSchedulesResponse
      • ListTaskQueuePartitionsRequest
      • ListTaskQueuePartitionsResponse
      • ListWorkflowExecutionsRequest
      • ListWorkflowExecutionsResponse
      • PatchScheduleRequest
      • PatchScheduleResponse
      • PollActivityTaskQueueRequest
      • PollActivityTaskQueueResponse
      • PollWorkflowTaskQueueRequest
      • PollWorkflowTaskQueueResponse
      • QueryWorkflowRequest
      • QueryWorkflowResponse
      • RecordActivityTaskHeartbeatByIdRequest
      • RecordActivityTaskHeartbeatByIdResponse
      • RecordActivityTaskHeartbeatRequest
      • RecordActivityTaskHeartbeatResponse
      • RegisterNamespaceRequest
      • RegisterNamespaceResponse
      • RequestCancelWorkflowExecutionRequest
      • RequestCancelWorkflowExecutionResponse
      • RequestResponseReflection
      • ResetStickyTaskQueueRequest
      • ResetStickyTaskQueueResponse
      • ResetWorkflowExecutionRequest
      • ResetWorkflowExecutionResponse
      • RespondActivityTaskCanceledByIdRequest
      • RespondActivityTaskCanceledByIdResponse
      • RespondActivityTaskCanceledRequest
      • RespondActivityTaskCanceledResponse
      • RespondActivityTaskCompletedByIdRequest
      • RespondActivityTaskCompletedByIdResponse
      • RespondActivityTaskCompletedRequest
      • RespondActivityTaskCompletedResponse
      • RespondActivityTaskFailedByIdRequest
      • RespondActivityTaskFailedByIdResponse
      • RespondActivityTaskFailedRequest
      • RespondActivityTaskFailedResponse
      • RespondQueryTaskCompletedRequest
      • RespondQueryTaskCompletedResponse
      • RespondWorkflowTaskCompletedRequest
      • RespondWorkflowTaskCompletedResponse
      • RespondWorkflowTaskFailedRequest
      • RespondWorkflowTaskFailedResponse
      • ScanWorkflowExecutionsRequest
      • ScanWorkflowExecutionsResponse
      • ServiceReflection
      • SignalWithStartWorkflowExecutionRequest
      • SignalWithStartWorkflowExecutionResponse
      • SignalWorkflowExecutionRequest
      • SignalWorkflowExecutionResponse
      • StartBatchOperationRequest
      • StartBatchOperationRequest.OperationOneofCase
      • StartBatchOperationResponse
      • StartWorkflowExecutionRequest
      • StartWorkflowExecutionResponse
      • StopBatchOperationRequest
      • StopBatchOperationResponse
      • TerminateWorkflowExecutionRequest
      • TerminateWorkflowExecutionResponse
      • UpdateNamespaceRequest
      • UpdateNamespaceResponse
      • UpdateScheduleRequest
      • UpdateScheduleResponse
      • UpdateWorkerBuildIdOrderingRequest
      • UpdateWorkerBuildIdOrderingResponse
      • UpdateWorkflowRequest
      • UpdateWorkflowResponse
    • Temporalio.Client
      • AsyncActivityCompleteOptions
      • AsyncActivityFailOptions
      • AsyncActivityHeartbeatOptions
      • AsyncActivityReportCancellationOptions
      • IBridgeClientProvider
      • ITemporalClient
      • ITemporalClientExtensions
      • ITemporalConnection
      • OperatorService
      • OperatorService.Core
      • RpcOptions
      • RpcRetryOptions
      • RpcService
      • TemporalClient
      • TemporalClientConnectOptions
      • TemporalClientOptions
      • TemporalConnection
      • TemporalConnectionOptions
      • TestService
      • TestService.Core
      • TlsOptions
      • WorkflowCancelOptions
      • WorkflowDescribeOptions
      • WorkflowExecution
      • WorkflowExecutionDescription
      • WorkflowOptions
      • WorkflowQueryOptions
      • WorkflowService
      • WorkflowService.Core
      • WorkflowSignalOptions
      • WorkflowTerminateOptions
    • Temporalio.Client.Interceptors
      • ClientOutboundInterceptor
      • IClientInterceptor
    • Temporalio.Converters
      • BinaryNullConverter
      • BinaryPlainConverter
      • BinaryProtoConverter
      • ConverterExtensions
      • DefaultFailureConverter
      • DefaultFailureConverterOptions
      • DefaultPayloadConverter
      • IEncodedRawValue
      • IEncodingConverter
      • IFailureConverter
      • IPayloadConverter
      • IRawValue
      • JsonPlainConverter
      • JsonProtoConverter
      • PayloadCodecExtensions
      • WithEncodedCommonAttributes
    • Temporalio.Exceptions
      • ActivityFailureException
      • ApplicationFailureException
      • AsyncActivityCancelledException
      • CancelledFailureException
      • ChildWorkflowFailureException
      • FailureException
      • IFailureDetails
      • InvalidWorkflowOperationException
      • RpcException
      • RpcException.StatusCode
      • ServerFailureException
      • TemporalException
      • TerminatedFailureException
      • TimeoutFailureException
      • WorkflowAlreadyStartedException
      • WorkflowContinuedAsNewException
      • WorkflowFailedException
      • WorkflowQueryFailedException
      • WorkflowQueryRejectedException
    • Temporalio.Runtime
      • LoggingOptions
      • MetricsOptions
      • OpenTelemetryOptions
      • PrometheusOptions
      • TelemetryFilterOptions
      • TelemetryFilterOptions.Level
      • TelemetryOptions
      • TemporalRuntime
      • TemporalRuntimeOptions
      • TracingOptions
    • Temporalio.Testing
      • TemporaliteOptions
      • TestServerOptions
      • WorkflowEnvironment
      • WorkflowEnvironmentStartLocalOptions
      • WorkflowEnvironmentStartTimeSkippingOptions
    • Temporalio.Worker
      • IWorkerClient
      • TemporalWorker
      • TemporalWorkerOptions
    • Temporalio.Worker.Interceptors
      • ActivityInboundInterceptor
      • ActivityOutboundInterceptor
      • IWorkerInterceptor
      • WorkflowInboundInterceptor
      • WorkflowOutboundInterceptor
    • Temporalio.Workflows
      • ActivityCancellationType
      • ActivityOptions
      • ChildWorkflowCancellationType
      • ChildWorkflowHandle
      • ChildWorkflowHandle<TResult>
      • ChildWorkflowOptions
      • ContinueAsNewException
      • ContinueAsNewOptions
      • LocalActivityOptions
      • MemoUpdate
      • ParentClosePolicy
      • SearchAttributeUpdate
      • Workflow
      • Workflow.Unsafe
      • WorkflowAttribute
      • WorkflowDefinition
      • WorkflowInitAttribute
      • WorkflowQueryAttribute
      • WorkflowQueryDefinition
      • WorkflowRunAttribute
      • WorkflowSignalAttribute
      • WorkflowSignalDefinition

    Class ClientOutboundInterceptor

    Base class for all outbound interceptors.

    Inheritance
    Object
    ClientOutboundInterceptor
    Namespace: Temporalio.Client.Interceptors
    Assembly: Temporalio.dll
    Syntax
    public abstract class ClientOutboundInterceptor : object

    Constructors

    ClientOutboundInterceptor(ClientOutboundInterceptor)

    Initializes a new instance of the ClientOutboundInterceptor class.

    Declaration
    protected ClientOutboundInterceptor(ClientOutboundInterceptor next)
    Parameters
    Type Name Description
    ClientOutboundInterceptor next

    Next outbound interceptor in the chain.

    Properties

    Next

    Gets the next interceptor in the chain.

    Declaration
    protected ClientOutboundInterceptor Next { get; }
    Property Value
    Type Description
    ClientOutboundInterceptor

    Methods

    CancelWorkflowAsync(CancelWorkflowInput)

    Intercept cancel workflow calls.

    Declaration
    public virtual Task CancelWorkflowAsync(CancelWorkflowInput input)
    Parameters
    Type Name Description
    CancelWorkflowInput input

    Input details of the call.

    Returns
    Type Description
    Task

    Task for acceptance of the cancel.

    CompleteAsyncActivityAsync(CompleteAsyncActivityInput)

    Intercept async activity complete calls.

    Declaration
    public virtual Task CompleteAsyncActivityAsync(CompleteAsyncActivityInput input)
    Parameters
    Type Name Description
    CompleteAsyncActivityInput input

    Input details of the call.

    Returns
    Type Description
    Task

    Task completion.

    DescribeWorkflowAsync(DescribeWorkflowInput)

    Intercept describe workflow calls.

    Declaration
    public virtual Task<WorkflowExecutionDescription> DescribeWorkflowAsync(DescribeWorkflowInput input)
    Parameters
    Type Name Description
    DescribeWorkflowInput input

    Input details of the call.

    Returns
    Type Description
    Task<WorkflowExecutionDescription>

    Workflow execution description.

    FailAsyncActivityAsync(FailAsyncActivityInput)

    Intercept async activity fail calls.

    Declaration
    public virtual Task FailAsyncActivityAsync(FailAsyncActivityInput input)
    Parameters
    Type Name Description
    FailAsyncActivityInput input

    Input details of the call.

    Returns
    Type Description
    Task

    Task completion.

    FetchWorkflowHistoryEventPageAsync(FetchWorkflowHistoryEventPageInput)

    Intercept a history event page fetch.

    Declaration
    public virtual Task<WorkflowHistoryEventPage> FetchWorkflowHistoryEventPageAsync(FetchWorkflowHistoryEventPageInput input)
    Parameters
    Type Name Description
    FetchWorkflowHistoryEventPageInput input

    Input details of the call.

    Returns
    Type Description
    Task<WorkflowHistoryEventPage>

    Event page. This will not return an empty event set and a next page token.

    HeartbeatAsyncActivityAsync(HeartbeatAsyncActivityInput)

    Intercept async activity heartbeat calls.

    Declaration
    public virtual Task HeartbeatAsyncActivityAsync(HeartbeatAsyncActivityInput input)
    Parameters
    Type Name Description
    HeartbeatAsyncActivityInput input

    Input details of the call.

    Returns
    Type Description
    Task

    Task completion.

    QueryWorkflowAsync<TResult>(QueryWorkflowInput)

    Intercept query workflow calls.

    Declaration
    public virtual Task<TResult> QueryWorkflowAsync<TResult>(QueryWorkflowInput input)
    Parameters
    Type Name Description
    QueryWorkflowInput input

    Input details of the call.

    Returns
    Type Description
    Task<TResult>

    Result of the query.

    Type Parameters
    Name Description
    TResult

    Return type of the query.

    ReportCancellationAsyncActivityAsync(ReportCancellationAsyncActivityInput)

    Intercept async activity report cancellation calls.

    Declaration
    public virtual Task ReportCancellationAsyncActivityAsync(ReportCancellationAsyncActivityInput input)
    Parameters
    Type Name Description
    ReportCancellationAsyncActivityInput input

    Input details of the call.

    Returns
    Type Description
    Task

    Task completion.

    SignalWorkflowAsync(SignalWorkflowInput)

    Intercept signal workflow calls.

    Declaration
    public virtual Task SignalWorkflowAsync(SignalWorkflowInput input)
    Parameters
    Type Name Description
    SignalWorkflowInput input

    Input details of the call.

    Returns
    Type Description
    Task

    Task for acceptance of the signal.

    StartWorkflowAsync<TResult>(StartWorkflowInput)

    Intercept start workflow calls.

    Declaration
    public virtual Task<WorkflowHandle<TResult>> StartWorkflowAsync<TResult>(StartWorkflowInput input)
    Parameters
    Type Name Description
    StartWorkflowInput input

    Input details of the call.

    Returns
    Type Description
    Task<WorkflowHandle<TResult>>

    Handle for the workflow.

    Type Parameters
    Name Description
    TResult

    Result type of the workflow.

    TerminateWorkflowAsync(TerminateWorkflowInput)

    Intercept terminate workflow calls.

    Declaration
    public virtual Task TerminateWorkflowAsync(TerminateWorkflowInput input)
    Parameters
    Type Name Description
    TerminateWorkflowInput input

    Input details of the call.

    Returns
    Type Description
    Task

    Task for termination completion.

    In This Article
    Back to top