Receive Class

Receive Class

An activity that receives a message.


Namespace:  System.ServiceModel.Activities
Assembly:  System.ServiceModel.Activities (in System.ServiceModel.Activities.dll)

public sealed class Receive : Activity

The Receive type exposes the following members.

Public methodReceiveInitializes a new instance of the Receive class.

Public propertyActionGets or sets the value of the action header of the message.
Protected propertyCacheIdGets the identifier of the cache that is unique within the scope of the workflow definition. (Inherited from Activity.)
Public propertyCanCreateInstanceGets or sets a value that indicates whether a new workflow instance is created to process the message if the message does not correlate to an existing workflow instance..
Protected propertyConstraintsGets a collection of Constraint activities that can be configured to provide validation for the Activity. (Inherited from Activity.)
Public propertyContentGets or sets the data to receive. The content can be either a ReceiveMessageContent or a ReceiveParametersContent.
Public propertyCorrelatesOnGets or sets the MessageQuerySet used to query the message to extract correlation data.
Public propertyCorrelatesWithGets or sets a correlation handle that is used to route the message to the appropriate workflow instance.
Public propertyCorrelationInitializersGets a collection of correlation initializers that initialize query-based, context, callback context, or request-reply correlations with a Send activity runs.
Public propertyDisplayNameGets or sets an optional friendly name that is used for debugging, validation, exception handling, and tracking. (Inherited from Activity.)
Public propertyIdGets an identifier that is unique in the scope of the workflow definition. (Inherited from Activity.)
Protected propertyImplementationGets or sets the delegate that returns an Activity that contains the execution logic. (Inherited from Activity.)
Public propertyKnownTypesGets a collection of known types for the operation.
Public propertyOperationNameGets or sets the name of the operation implemented by the Receive.
Public propertyProtectionLevelGets or sets a value that indicates the protection level for the operation.
Public propertySerializerOptionGets or sets a value that specifies the serializer to use for this operation.
Public propertyServiceContractNameGets or sets the name of the service contract.

Protected methodCacheMetadataCreates and validates a description of the activity’s arguments, variables, child activities, and activity delegates. (Inherited from Activity.)
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodShouldSerializeCorrelatesOnReturns a value that indicates whether the CorrelatesOn property has changed from its default value and should be serialized.
Public methodShouldSerializeDisplayNameIndicates whether the DisplayName property should be serialized. (Inherited from Activity.)
Public methodToStringReturns a String that contains the Id and DisplayName of the Activity. (Inherited from Activity.)

The Receive activity can receive a single item or multiple items depending on the type of receive content used.

Caution noteCaution

When a workflow contains multiple Receive activities with the same operation name, the CorrelatesOn property must be set to the same set of correlation queries.

The following example shows how to create a Receive activity and add it to a workflow in code.

Variable<string> message = new Variable<string> { Name = "message" };
Variable<string> echo = new Variable<string> { Name = "echo" };
Receive receiveString = new Receive
    OperationName = "Echo",
    ServiceContractName = "Echo",
    CanCreateInstance = true,
    //parameters for receive
    Content = new ReceiveParametersContent
        Parameters = 
            {"message", new OutArgument<string>(message)}

Sequence workflow = new Sequence()
    Variables = { message, echo },
    Activities =
            new WriteLine
                Text = new InArgument<string>(env =>("Message received: " + message.Get(env)))
            new Assign<string>
                Value = new InArgument<string>(env =>("<echo> " + message.Get(env))),
                To = new OutArgument<string>(echo)
            //parameters for reply
            new SendReply
                Request = receiveString,                            
                Content = new SendParametersContent
                    Parameters =
                        { "echo", new InArgument<string>(echo) }
            new WriteLine
                Text = new InArgument<string>(env =>("Message sent: " + echo.Get(env)))

service = new WorkflowService
    Name = "Echo",
    Body = workflow

The following example shows how to create a Receive activity and add it to a workflow service in XAML.

<WorkflowService mc:Ignorable="sap" ConfigurationName="Service1" Name="Service1" mva:VisualBasic.Settings="Assembly references and imported namespaces serialized as XML namespaces" xmlns="" xmlns:mc="" xmlns:mv="clr-namespace:Microsoft.VisualBasic;assembly=System" xmlns:mva="clr-namespace:Microsoft.VisualBasic.Activities;assembly=System.Activities" xmlns:p="" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:s1="clr-namespace:System;assembly=System" xmlns:s2="clr-namespace:System;assembly=System.Xml" xmlns:s3="clr-namespace:System;assembly=System.Core" xmlns:sad="clr-namespace:System.Activities.Debugger;assembly=System.Activities" xmlns:sap="" xmlns:scg="clr-namespace:System.Collections.Generic;assembly=System" xmlns:scg1="clr-namespace:System.Collections.Generic;assembly=System.ServiceModel" xmlns:scg2="clr-namespace:System.Collections.Generic;assembly=System.Core" xmlns:scg3="clr-namespace:System.Collections.Generic;assembly=mscorlib" xmlns:sd="clr-namespace:System.Data;assembly=System.Data" xmlns:sl="clr-namespace:System.Linq;assembly=System.Core" xmlns:ssa="clr-namespace:System.ServiceModel.Activities;assembly=System.ServiceModel.Activities" xmlns:st="clr-namespace:System.Text;assembly=mscorlib" xmlns:x="">
  <p:Sequence sad:XamlDebuggerXmlReader.FileName="c:\Projects\WFServiceSnippets\WFServiceSnippets\Service1.xamlx" sap:VirtualizedContainerService.HintSize="277,644" mva:VisualBasic.Settings="Assembly references and imported namespaces serialized as XML namespaces">
      <p:Variable x:TypeArguments="CorrelationHandle" Name="__handle1" />
      <p:Variable x:TypeArguments="x:String" Name="Message" />
      <p:Variable x:TypeArguments="x:String" Name="Echo" />
      <scg3:Dictionary x:TypeArguments="x:String, x:Object">
        <x:Boolean x:Key="IsExpanded">True</x:Boolean>
    <Receive x:Name="__ReferenceID0" CanCreateInstance="True" DisplayName="ReceiveString" sap:VirtualizedContainerService.HintSize="255,90" OperationName="Echo" ServiceContractName="Echo">
        <RequestReplyCorrelationInitializer CorrelationHandle="[__handle1]" />
        <p:OutArgument x:TypeArguments="x:String" x:Key="message">[Message]</p:OutArgument>
    <p:WriteLine sap:VirtualizedContainerService.HintSize="255,61" Text="[&quot;Message received: &quot; + Message]" />
    <p:Assign sap:VirtualizedContainerService.HintSize="255,58">
        <p:OutArgument x:TypeArguments="x:String">[Echo]</p:OutArgument>
        <p:InArgument x:TypeArguments="x:String">["&lt;echo&gt; " + Message]</p:InArgument>
    <SendReply Request="{x:Reference __ReferenceID0}" DisplayName="SendReply" sap:VirtualizedContainerService.HintSize="255,90">
        <p:InArgument x:TypeArguments="x:String" x:Key="echo">[Echo]</p:InArgument>
    <p:WriteLine sap:VirtualizedContainerService.HintSize="255,61" Text="[&quot;Message sent: &quot; + Echo]" />

.NET Framework

Supported in: 4

.NET Framework Client Profile

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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

Community Additions

© 2015 Microsoft