Permalink
Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
1385 lines (1385 sloc) 91.2 KB
<Type Name="BrokeredMessage" FullName="Microsoft.ServiceBus.Messaging.BrokeredMessage">
<TypeSignature Language="C#" Value="public sealed class BrokeredMessage : IDisposable, System.Xml.Serialization.IXmlSerializable" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit BrokeredMessage extends System.Object implements class System.IDisposable, class System.Xml.Serialization.IXmlSerializable" />
<TypeSignature Language="DocId" Value="T:Microsoft.ServiceBus.Messaging.BrokeredMessage" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class BrokeredMessage&#xA;Implements IDisposable, IXmlSerializable" />
<TypeSignature Language="F#" Value="type BrokeredMessage = class&#xA; interface IXmlSerializable&#xA; interface IDisposable" />
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.Xml.Serialization.IXmlSerializable</InterfaceName>
</Interface>
</Interfaces>
<Attributes>
<Attribute FrameworkAlternate="azure-dotnet">
<AttributeName>System.Xml.Serialization.XmlRoot("BrokeredMessage", Namespace="http://schemas.microsoft.com/netservices/2011/06/servicebus")</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Represents the unit of communication between Service Bus clients.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public BrokeredMessage ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.BrokeredMessage.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:Microsoft.ServiceBus.Messaging.BrokeredMessage" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public BrokeredMessage (System.IO.Stream messageBodyStream);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.IO.Stream messageBodyStream) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.BrokeredMessage.#ctor(System.IO.Stream)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (messageBodyStream As Stream)" />
<MemberSignature Language="F#" Value="new Microsoft.ServiceBus.Messaging.BrokeredMessage : System.IO.Stream -&gt; Microsoft.ServiceBus.Messaging.BrokeredMessage" Usage="new Microsoft.ServiceBus.Messaging.BrokeredMessage messageBodyStream" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="messageBodyStream" Type="System.IO.Stream" />
</Parameters>
<Docs>
<param name="messageBodyStream">The message body stream.</param>
<summary>Initializes a new instance of the <see cref="T:Microsoft.ServiceBus.Messaging.BrokeredMessage" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public BrokeredMessage (object serializableObject);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(object serializableObject) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.BrokeredMessage.#ctor(System.Object)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (serializableObject As Object)" />
<MemberSignature Language="F#" Value="new Microsoft.ServiceBus.Messaging.BrokeredMessage : obj -&gt; Microsoft.ServiceBus.Messaging.BrokeredMessage" Usage="new Microsoft.ServiceBus.Messaging.BrokeredMessage serializableObject" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="serializableObject" Type="System.Object" />
</Parameters>
<Docs>
<param name="serializableObject">The object to be serialized into the message body.</param>
<summary>Initializes a new instance of the
<see cref="T:Microsoft.ServiceBus.Messaging.BrokeredMessage" /> class from a given object by using DataContractSerializer with a binary XmlDictionaryWriter.</summary>
<remarks>A default <see cref="T:Microsoft.ServiceBus.Messaging.DataContractBinarySerializer" /> is used for serializing the object.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public BrokeredMessage (System.IO.Stream messageBodyStream, bool ownsStream);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.IO.Stream messageBodyStream, bool ownsStream) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.BrokeredMessage.#ctor(System.IO.Stream,System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (messageBodyStream As Stream, ownsStream As Boolean)" />
<MemberSignature Language="F#" Value="new Microsoft.ServiceBus.Messaging.BrokeredMessage : System.IO.Stream * bool -&gt; Microsoft.ServiceBus.Messaging.BrokeredMessage" Usage="new Microsoft.ServiceBus.Messaging.BrokeredMessage (messageBodyStream, ownsStream)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="messageBodyStream" Type="System.IO.Stream" />
<Parameter Name="ownsStream" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="messageBodyStream">The message body stream.</param>
<param name="ownsStream">true to indicate that the stream will be closed when the message is
closed; false to indicate that the stream will not be closed when the message is closed.</param>
<summary>Initializes a new instance of the
<see cref="T:Microsoft.ServiceBus.Messaging.BrokeredMessage" /> class using the supplied stream as its body.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public BrokeredMessage (object serializableObject, System.Runtime.Serialization.XmlObjectSerializer serializer);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(object serializableObject, class System.Runtime.Serialization.XmlObjectSerializer serializer) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.BrokeredMessage.#ctor(System.Object,System.Runtime.Serialization.XmlObjectSerializer)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (serializableObject As Object, serializer As XmlObjectSerializer)" />
<MemberSignature Language="F#" Value="new Microsoft.ServiceBus.Messaging.BrokeredMessage : obj * System.Runtime.Serialization.XmlObjectSerializer -&gt; Microsoft.ServiceBus.Messaging.BrokeredMessage" Usage="new Microsoft.ServiceBus.Messaging.BrokeredMessage (serializableObject, serializer)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="serializableObject" Type="System.Object" />
<Parameter Name="serializer" Type="System.Runtime.Serialization.XmlObjectSerializer" />
</Parameters>
<Docs>
<param name="serializableObject"> The serializable object. </param>
<param name="serializer"> The serializer object. </param>
<summary> Constructor that creates a BrokeredMessage from a given object using the provided XmlObjectSerializer </summary>
<remarks> You should be aware of the exceptions that their provided Serializer can throw and take appropriate
actions. Please refer to <see href="http://msdn.microsoft.com/en-us/library/ms574055.aspx" /> for
a possible list of exceptions and their cause. </remarks>
<exception cref="T:System.ArgumentNullException">Thrown when null serializer is passed to the method
with a non-null serializableObject</exception>
</Docs>
</Member>
<Member MemberName="Abandon">
<MemberSignature Language="C#" Value="public void Abandon ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Abandon() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.BrokeredMessage.Abandon" />
<MemberSignature Language="VB.NET" Value="Public Sub Abandon ()" />
<MemberSignature Language="F#" Value="member this.Abandon : unit -&gt; unit" Usage="brokeredMessage.Abandon " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Abandons the lock on a peek-locked message.</summary>
<remarks> This operation should only be exercised on a message received in peek-lock mode.</remarks>
<exception cref="T:System.ObjectDisposedException">Thrown when the message is in the disposed state or
the receiver with which the message was received is in disposed state.</exception>
<exception cref="T:System.InvalidOperationException">Thrown when invoked on a message that has not been received from the
message server or invoked on a message that has not been received in peek-lock mode.</exception>
<exception cref="T:System.TimeoutException">Thrown when operation times out. The timeout period is initialized through the
<see cref="T:Microsoft.ServiceBus.Messaging.MessagingFactorySettings" />. You may need to increase the value of
<see cref="P:Microsoft.ServiceBus.Messaging.MessagingFactorySettings.OperationTimeout" /> to avoid this exception if the timeout value is relatively low.</exception>
<exception cref="T:Microsoft.ServiceBus.Messaging.MessagingCommunicationException">Thrown when the queue or subscription that receives
the message is no longer present in the message server.</exception>
<exception cref="T:Microsoft.ServiceBus.Messaging.ServerBusyException">When service bus service is
busy and is unable process the request.</exception>
<exception cref="T:Microsoft.ServiceBus.Messaging.MessagingEntityNotFoundException">When messaging entity the
message was received from has been deleted.</exception>
<exception cref="T:Microsoft.ServiceBus.Messaging.MessageLockLostException">When the lock associated with this message
was lost or the lock token was not found.</exception>
<exception cref="T:Microsoft.ServiceBus.Messaging.SessionLockLostException">When this message was received from a
Session and the lock associated with the session was lost.</exception>
<exception cref="T:System.UnauthorizedAccessException">When the security token provided by the
TokenProvider does not contain the claims to perform this operation.</exception>
<exception cref="T:System.ServiceModel.QuotaExceededException">When the number of concurrent connections
to an entity exceed the maximum allowed value.</exception>
</Docs>
</Member>
<Member MemberName="Abandon">
<MemberSignature Language="C#" Value="public void Abandon (System.Collections.Generic.IDictionary&lt;string,object&gt; propertiesToModify);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Abandon(class System.Collections.Generic.IDictionary`2&lt;string, object&gt; propertiesToModify) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.BrokeredMessage.Abandon(System.Collections.Generic.IDictionary{System.String,System.Object})" />
<MemberSignature Language="VB.NET" Value="Public Sub Abandon (propertiesToModify As IDictionary(Of String, Object))" />
<MemberSignature Language="F#" Value="member this.Abandon : System.Collections.Generic.IDictionary&lt;string, obj&gt; -&gt; unit" Usage="brokeredMessage.Abandon propertiesToModify" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="propertiesToModify" Type="System.Collections.Generic.IDictionary&lt;System.String,System.Object&gt;" />
</Parameters>
<Docs>
<param name="propertiesToModify">The key-value pair collection of properties to modify.</param>
<summary>Abandons the lock on a peek-locked message.</summary>
<remarks> This operation should only be exercised on a message received in peek-lock mode.</remarks>
<exception cref="T:System.ObjectDisposedException">Thrown when
<list type="bullet"><item>message is in disposed state.</item><item>the receiver with which the messsage was received is in disposed state</item></list></exception>
<exception cref="T:System.InvalidOperationException">Thrown when
<list type="bullet"><item>invoked on a message that has not been received from the message server.</item><item>invoked on a message that has not been received in peek-lock mode</item></list></exception>
<exception cref="T:System.TimeoutException">Thrown when operation times out. Timeout period is initialized through the <see cref="T:Microsoft.ServiceBus.Messaging.MessagingFactorySettings" />. You
may need to increase the value of <see cref="P:Microsoft.ServiceBus.Messaging.MessagingFactorySettings.OperationTimeout" /> to avoid this exception if timeout value
is relatively low.
<seealso cref="P:Microsoft.ServiceBus.Messaging.MessagingFactorySettings.OperationTimeout" /></exception>
<exception cref="T:System.ServiceModel.CommunicationException">Thrown when the queue or subscription that the message was received from is no longer present in the message server.</exception>
</Docs>
</Member>
<Member MemberName="AbandonAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task AbandonAsync ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task AbandonAsync() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.BrokeredMessage.AbandonAsync" />
<MemberSignature Language="VB.NET" Value="Public Function AbandonAsync () As Task" />
<MemberSignature Language="F#" Value="member this.AbandonAsync : unit -&gt; System.Threading.Tasks.Task" Usage="brokeredMessage.AbandonAsync " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Asynchronously abandons the lock on a peek-locked message.</summary>
<returns>The asynchronous result of the operation.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AbandonAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task AbandonAsync (System.Collections.Generic.IDictionary&lt;string,object&gt; propertiesToModify);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task AbandonAsync(class System.Collections.Generic.IDictionary`2&lt;string, object&gt; propertiesToModify) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.BrokeredMessage.AbandonAsync(System.Collections.Generic.IDictionary{System.String,System.Object})" />
<MemberSignature Language="VB.NET" Value="Public Function AbandonAsync (propertiesToModify As IDictionary(Of String, Object)) As Task" />
<MemberSignature Language="F#" Value="member this.AbandonAsync : System.Collections.Generic.IDictionary&lt;string, obj&gt; -&gt; System.Threading.Tasks.Task" Usage="brokeredMessage.AbandonAsync propertiesToModify" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="propertiesToModify" Type="System.Collections.Generic.IDictionary&lt;System.String,System.Object&gt;" />
</Parameters>
<Docs>
<param name="propertiesToModify">The key-value pair collection of properties to modify.</param>
<summary>Asynchronously abandons the lock on a peek-locked message.</summary>
<returns>The asynchronous result of the operation.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Clone">
<MemberSignature Language="C#" Value="public Microsoft.ServiceBus.Messaging.BrokeredMessage Clone ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.ServiceBus.Messaging.BrokeredMessage Clone() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.BrokeredMessage.Clone" />
<MemberSignature Language="VB.NET" Value="Public Function Clone () As BrokeredMessage" />
<MemberSignature Language="F#" Value="member this.Clone : unit -&gt; Microsoft.ServiceBus.Messaging.BrokeredMessage" Usage="brokeredMessage.Clone " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ServiceBus.Messaging.BrokeredMessage</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Clones a message, so that it is possible to send a clone of a message as a new message.</summary>
<returns>The <see cref="T:Microsoft.ServiceBus.Messaging.BrokeredMessage" /> that contains the cloned message.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Complete">
<MemberSignature Language="C#" Value="public void Complete ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Complete() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.BrokeredMessage.Complete" />
<MemberSignature Language="VB.NET" Value="Public Sub Complete ()" />
<MemberSignature Language="F#" Value="member this.Complete : unit -&gt; unit" Usage="brokeredMessage.Complete " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Completes the receive operation of a message and indicates that the message should be marked as processed and deleted.</summary>
<remarks> This method is used as a handshake between the receiver and Service Bus for a guaranteed delivery of the message. If the
receiver failed before calling this method, the message will be kept in the queue.</remarks>
<exception cref="T:System.ObjectDisposedException">Thrown when the message is in disposed state or
the receiver with which the message was received is in disposed state.</exception>
<exception cref="T:System.InvalidOperationException">Thrown when invoked on a message that has not been received from the
message server or invoked on a message that has not been received in peek-lock mode.</exception>
<exception cref="T:Microsoft.ServiceBus.Messaging.MessagingCommunicationException">Thrown when the queue or subscription that receives
the message is no longer present in the message server.</exception>
<exception cref="T:System.TimeoutException">Thrown when the operation times out. The timeout period is initialized through the
<see cref="T:Microsoft.ServiceBus.Messaging.MessagingFactorySettings" />. You may need to increase the value of
<see cref="P:Microsoft.ServiceBus.Messaging.MessagingFactorySettings.OperationTimeout" /> to avoid this exception if the timeout value is relatively low.</exception>
<exception cref="T:Microsoft.ServiceBus.Messaging.MessageLockLostException">Thrown if the lock on the message has expired. LockDuration is an entity-wide setting and can be initialized through
<see cref="P:Microsoft.ServiceBus.Messaging.QueueDescription.LockDuration" /> and
<see cref="P:Microsoft.ServiceBus.Messaging.SubscriptionDescription.LockDuration" /> for queues and subscriptions respectively.</exception>
<exception cref="T:Microsoft.ServiceBus.Messaging.SessionLockLostException">Thrown if the lock on the session has expired. The session lock duration is the same as the message LockDuration and is an entity-wide setting. It can be initialized through
<see cref="P:Microsoft.ServiceBus.Messaging.QueueDescription.LockDuration" /> and
<see cref="P:Microsoft.ServiceBus.Messaging.SubscriptionDescription.LockDuration" /> for queues and subscriptions respectively.</exception>
<exception cref="T:Microsoft.ServiceBus.Messaging.ServerBusyException">When service bus service is
busy and is unable process the request.</exception>
<exception cref="T:Microsoft.ServiceBus.Messaging.MessagingEntityNotFoundException">When messaging entity the
message was received from has been deleted.</exception>
<exception cref="T:System.UnauthorizedAccessException">When the security token provided by the
TokenProvider does not contain the claims to perform this operation.</exception>
<exception cref="T:System.ServiceModel.QuotaExceededException">When the number of concurrent connections
to an entity exceed the maximum allowed value.</exception>
</Docs>
</Member>
<Member MemberName="CompleteAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task CompleteAsync ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task CompleteAsync() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.BrokeredMessage.CompleteAsync" />
<MemberSignature Language="VB.NET" Value="Public Function CompleteAsync () As Task" />
<MemberSignature Language="F#" Value="member this.CompleteAsync : unit -&gt; System.Threading.Tasks.Task" Usage="brokeredMessage.CompleteAsync " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Asynchronously completes the receive operation of a message and
indicates that the message should be marked as processed and deleted.</summary>
<returns>The asynchronous result of the operation.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ContentType">
<MemberSignature Language="C#" Value="public string ContentType { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ContentType" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.BrokeredMessage.ContentType" />
<MemberSignature Language="VB.NET" Value="Public Property ContentType As String" />
<MemberSignature Language="F#" Value="member this.ContentType : string with get, set" Usage="Microsoft.ServiceBus.Messaging.BrokeredMessage.ContentType" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the type of the content.</summary>
<value>The type of the content of the message body. This is a
content type identifier utilized by the sender and receiver for application specific logic.</value>
<remarks>To be added.</remarks>
<exception cref="T:System.ObjectDisposedException">Thrown if the message is in disposed state.</exception>
</Docs>
</Member>
<Member MemberName="CorrelationId">
<MemberSignature Language="C#" Value="public string CorrelationId { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string CorrelationId" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.BrokeredMessage.CorrelationId" />
<MemberSignature Language="VB.NET" Value="Public Property CorrelationId As String" />
<MemberSignature Language="F#" Value="member this.CorrelationId : string with get, set" Usage="Microsoft.ServiceBus.Messaging.BrokeredMessage.CorrelationId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the identifier of the correlation.</summary>
<value>The identifier of the correlation.</value>
<remarks>To be added.</remarks>
<exception cref="T:System.ObjectDisposedException">Thrown if the message is in disposed state.</exception>
</Docs>
</Member>
<Member MemberName="DeadLetter">
<MemberSignature Language="C#" Value="public void DeadLetter ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void DeadLetter() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.BrokeredMessage.DeadLetter" />
<MemberSignature Language="VB.NET" Value="Public Sub DeadLetter ()" />
<MemberSignature Language="F#" Value="member this.DeadLetter : unit -&gt; unit" Usage="brokeredMessage.DeadLetter " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Moves the message to the dead letter queue.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ObjectDisposedException">Thrown when the message is in disposed state or
the receiver with which the message was received is in disposed state.</exception>
<exception cref="T:System.InvalidOperationException">Thrown when invoked on a message that has not been received from the
message server or invoked on a message that has not been received in peek-lock mode.</exception>
</Docs>
</Member>
<Member MemberName="DeadLetter">
<MemberSignature Language="C#" Value="public void DeadLetter (System.Collections.Generic.IDictionary&lt;string,object&gt; propertiesToModify);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void DeadLetter(class System.Collections.Generic.IDictionary`2&lt;string, object&gt; propertiesToModify) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.BrokeredMessage.DeadLetter(System.Collections.Generic.IDictionary{System.String,System.Object})" />
<MemberSignature Language="VB.NET" Value="Public Sub DeadLetter (propertiesToModify As IDictionary(Of String, Object))" />
<MemberSignature Language="F#" Value="member this.DeadLetter : System.Collections.Generic.IDictionary&lt;string, obj&gt; -&gt; unit" Usage="brokeredMessage.DeadLetter propertiesToModify" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="propertiesToModify" Type="System.Collections.Generic.IDictionary&lt;System.String,System.Object&gt;" />
</Parameters>
<Docs>
<param name="propertiesToModify">The key-value pair collection of properties to modify.</param>
<summary>Moves the message to the dead letter queue.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DeadLetter">
<MemberSignature Language="C#" Value="public void DeadLetter (string deadLetterReason, string deadLetterErrorDescription);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void DeadLetter(string deadLetterReason, string deadLetterErrorDescription) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.BrokeredMessage.DeadLetter(System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub DeadLetter (deadLetterReason As String, deadLetterErrorDescription As String)" />
<MemberSignature Language="F#" Value="member this.DeadLetter : string * string -&gt; unit" Usage="brokeredMessage.DeadLetter (deadLetterReason, deadLetterErrorDescription)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="deadLetterReason" Type="System.String" />
<Parameter Name="deadLetterErrorDescription" Type="System.String" />
</Parameters>
<Docs>
<param name="deadLetterReason">The reason for deadlettering the message.</param>
<param name="deadLetterErrorDescription">The description information for deadlettering the message.</param>
<summary>Moves the message to the dead letter queue.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ObjectDisposedException">Thrown when the message is in disposed state or
the receiver with which the message was received is in disposed state.</exception>
<exception cref="T:System.InvalidOperationException">Thrown when invoked on a message that has not been received from the
message server or invoked on a message that has not been received in peek-lock mode.</exception>
<exception cref="T:System.ServiceModel.CommunicationException">Thrown when the queue or subscription that receives
the message is no longer present in the message server.</exception>
<exception cref="T:System.TimeoutException">Thrown when operation times out. Timeout period is initialized through the
<see cref="T:Microsoft.ServiceBus.Messaging.MessagingFactorySettings" />. You may need to increase the value of
<see cref="P:Microsoft.ServiceBus.Messaging.MessagingFactorySettings.OperationTimeout" /> to avoid this exception if timeout value is relatively low.</exception>
<exception cref="T:Microsoft.ServiceBus.Messaging.MessageLockLostException">Thrown if the lock on the message has expired. LockDuration is an entity-wide setting and can be initialized through
<see cref="P:Microsoft.ServiceBus.Messaging.QueueDescription.LockDuration" /> and
<see cref="P:Microsoft.ServiceBus.Messaging.SubscriptionDescription.LockDuration" /> for Queues and Subscriptions respectively.</exception>
<exception cref="T:Microsoft.ServiceBus.Messaging.SessionLockLostException">Thrown if the lock on the session has expired. Session lock duration is the same as message LockDuration and is an entity-wide setting. It can be initialized through
<see cref="P:Microsoft.ServiceBus.Messaging.QueueDescription.LockDuration" /> and
<see cref="P:Microsoft.ServiceBus.Messaging.SubscriptionDescription.LockDuration" /> for Queues and Subscriptions respectively.</exception>
</Docs>
</Member>
<Member MemberName="DeadLetterAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task DeadLetterAsync ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task DeadLetterAsync() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.BrokeredMessage.DeadLetterAsync" />
<MemberSignature Language="VB.NET" Value="Public Function DeadLetterAsync () As Task" />
<MemberSignature Language="F#" Value="member this.DeadLetterAsync : unit -&gt; System.Threading.Tasks.Task" Usage="brokeredMessage.DeadLetterAsync " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Asynchronously moves the message to the dead letter queue.</summary>
<returns>The asynchronous result of the operation.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DeadLetterAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task DeadLetterAsync (System.Collections.Generic.IDictionary&lt;string,object&gt; propertiesToModify);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task DeadLetterAsync(class System.Collections.Generic.IDictionary`2&lt;string, object&gt; propertiesToModify) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.BrokeredMessage.DeadLetterAsync(System.Collections.Generic.IDictionary{System.String,System.Object})" />
<MemberSignature Language="VB.NET" Value="Public Function DeadLetterAsync (propertiesToModify As IDictionary(Of String, Object)) As Task" />
<MemberSignature Language="F#" Value="member this.DeadLetterAsync : System.Collections.Generic.IDictionary&lt;string, obj&gt; -&gt; System.Threading.Tasks.Task" Usage="brokeredMessage.DeadLetterAsync propertiesToModify" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="propertiesToModify" Type="System.Collections.Generic.IDictionary&lt;System.String,System.Object&gt;" />
</Parameters>
<Docs>
<param name="propertiesToModify">The key-value pair collection of properties to modify.</param>
<summary>Asynchronously moves the message to the dead letter queue.</summary>
<returns>The asynchronous result of the operation.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DeadLetterAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task DeadLetterAsync (string deadLetterReason, string deadLetterErrorDescription);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task DeadLetterAsync(string deadLetterReason, string deadLetterErrorDescription) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.BrokeredMessage.DeadLetterAsync(System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function DeadLetterAsync (deadLetterReason As String, deadLetterErrorDescription As String) As Task" />
<MemberSignature Language="F#" Value="member this.DeadLetterAsync : string * string -&gt; System.Threading.Tasks.Task" Usage="brokeredMessage.DeadLetterAsync (deadLetterReason, deadLetterErrorDescription)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="deadLetterReason" Type="System.String" />
<Parameter Name="deadLetterErrorDescription" Type="System.String" />
</Parameters>
<Docs>
<param name="deadLetterReason">The reason for deadlettering the message.</param>
<param name="deadLetterErrorDescription">The description information for deadlettering the message.</param>
<summary>Asynchronously moves the message to the dead letter queue.</summary>
<returns>The asynchronous result of the operation.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DeadLetterSource">
<MemberSignature Language="C#" Value="public string DeadLetterSource { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string DeadLetterSource" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.BrokeredMessage.DeadLetterSource" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property DeadLetterSource As String" />
<MemberSignature Language="F#" Value="member this.DeadLetterSource : string" Usage="Microsoft.ServiceBus.Messaging.BrokeredMessage.DeadLetterSource" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary />
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Defer">
<MemberSignature Language="C#" Value="public void Defer ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Defer() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.BrokeredMessage.Defer" />
<MemberSignature Language="VB.NET" Value="Public Sub Defer ()" />
<MemberSignature Language="F#" Value="member this.Defer : unit -&gt; unit" Usage="brokeredMessage.Defer " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Indicates that the receiver wants to defer the processing for this message.</summary>
<remarks>Before deferring the message, user MUST set aside the message receipt for later retrieval. </remarks>
<exception cref="T:System.ObjectDisposedException">Thrown when the message is in the disposed state or
the receiver with which the message was received is in the disposed state.</exception>
<exception cref="T:System.InvalidOperationException">Thrown when invoked on a message that has not been received from the
message server or invoked on a message that has not been received in peek-lock mode.</exception>
<exception cref="T:Microsoft.ServiceBus.Messaging.MessagingCommunicationException">Thrown when the queue or subscription that receives
the message is no longer present in the message server.</exception>
<exception cref="T:System.TimeoutException">Thrown when the operation times out. The timeout period is initialized through the
<see cref="T:Microsoft.ServiceBus.Messaging.MessagingFactorySettings" />. You may need to increase the value of
<see cref="P:Microsoft.ServiceBus.Messaging.MessagingFactorySettings.OperationTimeout" /> to avoid this exception if the timeout value is relatively low.</exception>
<exception cref="T:Microsoft.ServiceBus.Messaging.MessageLockLostException">Thrown if the lock on the message has expired. LockDuration is an entity-wide setting and can be initialized through
<see cref="P:Microsoft.ServiceBus.Messaging.QueueDescription.LockDuration" /> and
<see cref="P:Microsoft.ServiceBus.Messaging.SubscriptionDescription.LockDuration" /> for queues and subscriptions respectively.</exception>
<exception cref="T:Microsoft.ServiceBus.Messaging.SessionLockLostException">Thrown if the lock on the session has expired. The session lock duration is the same as the message LockDuration and is an entity-wide setting. It can be initialized through
<see cref="P:Microsoft.ServiceBus.Messaging.QueueDescription.LockDuration" /> and
<see cref="P:Microsoft.ServiceBus.Messaging.SubscriptionDescription.LockDuration" /> for queues and subscriptions respectively.</exception>
<exception cref="T:Microsoft.ServiceBus.Messaging.ServerBusyException">When service bus service is
busy and is unable process the request.</exception>
<exception cref="T:Microsoft.ServiceBus.Messaging.MessagingEntityNotFoundException">When messaging entity the
message was received from has been deleted.</exception>
<exception cref="T:System.UnauthorizedAccessException">When the security token provided by the
TokenProvider does not contain the claims to perform this operation.</exception>
<exception cref="T:System.ServiceModel.QuotaExceededException">When the number of concurrent connections
to an entity exceed the maximum allowed value.</exception>
</Docs>
</Member>
<Member MemberName="Defer">
<MemberSignature Language="C#" Value="public void Defer (System.Collections.Generic.IDictionary&lt;string,object&gt; propertiesToModify);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Defer(class System.Collections.Generic.IDictionary`2&lt;string, object&gt; propertiesToModify) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.BrokeredMessage.Defer(System.Collections.Generic.IDictionary{System.String,System.Object})" />
<MemberSignature Language="VB.NET" Value="Public Sub Defer (propertiesToModify As IDictionary(Of String, Object))" />
<MemberSignature Language="F#" Value="member this.Defer : System.Collections.Generic.IDictionary&lt;string, obj&gt; -&gt; unit" Usage="brokeredMessage.Defer propertiesToModify" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="propertiesToModify" Type="System.Collections.Generic.IDictionary&lt;System.String,System.Object&gt;" />
</Parameters>
<Docs>
<param name="propertiesToModify">The key-value pair collection of properties to modify.</param>
<summary>Indicates that the receiver wants to defer the processing for this message.</summary>
<remarks>Before deferring the message, user MUST set aside the message receipt for later retrieval. </remarks>
</Docs>
</Member>
<Member MemberName="DeferAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task DeferAsync ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task DeferAsync() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.BrokeredMessage.DeferAsync" />
<MemberSignature Language="VB.NET" Value="Public Function DeferAsync () As Task" />
<MemberSignature Language="F#" Value="member this.DeferAsync : unit -&gt; System.Threading.Tasks.Task" Usage="brokeredMessage.DeferAsync " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Asynchronously indicates that the receiver wants to defer the processing for this message.</summary>
<returns>The asynchronous result of the operation.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DeferAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task DeferAsync (System.Collections.Generic.IDictionary&lt;string,object&gt; propertiesToModify);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task DeferAsync(class System.Collections.Generic.IDictionary`2&lt;string, object&gt; propertiesToModify) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.BrokeredMessage.DeferAsync(System.Collections.Generic.IDictionary{System.String,System.Object})" />
<MemberSignature Language="VB.NET" Value="Public Function DeferAsync (propertiesToModify As IDictionary(Of String, Object)) As Task" />
<MemberSignature Language="F#" Value="member this.DeferAsync : System.Collections.Generic.IDictionary&lt;string, obj&gt; -&gt; System.Threading.Tasks.Task" Usage="brokeredMessage.DeferAsync propertiesToModify" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="propertiesToModify" Type="System.Collections.Generic.IDictionary&lt;System.String,System.Object&gt;" />
</Parameters>
<Docs>
<param name="propertiesToModify">The key-value pair collection of properties to modify.</param>
<summary>Asynchronously indicates that the receiver wants to defer the processing for this message.</summary>
<returns>The asynchronous result of the operation.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DeliveryCount">
<MemberSignature Language="C#" Value="public int DeliveryCount { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 DeliveryCount" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.BrokeredMessage.DeliveryCount" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property DeliveryCount As Integer" />
<MemberSignature Language="F#" Value="member this.DeliveryCount : int" Usage="Microsoft.ServiceBus.Messaging.BrokeredMessage.DeliveryCount" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the number of deliveries.</summary>
<value>The number of deliveries.</value>
<remarks>To be added.</remarks>
<exception cref="T:System.ObjectDisposedException">Thrown if the message is in disposed state.</exception>
<exception cref="T:System.InvalidOperationException">Thrown if the message has not been delivered by ServiceBus.</exception>
</Docs>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="public void Dispose ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Dispose() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.BrokeredMessage.Dispose" />
<MemberSignature Language="VB.NET" Value="Public Sub Dispose ()" />
<MemberSignature Language="F#" Value="abstract member Dispose : unit -&gt; unit&#xA;override this.Dispose : unit -&gt; unit" Usage="brokeredMessage.Dispose " />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.IDisposable.Dispose</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EnqueuedSequenceNumber">
<MemberSignature Language="C#" Value="public long EnqueuedSequenceNumber { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 EnqueuedSequenceNumber" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.BrokeredMessage.EnqueuedSequenceNumber" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property EnqueuedSequenceNumber As Long" />
<MemberSignature Language="F#" Value="member this.EnqueuedSequenceNumber : int64" Usage="Microsoft.ServiceBus.Messaging.BrokeredMessage.EnqueuedSequenceNumber" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the enqueued sequence number of the message.</summary>
<value>The enqueued sequence number of the message.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EnqueuedTimeUtc">
<MemberSignature Language="C#" Value="public DateTime EnqueuedTimeUtc { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTime EnqueuedTimeUtc" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.BrokeredMessage.EnqueuedTimeUtc" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property EnqueuedTimeUtc As DateTime" />
<MemberSignature Language="F#" Value="member this.EnqueuedTimeUtc : DateTime" Usage="Microsoft.ServiceBus.Messaging.BrokeredMessage.EnqueuedTimeUtc" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.DateTime</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the date and time of the sent time in UTC.</summary>
<value>The enqueue time in UTC. This value represents the actual time of enqueuing the message.</value>
<remarks>To be added.</remarks>
<exception cref="T:System.ObjectDisposedException">Thrown if the message is in disposed state.</exception>
</Docs>
</Member>
<Member MemberName="ExpiresAtUtc">
<MemberSignature Language="C#" Value="public DateTime ExpiresAtUtc { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTime ExpiresAtUtc" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.BrokeredMessage.ExpiresAtUtc" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ExpiresAtUtc As DateTime" />
<MemberSignature Language="F#" Value="member this.ExpiresAtUtc : DateTime" Usage="Microsoft.ServiceBus.Messaging.BrokeredMessage.ExpiresAtUtc" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.DateTime</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the date and time in UTC at which the message is set to expire.</summary>
<value>The message expiration time in UTC.</value>
<remarks>To be added.</remarks>
<exception cref="T:System.ObjectDisposedException">Thrown if the message is in disposed state.</exception>
<exception cref="T:System.InvalidOperationException">If the message has not been delivered by ServerBus.</exception>
</Docs>
</Member>
<Member MemberName="ForcePersistence">
<MemberSignature Language="C#" Value="public bool ForcePersistence { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool ForcePersistence" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.BrokeredMessage.ForcePersistence" />
<MemberSignature Language="VB.NET" Value="Public Property ForcePersistence As Boolean" />
<MemberSignature Language="F#" Value="member this.ForcePersistence : bool with get, set" Usage="Microsoft.ServiceBus.Messaging.BrokeredMessage.ForcePersistence" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value that indicates whether the message is to be persisted to the database immediately, instead of being
held in memory for a short time. This property is ignored if the message is sent to a non-express queue or topic.</summary>
<value>true if the message is to be persisted to the database
immediately, instead of being held in memory for a short time; otherwise, false.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetBody&lt;T&gt;">
<MemberSignature Language="C#" Value="public T GetBody&lt;T&gt; ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance !!T GetBody&lt;T&gt;() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.BrokeredMessage.GetBody``1" />
<MemberSignature Language="VB.NET" Value="Public Function GetBody(Of T) () As T" />
<MemberSignature Language="F#" Value="member this.GetBody : unit -&gt; 'T" Usage="brokeredMessage.GetBody " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>T</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T" />
</TypeParameters>
<Parameters />
<Docs>
<typeparam name="T">The type to which the message body will be deserialized.</typeparam>
<summary>Deserializes the brokered message body into an object of the specified type by using the
<see cref="T:System.Runtime.Serialization.DataContractSerializer" /> with a binary
<see cref="T:System.Xml.XmlDictionaryReader" />.</summary>
<returns>The deserialized object or graph.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ObjectDisposedException">If the message is in disposed state or the message body stream is already disposed.</exception>
<exception cref="T:System.InvalidOperationException">If the message contains a null body stream or the
body stream contains no data or the message body has already been consumed.</exception>
</Docs>
</Member>
<Member MemberName="GetBody&lt;T&gt;">
<MemberSignature Language="C#" Value="public T GetBody&lt;T&gt; (System.Runtime.Serialization.XmlObjectSerializer serializer);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance !!T GetBody&lt;T&gt;(class System.Runtime.Serialization.XmlObjectSerializer serializer) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.BrokeredMessage.GetBody``1(System.Runtime.Serialization.XmlObjectSerializer)" />
<MemberSignature Language="VB.NET" Value="Public Function GetBody(Of T) (serializer As XmlObjectSerializer) As T" />
<MemberSignature Language="F#" Value="member this.GetBody : System.Runtime.Serialization.XmlObjectSerializer -&gt; 'T" Usage="brokeredMessage.GetBody serializer" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>T</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T" />
</TypeParameters>
<Parameters>
<Parameter Name="serializer" Type="System.Runtime.Serialization.XmlObjectSerializer" />
</Parameters>
<Docs>
<typeparam name="T"> Generic type parameter. </typeparam>
<param name="serializer"> The serializer object. </param>
<summary>Deserializes the BrokeredMessage body into an object of the specified type using
DataContractSerializer with a Binary XmlObjectSerializer. </summary>
<returns> The deserialized object/graph</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ObjectDisposedException"> Thrown if the message is in disposed state. </exception>
<exception cref="T:System.ArgumentNullException"> Thrown when invoked with a Null serializer object. </exception>
<exception cref="T:System.InvalidOperationException"> Thrown if the message contains a Null body stream, contains no data,
or if the stream has been read once (through any GetBody() calls). </exception>
</Docs>
</Member>
<Member MemberName="IsBodyConsumed">
<MemberSignature Language="C#" Value="public bool IsBodyConsumed { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsBodyConsumed" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.BrokeredMessage.IsBodyConsumed" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property IsBodyConsumed As Boolean" />
<MemberSignature Language="F#" Value="member this.IsBodyConsumed : bool" Usage="Microsoft.ServiceBus.Messaging.BrokeredMessage.IsBodyConsumed" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Specifies whether the message has been consumed.</summary>
<value>true if the message has been consumed; otherwise, false.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Label">
<MemberSignature Language="C#" Value="public string Label { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Label" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.BrokeredMessage.Label" />
<MemberSignature Language="VB.NET" Value="Public Property Label As String" />
<MemberSignature Language="F#" Value="member this.Label : string with get, set" Usage="Microsoft.ServiceBus.Messaging.BrokeredMessage.Label" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the application specific label.</summary>
<value>The application specific label.</value>
<remarks>To be added.</remarks>
<exception cref="T:System.ObjectDisposedException">Thrown if the message is in disposed state.</exception>
</Docs>
</Member>
<Member MemberName="LockedUntilUtc">
<MemberSignature Language="C#" Value="public DateTime LockedUntilUtc { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTime LockedUntilUtc" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.BrokeredMessage.LockedUntilUtc" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property LockedUntilUtc As DateTime" />
<MemberSignature Language="F#" Value="member this.LockedUntilUtc : DateTime" Usage="Microsoft.ServiceBus.Messaging.BrokeredMessage.LockedUntilUtc" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.DateTime</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the date and time in UTC until which the message will be locked in the queue/subscription.</summary>
<value>The date and time until which the message will be locked in the queue/subscription.</value>
<remarks>To be added.</remarks>
<exception cref="T:System.ObjectDisposedException">Thrown if the message is in disposed state.</exception>
<exception cref="T:System.InvalidOperationException">Thrown if the message was not received from the ServiceBus.</exception>
</Docs>
</Member>
<Member MemberName="LockToken">
<MemberSignature Language="C#" Value="public Guid LockToken { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Guid LockToken" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.BrokeredMessage.LockToken" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property LockToken As Guid" />
<MemberSignature Language="F#" Value="member this.LockToken : Guid" Usage="Microsoft.ServiceBus.Messaging.BrokeredMessage.LockToken" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Guid</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the lock token assigned by Service Bus to this message.</summary>
<value>The lock token assigned by Service Bus to this message.</value>
<remarks>To be added.</remarks>
<exception cref="T:System.ObjectDisposedException">Thrown if the message is in disposed state.</exception>
<exception cref="T:System.InvalidOperationException">Thrown if the message was not received from the ServiceBus.</exception>
</Docs>
</Member>
<Member MemberName="MessageId">
<MemberSignature Language="C#" Value="public string MessageId { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string MessageId" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.BrokeredMessage.MessageId" />
<MemberSignature Language="VB.NET" Value="Public Property MessageId As String" />
<MemberSignature Language="F#" Value="member this.MessageId : string with get, set" Usage="Microsoft.ServiceBus.Messaging.BrokeredMessage.MessageId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the identifier of the message. This is a
user-defined value that Service Bus can use to identify duplicate messages, if enabled.</summary>
<value>The identifier of the message.</value>
<remarks>To be added.</remarks>
<exception cref="T:System.ObjectDisposedException">Thrown if the message is in a disposed state.</exception>
<exception cref="T:System.ArgumentException">Thrown if the message identifier is null or exceeds 128 characters in length.</exception>
</Docs>
</Member>
<Member MemberName="PartitionKey">
<MemberSignature Language="C#" Value="public string PartitionKey { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string PartitionKey" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.BrokeredMessage.PartitionKey" />
<MemberSignature Language="VB.NET" Value="Public Property PartitionKey As String" />
<MemberSignature Language="F#" Value="member this.PartitionKey : string with get, set" Usage="Microsoft.ServiceBus.Messaging.BrokeredMessage.PartitionKey" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a partition key for sending a transactional message to a queue or topic that is not session-aware.</summary>
<value>The partition key for sending a transactional message.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Properties">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IDictionary&lt;string,object&gt; Properties { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IDictionary`2&lt;string, object&gt; Properties" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.BrokeredMessage.Properties" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Properties As IDictionary(Of String, Object)" />
<MemberSignature Language="F#" Value="member this.Properties : System.Collections.Generic.IDictionary&lt;string, obj&gt;" Usage="Microsoft.ServiceBus.Messaging.BrokeredMessage.Properties" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IDictionary&lt;System.String,System.Object&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the application specific message properties.</summary>
<value>The application specific message properties.</value>
<remarks>The size of each property object within the Properties bag cannot exceed 32 kilobytes.
The collective size of the Properties bag cannot exceed 64 kilobytes.</remarks>
<exception cref="T:System.ObjectDisposedException">Thrown if the message is in disposed state.</exception>
</Docs>
</Member>
<Member MemberName="RenewLock">
<MemberSignature Language="C#" Value="public void RenewLock ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void RenewLock() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.BrokeredMessage.RenewLock" />
<MemberSignature Language="VB.NET" Value="Public Sub RenewLock ()" />
<MemberSignature Language="F#" Value="member this.RenewLock : unit -&gt; unit" Usage="brokeredMessage.RenewLock " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Renews the lock on a message.</summary>
<remarks>To be added.</remarks>
<exception cref="T:Microsoft.ServiceBus.Messaging.MessagingException">If
<see cref="P:Microsoft.ServiceBus.Messaging.MessagingException.IsTransient" /> is true, you can retry the operation immediately.</exception>
<exception cref="T:Microsoft.ServiceBus.Messaging.MessagingCommunicationException">You can retry the operation immediately.</exception>
<exception cref="T:Microsoft.ServiceBus.Messaging.MessageLockLostException">Thrown if you have called
<see cref="M:Microsoft.ServiceBus.Messaging.BrokeredMessage.RenewLock" /> too late. In a session, this is never thrown.</exception>
<exception cref="T:Microsoft.ServiceBus.Messaging.SessionLockLostException">Thrown instead of
<see cref="T:Microsoft.ServiceBus.Messaging.MessageLockLostException" /> if the message is from a
<see cref="T:Microsoft.ServiceBus.Messaging.MessageSession" />.</exception>
</Docs>
</Member>
<Member MemberName="RenewLockAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task RenewLockAsync ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task RenewLockAsync() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.BrokeredMessage.RenewLockAsync" />
<MemberSignature Language="VB.NET" Value="Public Function RenewLockAsync () As Task" />
<MemberSignature Language="F#" Value="member this.RenewLockAsync : unit -&gt; System.Threading.Tasks.Task" Usage="brokeredMessage.RenewLockAsync " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Asynchronously renews the lock on a message.</summary>
<returns>The asynchronous result of the operation.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ReplyTo">
<MemberSignature Language="C#" Value="public string ReplyTo { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ReplyTo" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.BrokeredMessage.ReplyTo" />
<MemberSignature Language="VB.NET" Value="Public Property ReplyTo As String" />
<MemberSignature Language="F#" Value="member this.ReplyTo : string with get, set" Usage="Microsoft.ServiceBus.Messaging.BrokeredMessage.ReplyTo" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the address of the queue to reply to.</summary>
<value>The reply to queue address.</value>
<remarks>To be added.</remarks>
<exception cref="T:System.ObjectDisposedException">Thrown if the message is in disposed state.</exception>
</Docs>
</Member>
<Member MemberName="ReplyToSessionId">
<MemberSignature Language="C#" Value="public string ReplyToSessionId { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ReplyToSessionId" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.BrokeredMessage.ReplyToSessionId" />
<MemberSignature Language="VB.NET" Value="Public Property ReplyToSessionId As String" />
<MemberSignature Language="F#" Value="member this.ReplyToSessionId : string with get, set" Usage="Microsoft.ServiceBus.Messaging.BrokeredMessage.ReplyToSessionId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the session identifier to reply to.</summary>
<value>The session identifier to reply to.</value>
<remarks>To be added.</remarks>
<exception cref="T:System.ObjectDisposedException">Thrown if the message is in disposed state.</exception>
</Docs>
</Member>
<Member MemberName="ScheduledEnqueueTimeUtc">
<MemberSignature Language="C#" Value="public DateTime ScheduledEnqueueTimeUtc { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTime ScheduledEnqueueTimeUtc" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.BrokeredMessage.ScheduledEnqueueTimeUtc" />
<MemberSignature Language="VB.NET" Value="Public Property ScheduledEnqueueTimeUtc As DateTime" />
<MemberSignature Language="F#" Value="member this.ScheduledEnqueueTimeUtc : DateTime with get, set" Usage="Microsoft.ServiceBus.Messaging.BrokeredMessage.ScheduledEnqueueTimeUtc" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.DateTime</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the date and time in UTC at which the message will be enqueued. This
property returns the time in UTC; when setting the property, the supplied DateTime value must also be in UTC.</summary>
<value>The scheduled enqueue time in UTC. This value is for delayed message sending.
It is utilized to delay messages sending to a specific time in the future.</value>
<remarks> Message enquing time does not mean that the message will be sent at the same time. It will get enqueued, but the actual sending time
depends on the queue's workload and its state. <seealso cref="P:Microsoft.ServiceBus.Messaging.BrokeredMessage.EnqueuedTimeUtc" /></remarks>
<exception cref="T:System.ObjectDisposedException">Thrown if the message is in disposed state.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">Thrown if the passed in value is DateTime.MaxValue.</exception>
</Docs>
</Member>
<Member MemberName="SequenceNumber">
<MemberSignature Language="C#" Value="public long SequenceNumber { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 SequenceNumber" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.BrokeredMessage.SequenceNumber" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property SequenceNumber As Long" />
<MemberSignature Language="F#" Value="member this.SequenceNumber : int64" Usage="Microsoft.ServiceBus.Messaging.BrokeredMessage.SequenceNumber" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the unique number assigned to a message by the Service Bus.</summary>
<value>The unique number assigned to a message by the Service Bus.</value>
<remarks>To be added.</remarks>
<exception cref="T:System.ObjectDisposedException">Thrown if the message is in disposed state.</exception>
<exception cref="T:System.InvalidOperationException">Thrown if the message was not received from the message server.</exception>
</Docs>
</Member>
<Member MemberName="SessionId">
<MemberSignature Language="C#" Value="public string SessionId { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string SessionId" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.BrokeredMessage.SessionId" />
<MemberSignature Language="VB.NET" Value="Public Property SessionId As String" />
<MemberSignature Language="F#" Value="member this.SessionId : string with get, set" Usage="Microsoft.ServiceBus.Messaging.BrokeredMessage.SessionId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the identifier of the session.</summary>
<value>The identifier of the session.</value>
<remarks>To be added.</remarks>
<exception cref="T:System.ObjectDisposedException">Thrown if the message is in disposed state.</exception>
</Docs>
</Member>
<Member MemberName="Size">
<MemberSignature Language="C#" Value="public long Size { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 Size" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.BrokeredMessage.Size" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Size As Long" />
<MemberSignature Language="F#" Value="member this.Size : int64" Usage="Microsoft.ServiceBus.Messaging.BrokeredMessage.Size" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the size of the message in bytes.</summary>
<value>The message size in bytes.</value>
<remarks>The value of Size is only accurate after the BrokeredMessage instance is
sent or received.</remarks>
<exception cref="T:System.ObjectDisposedException">Thrown if the message is in disposed state.</exception>
</Docs>
</Member>
<Member MemberName="State">
<MemberSignature Language="C#" Value="public Microsoft.ServiceBus.Messaging.MessageState State { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.ServiceBus.Messaging.MessageState State" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.BrokeredMessage.State" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property State As MessageState" />
<MemberSignature Language="F#" Value="member this.State : Microsoft.ServiceBus.Messaging.MessageState" Usage="Microsoft.ServiceBus.Messaging.BrokeredMessage.State" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ServiceBus.Messaging.MessageState</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the state of the message.</summary>
<value>The state of the message.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="System.Xml.Serialization.IXmlSerializable.GetSchema">
<MemberSignature Language="C#" Value="System.Xml.Schema.XmlSchema IXmlSerializable.GetSchema ();" />
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance class System.Xml.Schema.XmlSchema System.Xml.Serialization.IXmlSerializable.GetSchema() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.BrokeredMessage.System#Xml#Serialization#IXmlSerializable#GetSchema" />
<MemberSignature Language="VB.NET" Value="Function GetSchema () As XmlSchema Implements IXmlSerializable.GetSchema" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.Xml.Serialization.IXmlSerializable.GetSchema</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Xml.Schema.XmlSchema</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>This method is reserved and should not be used. When implementing the IXmlSerializable interface, you should return null (Nothing
in Visual Basic) from this method, and instead, if specifying a custom schema is required, apply the XmlSchemaProviderAttribute to the class.</summary>
<returns>An XmlSchema that describes the XML representation of the object that
is produced by the WriteXml method and consumed by the ReadXml method.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="System.Xml.Serialization.IXmlSerializable.ReadXml">
<MemberSignature Language="C#" Value="void IXmlSerializable.ReadXml (System.Xml.XmlReader reader);" />
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance void System.Xml.Serialization.IXmlSerializable.ReadXml(class System.Xml.XmlReader reader) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.BrokeredMessage.System#Xml#Serialization#IXmlSerializable#ReadXml(System.Xml.XmlReader)" />
<MemberSignature Language="VB.NET" Value="Sub ReadXml (reader As XmlReader) Implements IXmlSerializable.ReadXml" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.Xml.Serialization.IXmlSerializable.ReadXml(System.Xml.XmlReader)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="reader" Type="System.Xml.XmlReader" />
</Parameters>
<Docs>
<param name="reader">The XmlReader stream from which the object is deserialized.</param>
<summary>Generates an object from its XML representation. This method is reserved for internal use
and should not be used directly or indirectly (for example, using a serializer or a formatter).</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="System.Xml.Serialization.IXmlSerializable.WriteXml">
<MemberSignature Language="C#" Value="void IXmlSerializable.WriteXml (System.Xml.XmlWriter writer);" />
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance void System.Xml.Serialization.IXmlSerializable.WriteXml(class System.Xml.XmlWriter writer) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.BrokeredMessage.System#Xml#Serialization#IXmlSerializable#WriteXml(System.Xml.XmlWriter)" />
<MemberSignature Language="VB.NET" Value="Sub WriteXml (writer As XmlWriter) Implements IXmlSerializable.WriteXml" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.Xml.Serialization.IXmlSerializable.WriteXml(System.Xml.XmlWriter)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="writer" Type="System.Xml.XmlWriter" />
</Parameters>
<Docs>
<param name="writer">The XmlWriter stream to which the object is serialized.</param>
<summary>Converts an object into its XML representation. This method is reserved for internal use
and should not be used directly or indirectly (e.g. using a serializer or a formatter).</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TimeToLive">
<MemberSignature Language="C#" Value="public TimeSpan TimeToLive { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan TimeToLive" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.BrokeredMessage.TimeToLive" />
<MemberSignature Language="VB.NET" Value="Public Property TimeToLive As TimeSpan" />
<MemberSignature Language="F#" Value="member this.TimeToLive : TimeSpan with get, set" Usage="Microsoft.ServiceBus.Messaging.BrokeredMessage.TimeToLive" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the message’s time to live value. This is the duration after which the message expires, starting from when the message is sent to the Service Bus. Messages older than their TimeToLive value will expire and no longer be retained in the message store. Subscribers will be unable to receive expired messages.TimeToLive is the maximum lifetime that a message can receive, but its value cannot exceed the entity specified the
<see cref="P:Microsoft.ServiceBus.Messaging.QueueDescription.DefaultMessageTimeToLive" /> value on the destination queue or subscription. If a lower TimeToLive value is specified, it will be applied to the individual message. However, a larger value specified on the message will be overridden by the entity’s DefaultMessageTimeToLive value.</summary>
<value>The message’s time to live value.</value>
<remarks>If the TTL set on a message by the sender exceeds the destination's TTL, then the message's TTL will be overwritten by the later one.
See <see cref="P:Microsoft.ServiceBus.Messaging.QueueDescription.DefaultMessageTimeToLive" />, <see cref="P:Microsoft.ServiceBus.Messaging.TopicDescription.DefaultMessageTimeToLive" /> and <see cref="P:Microsoft.ServiceBus.Messaging.SubscriptionDescription.DefaultMessageTimeToLive" />
to learn more about how to control message TTL at an entity level.</remarks>
<exception cref="T:System.ObjectDisposedException">Thrown if the message is in disposed state.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">Thrown if the passed in value is less than or equal to TimeSpan.Zero.</exception>
</Docs>
</Member>
<Member MemberName="To">
<MemberSignature Language="C#" Value="public string To { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string To" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.BrokeredMessage.To" />
<MemberSignature Language="VB.NET" Value="Public Property To As String" />
<MemberSignature Language="F#" Value="member this.To : string with get, set" Usage="Microsoft.ServiceBus.Messaging.BrokeredMessage.To" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the send to address.</summary>
<value>The send to address.</value>
<remarks>To be added.</remarks>
<exception cref="T:System.ObjectDisposedException">Thrown if the message is in disposed state.</exception>
</Docs>
</Member>
<Member MemberName="ToString">
<MemberSignature Language="C#" Value="public override string ToString ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.BrokeredMessage.ToString" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
<MemberSignature Language="F#" Value="override this.ToString : unit -&gt; string" Usage="brokeredMessage.ToString " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Returns a string that represents the current message.</summary>
<returns>The string representation of the current message.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ViaPartitionKey">
<MemberSignature Language="C#" Value="public string ViaPartitionKey { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ViaPartitionKey" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.BrokeredMessage.ViaPartitionKey" />
<MemberSignature Language="VB.NET" Value="Public Property ViaPartitionKey As String" />
<MemberSignature Language="F#" Value="member this.ViaPartitionKey : string with get, set" Usage="Microsoft.ServiceBus.Messaging.BrokeredMessage.ViaPartitionKey" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a partition key value when a transaction is to be used to send messages via a transfer queue.</summary>
<value>The partition key value when a transaction is to be used to send messages via a transfer queue.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>