ReceiveActivity Class

 
Note: This API is now obsolete.

Service activity that implements an operation defined by a Windows Communication Foundation (WCF) service contract.

Namespace:   System.Workflow.Activities
Assembly:  System.WorkflowServices (in System.WorkflowServices.dll)


[SerializableAttribute]
[ToolboxBitmapAttribute(typeof(ReceiveActivity), "Design.Resources.ReceiveActivity.png")]
[ObsoleteAttribute("The System.Workflow.* types are deprecated.  Instead, please use the new types from System.Activities.*")]
public sealed class ReceiveActivity : SequenceActivity, IEventActivity, 
	IActivityEventListener<QueueEventArgs>

NameDescription
System_CAPS_pubmethodReceiveActivity()

Initializes a new instance of the ReceiveActivity class.

System_CAPS_pubmethodReceiveActivity(String)

Initializes a new instance of the ReceiveActivity class, initializing its Name property.

NameDescription
System_CAPS_pubpropertyActivities

Gets the object representing the collection, ActivityCollection, of all child activities.(Inherited from CompositeActivity.)

System_CAPS_pubpropertyCanCreateInstance

Gets or sets whether the operation causes a new workflow service instance to be created.

System_CAPS_protpropertyCanModifyActivities

Gets or sets a value which controls whether the individual activities within Activities can be modified.(Inherited from CompositeActivity.)

System_CAPS_pubpropertyContext

Gets the context information for this activity.

System_CAPS_pubpropertyContextToken

Represents a token that can be used to specify the context that should be used to correlate the exchange between a ReceiveActivity activity and the client that the activity is communicating with.

System_CAPS_pubpropertyDescription

Gets or sets the user-defined description of the Activity.(Inherited from Activity.)

System_CAPS_protpropertyDesignMode

Gets the value that indicates whether this instance is in design or run-time mode.(Inherited from DependencyObject.)

System_CAPS_pubpropertyEnabled

Gets or sets a value that indicates whether this instance is enabled for execution and validation.(Inherited from Activity.)

System_CAPS_pubpropertyEnabledActivities

Gets the read-only collection that represents the subset of Activities that are enabled. (Inherited from CompositeActivity.)

System_CAPS_pubpropertyExecutionResult

Gets the ActivityExecutionResult of the last attempt to run this instance.(Inherited from Activity.)

System_CAPS_pubpropertyExecutionStatus

Gets the current ActivityExecutionStatus of this instance.(Inherited from Activity.)

System_CAPS_pubpropertyFaultMessage

The exception that is returned when a receive activity completes execution.

System_CAPS_pubpropertyIsDynamicActivity

Gets information about whether the activity is executing within the default ActivityExecutionContext of the workflow instance.(Inherited from Activity.)

System_CAPS_pubpropertyName

Gets or sets the name of this instance. This name must conform to the variable naming convention of the programming language that is being used in the Workflow project.(Inherited from Activity.)

System_CAPS_pubpropertyParameterBindings

Gets the collection of bindable parameters as found in the service's formal parameter list.

System_CAPS_pubpropertyParent

Gets the CompositeActivity that contains this Activity.(Inherited from Activity.)

System_CAPS_pubpropertyQualifiedName

Gets the qualified name of the activity. Qualified activity names are always unique in a workflow instance.(Inherited from Activity.)

System_CAPS_pubpropertyServiceOperationInfo

Defines the contract and service operation that the ReceiveActivity activity implements.

System_CAPS_pubpropertySite

Gets or sets a reference to the Site component of the DependencyObject.(Inherited from DependencyObject.)

System_CAPS_pubpropertyUserData

Gets an IDictionary that associates custom data with this class instance.(Inherited from DependencyObject.)

NameDescription
System_CAPS_pubmethodAddHandler(DependencyProperty, Object)

Adds a handler for an event of a DependencyObject.(Inherited from DependencyObject.)

System_CAPS_protmethodCancel(ActivityExecutionContext)

Called by the workflow runtime to cancel execution of an activity that is currently executing.(Inherited from Activity.)

System_CAPS_pubmethodClone()

Creates a deep copy of the Activity.(Inherited from Activity.)

System_CAPS_pubmethodDispose()

Releases all the resources used by the DependencyObject.(Inherited from DependencyObject.)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodExecute(ActivityExecutionContext)

Called by the workflow runtime to execute an activity. (Inherited from Activity.)

System_CAPS_pubmethodGetActivityByName(String)

Returns the instance of the Activity whose name is requested from the set of all activities running under the root activity of this instance, which is within the workflow.(Inherited from Activity.)

System_CAPS_pubmethodGetActivityByName(String, Boolean)

Returns the instance of the Activity whose name is requested from the set of all activities under the root the Activity of this instance if the second parameter is false and under the current Activity if the second parameter is true.(Inherited from Activity.)

