MessageInteropExtensions.xml

<Type Name="MessageInteropExtensions" FullName="Microsoft.Azure.ServiceBus.InteropExtensions.MessageInteropExtensions">
  <TypeSignature Language="C#" Value="public static class MessageInteropExtensions" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit MessageInteropExtensions extends System.Object" />
  <TypeSignature Language="DocId" Value="T:Microsoft.Azure.ServiceBus.InteropExtensions.MessageInteropExtensions" />
  <TypeSignature Language="VB.NET" Value="Public Module MessageInteropExtensions" />
  <TypeSignature Language="F#" Value="type MessageInteropExtensions = class" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
    <AssemblyVersion>5.1.3.0</AssemblyVersion>
    <AssemblyVersion>5.2.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
             A Message Extension Class that provides extension methods to deserialize
             the body of a message that was serialized and sent to ServiceBus Queue/Topic
             using the WindowsAzure.Messaging client library. The WindowsAzure.Messaging
             client library serializes objects using the
             <see cref="T:Microsoft.Azure.ServiceBus.InteropExtensions.DataContractBinarySerializer" /> (default serializer) or <see cref="T:System.Runtime.Serialization.DataContractSerializer" />
             when sending message. This class provides extension methods to deserialize
             and retrieve the body of such messages.
             </summary>
    <remarks>
             1. If a message is only being sent and received using this Microsoft.Azure.ServiceBus
             client library, then the below extension methods are not relevant and should not be used.
            
             2. If this client library will be used to receive messages that were sent using both
             WindowsAzure.Messaging client library and this (Microsoft.Azure.ServiceBus) library,
             then the Users need to add a User property <see cref="P:Microsoft.Azure.ServiceBus.Message.UserProperties" />
             while sending the message. On receiving the message, this property can be examined to
             determine if the message was from WindowsAzure.Messaging client library and if so
             use the message.GetBody() extension method to get the actual body associated with the message.
            
             ----------------------------------------------
             Scenarios to use the GetBody Extension method:
             ----------------------------------------------
             If message was constructed using the WindowsAzure.Messaging client library as follows:
             <code>
                 var message1 = new BrokeredMessage("contoso"); // Sending a plain string
                 var message2 = new BrokeredMessage(sampleObject); // Sending an actual customer object
                 var message3 = new BrokeredMessage(Encoding.UTF8.GetBytes("contoso")); // Sending a UTF8 encoded byte array object
            
                 await messageSender.SendAsync(message1);
                 await messageSender.SendAsync(message2);
                 await messageSender.SendAsync(message3);
             </code>
            
             Then retrieve the original objects using this client library as follows:
             (By default <see cref="T:Microsoft.Azure.ServiceBus.InteropExtensions.DataContractBinarySerializer" /> will be used to deserialize and retrieve the body.
              If a serializer other than that was used, pass in the serializer explicitly.)
             <code>
                 var message1 = await messageReceiver.ReceiveAsync();
                 var returnedData1 = message1.GetBody&lt;string&gt;();
            
                 var message2 = await messageReceiver.ReceiveAsync();
                 var returnedData2 = message1.GetBody&lt;SampleObject&gt;();
            
                 var message3 = await messageReceiver.ReceiveAsync();
                 var returnedData3Bytes = message1.GetBody&lt;byte[]&gt;();
                 Console.WriteLine($"Message3 String: {Encoding.UTF8.GetString(returnedData3Bytes)}");
             </code>
            
             -------------------------------------------------
             Scenarios to NOT use the GetBody Extension method:
             -------------------------------------------------
              If message was sent using the WindowsAzure.Messaging client library as follows:
                 var message4 = new BrokeredMessage(new MemoryStream(Encoding.UTF8.GetBytes("contoso")));
                 await messageSender.SendAsync(message4);
            
              Then retrieve the original objects using this client library as follows:
                 var message4 = await messageReceiver.ReceiveAsync();
                 string returned = Encoding.UTF8.GetString(message4.Body); // Since message was sent as Stream, no deserialization required here.
            
             </remarks>
  </Docs>
  <Members>
    <Member MemberName="GetBody&lt;T&gt;">
      <MemberSignature Language="C#" Value="public static T GetBody&lt;T&gt; (this Microsoft.Azure.ServiceBus.Message message, System.Runtime.Serialization.XmlObjectSerializer serializer = default);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig !!T GetBody&lt;T&gt;(class Microsoft.Azure.ServiceBus.Message message, class System.Runtime.Serialization.XmlObjectSerializer serializer) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.ServiceBus.InteropExtensions.MessageInteropExtensions.GetBody``1(Microsoft.Azure.ServiceBus.Message,System.Runtime.Serialization.XmlObjectSerializer)" />
      <MemberSignature Language="VB.NET" Value="&lt;Extension()&gt;&#xA;Public Function GetBody(Of T) (message As Message, Optional serializer As XmlObjectSerializer = Nothing) As T" />
      <MemberSignature Language="F#" Value="static member GetBody : Microsoft.Azure.ServiceBus.Message * System.Runtime.Serialization.XmlObjectSerializer -&gt; 'T" Usage="Microsoft.Azure.ServiceBus.InteropExtensions.MessageInteropExtensions.GetBody (message, serializer)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
        <AssemblyVersion>5.2.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>T</ReturnType>
      </ReturnValue>
      <TypeParameters>
        <TypeParameter Name="T" />
      </TypeParameters>
      <Parameters>
        <Parameter Name="message" Type="Microsoft.Azure.ServiceBus.Message" RefType="this" />
        <Parameter Name="serializer" Type="System.Runtime.Serialization.XmlObjectSerializer" />
      </Parameters>
      <Docs>
        <typeparam name="T">To be added.</typeparam>
        <param name="message">To be added.</param>
        <param name="serializer">To be added.</param>
        <summary>
            Deserializes the body of a message that was serialized using XmlObjectSerializer
            </summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>