System_CAPS_pubmethodGetBinding(DependencyProperty)

Provides access to the ActivityBind associated with the specific DependencyProperty.(Inherited from DependencyObject.)

System_CAPS_pubmethodSystem_CAPS_staticGetContext(Activity, ContextToken)

Static method that returns context information given an activity instance and context token.

System_CAPS_pubmethodSystem_CAPS_staticGetContext(Activity, String, String)

Static method that returns context information given an activity instance and context token.

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodSystem_CAPS_staticGetRootContext(Activity)

Static method that returns context information for the root context associated with a given activity instance. Context information is used for communication between a host application and the workflow service.

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodGetValue(DependencyProperty)

Provides access to the value of the designated DependencyProperty.(Inherited from DependencyObject.)

System_CAPS_pubmethodGetValueBase(DependencyProperty)

Provides access to the bound object of a DependencyProperty and bypasses the GetValue override.(Inherited from DependencyObject.)

System_CAPS_pubmethodSystem_CAPS_staticGetWorkflowServiceAttributes(Object)

Returns the WorkflowServiceAttributes attributes for the service implemented by the ReceiveActivity activity. These attributes include items like the AddressFilterMode, the ConfigurationName, the IncludeExceptionDetailInFaults, and whether to include exception details in any faults that are returned from the ReceiveActivity activity.

System_CAPS_protmethodHandleFault(ActivityExecutionContext, Exception)

Called when an exception is raised within the context of the execution of this instance.(Inherited from CompositeActivity.)

System_CAPS_protmethodInitialize(IServiceProvider)

Initializes all appropriate child activities of this instance and the specified IServiceProvider.(Inherited from CompositeActivity.)

System_CAPS_protmethodInvoke<T>(EventHandler<T>, T)

Subscribes an EventHandler and invokes that delegate.(Inherited from Activity.)

System_CAPS_protmethodInvoke<T>(IActivityEventListener<T>, T)

Subscribes an IActivityEventListener<T> and invokes that delegate.(Inherited from Activity.)

System_CAPS_pubmethodIsBindingSet(DependencyProperty)

Indicates whether the value of a DependencyProperty is set as a binding. See SetBinding.(Inherited from DependencyObject.)

System_CAPS_pubmethodMetaEquals(DependencyObject)

Determines whether the metaproperties of this DependencyObject equals the metaproperties of the parameterized DependencyObject.(Inherited from DependencyObject.)

System_CAPS_protmethodOnActivityChangeAdd(ActivityExecutionContext, Activity)

Calls when an activity is added.(Inherited from CompositeActivity.)

System_CAPS_protmethodOnActivityChangeRemove(ActivityExecutionContext, Activity)

Called when an activity is removed.(Inherited from CompositeActivity.)

System_CAPS_protmethodOnActivityExecutionContextLoad(IServiceProvider)

Called by the workflow runtime engine every time the ActivityExecutionContext for this activity is loaded.(Inherited from CompositeActivity.)

System_CAPS_protmethodOnActivityExecutionContextUnload(IServiceProvider)

Called by the workflow runtime engine every time the ActivityExecutionContext for this activity is unloaded.(Inherited from CompositeActivity.)

System_CAPS_protmethodOnWorkflowChangesCompleted(ActivityExecutionContext)

Called after changes have been made to the collection Activities of this instance.(Inherited from CompositeActivity.)

System_CAPS_protmethodRaiseEvent(DependencyProperty, Object, EventArgs)

Raises an Event associated with the specified dependency property.(Inherited from Activity.)

System_CAPS_protmethodRaiseGenericEvent<T>(DependencyProperty, Object, T)

Raises the event associated with the referenced DependencyProperty.(Inherited from Activity.)

System_CAPS_pubmethodRegisterForStatusChange(DependencyProperty, IActivityEventListener<ActivityExecutionStatusChangedEventArgs>)

Registers the specified DependencyProperty for the status change event.(Inherited from Activity.)

System_CAPS_pubmethodRemoveHandler(DependencyProperty, Object)

Removes an EventHandler from an associated DependencyProperty.(Inherited from DependencyObject.)

System_CAPS_pubmethodRemoveProperty(DependencyProperty)

Removes a DependencyProperty from the DependencyObject.(Inherited from DependencyObject.)

System_CAPS_pubmethodSave(Stream)

Writes the Activity to a Stream for persistence.(Inherited from Activity.)

System_CAPS_pubmethodSave(Stream, IFormatter)

Writes the Activity to a Stream for persistence using the custom IFormatter provided for serialization.(Inherited from Activity.)

System_CAPS_pubmethodSetBinding(DependencyProperty, ActivityBind)

Sets the ActivityBind for the specified DependencyProperty. (Inherited from DependencyObject.)

System_CAPS_protmethodSetReadOnlyPropertyValue(DependencyProperty, Object)

Sets the value of a DependencyProperty, which is read-only.(Inherited from DependencyObject.)

System_CAPS_pubmethodSetValue(DependencyProperty, Object)

Sets the value of the DependencyProperty to the object.(Inherited from DependencyObject.)

System_CAPS_pubmethodSetValueBase(DependencyProperty, Object)

Sets the value of the DependencyProperty to the specified Object, bypassing the SetValue.(Inherited from DependencyObject.)

System_CAPS_pubmethodSystem_CAPS_staticSetWorkflowServiceAttributes(Object, Object)

Sets the attributes for the service implemented by the ReceiveActivity activity. These attributes include items like the AddressFilterMode, the ConfigurationName, and whether to include exception details in any faults that are returned from the ReceiveActivity activity.

System_CAPS_pubmethodToString()

Provides a string that represents this instance.(Inherited from Activity.)

System_CAPS_protmethodUninitialize(IServiceProvider)

Called by the workflow runtime engine when an activity transitions into the Closed state from the Initialized state.(Inherited from CompositeActivity.)

System_CAPS_pubmethodUnregisterForStatusChange(DependencyProperty, IActivityEventListener<ActivityExecutionStatusChangedEventArgs>)

Un-registers the specified DependencyProperty for the status change event.(Inherited from Activity.)

NameDescription
System_CAPS_pubfieldSystem_CAPS_staticFaultMessageProperty

Represents the DependencyProperty that targets the FaultMessage property.

System_CAPS_pubfieldSystem_CAPS_staticOperationValidationEvent

Represents the DependencyProperty that targets the OperationValidation event.

System_CAPS_pubfieldSystem_CAPS_staticWorkflowServiceAttributesProperty

Represents the DependencyProperty that targets the ServiceOperationInfo property.

NameDescription
System_CAPS_pubeventCanceling

Occurs when the activity execution is canceled. (Inherited from Activity.)

System_CAPS_pubeventClosed

Occurs when an Activity has completed execution.(Inherited from Activity.)

System_CAPS_pubeventCompensating

Occurs when running a compensation method on the Activity.(Inherited from Activity.)

System_CAPS_pubeventExecuting

Occurs when the Activity is run.(Inherited from Activity.)

System_CAPS_pubeventFaulting

Occurs when an exception is raised during the running of the instance.(Inherited from Activity.)

System_CAPS_pubeventOperationValidation

Occurs when a message is received for an operation and validation is required.

System_CAPS_pubeventStatusChanged

Occurs when the ActivityExecutionStatus of a running Activity changes.(Inherited from Activity.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_priveventIComponent.Disposed

Represents the method that handles the Disposed event of a component.(Inherited from DependencyObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIEventActivity.Subscribe(ActivityExecutionContext, IActivityEventListener<QueueEventArgs>)

Creates the subscription of the ReceiveActivity activity to an event.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIEventActivity.Unsubscribe(ActivityExecutionContext, IActivityEventListener<QueueEventArgs>)

Cancels the subscription of a Activity to an event.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIActivityEventListener<ActivityExecutionStatusChangedEventArgs>.OnEvent(Object, ActivityExecutionStatusChangedEventArgs)

Defines the processing procedure when the subscribed-to event occurs.(Inherited from SequenceActivity.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIActivityEventListener<QueueEventArgs>.OnEvent(Object, QueueEventArgs)

Defines the processing procedure when the subscribed-to event occurs.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIEventActivity.QueueName

Gets the name of the WorkflowQueue on which the activity is waiting for data to arrive.

System_CAPS_noteNote

This material discusses types and namespaces that are obsolete. For more information, see Deprecated Types in Windows Workflow Foundation 4.5.

The ReceiveActivity activity is used when a workflow implements an operation defined in a WCF service contract. The ReceiveActivity can implement an operation from an already defined service contract or can define the service contract and operation within the workflow itself. The latter is known as a workflow-first contract.

The ReceiveActivity activity supports a set of predefined message exchange patterns. These patterns include:

  • One-way receive

    The client that sends the message does not expect the service to send a response. The contract operation should have a void return type.

  • Receive request - Send response

    After a message is received and processed by the ReceiveActivity activity, a response is sent back to the client. When the contract operation has a void return type, an acknowledgement is sent back to the send activity.

  • Receive request - Send fault

    After a message is received and processed by the ReceiveActivity activity, a response or a fault is sent back to the client.

System_CAPS_noteNote

To ensure that persistence performs properly and does not persist transient messages, make sure that child activities of the ReceiveActivity do not persist by themselves. This can occur if the child activities go idle when a persistence provider was created with UnloadOnIdle set to true, for instance.

System_CAPS_noteNote

This activity is part of .NET Framework 3.5. For the equivalent activity in .NET Framework 4, see Receive.

.NET Framework
Available since 3.5

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: