xml/Microsoft.ServiceBus.Messaging/QueueClient.xml

<Type Name="QueueClient" FullName="Microsoft.ServiceBus.Messaging.QueueClient"> <TypeSignature Language="C#" Value="public abstract class QueueClient : Microsoft.ServiceBus.Messaging.MessagingEntityClient" /> <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit QueueClient extends Microsoft.ServiceBus.Messaging.MessagingEntityClient" /> <TypeSignature Language="DocId" Value="T:Microsoft.ServiceBus.Messaging.QueueClient" /> <TypeSignature Language="VB.NET" Value="Public MustInherit Class QueueClient
Inherits MessagingEntityClient" /> <TypeSignature Language="F#" Value="type QueueClient = class
 inherit MessagingEntityClient" /> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <Base> <BaseTypeName>Microsoft.ServiceBus.Messaging.MessagingEntityClient</BaseTypeName> </Base> <Interfaces /> <Docs> <summary>Represents the queue client object.</summary> <remarks>To be added.</remarks> </Docs> <Members> <Member MemberName="Abandon"> <MemberSignature Language="C#" Value="public void Abandon (Guid lockToken);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Abandon(valuetype System.Guid lockToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.Abandon(System.Guid)" /> <MemberSignature Language="VB.NET" Value="Public Sub Abandon (lockToken As Guid)" /> <MemberSignature Language="F#" Value="abstract member Abandon : Guid -> unit
override this.Abandon : Guid -> unit" Usage="queueClient.Abandon lockToken" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="lockToken" Type="System.Guid" /> </Parameters> <Docs> <param name="lockToken">The lock token bound to the locked message instance to abandon.</param> <summary>Discards the message and relinquishes the message lock ownership.</summary> <remarks>When the client fails to get the message from the queue/topic, this method should be called. The Service Bus will increment the delivery count of the message. The client now can either attempt to receive the message again or move it to the dead-letter queue.</remarks> <exception cref="T:System.TimeoutException">Thrown if the operation exceeded the timeout value set by <see cref="P:Microsoft.ServiceBus.Messaging.MessagingFactorySettings.OperationTimeout" />.</exception> <exception cref="T:System.OperationCanceledException">Thrown if the client entity has been closed or aborted.</exception> </Docs> </Member> <Member MemberName="Abandon"> <MemberSignature Language="C#" Value="public void Abandon (Guid lockToken, System.Collections.Generic.IDictionary<string,object> propertiesToModify);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Abandon(valuetype System.Guid lockToken, class System.Collections.Generic.IDictionary`2<string, object> propertiesToModify) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.Abandon(System.Guid,System.Collections.Generic.IDictionary{System.String,System.Object})" /> <MemberSignature Language="VB.NET" Value="Public Sub Abandon (lockToken As Guid, propertiesToModify As IDictionary(Of String, Object))" /> <MemberSignature Language="F#" Value="abstract member Abandon : Guid * System.Collections.Generic.IDictionary<string, obj> -> unit
override this.Abandon : Guid * System.Collections.Generic.IDictionary<string, obj> -> unit" Usage="queueClient.Abandon (lockToken, 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="lockToken" Type="System.Guid" /> <Parameter Name="propertiesToModify" Type="System.Collections.Generic.IDictionary<System.String,System.Object>" /> </Parameters> <Docs> <param name="lockToken">The lock token bound to the locked message instance to abandon.</param> <param name="propertiesToModify">The properties of the message to modify.</param> <summary>Discards the message and relinquishes the message lock ownership.</summary> <remarks>When the client fails to get the message from the queue/topic, this method should be called. The Service Bus will increment the delivery count of the message. The client now can either attempt to receive the message again or move it to the dead-letter queue.</remarks> </Docs> </Member> <Member MemberName="AbandonAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task AbandonAsync (Guid lockToken);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task AbandonAsync(valuetype System.Guid lockToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.AbandonAsync(System.Guid)" /> <MemberSignature Language="VB.NET" Value="Public Function AbandonAsync (lockToken As Guid) As Task" /> <MemberSignature Language="F#" Value="abstract member AbandonAsync : Guid -> System.Threading.Tasks.Task
override this.AbandonAsync : Guid -> System.Threading.Tasks.Task" Usage="queueClient.AbandonAsync lockToken" /> <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="lockToken" Type="System.Guid" /> </Parameters> <Docs> <param name="lockToken">The lock token bound to the locked message instance to abandon.</param> <summary>Asynchronously discards the message and relinquishes the message lock ownership.</summary> <returns>The discarded message.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="AbandonAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task AbandonAsync (Guid lockToken, System.Collections.Generic.IDictionary<string,object> propertiesToModify);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task AbandonAsync(valuetype System.Guid lockToken, class System.Collections.Generic.IDictionary`2<string, object> propertiesToModify) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.AbandonAsync(System.Guid,System.Collections.Generic.IDictionary{System.String,System.Object})" /> <MemberSignature Language="VB.NET" Value="Public Function AbandonAsync (lockToken As Guid, propertiesToModify As IDictionary(Of String, Object)) As Task" /> <MemberSignature Language="F#" Value="abstract member AbandonAsync : Guid * System.Collections.Generic.IDictionary<string, obj> -> System.Threading.Tasks.Task
override this.AbandonAsync : Guid * System.Collections.Generic.IDictionary<string, obj> -> System.Threading.Tasks.Task" Usage="queueClient.AbandonAsync (lockToken, 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="lockToken" Type="System.Guid" /> <Parameter Name="propertiesToModify" Type="System.Collections.Generic.IDictionary<System.String,System.Object>" /> </Parameters> <Docs> <param name="lockToken">The lock token bound to the locked message instance to abandon.</param> <param name="propertiesToModify">The properties of the message to modify.</param> <summary>Asynchronously discards the message and relinquishes the message lock ownership.</summary> <returns>The discarded message.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="AcceptMessageSession"> <MemberSignature Language="C#" Value="public Microsoft.ServiceBus.Messaging.MessageSession AcceptMessageSession ();" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.ServiceBus.Messaging.MessageSession AcceptMessageSession() cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.AcceptMessageSession" /> <MemberSignature Language="VB.NET" Value="Public Function AcceptMessageSession () As MessageSession" /> <MemberSignature Language="F#" Value="abstract member AcceptMessageSession : unit -> Microsoft.ServiceBus.Messaging.MessageSession
override this.AcceptMessageSession : unit -> Microsoft.ServiceBus.Messaging.MessageSession" Usage="queueClient.AcceptMessageSession " /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Microsoft.ServiceBus.Messaging.MessageSession</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary>Accepts a message session that allows grouping of related messages for processing in a single transaction.</summary> <returns>A <see cref="T:Microsoft.ServiceBus.Messaging.MessageSession" /> that allows grouping of related messages for processing in a single transaction.</returns> <remarks>To be added.</remarks> <exception cref="T:System.TimeoutException">Thrown if the operation exceeded the timeout value set by <see cref="P:Microsoft.ServiceBus.Messaging.MessagingFactorySettings.OperationTimeout" />.</exception> <exception cref="T:System.OperationCanceledException">Thrown if the client is already closed, aborted, or disposed.</exception> </Docs> </Member> <Member MemberName="AcceptMessageSession"> <MemberSignature Language="C#" Value="public Microsoft.ServiceBus.Messaging.MessageSession AcceptMessageSession (bool isExclusiveMode);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.ServiceBus.Messaging.MessageSession AcceptMessageSession(bool isExclusiveMode) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.AcceptMessageSession(System.Boolean)" /> <MemberSignature Language="VB.NET" Value="Public Function AcceptMessageSession (isExclusiveMode As Boolean) As MessageSession" /> <MemberSignature Language="F#" Value="abstract member AcceptMessageSession : bool -> Microsoft.ServiceBus.Messaging.MessageSession
override this.AcceptMessageSession : bool -> Microsoft.ServiceBus.Messaging.MessageSession" Usage="queueClient.AcceptMessageSession isExclusiveMode" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Microsoft.ServiceBus.Messaging.MessageSession</ReturnType> </ReturnValue> <Parameters> <Parameter Name="isExclusiveMode" Type="System.Boolean" /> </Parameters> <Docs> <param name="isExclusiveMode">Ture if exclusive mode, or false is not.</param> <summary> Accepts a message session that allows grouping of related messages for processing in a single transaction ith whether in exclusive mode. </summary> <returns /> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="AcceptMessageSession"> <MemberSignature Language="C#" Value="public Microsoft.ServiceBus.Messaging.MessageSession AcceptMessageSession (string sessionId);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.ServiceBus.Messaging.MessageSession AcceptMessageSession(string sessionId) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.AcceptMessageSession(System.String)" /> <MemberSignature Language="VB.NET" Value="Public Function AcceptMessageSession (sessionId As String) As MessageSession" /> <MemberSignature Language="F#" Value="abstract member AcceptMessageSession : string -> Microsoft.ServiceBus.Messaging.MessageSession
override this.AcceptMessageSession : string -> Microsoft.ServiceBus.Messaging.MessageSession" Usage="queueClient.AcceptMessageSession sessionId" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Microsoft.ServiceBus.Messaging.MessageSession</ReturnType> </ReturnValue> <Parameters> <Parameter Name="sessionId" Type="System.String" /> </Parameters> <Docs> <param name="sessionId">The session identifier of the message session.</param> <summary>Accepts a message session that allows grouping of related messages for processing in a single transaction using the given session identifier.</summary> <returns>A <see cref="T:Microsoft.ServiceBus.Messaging.MessageSession" /> that allows grouping of related messages for processing in a single transaction.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentException">Thrown if sessionId is null, empty, or white spaces.</exception> <exception cref="T:System.TimeoutException">Thrown if the operation exceeded the timeout value set by <see cref="P:Microsoft.ServiceBus.Messaging.MessagingFactorySettings.OperationTimeout" />.</exception> <exception cref="T:System.OperationCanceledException">Thrown if the client is already closed, aborted, or disposed.</exception> </Docs> </Member> <Member MemberName="AcceptMessageSession"> <MemberSignature Language="C#" Value="public Microsoft.ServiceBus.Messaging.MessageSession AcceptMessageSession (TimeSpan serverWaitTime);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.ServiceBus.Messaging.MessageSession AcceptMessageSession(valuetype System.TimeSpan serverWaitTime) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.AcceptMessageSession(System.TimeSpan)" /> <MemberSignature Language="VB.NET" Value="Public Function AcceptMessageSession (serverWaitTime As TimeSpan) As MessageSession" /> <MemberSignature Language="F#" Value="abstract member AcceptMessageSession : TimeSpan -> Microsoft.ServiceBus.Messaging.MessageSession
override this.AcceptMessageSession : TimeSpan -> Microsoft.ServiceBus.Messaging.MessageSession" Usage="queueClient.AcceptMessageSession serverWaitTime" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Microsoft.ServiceBus.Messaging.MessageSession</ReturnType> </ReturnValue> <Parameters> <Parameter Name="serverWaitTime" Type="System.TimeSpan" /> </Parameters> <Docs> <param name="serverWaitTime">The time span the server waits for processing messages before it times out.</param> <summary>Accepts a message session that allows grouping of related messages for processing in a single transaction using the specified server wait time.</summary> <returns>A <see cref="T:Microsoft.ServiceBus.Messaging.MessageSession" /> that allows grouping of related messages for processing in a single transaction.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentOutOfRangeException">Thrown if <paramref name="serverWaitTime" /> is not a positive TimeSpan value.</exception> <exception cref="T:System.TimeoutException">Thrown if the operation exceeded the timeout value set by <paramref name="serverWaitTime" />.</exception> <exception cref="T:System.OperationCanceledException">Thrown if the client is already closed, aborted, or disposed.</exception> </Docs> </Member> <Member MemberName="AcceptMessageSession"> <MemberSignature Language="C#" Value="public Microsoft.ServiceBus.Messaging.MessageSession AcceptMessageSession (bool isExclusiveMode, TimeSpan serverWaitTime);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.ServiceBus.Messaging.MessageSession AcceptMessageSession(bool isExclusiveMode, valuetype System.TimeSpan serverWaitTime) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.AcceptMessageSession(System.Boolean,System.TimeSpan)" /> <MemberSignature Language="VB.NET" Value="Public Function AcceptMessageSession (isExclusiveMode As Boolean, serverWaitTime As TimeSpan) As MessageSession" /> <MemberSignature Language="F#" Value="abstract member AcceptMessageSession : bool * TimeSpan -> Microsoft.ServiceBus.Messaging.MessageSession
override this.AcceptMessageSession : bool * TimeSpan -> Microsoft.ServiceBus.Messaging.MessageSession" Usage="queueClient.AcceptMessageSession (isExclusiveMode, serverWaitTime)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Microsoft.ServiceBus.Messaging.MessageSession</ReturnType> </ReturnValue> <Parameters> <Parameter Name="isExclusiveMode" Type="System.Boolean" /> <Parameter Name="serverWaitTime" Type="System.TimeSpan" /> </Parameters> <Docs> <param name="isExclusiveMode">Ture if exclusive mode, or false is not.</param> <param name="serverWaitTime">The server wait timeout</param> <summary> Accepts a message session that allows grouping of related messages for processing in a single transaction ith whether in exclusive mode. </summary> <returns /> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="AcceptMessageSession"> <MemberSignature Language="C#" Value="public Microsoft.ServiceBus.Messaging.MessageSession AcceptMessageSession (string sessionId, bool isExclusiveMode);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.ServiceBus.Messaging.MessageSession AcceptMessageSession(string sessionId, bool isExclusiveMode) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.AcceptMessageSession(System.String,System.Boolean)" /> <MemberSignature Language="VB.NET" Value="Public Function AcceptMessageSession (sessionId As String, isExclusiveMode As Boolean) As MessageSession" /> <MemberSignature Language="F#" Value="abstract member AcceptMessageSession : string * bool -> Microsoft.ServiceBus.Messaging.MessageSession
override this.AcceptMessageSession : string * bool -> Microsoft.ServiceBus.Messaging.MessageSession" Usage="queueClient.AcceptMessageSession (sessionId, isExclusiveMode)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Microsoft.ServiceBus.Messaging.MessageSession</ReturnType> </ReturnValue> <Parameters> <Parameter Name="sessionId" Type="System.String" /> <Parameter Name="isExclusiveMode" Type="System.Boolean" /> </Parameters> <Docs> <param name="sessionId">The session identifier of the message session.</param> <param name="isExclusiveMode">Ture if exclusive mode, or false is not.</param> <summary> Accepts a message session that allows grouping of related messages for processing in a single transaction with whether in exclusive mode. </summary> <returns>A <see cref="T:Microsoft.ServiceBus.Messaging.MessageSession" /> that allows grouping of related messages for processing in a single transaction.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="AcceptMessageSession"> <MemberSignature Language="C#" Value="public Microsoft.ServiceBus.Messaging.MessageSession AcceptMessageSession (string sessionId, Guid lockToken);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.ServiceBus.Messaging.MessageSession AcceptMessageSession(string sessionId, valuetype System.Guid lockToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.AcceptMessageSession(System.String,System.Guid)" /> <MemberSignature Language="VB.NET" Value="Public Function AcceptMessageSession (sessionId As String, lockToken As Guid) As MessageSession" /> <MemberSignature Language="F#" Value="abstract member AcceptMessageSession : string * Guid -> Microsoft.ServiceBus.Messaging.MessageSession
override this.AcceptMessageSession : string * Guid -> Microsoft.ServiceBus.Messaging.MessageSession" Usage="queueClient.AcceptMessageSession (sessionId, lockToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Microsoft.ServiceBus.Messaging.MessageSession</ReturnType> </ReturnValue> <Parameters> <Parameter Name="sessionId" Type="System.String" /> <Parameter Name="lockToken" Type="System.Guid" /> </Parameters> <Docs> <param name="sessionId">The session identifier of the message session.</param> <param name="lockToken">The session lock token.</param> <summary> Accepts a message non-exclusive locked session that allows grouping of related messages for processing in a single transaction using the given session identifier and session lock token. </summary> <returns>A <see cref="T:Microsoft.ServiceBus.Messaging.MessageSession" /> that allows grouping of related messages for processing in a single transaction.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="AcceptMessageSession"> <MemberSignature Language="C#" Value="public Microsoft.ServiceBus.Messaging.MessageSession AcceptMessageSession (string sessionId, TimeSpan serverWaitTime);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.ServiceBus.Messaging.MessageSession AcceptMessageSession(string sessionId, valuetype System.TimeSpan serverWaitTime) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.AcceptMessageSession(System.String,System.TimeSpan)" /> <MemberSignature Language="VB.NET" Value="Public Function AcceptMessageSession (sessionId As String, serverWaitTime As TimeSpan) As MessageSession" /> <MemberSignature Language="F#" Value="abstract member AcceptMessageSession : string * TimeSpan -> Microsoft.ServiceBus.Messaging.MessageSession
override this.AcceptMessageSession : string * TimeSpan -> Microsoft.ServiceBus.Messaging.MessageSession" Usage="queueClient.AcceptMessageSession (sessionId, serverWaitTime)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Microsoft.ServiceBus.Messaging.MessageSession</ReturnType> </ReturnValue> <Parameters> <Parameter Name="sessionId" Type="System.String" /> <Parameter Name="serverWaitTime" Type="System.TimeSpan" /> </Parameters> <Docs> <param name="sessionId">The session identifier of the message session.</param> <param name="serverWaitTime">The time span the server waits for processing messages before it times out.</param> <summary>Accepts a message session that allows grouping of related messages for processing in a single transaction using the given session identifier and wait time.</summary> <returns>A <see cref="T:Microsoft.ServiceBus.Messaging.MessageSession" /> that allows grouping of related messages for processing in a single transaction.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentException">Thrown if sessionId is null, empty, or white spaces.</exception> <exception cref="T:System.ArgumentOutOfRangeException">Thrown if <paramref name="serverWaitTime" /> is not a positive TimeSpan value.</exception> <exception cref="T:System.TimeoutException">Thrown if the operation exceeded the timeout value set by <see cref="P:Microsoft.ServiceBus.Messaging.MessagingFactorySettings.OperationTimeout" />.</exception> <exception cref="T:System.OperationCanceledException">Thrown if the client is already closed, aborted, or disposed.</exception> </Docs> </Member> <Member MemberName="AcceptMessageSession"> <MemberSignature Language="C#" Value="public Microsoft.ServiceBus.Messaging.MessageSession AcceptMessageSession (string sessionId, bool isExclusiveMode, TimeSpan serverWaitTime);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.ServiceBus.Messaging.MessageSession AcceptMessageSession(string sessionId, bool isExclusiveMode, valuetype System.TimeSpan serverWaitTime) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.AcceptMessageSession(System.String,System.Boolean,System.TimeSpan)" /> <MemberSignature Language="VB.NET" Value="Public Function AcceptMessageSession (sessionId As String, isExclusiveMode As Boolean, serverWaitTime As TimeSpan) As MessageSession" /> <MemberSignature Language="F#" Value="abstract member AcceptMessageSession : string * bool * TimeSpan -> Microsoft.ServiceBus.Messaging.MessageSession
override this.AcceptMessageSession : string * bool * TimeSpan -> Microsoft.ServiceBus.Messaging.MessageSession" Usage="queueClient.AcceptMessageSession (sessionId, isExclusiveMode, serverWaitTime)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Microsoft.ServiceBus.Messaging.MessageSession</ReturnType> </ReturnValue> <Parameters> <Parameter Name="sessionId" Type="System.String" /> <Parameter Name="isExclusiveMode" Type="System.Boolean" /> <Parameter Name="serverWaitTime" Type="System.TimeSpan" /> </Parameters> <Docs> <param name="sessionId">The session identifier of the message session.</param> <param name="isExclusiveMode">Ture if exclusive mode, or false is not.</param> <param name="serverWaitTime">The server wait timeout</param> <summary> Accepts a message session that allows grouping of related messages for processing in a single transaction using the given session identifier with whether in exclusive mode. </summary> <returns>A <see cref="T:Microsoft.ServiceBus.Messaging.MessageSession" /> that allows grouping of related messages for processing in a single transaction.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="AcceptMessageSession"> <MemberSignature Language="C#" Value="public Microsoft.ServiceBus.Messaging.MessageSession AcceptMessageSession (string sessionId, Guid lockToken, TimeSpan serverWaitTime);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.ServiceBus.Messaging.MessageSession AcceptMessageSession(string sessionId, valuetype System.Guid lockToken, valuetype System.TimeSpan serverWaitTime) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.AcceptMessageSession(System.String,System.Guid,System.TimeSpan)" /> <MemberSignature Language="VB.NET" Value="Public Function AcceptMessageSession (sessionId As String, lockToken As Guid, serverWaitTime As TimeSpan) As MessageSession" /> <MemberSignature Language="F#" Value="abstract member AcceptMessageSession : string * Guid * TimeSpan -> Microsoft.ServiceBus.Messaging.MessageSession
override this.AcceptMessageSession : string * Guid * TimeSpan -> Microsoft.ServiceBus.Messaging.MessageSession" Usage="queueClient.AcceptMessageSession (sessionId, lockToken, serverWaitTime)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Microsoft.ServiceBus.Messaging.MessageSession</ReturnType> </ReturnValue> <Parameters> <Parameter Name="sessionId" Type="System.String" /> <Parameter Name="lockToken" Type="System.Guid" /> <Parameter Name="serverWaitTime" Type="System.TimeSpan" /> </Parameters> <Docs> <param name="sessionId">The session identifier of the message session.</param> <param name="lockToken">The session locktoken</param> <param name="serverWaitTime">The server wait timeout</param> <summary> Accepts a message non-exclusive locked session that allows grouping of related messages for processing in a single transaction using the given session identifier and session lock token. </summary> <returns /> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="AcceptMessageSessionAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.MessageSession> AcceptMessageSessionAsync ();" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.ServiceBus.Messaging.MessageSession> AcceptMessageSessionAsync() cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.AcceptMessageSessionAsync" /> <MemberSignature Language="VB.NET" Value="Public Function AcceptMessageSessionAsync () As Task(Of MessageSession)" /> <MemberSignature Language="F#" Value="abstract member AcceptMessageSessionAsync : unit -> System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.MessageSession>
override this.AcceptMessageSessionAsync : unit -> System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.MessageSession>" Usage="queueClient.AcceptMessageSessionAsync " /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.MessageSession></ReturnType> </ReturnValue> <Parameters /> <Docs> <summary>Asynchronously accepts a message session that allows grouping of related messages for processing in a single transaction.</summary> <returns>The result of an asynchronous operation.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="AcceptMessageSessionAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.MessageSession> AcceptMessageSessionAsync (bool isExclusiveMode);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.ServiceBus.Messaging.MessageSession> AcceptMessageSessionAsync(bool isExclusiveMode) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.AcceptMessageSessionAsync(System.Boolean)" /> <MemberSignature Language="VB.NET" Value="Public Function AcceptMessageSessionAsync (isExclusiveMode As Boolean) As Task(Of MessageSession)" /> <MemberSignature Language="F#" Value="abstract member AcceptMessageSessionAsync : bool -> System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.MessageSession>
override this.AcceptMessageSessionAsync : bool -> System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.MessageSession>" Usage="queueClient.AcceptMessageSessionAsync isExclusiveMode" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.MessageSession></ReturnType> </ReturnValue> <Parameters> <Parameter Name="isExclusiveMode" Type="System.Boolean" /> </Parameters> <Docs> <param name="isExclusiveMode">Ture if exclusive mode, or false is not.</param> <summary>Asynchronously accepts a message session that allows grouping of related messages for processing in a single transaction with whether in exclusive mode and wait time.</summary> <returns>The result of an asynchronous operation.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="AcceptMessageSessionAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.MessageSession> AcceptMessageSessionAsync (string sessionId);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.ServiceBus.Messaging.MessageSession> AcceptMessageSessionAsync(string sessionId) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.AcceptMessageSessionAsync(System.String)" /> <MemberSignature Language="VB.NET" Value="Public Function AcceptMessageSessionAsync (sessionId As String) As Task(Of MessageSession)" /> <MemberSignature Language="F#" Value="abstract member AcceptMessageSessionAsync : string -> System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.MessageSession>
override this.AcceptMessageSessionAsync : string -> System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.MessageSession>" Usage="queueClient.AcceptMessageSessionAsync sessionId" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.MessageSession></ReturnType> </ReturnValue> <Parameters> <Parameter Name="sessionId" Type="System.String" /> </Parameters> <Docs> <param name="sessionId">The session identifier of the message session.</param> <summary>Asynchronously accepts a message session that allows grouping of related messages for processing in a single transaction using the given session identifier.</summary> <returns>The result of an asynchronous operation.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="AcceptMessageSessionAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.MessageSession> AcceptMessageSessionAsync (TimeSpan serverWaitTime);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.ServiceBus.Messaging.MessageSession> AcceptMessageSessionAsync(valuetype System.TimeSpan serverWaitTime) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.AcceptMessageSessionAsync(System.TimeSpan)" /> <MemberSignature Language="VB.NET" Value="Public Function AcceptMessageSessionAsync (serverWaitTime As TimeSpan) As Task(Of MessageSession)" /> <MemberSignature Language="F#" Value="abstract member AcceptMessageSessionAsync : TimeSpan -> System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.MessageSession>
override this.AcceptMessageSessionAsync : TimeSpan -> System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.MessageSession>" Usage="queueClient.AcceptMessageSessionAsync serverWaitTime" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.MessageSession></ReturnType> </ReturnValue> <Parameters> <Parameter Name="serverWaitTime" Type="System.TimeSpan" /> </Parameters> <Docs> <param name="serverWaitTime">The time span the server waits for processing messages before it times out.</param> <summary>Asynchronously accepts a message session that allows grouping of related messages for processing in a single transaction using the specified server wait time.</summary> <returns>The result of an asynchronous operation.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="AcceptMessageSessionAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.MessageSession> AcceptMessageSessionAsync (bool isExclusiveMode, TimeSpan serverWaitTime);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.ServiceBus.Messaging.MessageSession> AcceptMessageSessionAsync(bool isExclusiveMode, valuetype System.TimeSpan serverWaitTime) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.AcceptMessageSessionAsync(System.Boolean,System.TimeSpan)" /> <MemberSignature Language="VB.NET" Value="Public Function AcceptMessageSessionAsync (isExclusiveMode As Boolean, serverWaitTime As TimeSpan) As Task(Of MessageSession)" /> <MemberSignature Language="F#" Value="abstract member AcceptMessageSessionAsync : bool * TimeSpan -> System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.MessageSession>
override this.AcceptMessageSessionAsync : bool * TimeSpan -> System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.MessageSession>" Usage="queueClient.AcceptMessageSessionAsync (isExclusiveMode, serverWaitTime)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.MessageSession></ReturnType> </ReturnValue> <Parameters> <Parameter Name="isExclusiveMode" Type="System.Boolean" /> <Parameter Name="serverWaitTime" Type="System.TimeSpan" /> </Parameters> <Docs> <param name="isExclusiveMode">Ture if exclusive mode, or false is not.</param> <param name="serverWaitTime">The time span the server waits for processing messages before it times out.</param> <summary>Asynchronously accepts a message session that allows grouping of related messages for processing in a single transaction with whether in exclusive mode and wait time.</summary> <returns>The result of an asynchronous operation.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="AcceptMessageSessionAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.MessageSession> AcceptMessageSessionAsync (string sessionId, bool isExclusiveMode);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.ServiceBus.Messaging.MessageSession> AcceptMessageSessionAsync(string sessionId, bool isExclusiveMode) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.AcceptMessageSessionAsync(System.String,System.Boolean)" /> <MemberSignature Language="VB.NET" Value="Public Function AcceptMessageSessionAsync (sessionId As String, isExclusiveMode As Boolean) As Task(Of MessageSession)" /> <MemberSignature Language="F#" Value="abstract member AcceptMessageSessionAsync : string * bool -> System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.MessageSession>
override this.AcceptMessageSessionAsync : string * bool -> System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.MessageSession>" Usage="queueClient.AcceptMessageSessionAsync (sessionId, isExclusiveMode)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.MessageSession></ReturnType> </ReturnValue> <Parameters> <Parameter Name="sessionId" Type="System.String" /> <Parameter Name="isExclusiveMode" Type="System.Boolean" /> </Parameters> <Docs> <param name="sessionId">The session identifier of the message session.</param> <param name="isExclusiveMode">Ture if exclusive mode, or false is not.</param> <summary> Accepts a message session that allows grouping of related messages for processing in a single transaction using the given session identifier with whether in exclusive mode. </summary> <returns>The result of an asynchronous operation.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="AcceptMessageSessionAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.MessageSession> AcceptMessageSessionAsync (string sessionId, Guid lockToken);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.ServiceBus.Messaging.MessageSession> AcceptMessageSessionAsync(string sessionId, valuetype System.Guid lockToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.AcceptMessageSessionAsync(System.String,System.Guid)" /> <MemberSignature Language="VB.NET" Value="Public Function AcceptMessageSessionAsync (sessionId As String, lockToken As Guid) As Task(Of MessageSession)" /> <MemberSignature Language="F#" Value="abstract member AcceptMessageSessionAsync : string * Guid -> System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.MessageSession>
override this.AcceptMessageSessionAsync : string * Guid -> System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.MessageSession>" Usage="queueClient.AcceptMessageSessionAsync (sessionId, lockToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.MessageSession></ReturnType> </ReturnValue> <Parameters> <Parameter Name="sessionId" Type="System.String" /> <Parameter Name="lockToken" Type="System.Guid" /> </Parameters> <Docs> <param name="sessionId">The session identifier of the message session.</param> <param name="lockToken">The session lock token.</param> <summary> Accepts a message non-exclusive locked session that allows grouping of related messages for processing in a single transaction using the given session identifier and session lock token. </summary> <returns>The result of an asynchronous operation.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="AcceptMessageSessionAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.MessageSession> AcceptMessageSessionAsync (string sessionId, TimeSpan serverWaitTime);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.ServiceBus.Messaging.MessageSession> AcceptMessageSessionAsync(string sessionId, valuetype System.TimeSpan serverWaitTime) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.AcceptMessageSessionAsync(System.String,System.TimeSpan)" /> <MemberSignature Language="VB.NET" Value="Public Function AcceptMessageSessionAsync (sessionId As String, serverWaitTime As TimeSpan) As Task(Of MessageSession)" /> <MemberSignature Language="F#" Value="abstract member AcceptMessageSessionAsync : string * TimeSpan -> System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.MessageSession>
override this.AcceptMessageSessionAsync : string * TimeSpan -> System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.MessageSession>" Usage="queueClient.AcceptMessageSessionAsync (sessionId, serverWaitTime)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.MessageSession></ReturnType> </ReturnValue> <Parameters> <Parameter Name="sessionId" Type="System.String" /> <Parameter Name="serverWaitTime" Type="System.TimeSpan" /> </Parameters> <Docs> <param name="sessionId">The session identifier of the message session.</param> <param name="serverWaitTime">The time span the server waits for processing messages before it times out.</param> <summary>Asynchronously accepts a message session that allows grouping of related messages for processing in a single transaction using the given session identifier and wait time.</summary> <returns>The result of an asynchronous operation.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="AcceptMessageSessionAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.MessageSession> AcceptMessageSessionAsync (string sessionId, bool isExclusiveMode, TimeSpan serverWaitTime);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.ServiceBus.Messaging.MessageSession> AcceptMessageSessionAsync(string sessionId, bool isExclusiveMode, valuetype System.TimeSpan serverWaitTime) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.AcceptMessageSessionAsync(System.String,System.Boolean,System.TimeSpan)" /> <MemberSignature Language="VB.NET" Value="Public Function AcceptMessageSessionAsync (sessionId As String, isExclusiveMode As Boolean, serverWaitTime As TimeSpan) As Task(Of MessageSession)" /> <MemberSignature Language="F#" Value="abstract member AcceptMessageSessionAsync : string * bool * TimeSpan -> System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.MessageSession>
override this.AcceptMessageSessionAsync : string * bool * TimeSpan -> System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.MessageSession>" Usage="queueClient.AcceptMessageSessionAsync (sessionId, isExclusiveMode, serverWaitTime)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.MessageSession></ReturnType> </ReturnValue> <Parameters> <Parameter Name="sessionId" Type="System.String" /> <Parameter Name="isExclusiveMode" Type="System.Boolean" /> <Parameter Name="serverWaitTime" Type="System.TimeSpan" /> </Parameters> <Docs> <param name="sessionId">The session identifier of the message session.</param> <param name="isExclusiveMode">Ture if exclusive mode, or false is not.</param> <param name="serverWaitTime">The server wait timeout</param> <summary> Accepts a message session that allows grouping of related messages for processing in a single transaction using the given session identifier with whether in exclusive mode. </summary> <returns /> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="AcceptMessageSessionAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.MessageSession> AcceptMessageSessionAsync (string sessionId, Guid lockToken, TimeSpan serverWaitTime);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.ServiceBus.Messaging.MessageSession> AcceptMessageSessionAsync(string sessionId, valuetype System.Guid lockToken, valuetype System.TimeSpan serverWaitTime) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.AcceptMessageSessionAsync(System.String,System.Guid,System.TimeSpan)" /> <MemberSignature Language="VB.NET" Value="Public Function AcceptMessageSessionAsync (sessionId As String, lockToken As Guid, serverWaitTime As TimeSpan) As Task(Of MessageSession)" /> <MemberSignature Language="F#" Value="abstract member AcceptMessageSessionAsync : string * Guid * TimeSpan -> System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.MessageSession>
override this.AcceptMessageSessionAsync : string * Guid * TimeSpan -> System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.MessageSession>" Usage="queueClient.AcceptMessageSessionAsync (sessionId, lockToken, serverWaitTime)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.MessageSession></ReturnType> </ReturnValue> <Parameters> <Parameter Name="sessionId" Type="System.String" /> <Parameter Name="lockToken" Type="System.Guid" /> <Parameter Name="serverWaitTime" Type="System.TimeSpan" /> </Parameters> <Docs> <param name="sessionId">The session identifier of the message session.</param> <param name="lockToken">The session locktoken</param> <param name="serverWaitTime">The server wait timeout</param> <summary> Accepts a message non-exclusive locked session that allows grouping of related messages for processing in a single transaction using the given session identifier and session lock token. </summary> <returns /> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="CancelScheduledMessageAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task CancelScheduledMessageAsync (long sequenceNumber);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task CancelScheduledMessageAsync(int64 sequenceNumber) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.CancelScheduledMessageAsync(System.Int64)" /> <MemberSignature Language="VB.NET" Value="Public Function CancelScheduledMessageAsync (sequenceNumber As Long) As Task" /> <MemberSignature Language="F#" Value="member this.CancelScheduledMessageAsync : int64 -> System.Threading.Tasks.Task" Usage="queueClient.CancelScheduledMessageAsync sequenceNumber" /> <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="sequenceNumber" Type="System.Int64" /> </Parameters> <Docs> <param name="sequenceNumber">Returned on scheduling a message.</param> <summary> Cancels a scheduled message </summary> <returns /> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="Complete"> <MemberSignature Language="C#" Value="public void Complete (Guid lockToken);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Complete(valuetype System.Guid lockToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.Complete(System.Guid)" /> <MemberSignature Language="VB.NET" Value="Public Sub Complete (lockToken As Guid)" /> <MemberSignature Language="F#" Value="abstract member Complete : Guid -> unit
override this.Complete : Guid -> unit" Usage="queueClient.Complete lockToken" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="lockToken" Type="System.Guid" /> </Parameters> <Docs> <param name="lockToken">The lock token bound to the locked message instance.</param> <summary>Completes processing of a message.</summary> <remarks> This method is used as a handshake between the client and Service Bus for a guaranteed delivery of the message. If the client failed before calling this method, the message will be kept in the queue. </remarks> <exception cref="T:System.TimeoutException">Thrown if the operation exceeded the timeout value set by <see cref="P:Microsoft.ServiceBus.Messaging.MessagingFactorySettings.OperationTimeout" /></exception> <exception cref="T:System.OperationCanceledException">Thrown if the client entity has been closed or aborted.</exception> <exception cref="T:Microsoft.ServiceBus.Messaging.MessageLockLostException">Thrown if the message represented by the <paramref name="lockToken" /> has lost the message lock.</exception> </Docs> </Member> <Member MemberName="CompleteAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task CompleteAsync (Guid lockToken);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task CompleteAsync(valuetype System.Guid lockToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.CompleteAsync(System.Guid)" /> <MemberSignature Language="VB.NET" Value="Public Function CompleteAsync (lockToken As Guid) As Task" /> <MemberSignature Language="F#" Value="abstract member CompleteAsync : Guid -> System.Threading.Tasks.Task
override this.CompleteAsync : Guid -> System.Threading.Tasks.Task" Usage="queueClient.CompleteAsync lockToken" /> <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="lockToken" Type="System.Guid" /> </Parameters> <Docs> <param name="lockToken">The lock token bound to the locked message instance.</param> <summary>Asynchronously completes processing of a message.</summary> <returns>The asynchronous operation.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="CompleteBatch"> <MemberSignature Language="C#" Value="public void CompleteBatch (System.Collections.Generic.IEnumerable<Guid> lockTokens);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void CompleteBatch(class System.Collections.Generic.IEnumerable`1<valuetype System.Guid> lockTokens) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.CompleteBatch(System.Collections.Generic.IEnumerable{System.Guid})" /> <MemberSignature Language="VB.NET" Value="Public Sub CompleteBatch (lockTokens As IEnumerable(Of Guid))" /> <MemberSignature Language="F#" Value="abstract member CompleteBatch : seq<Guid> -> unit
override this.CompleteBatch : seq<Guid> -> unit" Usage="queueClient.CompleteBatch lockTokens" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="lockTokens" Type="System.Collections.Generic.IEnumerable<System.Guid>" /> </Parameters> <Docs> <param name="lockTokens">The lock tokens associated with locked messages in the batch.</param> <summary>Completes processing of a message batch.</summary> <remarks> This method is used as a handshake between the client and Service Bus for a guaranteed delivery of the message. If the client failed before calling this method, the message will be kept in the queue. </remarks> </Docs> </Member> <Member MemberName="CompleteBatchAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task CompleteBatchAsync (System.Collections.Generic.IEnumerable<Guid> lockTokens);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task CompleteBatchAsync(class System.Collections.Generic.IEnumerable`1<valuetype System.Guid> lockTokens) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.CompleteBatchAsync(System.Collections.Generic.IEnumerable{System.Guid})" /> <MemberSignature Language="VB.NET" Value="Public Function CompleteBatchAsync (lockTokens As IEnumerable(Of Guid)) As Task" /> <MemberSignature Language="F#" Value="abstract member CompleteBatchAsync : seq<Guid> -> System.Threading.Tasks.Task
override this.CompleteBatchAsync : seq<Guid> -> System.Threading.Tasks.Task" Usage="queueClient.CompleteBatchAsync lockTokens" /> <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="lockTokens" Type="System.Collections.Generic.IEnumerable<System.Guid>" /> </Parameters> <Docs> <param name="lockTokens">The lock tokens associated with locked messages in the batch.</param> <summary>Asynchronously completes processing of a message batch.</summary> <returns>The asynchronous operation.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="Create"> <MemberSignature Language="C#" Value="public static Microsoft.ServiceBus.Messaging.QueueClient Create (string path);" /> <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.ServiceBus.Messaging.QueueClient Create(string path) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.Create(System.String)" /> <MemberSignature Language="VB.NET" Value="Public Shared Function Create (path As String) As QueueClient" /> <MemberSignature Language="F#" Value="static member Create : string -> Microsoft.ServiceBus.Messaging.QueueClient" Usage="Microsoft.ServiceBus.Messaging.QueueClient.Create path" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Microsoft.ServiceBus.Messaging.QueueClient</ReturnType> </ReturnValue> <Parameters> <Parameter Name="path" Type="System.String" /> </Parameters> <Docs> <param name="path">The path.</param> <summary>Creates a new copy of <see cref="T:Microsoft.ServiceBus.Messaging.QueueClient" /> with specified path.</summary> <returns>The created <see cref="T:Microsoft.ServiceBus.Messaging.QueueClient" />.</returns> <remarks>This method will attempt to retrieve the connection string information from either app.config, or web.config files. User must supply the connection string using the "AppSettings" section of the configuration. The format of the section is as follows: <code><appSettings><add key="Microsoft.ServiceBus.ConnectionString" value="Endpoint=sb://[your namespace].servicebus.windows.net;SharedSecretIssuer=owner;SharedSecretValue=[your secret]" /></appSettings></code></remarks> </Docs> </Member> <Member MemberName="Create"> <MemberSignature Language="C#" Value="public static Microsoft.ServiceBus.Messaging.QueueClient Create (string path, Microsoft.ServiceBus.Messaging.ReceiveMode mode);" /> <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.ServiceBus.Messaging.QueueClient Create(string path, valuetype Microsoft.ServiceBus.Messaging.ReceiveMode mode) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.Create(System.String,Microsoft.ServiceBus.Messaging.ReceiveMode)" /> <MemberSignature Language="VB.NET" Value="Public Shared Function Create (path As String, mode As ReceiveMode) As QueueClient" /> <MemberSignature Language="F#" Value="static member Create : string * Microsoft.ServiceBus.Messaging.ReceiveMode -> Microsoft.ServiceBus.Messaging.QueueClient" Usage="Microsoft.ServiceBus.Messaging.QueueClient.Create (path, mode)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Microsoft.ServiceBus.Messaging.QueueClient</ReturnType> </ReturnValue> <Parameters> <Parameter Name="path" Type="System.String" /> <Parameter Name="mode" Type="Microsoft.ServiceBus.Messaging.ReceiveMode" /> </Parameters> <Docs> <param name="path">The path.</param> <param name="mode">The mode.</param> <summary>Creates a new copy of <see cref="T:Microsoft.ServiceBus.Messaging.QueueClient" /> with specified path and mode.</summary> <returns>The created <see cref="T:Microsoft.ServiceBus.Messaging.QueueClient" />.</returns> <remarks>This method will attempt to retrieve the connection string information from either app.config, or web.config files. User must supply the connection string using the "AppSettings" section of the configuration. The format of the section is as follows: <code><appSettings><add key="Microsoft.ServiceBus.ConnectionString" value="Endpoint=sb://[your namespace].servicebus.windows.net;SharedSecretIssuer=owner;SharedSecretValue=[your secret]" /></appSettings></code></remarks> </Docs> </Member> <Member MemberName="CreateFromConnectionString"> <MemberSignature Language="C#" Value="public static Microsoft.ServiceBus.Messaging.QueueClient CreateFromConnectionString (string connectionString);" /> <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.ServiceBus.Messaging.QueueClient CreateFromConnectionString(string connectionString) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.CreateFromConnectionString(System.String)" /> <MemberSignature Language="VB.NET" Value="Public Shared Function CreateFromConnectionString (connectionString As String) As QueueClient" /> <MemberSignature Language="F#" Value="static member CreateFromConnectionString : string -> Microsoft.ServiceBus.Messaging.QueueClient" Usage="Microsoft.ServiceBus.Messaging.QueueClient.CreateFromConnectionString connectionString" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Microsoft.ServiceBus.Messaging.QueueClient</ReturnType> </ReturnValue> <Parameters> <Parameter Name="connectionString" Type="System.String" /> </Parameters> <Docs> <param name="connectionString">The connection string to use.</param> <summary>Creates a new instance of <see cref="T:Microsoft.ServiceBus.Messaging.QueueClient" /> using the specified connection string.</summary> <returns>The newly created <see cref="T:Microsoft.ServiceBus.Messaging.QueueClient" /> instance.</returns> <remarks>This method expects the connection string supplied has entity level information such as the entity path and authentication information supplied.</remarks> <exception cref="T:System.ArgumentException">Thrown when the format of the <paramref name="connectionString" /> parameter is incorrect.</exception> </Docs> </Member> <Member MemberName="CreateFromConnectionString"> <MemberSignature Language="C#" Value="public static Microsoft.ServiceBus.Messaging.QueueClient CreateFromConnectionString (string connectionString, Microsoft.ServiceBus.Messaging.ReceiveMode mode);" /> <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.ServiceBus.Messaging.QueueClient CreateFromConnectionString(string connectionString, valuetype Microsoft.ServiceBus.Messaging.ReceiveMode mode) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.CreateFromConnectionString(System.String,Microsoft.ServiceBus.Messaging.ReceiveMode)" /> <MemberSignature Language="VB.NET" Value="Public Shared Function CreateFromConnectionString (connectionString As String, mode As ReceiveMode) As QueueClient" /> <MemberSignature Language="F#" Value="static member CreateFromConnectionString : string * Microsoft.ServiceBus.Messaging.ReceiveMode -> Microsoft.ServiceBus.Messaging.QueueClient" Usage="Microsoft.ServiceBus.Messaging.QueueClient.CreateFromConnectionString (connectionString, mode)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Microsoft.ServiceBus.Messaging.QueueClient</ReturnType> </ReturnValue> <Parameters> <Parameter Name="connectionString" Type="System.String" /> <Parameter Name="mode" Type="Microsoft.ServiceBus.Messaging.ReceiveMode" /> </Parameters> <Docs> <param name="connectionString">The connection string to use.</param> <param name="mode">The <see cref="T:Microsoft.ServiceBus.Messaging.ReceiveMode" />.</param> <summary>Creates a new instance of <see cref="T:Microsoft.ServiceBus.Messaging.QueueClient" /> using the specified connection string and receiving mode.</summary> <returns>The newly created <see cref="T:Microsoft.ServiceBus.Messaging.QueueClient" /> instance.</returns> <remarks>This method expects the connection string supplied has entity level information such as the entity path and authentication information supplied.</remarks> <exception cref="T:System.ArgumentException">Thrown when the format of the <paramref name="connectionString" /> parameter is incorrect.</exception> </Docs> </Member> <Member MemberName="CreateFromConnectionString"> <MemberSignature Language="C#" Value="public static Microsoft.ServiceBus.Messaging.QueueClient CreateFromConnectionString (string connectionString, string path);" /> <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.ServiceBus.Messaging.QueueClient CreateFromConnectionString(string connectionString, string path) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.CreateFromConnectionString(System.String,System.String)" /> <MemberSignature Language="VB.NET" Value="Public Shared Function CreateFromConnectionString (connectionString As String, path As String) As QueueClient" /> <MemberSignature Language="F#" Value="static member CreateFromConnectionString : string * string -> Microsoft.ServiceBus.Messaging.QueueClient" Usage="Microsoft.ServiceBus.Messaging.QueueClient.CreateFromConnectionString (connectionString, path)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Microsoft.ServiceBus.Messaging.QueueClient</ReturnType> </ReturnValue> <Parameters> <Parameter Name="connectionString" Type="System.String" /> <Parameter Name="path" Type="System.String" /> </Parameters> <Docs> <param name="connectionString">The connection string used.</param> <param name="path">The path to the queue.</param> <summary>Creates a new copy of <see cref="T:Microsoft.ServiceBus.Messaging.QueueClient" /> from a connection string with the specified queue path. Use this overload only when the connection string does not use the <see cref="P:Microsoft.ServiceBus.ServiceBusConnectionStringBuilder.EntityPath" /> property.</summary> <returns>The created <see cref="T:Microsoft.ServiceBus.Messaging.QueueClient" />.</returns> <remarks>This method should only be used with a connection string that has namespace level authentication because the connection string supplied should not have entity level information associated with it.</remarks> <exception cref="T:System.ArgumentException">Thrown when the format of the <paramref name="connectionString" /> parameter is incorrect.</exception> </Docs> </Member> <Member MemberName="CreateFromConnectionString"> <MemberSignature Language="C#" Value="public static Microsoft.ServiceBus.Messaging.QueueClient CreateFromConnectionString (string connectionString, string path, Microsoft.ServiceBus.Messaging.ReceiveMode mode);" /> <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.ServiceBus.Messaging.QueueClient CreateFromConnectionString(string connectionString, string path, valuetype Microsoft.ServiceBus.Messaging.ReceiveMode mode) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.CreateFromConnectionString(System.String,System.String,Microsoft.ServiceBus.Messaging.ReceiveMode)" /> <MemberSignature Language="VB.NET" Value="Public Shared Function CreateFromConnectionString (connectionString As String, path As String, mode As ReceiveMode) As QueueClient" /> <MemberSignature Language="F#" Value="static member CreateFromConnectionString : string * string * Microsoft.ServiceBus.Messaging.ReceiveMode -> Microsoft.ServiceBus.Messaging.QueueClient" Usage="Microsoft.ServiceBus.Messaging.QueueClient.CreateFromConnectionString (connectionString, path, mode)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Microsoft.ServiceBus.Messaging.QueueClient</ReturnType> </ReturnValue> <Parameters> <Parameter Name="connectionString" Type="System.String" /> <Parameter Name="path" Type="System.String" /> <Parameter Name="mode" Type="Microsoft.ServiceBus.Messaging.ReceiveMode" /> </Parameters> <Docs> <param name="connectionString">The connection string.</param> <param name="path">The path to the queue.</param> <param name="mode">The <see cref="T:Microsoft.ServiceBus.Messaging.ReceiveMode" />.</param> <summary>Creates a new instance of <see cref="T:Microsoft.ServiceBus.Messaging.QueueClient" /> from a connection string with the specified path and mode. Use this overload only when the connection string does not use the <see cref="P:Microsoft.ServiceBus.ServiceBusConnectionStringBuilder.EntityPath" /> property.</summary> <returns>The created <see cref="T:Microsoft.ServiceBus.Messaging.QueueClient" />.</returns> <remarks>This method should only be used with a connection string that has namespace level authentication because the connection string supplied should not have entity level information associated with it.</remarks> <exception cref="T:System.ArgumentException">Thrown when the format of the <paramref name="connectionString" /> parameter is incorrect.</exception> </Docs> </Member> <Member MemberName="CreateWithAzureActiveDirectory"> <MemberSignature Language="C#" Value="public static Microsoft.ServiceBus.Messaging.QueueClient CreateWithAzureActiveDirectory (Uri endpointAddress, string path, Microsoft.ServiceBus.AzureActiveDirectoryTokenProvider.AuthenticationCallback authCallback, string authority, Microsoft.ServiceBus.Messaging.ReceiveMode mode = Microsoft.ServiceBus.Messaging.ReceiveMode.PeekLock, TimeSpan? operationTimeout = default, Microsoft.ServiceBus.Messaging.TransportType transportType = Microsoft.ServiceBus.Messaging.TransportType.NetMessaging);" /> <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.ServiceBus.Messaging.QueueClient CreateWithAzureActiveDirectory(class System.Uri endpointAddress, string path, class Microsoft.ServiceBus.AzureActiveDirectoryTokenProvider/AuthenticationCallback authCallback, string authority, valuetype Microsoft.ServiceBus.Messaging.ReceiveMode mode, valuetype System.Nullable`1<valuetype System.TimeSpan> operationTimeout, valuetype Microsoft.ServiceBus.Messaging.TransportType transportType) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.CreateWithAzureActiveDirectory(System.Uri,System.String,Microsoft.ServiceBus.AzureActiveDirectoryTokenProvider.AuthenticationCallback,System.String,Microsoft.ServiceBus.Messaging.ReceiveMode,System.Nullable{System.TimeSpan},Microsoft.ServiceBus.Messaging.TransportType)" /> <MemberSignature Language="VB.NET" Value="Public Shared Function CreateWithAzureActiveDirectory (endpointAddress As Uri, path As String, authCallback As AzureActiveDirectoryTokenProvider.AuthenticationCallback, authority As String, Optional mode As ReceiveMode = Microsoft.ServiceBus.Messaging.ReceiveMode.PeekLock, Optional operationTimeout As Nullable(Of TimeSpan) = Nothing, Optional transportType As TransportType = Microsoft.ServiceBus.Messaging.TransportType.NetMessaging) As QueueClient" /> <MemberSignature Language="F#" Value="static member CreateWithAzureActiveDirectory : Uri * string * Microsoft.ServiceBus.AzureActiveDirectoryTokenProvider.AuthenticationCallback * string * Microsoft.ServiceBus.Messaging.ReceiveMode * Nullable<TimeSpan> * Microsoft.ServiceBus.Messaging.TransportType -> Microsoft.ServiceBus.Messaging.QueueClient" Usage="Microsoft.ServiceBus.Messaging.QueueClient.CreateWithAzureActiveDirectory (endpointAddress, path, authCallback, authority, mode, operationTimeout, transportType)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Microsoft.ServiceBus.Messaging.QueueClient</ReturnType> </ReturnValue> <Parameters> <Parameter Name="endpointAddress" Type="System.Uri" /> <Parameter Name="path" Type="System.String" /> <Parameter Name="authCallback" Type="Microsoft.ServiceBus.AzureActiveDirectoryTokenProvider+AuthenticationCallback" /> <Parameter Name="authority" Type="System.String" /> <Parameter Name="mode" Type="Microsoft.ServiceBus.Messaging.ReceiveMode" /> <Parameter Name="operationTimeout" Type="System.Nullable<System.TimeSpan>" /> <Parameter Name="transportType" Type="Microsoft.ServiceBus.Messaging.TransportType" /> </Parameters> <Docs> <param name="endpointAddress">Fully qualified domain name for Service Bus. Most likely, {yournamespace}.servicebus.windows.net</param> <param name="path">The path to the queue.</param> <param name="authCallback">The authentication delegate to provide access token.</param> <param name="authority">Address of the authority to issue token.</param> <param name="mode">The receive mode.</param> <param name="operationTimeout"> <see cref="T:System.TimeSpan" /> that specifies how long the messaging operation has to complete before timing out</param> <param name="transportType">Messaging transport type.</param> <summary>Creates a new instance of the <see cref="T:Microsoft.ServiceBus.Messaging.QueueClient" /> by using Azure Active Directory authentication context.</summary> <returns>The created <see cref="T:Microsoft.ServiceBus.Messaging.QueueClient" />.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="CreateWithManagedIdentity"> <MemberSignature Language="C#" Value="public static Microsoft.ServiceBus.Messaging.QueueClient CreateWithManagedIdentity (Uri endpointAddress, string path, Microsoft.ServiceBus.Messaging.ReceiveMode mode = Microsoft.ServiceBus.Messaging.ReceiveMode.PeekLock, TimeSpan? operationTimeout = default, Microsoft.ServiceBus.Messaging.TransportType transportType = Microsoft.ServiceBus.Messaging.TransportType.NetMessaging);" /> <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.ServiceBus.Messaging.QueueClient CreateWithManagedIdentity(class System.Uri endpointAddress, string path, valuetype Microsoft.ServiceBus.Messaging.ReceiveMode mode, valuetype System.Nullable`1<valuetype System.TimeSpan> operationTimeout, valuetype Microsoft.ServiceBus.Messaging.TransportType transportType) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.CreateWithManagedIdentity(System.Uri,System.String,Microsoft.ServiceBus.Messaging.ReceiveMode,System.Nullable{System.TimeSpan},Microsoft.ServiceBus.Messaging.TransportType)" /> <MemberSignature Language="VB.NET" Value="Public Shared Function CreateWithManagedIdentity (endpointAddress As Uri, path As String, Optional mode As ReceiveMode = Microsoft.ServiceBus.Messaging.ReceiveMode.PeekLock, Optional operationTimeout As Nullable(Of TimeSpan) = Nothing, Optional transportType As TransportType = Microsoft.ServiceBus.Messaging.TransportType.NetMessaging) As QueueClient" /> <MemberSignature Language="F#" Value="static member CreateWithManagedIdentity : Uri * string * Microsoft.ServiceBus.Messaging.ReceiveMode * Nullable<TimeSpan> * Microsoft.ServiceBus.Messaging.TransportType -> Microsoft.ServiceBus.Messaging.QueueClient" Usage="Microsoft.ServiceBus.Messaging.QueueClient.CreateWithManagedIdentity (endpointAddress, path, mode, operationTimeout, transportType)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Microsoft.ServiceBus.Messaging.QueueClient</ReturnType> </ReturnValue> <Parameters> <Parameter Name="endpointAddress" Type="System.Uri" /> <Parameter Name="path" Type="System.String" /> <Parameter Name="mode" Type="Microsoft.ServiceBus.Messaging.ReceiveMode" /> <Parameter Name="operationTimeout" Type="System.Nullable<System.TimeSpan>" /> <Parameter Name="transportType" Type="Microsoft.ServiceBus.Messaging.TransportType" /> </Parameters> <Docs> <param name="endpointAddress">Fully qualified domain name for Service Bus. Most likely, {yournamespace}.servicebus.windows.net</param> <param name="path">The path to the queue.</param> <param name="mode">The receive mode.</param> <param name="operationTimeout"> <see cref="T:System.TimeSpan" /> that specifies how long the messaging operation has to complete before timing out</param> <param name="transportType">Messaging transport type.</param> <summary>Creates a new instance of the <see cref="T:Microsoft.ServiceBus.Messaging.QueueClient" /> by using Azure Managed Identity authentication.</summary> <returns>The created <see cref="T:Microsoft.ServiceBus.Messaging.QueueClient" />.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="DeadLetter"> <MemberSignature Language="C#" Value="public void DeadLetter (Guid lockToken);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void DeadLetter(valuetype System.Guid lockToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.DeadLetter(System.Guid)" /> <MemberSignature Language="VB.NET" Value="Public Sub DeadLetter (lockToken As Guid)" /> <MemberSignature Language="F#" Value="abstract member DeadLetter : Guid -> unit
override this.DeadLetter : Guid -> unit" Usage="queueClient.DeadLetter lockToken" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="lockToken" Type="System.Guid" /> </Parameters> <Docs> <param name="lockToken">The lock token bound to the locked message instance.</param> <summary>Moves the undelivered message to the dead letter queue.</summary> <remarks>To be added.</remarks> <exception cref="T:System.TimeoutException">Thrown if the operation exceeded the timeout value set by <see cref="P:Microsoft.ServiceBus.Messaging.MessagingFactorySettings.OperationTimeout" /></exception> <exception cref="T:System.OperationCanceledException">Thrown if the client entity has been closed or aborted.</exception> <exception cref="T:Microsoft.ServiceBus.Messaging.MessageLockLostException">Thrown if the message represented by the <paramref name="lockToken" /> has lost the message lock.</exception> </Docs> </Member> <Member MemberName="DeadLetter"> <MemberSignature Language="C#" Value="public void DeadLetter (Guid lockToken, System.Collections.Generic.IDictionary<string,object> propertiesToModify);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void DeadLetter(valuetype System.Guid lockToken, class System.Collections.Generic.IDictionary`2<string, object> propertiesToModify) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.DeadLetter(System.Guid,System.Collections.Generic.IDictionary{System.String,System.Object})" /> <MemberSignature Language="VB.NET" Value="Public Sub DeadLetter (lockToken As Guid, propertiesToModify As IDictionary(Of String, Object))" /> <MemberSignature Language="F#" Value="abstract member DeadLetter : Guid * System.Collections.Generic.IDictionary<string, obj> -> unit
override this.DeadLetter : Guid * System.Collections.Generic.IDictionary<string, obj> -> unit" Usage="queueClient.DeadLetter (lockToken, 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="lockToken" Type="System.Guid" /> <Parameter Name="propertiesToModify" Type="System.Collections.Generic.IDictionary<System.String,System.Object>" /> </Parameters> <Docs> <param name="lockToken">The lock token bound to the locked message instance.</param> <param name="propertiesToModify">The properties of the message to modify.</param> <summary>Moves the undelivered message to the dead letter queue.</summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="DeadLetter"> <MemberSignature Language="C#" Value="public void DeadLetter (Guid lockToken, string deadLetterReason, string deadLetterErrorDescription);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void DeadLetter(valuetype System.Guid lockToken, string deadLetterReason, string deadLetterErrorDescription) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.DeadLetter(System.Guid,System.String,System.String)" /> <MemberSignature Language="VB.NET" Value="Public Sub DeadLetter (lockToken As Guid, deadLetterReason As String, deadLetterErrorDescription As String)" /> <MemberSignature Language="F#" Value="abstract member DeadLetter : Guid * string * string -> unit
override this.DeadLetter : Guid * string * string -> unit" Usage="queueClient.DeadLetter (lockToken, 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="lockToken" Type="System.Guid" /> <Parameter Name="deadLetterReason" Type="System.String" /> <Parameter Name="deadLetterErrorDescription" Type="System.String" /> </Parameters> <Docs> <param name="lockToken">The lock token bound to the locked message instance.</param> <param name="deadLetterReason">The reason for deadlettering the message.</param> <param name="deadLetterErrorDescription">The error description for deadlettering the message.</param> <summary>Moves the undelivered message to the dead letter queue.</summary> <remarks>To be added.</remarks> <exception cref="T:System.TimeoutException">Thrown if the operation exceeded the timeout value set by <see cref="P:Microsoft.ServiceBus.Messaging.MessagingFactorySettings.OperationTimeout" /></exception> <exception cref="T:System.OperationCanceledException">Thrown if the client entity has been closed or aborted.</exception> <exception cref="T:Microsoft.ServiceBus.Messaging.MessageLockLostException">Thrown if the message represented by the <paramref name="lockToken" /> has lost the message lock.</exception> </Docs> </Member> <Member MemberName="DeadLetterAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task DeadLetterAsync (Guid lockToken);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task DeadLetterAsync(valuetype System.Guid lockToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.DeadLetterAsync(System.Guid)" /> <MemberSignature Language="VB.NET" Value="Public Function DeadLetterAsync (lockToken As Guid) As Task" /> <MemberSignature Language="F#" Value="abstract member DeadLetterAsync : Guid -> System.Threading.Tasks.Task
override this.DeadLetterAsync : Guid -> System.Threading.Tasks.Task" Usage="queueClient.DeadLetterAsync lockToken" /> <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="lockToken" Type="System.Guid" /> </Parameters> <Docs> <param name="lockToken">The lock token bound to the locked message instance.</param> <summary>Asynchronously moves the undelivered message to the dead letter queue.</summary> <returns>The asynchronous operation.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="DeadLetterAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task DeadLetterAsync (Guid lockToken, System.Collections.Generic.IDictionary<string,object> propertiesToModify);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task DeadLetterAsync(valuetype System.Guid lockToken, class System.Collections.Generic.IDictionary`2<string, object> propertiesToModify) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.DeadLetterAsync(System.Guid,System.Collections.Generic.IDictionary{System.String,System.Object})" /> <MemberSignature Language="VB.NET" Value="Public Function DeadLetterAsync (lockToken As Guid, propertiesToModify As IDictionary(Of String, Object)) As Task" /> <MemberSignature Language="F#" Value="abstract member DeadLetterAsync : Guid * System.Collections.Generic.IDictionary<string, obj> -> System.Threading.Tasks.Task
override this.DeadLetterAsync : Guid * System.Collections.Generic.IDictionary<string, obj> -> System.Threading.Tasks.Task" Usage="queueClient.DeadLetterAsync (lockToken, 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="lockToken" Type="System.Guid" /> <Parameter Name="propertiesToModify" Type="System.Collections.Generic.IDictionary<System.String,System.Object>" /> </Parameters> <Docs> <param name="lockToken">The lock token bound to the locked message instance.</param> <param name="propertiesToModify">The properties of the message to modify.</param> <summary>Asynchronously moves the undelivered message to the dead letter queue.</summary> <returns>The asynchronous operation.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="DeadLetterAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task DeadLetterAsync (Guid lockToken, string deadLetterReason, string deadLetterErrorDescription);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task DeadLetterAsync(valuetype System.Guid lockToken, string deadLetterReason, string deadLetterErrorDescription) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.DeadLetterAsync(System.Guid,System.String,System.String)" /> <MemberSignature Language="VB.NET" Value="Public Function DeadLetterAsync (lockToken As Guid, deadLetterReason As String, deadLetterErrorDescription As String) As Task" /> <MemberSignature Language="F#" Value="abstract member DeadLetterAsync : Guid * string * string -> System.Threading.Tasks.Task
override this.DeadLetterAsync : Guid * string * string -> System.Threading.Tasks.Task" Usage="queueClient.DeadLetterAsync (lockToken, 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="lockToken" Type="System.Guid" /> <Parameter Name="deadLetterReason" Type="System.String" /> <Parameter Name="deadLetterErrorDescription" Type="System.String" /> </Parameters> <Docs> <param name="lockToken">The lock token bound to the locked message instance.</param> <param name="deadLetterReason">The reason for deadlettering the message.</param> <param name="deadLetterErrorDescription">The error description for deadlettering the message.</param> <summary>Asynchronously moves the undelivered message to the dead letter queue.</summary> <returns>The asynchronous operation.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="Defer"> <MemberSignature Language="C#" Value="public void Defer (Guid lockToken);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Defer(valuetype System.Guid lockToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.Defer(System.Guid)" /> <MemberSignature Language="VB.NET" Value="Public Sub Defer (lockToken As Guid)" /> <MemberSignature Language="F#" Value="abstract member Defer : Guid -> unit
override this.Defer : Guid -> unit" Usage="queueClient.Defer lockToken" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="lockToken" Type="System.Guid" /> </Parameters> <Docs> <param name="lockToken">The lock token bound to the locked message instance.</param> <summary>Suspends the processing of a message.</summary> <remarks>Before deferring, you should set aside the message receipt for later retrieval. </remarks> <exception cref="T:System.TimeoutException">Thrown if the operation exceeded the timeout value set by <see cref="P:Microsoft.ServiceBus.Messaging.MessagingFactorySettings.OperationTimeout" /></exception> <exception cref="T:System.OperationCanceledException">Thrown if the client entity has been closed or aborted.</exception> <exception cref="T:Microsoft.ServiceBus.Messaging.MessageLockLostException">Thrown if the message represented by the <paramref name="lockToken" /> has lost the message lock.</exception> </Docs> </Member> <Member MemberName="Defer"> <MemberSignature Language="C#" Value="public void Defer (Guid lockToken, System.Collections.Generic.IDictionary<string,object> propertiesToModify);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Defer(valuetype System.Guid lockToken, class System.Collections.Generic.IDictionary`2<string, object> propertiesToModify) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.Defer(System.Guid,System.Collections.Generic.IDictionary{System.String,System.Object})" /> <MemberSignature Language="VB.NET" Value="Public Sub Defer (lockToken As Guid, propertiesToModify As IDictionary(Of String, Object))" /> <MemberSignature Language="F#" Value="abstract member Defer : Guid * System.Collections.Generic.IDictionary<string, obj> -> unit
override this.Defer : Guid * System.Collections.Generic.IDictionary<string, obj> -> unit" Usage="queueClient.Defer (lockToken, 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="lockToken" Type="System.Guid" /> <Parameter Name="propertiesToModify" Type="System.Collections.Generic.IDictionary<System.String,System.Object>" /> </Parameters> <Docs> <param name="lockToken">The lock token bound to the locked message instance.</param> <param name="propertiesToModify">The properties of the message to modify.</param> <summary>Suspends the processing of a message.</summary> <remarks>Before deferring, you should set aside the message receipt for later retrieval. </remarks> </Docs> </Member> <Member MemberName="DeferAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task DeferAsync (Guid lockToken);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task DeferAsync(valuetype System.Guid lockToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.DeferAsync(System.Guid)" /> <MemberSignature Language="VB.NET" Value="Public Function DeferAsync (lockToken As Guid) As Task" /> <MemberSignature Language="F#" Value="abstract member DeferAsync : Guid -> System.Threading.Tasks.Task
override this.DeferAsync : Guid -> System.Threading.Tasks.Task" Usage="queueClient.DeferAsync lockToken" /> <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="lockToken" Type="System.Guid" /> </Parameters> <Docs> <param name="lockToken">The lock token bound to the locked message instance.</param> <summary>Asynchronously suspends the processing of a message.</summary> <returns>The asynchronous operation.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="DeferAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task DeferAsync (Guid lockToken, System.Collections.Generic.IDictionary<string,object> propertiesToModify);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task DeferAsync(valuetype System.Guid lockToken, class System.Collections.Generic.IDictionary`2<string, object> propertiesToModify) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.DeferAsync(System.Guid,System.Collections.Generic.IDictionary{System.String,System.Object})" /> <MemberSignature Language="VB.NET" Value="Public Function DeferAsync (lockToken As Guid, propertiesToModify As IDictionary(Of String, Object)) As Task" /> <MemberSignature Language="F#" Value="abstract member DeferAsync : Guid * System.Collections.Generic.IDictionary<string, obj> -> System.Threading.Tasks.Task
override this.DeferAsync : Guid * System.Collections.Generic.IDictionary<string, obj> -> System.Threading.Tasks.Task" Usage="queueClient.DeferAsync (lockToken, 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="lockToken" Type="System.Guid" /> <Parameter Name="propertiesToModify" Type="System.Collections.Generic.IDictionary<System.String,System.Object>" /> </Parameters> <Docs> <param name="lockToken">The lock token bound to the locked message instance.</param> <param name="propertiesToModify">The properties of the message to modify.</param> <summary>Asynchronously suspends the processing of a message.</summary> <returns>The asynchronous operation.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="FormatDeadLetterPath"> <MemberSignature Language="C#" Value="public static string FormatDeadLetterPath (string queuePath);" /> <MemberSignature Language="ILAsm" Value=".method public static hidebysig string FormatDeadLetterPath(string queuePath) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.FormatDeadLetterPath(System.String)" /> <MemberSignature Language="VB.NET" Value="Public Shared Function FormatDeadLetterPath (queuePath As String) As String" /> <MemberSignature Language="F#" Value="static member FormatDeadLetterPath : string -> string" Usage="Microsoft.ServiceBus.Messaging.QueueClient.FormatDeadLetterPath queuePath" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.String</ReturnType> </ReturnValue> <Parameters> <Parameter Name="queuePath" Type="System.String" /> </Parameters> <Docs> <param name="queuePath">The path to the dead letter queue.</param> <summary>Builds a format name from the specified dead letter queue path.</summary> <returns>The <see cref="T:System.String" /> resulted from building the format name for the specified dead letter queue path.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="FormatTransferDeadLetterPath"> <MemberSignature Language="C#" Value="public static string FormatTransferDeadLetterPath (string queuePath);" /> <MemberSignature Language="ILAsm" Value=".method public static hidebysig string FormatTransferDeadLetterPath(string queuePath) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.FormatTransferDeadLetterPath(System.String)" /> <MemberSignature Language="VB.NET" Value="Public Shared Function FormatTransferDeadLetterPath (queuePath As String) As String" /> <MemberSignature Language="F#" Value="static member FormatTransferDeadLetterPath : string -> string" Usage="Microsoft.ServiceBus.Messaging.QueueClient.FormatTransferDeadLetterPath queuePath" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.String</ReturnType> </ReturnValue> <Parameters> <Parameter Name="queuePath" Type="System.String" /> </Parameters> <Docs> <param name="queuePath" /> <summary /> <returns>To be added.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="GetMessageSessions"> <MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.MessageSession> GetMessageSessions ();" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Collections.Generic.IEnumerable`1<class Microsoft.ServiceBus.Messaging.MessageSession> GetMessageSessions() cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.GetMessageSessions" /> <MemberSignature Language="VB.NET" Value="Public Function GetMessageSessions () As IEnumerable(Of MessageSession)" /> <MemberSignature Language="F#" Value="abstract member GetMessageSessions : unit -> seq<Microsoft.ServiceBus.Messaging.MessageSession>
override this.GetMessageSessions : unit -> seq<Microsoft.ServiceBus.Messaging.MessageSession>" Usage="queueClient.GetMessageSessions " /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.MessageSession></ReturnType> </ReturnValue> <Parameters /> <Docs> <summary>Gets the message sessions, enabling you to browse sessions on queues. Only sessions with active messages in the queue are returned. The sessions on the deadletter queue or sessions having a SessionState as 'active' and no messages are not returned with this call.</summary> <returns>The message session.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="GetMessageSessions"> <MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.MessageSession> GetMessageSessions (DateTime lastUpdatedTime);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Collections.Generic.IEnumerable`1<class Microsoft.ServiceBus.Messaging.MessageSession> GetMessageSessions(valuetype System.DateTime lastUpdatedTime) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.GetMessageSessions(System.DateTime)" /> <MemberSignature Language="VB.NET" Value="Public Function GetMessageSessions (lastUpdatedTime As DateTime) As IEnumerable(Of MessageSession)" /> <MemberSignature Language="F#" Value="abstract member GetMessageSessions : DateTime -> seq<Microsoft.ServiceBus.Messaging.MessageSession>
override this.GetMessageSessions : DateTime -> seq<Microsoft.ServiceBus.Messaging.MessageSession>" Usage="queueClient.GetMessageSessions lastUpdatedTime" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.MessageSession></ReturnType> </ReturnValue> <Parameters> <Parameter Name="lastUpdatedTime" Type="System.DateTime" /> </Parameters> <Docs> <param name="lastUpdatedTime">The time the session was last updated.</param> <summary>Retrieves all message sessions whose session state was updated since <paramref name="lastUpdatedTime" />.</summary> <returns>The message sessions.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="GetMessageSessionsAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.MessageSession>> GetMessageSessionsAsync ();" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class System.Collections.Generic.IEnumerable`1<class Microsoft.ServiceBus.Messaging.MessageSession>> GetMessageSessionsAsync() cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.GetMessageSessionsAsync" /> <MemberSignature Language="VB.NET" Value="Public Function GetMessageSessionsAsync () As Task(Of IEnumerable(Of MessageSession))" /> <MemberSignature Language="F#" Value="abstract member GetMessageSessionsAsync : unit -> System.Threading.Tasks.Task<seq<Microsoft.ServiceBus.Messaging.MessageSession>>
override this.GetMessageSessionsAsync : unit -> System.Threading.Tasks.Task<seq<Microsoft.ServiceBus.Messaging.MessageSession>>" Usage="queueClient.GetMessageSessionsAsync " /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.MessageSession>></ReturnType> </ReturnValue> <Parameters /> <Docs> <summary>Asynchronously gets the message sessions, enabling you to browse sessions on queues. Only sessions with active messages in the queue are returned. The sessions on the deadletter queue or sessions having a SessionState as 'active' and no messages are not returned with this call.</summary> <returns>The asynchronous operation.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="GetMessageSessionsAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.MessageSession>> GetMessageSessionsAsync (DateTime lastUpdatedTime);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class System.Collections.Generic.IEnumerable`1<class Microsoft.ServiceBus.Messaging.MessageSession>> GetMessageSessionsAsync(valuetype System.DateTime lastUpdatedTime) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.GetMessageSessionsAsync(System.DateTime)" /> <MemberSignature Language="VB.NET" Value="Public Function GetMessageSessionsAsync (lastUpdatedTime As DateTime) As Task(Of IEnumerable(Of MessageSession))" /> <MemberSignature Language="F#" Value="abstract member GetMessageSessionsAsync : DateTime -> System.Threading.Tasks.Task<seq<Microsoft.ServiceBus.Messaging.MessageSession>>
override this.GetMessageSessionsAsync : DateTime -> System.Threading.Tasks.Task<seq<Microsoft.ServiceBus.Messaging.MessageSession>>" Usage="queueClient.GetMessageSessionsAsync lastUpdatedTime" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.MessageSession>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="lastUpdatedTime" Type="System.DateTime" /> </Parameters> <Docs> <param name="lastUpdatedTime">The time the session was last updated.</param> <summary>Asynchronously retrieves all message sessions whose session state was updated since <paramref name="lastUpdatedTime" />.</summary> <returns>The asynchronous operation.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="MessagingFactory"> <MemberSignature Language="C#" Value="public Microsoft.ServiceBus.Messaging.MessagingFactory MessagingFactory { get; }" /> <MemberSignature Language="ILAsm" Value=".property instance class Microsoft.ServiceBus.Messaging.MessagingFactory MessagingFactory" /> <MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.QueueClient.MessagingFactory" /> <MemberSignature Language="VB.NET" Value="Public ReadOnly Property MessagingFactory As MessagingFactory" /> <MemberSignature Language="F#" Value="member this.MessagingFactory : Microsoft.ServiceBus.Messaging.MessagingFactory" Usage="Microsoft.ServiceBus.Messaging.QueueClient.MessagingFactory" /> <MemberType>Property</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Microsoft.ServiceBus.Messaging.MessagingFactory</ReturnType> </ReturnValue> <Docs> <summary>Gets or sets the messaging factory.</summary> <value>The messaging factory.</value> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="Mode"> <MemberSignature Language="C#" Value="public Microsoft.ServiceBus.Messaging.ReceiveMode Mode { get; }" /> <MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.ServiceBus.Messaging.ReceiveMode Mode" /> <MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.QueueClient.Mode" /> <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Mode As ReceiveMode" /> <MemberSignature Language="F#" Value="member this.Mode : Microsoft.ServiceBus.Messaging.ReceiveMode" Usage="Microsoft.ServiceBus.Messaging.QueueClient.Mode" /> <MemberType>Property</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Microsoft.ServiceBus.Messaging.ReceiveMode</ReturnType> </ReturnValue> <Docs> <summary>Gets the message receive mode when processing the received message.</summary> <value>The message <see cref="T:Microsoft.ServiceBus.Messaging.ReceiveMode" /> when processing the received message.</value> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="OnAbort"> <MemberSignature Language="C#" Value="protected override void OnAbort ();" /> <MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void OnAbort() cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.OnAbort" /> <MemberSignature Language="VB.NET" Value="Protected Overrides Sub OnAbort ()" /> <MemberSignature Language="F#" Value="override this.OnAbort : unit -> unit" Usage="queueClient.OnAbort " /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary>Executes upon calling the Abort event.</summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="OnBeginAcceptMessageSession"> <MemberSignature Language="C#" Value="protected abstract IAsyncResult OnBeginAcceptMessageSession (string sessionId, Microsoft.ServiceBus.Messaging.ReceiveMode receiveMode, int prefetchCount, bool isExclusiveMode, Guid? lockToken, TimeSpan serverWaitTime, TimeSpan timeout, AsyncCallback callback, object state);" /> <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance class System.IAsyncResult OnBeginAcceptMessageSession(string sessionId, valuetype Microsoft.ServiceBus.Messaging.ReceiveMode receiveMode, int32 prefetchCount, bool isExclusiveMode, valuetype System.Nullable`1<valuetype System.Guid> lockToken, valuetype System.TimeSpan serverWaitTime, valuetype System.TimeSpan timeout, class System.AsyncCallback callback, object state) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.OnBeginAcceptMessageSession(System.String,Microsoft.ServiceBus.Messaging.ReceiveMode,System.Int32,System.Boolean,System.Nullable{System.Guid},System.TimeSpan,System.TimeSpan,System.AsyncCallback,System.Object)" /> <MemberSignature Language="VB.NET" Value="Protected MustOverride Function OnBeginAcceptMessageSession (sessionId As String, receiveMode As ReceiveMode, prefetchCount As Integer, isExclusiveMode As Boolean, lockToken As Nullable(Of Guid), serverWaitTime As TimeSpan, timeout As TimeSpan, callback As AsyncCallback, state As Object) As IAsyncResult" /> <MemberSignature Language="F#" Value="abstract member OnBeginAcceptMessageSession : string * Microsoft.ServiceBus.Messaging.ReceiveMode * int * bool * Nullable<Guid> * TimeSpan * TimeSpan * AsyncCallback * obj -> IAsyncResult" Usage="queueClient.OnBeginAcceptMessageSession (sessionId, receiveMode, prefetchCount, isExclusiveMode, lockToken, serverWaitTime, timeout, callback, state)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.IAsyncResult</ReturnType> </ReturnValue> <Parameters> <Parameter Name="sessionId" Type="System.String" /> <Parameter Name="receiveMode" Type="Microsoft.ServiceBus.Messaging.ReceiveMode" /> <Parameter Name="prefetchCount" Type="System.Int32" /> <Parameter Name="isExclusiveMode" Type="System.Boolean" /> <Parameter Name="lockToken" Type="System.Nullable<System.Guid>" /> <Parameter Name="serverWaitTime" Type="System.TimeSpan" /> <Parameter Name="timeout" Type="System.TimeSpan" /> <Parameter Name="callback" Type="System.AsyncCallback" /> <Parameter Name="state" Type="System.Object" /> </Parameters> <Docs> <param name="sessionId" /> <param name="receiveMode" /> <param name="prefetchCount" /> <param name="isExclusiveMode" /> <param name="lockToken" /> <param name="serverWaitTime" /> <param name="timeout" /> <param name="callback" /> <param name="state" /> <summary /> <returns>To be added.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="OnBeginClose"> <MemberSignature Language="C#" Value="protected override IAsyncResult OnBeginClose (TimeSpan timeout, AsyncCallback callback, object state);" /> <MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance class System.IAsyncResult OnBeginClose(valuetype System.TimeSpan timeout, class System.AsyncCallback callback, object state) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.OnBeginClose(System.TimeSpan,System.AsyncCallback,System.Object)" /> <MemberSignature Language="VB.NET" Value="Protected Overrides Function OnBeginClose (timeout As TimeSpan, callback As AsyncCallback, state As Object) As IAsyncResult" /> <MemberSignature Language="F#" Value="override this.OnBeginClose : TimeSpan * AsyncCallback * obj -> IAsyncResult" Usage="queueClient.OnBeginClose (timeout, callback, state)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.IAsyncResult</ReturnType> </ReturnValue> <Parameters> <Parameter Name="timeout" Type="System.TimeSpan" /> <Parameter Name="callback" Type="System.AsyncCallback" /> <Parameter Name="state" Type="System.Object" /> </Parameters> <Docs> <param name="timeout">The maximum time before the close operation times out.</param> <param name="callback">An <see cref="T:System.AsyncCallback" /> delegate that references the method to invoke when the operation is complete.</param> <param name="state">A user-defined object that contains information about the receive operation. This object is passed to the EndClose delegate when the operation is complete.</param> <summary>Executes when the Close operation is called.</summary> <returns>An <see cref="T:System.IAsyncResult" /> object that references the asynchronous parent method.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="OnBeginCreateReceiver"> <MemberSignature Language="C#" Value="protected abstract IAsyncResult OnBeginCreateReceiver (Microsoft.ServiceBus.Messaging.ReceiveMode receiveMode, TimeSpan timeout, AsyncCallback callback, object state);" /> <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance class System.IAsyncResult OnBeginCreateReceiver(valuetype Microsoft.ServiceBus.Messaging.ReceiveMode receiveMode, valuetype System.TimeSpan timeout, class System.AsyncCallback callback, object state) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.OnBeginCreateReceiver(Microsoft.ServiceBus.Messaging.ReceiveMode,System.TimeSpan,System.AsyncCallback,System.Object)" /> <MemberSignature Language="VB.NET" Value="Protected MustOverride Function OnBeginCreateReceiver (receiveMode As ReceiveMode, timeout As TimeSpan, callback As AsyncCallback, state As Object) As IAsyncResult" /> <MemberSignature Language="F#" Value="abstract member OnBeginCreateReceiver : Microsoft.ServiceBus.Messaging.ReceiveMode * TimeSpan * AsyncCallback * obj -> IAsyncResult" Usage="queueClient.OnBeginCreateReceiver (receiveMode, timeout, callback, state)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.IAsyncResult</ReturnType> </ReturnValue> <Parameters> <Parameter Name="receiveMode" Type="Microsoft.ServiceBus.Messaging.ReceiveMode" /> <Parameter Name="timeout" Type="System.TimeSpan" /> <Parameter Name="callback" Type="System.AsyncCallback" /> <Parameter Name="state" Type="System.Object" /> </Parameters> <Docs> <param name="receiveMode">The message <see cref="T:Microsoft.ServiceBus.Messaging.ReceiveMode" /> receive mode.</param> <param name="timeout">The maximum time before this operation times out.</param> <param name="callback">An <see cref="T:System.AsyncCallback" /> delegate that references the method to invoke when the operation is complete.</param> <param name="state">A user-defined object that contains information about the receive operation. This object is passed to the <see cref="M:Microsoft.ServiceBus.Messaging.QueueClient.EndCreateReceiver(System.IAsyncResult)" /> delegate when the operation is complete.</param> <summary>Executes the begin create receiver action.</summary> <returns>An <see cref="T:System.IAsyncResult" /> object that references the asynchronous parent method.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="OnBeginCreateReceiver"> <MemberSignature Language="C#" Value="protected abstract IAsyncResult OnBeginCreateReceiver (string subQueueName, Microsoft.ServiceBus.Messaging.ReceiveMode receiveMode, TimeSpan timeout, AsyncCallback callback, object state);" /> <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance class System.IAsyncResult OnBeginCreateReceiver(string subQueueName, valuetype Microsoft.ServiceBus.Messaging.ReceiveMode receiveMode, valuetype System.TimeSpan timeout, class System.AsyncCallback callback, object state) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.OnBeginCreateReceiver(System.String,Microsoft.ServiceBus.Messaging.ReceiveMode,System.TimeSpan,System.AsyncCallback,System.Object)" /> <MemberSignature Language="VB.NET" Value="Protected MustOverride Function OnBeginCreateReceiver (subQueueName As String, receiveMode As ReceiveMode, timeout As TimeSpan, callback As AsyncCallback, state As Object) As IAsyncResult" /> <MemberSignature Language="F#" Value="abstract member OnBeginCreateReceiver : string * Microsoft.ServiceBus.Messaging.ReceiveMode * TimeSpan * AsyncCallback * obj -> IAsyncResult" Usage="queueClient.OnBeginCreateReceiver (subQueueName, receiveMode, timeout, callback, state)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.IAsyncResult</ReturnType> </ReturnValue> <Parameters> <Parameter Name="subQueueName" Type="System.String" /> <Parameter Name="receiveMode" Type="Microsoft.ServiceBus.Messaging.ReceiveMode" /> <Parameter Name="timeout" Type="System.TimeSpan" /> <Parameter Name="callback" Type="System.AsyncCallback" /> <Parameter Name="state" Type="System.Object" /> </Parameters> <Docs> <param name="subQueueName">Name of the sub-queue.</param> <param name="receiveMode">The message <see cref="T:Microsoft.ServiceBus.Messaging.ReceiveMode" /> receive mode.</param> <param name="timeout">The maximum time before this operation times out.</param> <param name="callback">An <see cref="T:System.AsyncCallback" /> delegate that references the method to invoke when the operation is complete.</param> <param name="state">A user-defined object that contains information about the receive operation. This object is passed to the <see cref="M:Microsoft.ServiceBus.Messaging.QueueClient.EndCreateReceiver(System.IAsyncResult)" /> delegate when the operation is complete.</param> <summary>Executes the begin create receiver action.</summary> <returns>An <see cref="T:System.IAsyncResult" /> object that references the asynchronous parent method.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="OnBeginCreateSender"> <MemberSignature Language="C#" Value="protected abstract IAsyncResult OnBeginCreateSender (TimeSpan timeout, AsyncCallback callback, object state);" /> <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance class System.IAsyncResult OnBeginCreateSender(valuetype System.TimeSpan timeout, class System.AsyncCallback callback, object state) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.OnBeginCreateSender(System.TimeSpan,System.AsyncCallback,System.Object)" /> <MemberSignature Language="VB.NET" Value="Protected MustOverride Function OnBeginCreateSender (timeout As TimeSpan, callback As AsyncCallback, state As Object) As IAsyncResult" /> <MemberSignature Language="F#" Value="abstract member OnBeginCreateSender : TimeSpan * AsyncCallback * obj -> IAsyncResult" Usage="queueClient.OnBeginCreateSender (timeout, callback, state)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.IAsyncResult</ReturnType> </ReturnValue> <Parameters> <Parameter Name="timeout" Type="System.TimeSpan" /> <Parameter Name="callback" Type="System.AsyncCallback" /> <Parameter Name="state" Type="System.Object" /> </Parameters> <Docs> <param name="timeout">The maximum time before this operation times out.</param> <param name="callback">An <see cref="T:System.AsyncCallback" /> delegate that references the method to invoke when the operation is complete.</param> <param name="state">A user-defined object that contains information about the receive operation. This object is passed to the <see cref="M:Microsoft.ServiceBus.Messaging.QueueClient.EndCreateSender(System.IAsyncResult)" /> delegate when the operation is complete.</param> <summary>Executes the begin create sender action.</summary> <returns>An <see cref="T:System.IAsyncResult" /> object that references the asynchronous parent method</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="OnBeginGetMessageSessions"> <MemberSignature Language="C#" Value="protected abstract IAsyncResult OnBeginGetMessageSessions (DateTime lastUpdatedTime, AsyncCallback callback, object state);" /> <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance class System.IAsyncResult OnBeginGetMessageSessions(valuetype System.DateTime lastUpdatedTime, class System.AsyncCallback callback, object state) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.OnBeginGetMessageSessions(System.DateTime,System.AsyncCallback,System.Object)" /> <MemberSignature Language="VB.NET" Value="Protected MustOverride Function OnBeginGetMessageSessions (lastUpdatedTime As DateTime, callback As AsyncCallback, state As Object) As IAsyncResult" /> <MemberSignature Language="F#" Value="abstract member OnBeginGetMessageSessions : DateTime * AsyncCallback * obj -> IAsyncResult" Usage="queueClient.OnBeginGetMessageSessions (lastUpdatedTime, callback, state)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.IAsyncResult</ReturnType> </ReturnValue> <Parameters> <Parameter Name="lastUpdatedTime" Type="System.DateTime" /> <Parameter Name="callback" Type="System.AsyncCallback" /> <Parameter Name="state" Type="System.Object" /> </Parameters> <Docs> <param name="lastUpdatedTime">The date and time of the last update.</param> <param name="callback">An <see cref="T:System.AsyncCallback" /> delegate that references the method to invoke when the operation is complete.</param> <param name="state">A user-defined object that contains state information about the asynchronous operation.</param> <summary>Executes the BeginGetMessageSessions action.</summary> <returns>An <see cref="T:System.IAsyncResult" /> that references the asynchronous operation to get the message sessions.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="OnClose"> <MemberSignature Language="C#" Value="protected override void OnClose (TimeSpan timeout);" /> <MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void OnClose(valuetype System.TimeSpan timeout) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.OnClose(System.TimeSpan)" /> <MemberSignature Language="VB.NET" Value="Protected Overrides Sub OnClose (timeout As TimeSpan)" /> <MemberSignature Language="F#" Value="override this.OnClose : TimeSpan -> unit" Usage="queueClient.OnClose timeout" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="timeout" Type="System.TimeSpan" /> </Parameters> <Docs> <param name="timeout">The maximum time before the close operation times out.</param> <summary>Executes upon calling the Close action.</summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="OnEndAcceptMessageSession"> <MemberSignature Language="C#" Value="protected abstract Microsoft.ServiceBus.Messaging.MessageSession OnEndAcceptMessageSession (IAsyncResult result);" /> <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance class Microsoft.ServiceBus.Messaging.MessageSession OnEndAcceptMessageSession(class System.IAsyncResult result) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.OnEndAcceptMessageSession(System.IAsyncResult)" /> <MemberSignature Language="VB.NET" Value="Protected MustOverride Function OnEndAcceptMessageSession (result As IAsyncResult) As MessageSession" /> <MemberSignature Language="F#" Value="abstract member OnEndAcceptMessageSession : IAsyncResult -> Microsoft.ServiceBus.Messaging.MessageSession" Usage="queueClient.OnEndAcceptMessageSession result" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Microsoft.ServiceBus.Messaging.MessageSession</ReturnType> </ReturnValue> <Parameters> <Parameter Name="result" Type="System.IAsyncResult" /> </Parameters> <Docs> <param name="result">An <see cref="T:System.IAsyncResult" /> that represents the status of the asynchronous accept message session operation.</param> <summary>Executes upon calling the EndAcceptMessageSession operation.</summary> <returns>The <see cref="T:Microsoft.ServiceBus.Messaging.MessageSession" /> that allows grouping of related messages for processing in a single transaction.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="OnEndClose"> <MemberSignature Language="C#" Value="protected override void OnEndClose (IAsyncResult result);" /> <MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void OnEndClose(class System.IAsyncResult result) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.OnEndClose(System.IAsyncResult)" /> <MemberSignature Language="VB.NET" Value="Protected Overrides Sub OnEndClose (result As IAsyncResult)" /> <MemberSignature Language="F#" Value="override this.OnEndClose : IAsyncResult -> unit" Usage="queueClient.OnEndClose result" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="result" Type="System.IAsyncResult" /> </Parameters> <Docs> <param name="result">The result of the asynchronous parent method.</param> <summary>Executes the end close action.</summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="OnEndCreateReceiver"> <MemberSignature Language="C#" Value="protected abstract Microsoft.ServiceBus.Messaging.MessageReceiver OnEndCreateReceiver (IAsyncResult result);" /> <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance class Microsoft.ServiceBus.Messaging.MessageReceiver OnEndCreateReceiver(class System.IAsyncResult result) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.OnEndCreateReceiver(System.IAsyncResult)" /> <MemberSignature Language="VB.NET" Value="Protected MustOverride Function OnEndCreateReceiver (result As IAsyncResult) As MessageReceiver" /> <MemberSignature Language="F#" Value="abstract member OnEndCreateReceiver : IAsyncResult -> Microsoft.ServiceBus.Messaging.MessageReceiver" Usage="queueClient.OnEndCreateReceiver result" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Microsoft.ServiceBus.Messaging.MessageReceiver</ReturnType> </ReturnValue> <Parameters> <Parameter Name="result" Type="System.IAsyncResult" /> </Parameters> <Docs> <param name="result">The result of the asynchronous <see cref="M:Microsoft.ServiceBus.Messaging.QueueClient.EndCreateReceiver(System.IAsyncResult)" /> operation.</param> <summary>Executes the end create receiver action.</summary> <returns>A <see cref="T:Microsoft.ServiceBus.Messaging.MessageReceiver" /> object.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="OnEndCreateSender"> <MemberSignature Language="C#" Value="protected abstract Microsoft.ServiceBus.Messaging.MessageSender OnEndCreateSender (IAsyncResult result);" /> <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance class Microsoft.ServiceBus.Messaging.MessageSender OnEndCreateSender(class System.IAsyncResult result) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.OnEndCreateSender(System.IAsyncResult)" /> <MemberSignature Language="VB.NET" Value="Protected MustOverride Function OnEndCreateSender (result As IAsyncResult) As MessageSender" /> <MemberSignature Language="F#" Value="abstract member OnEndCreateSender : IAsyncResult -> Microsoft.ServiceBus.Messaging.MessageSender" Usage="queueClient.OnEndCreateSender result" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Microsoft.ServiceBus.Messaging.MessageSender</ReturnType> </ReturnValue> <Parameters> <Parameter Name="result" Type="System.IAsyncResult" /> </Parameters> <Docs> <param name="result">An <see cref="T:System.IAsyncResult" /> object that references the asynchronous parent method.</param> <summary>Executes the end create sender action.</summary> <returns>A <see cref="T:Microsoft.ServiceBus.Messaging.MessageSender" /> object.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="OnEndGetMessageSessions"> <MemberSignature Language="C#" Value="protected abstract System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.MessageSession> OnEndGetMessageSessions (IAsyncResult result);" /> <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance class System.Collections.Generic.IEnumerable`1<class Microsoft.ServiceBus.Messaging.MessageSession> OnEndGetMessageSessions(class System.IAsyncResult result) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.OnEndGetMessageSessions(System.IAsyncResult)" /> <MemberSignature Language="VB.NET" Value="Protected MustOverride Function OnEndGetMessageSessions (result As IAsyncResult) As IEnumerable(Of MessageSession)" /> <MemberSignature Language="F#" Value="abstract member OnEndGetMessageSessions : IAsyncResult -> seq<Microsoft.ServiceBus.Messaging.MessageSession>" Usage="queueClient.OnEndGetMessageSessions result" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.MessageSession></ReturnType> </ReturnValue> <Parameters> <Parameter Name="result" Type="System.IAsyncResult" /> </Parameters> <Docs> <param name="result">The result of the session.</param> <summary>Executes the end get message action.</summary> <returns> The <see cref="T:Microsoft.ServiceBus.Messaging.MessageSession" /> that allows grouping of related messages for processing in a single transaction.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="OnMessage"> <MemberSignature Language="C#" Value="public void OnMessage (Action<Microsoft.ServiceBus.Messaging.BrokeredMessage> callback);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void OnMessage(class System.Action`1<class Microsoft.ServiceBus.Messaging.BrokeredMessage> callback) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.OnMessage(System.Action{Microsoft.ServiceBus.Messaging.BrokeredMessage})" /> <MemberSignature Language="VB.NET" Value="Public Sub OnMessage (callback As Action(Of BrokeredMessage))" /> <MemberSignature Language="F#" Value="member this.OnMessage : Action<Microsoft.ServiceBus.Messaging.BrokeredMessage> -> unit" Usage="queueClient.OnMessage callback" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="callback" Type="System.Action<Microsoft.ServiceBus.Messaging.BrokeredMessage>" /> </Parameters> <Docs> <param name="callback">The method to invoke when the operation is complete.</param> <summary>Processes a message in an event-driven message pump.</summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="OnMessage"> <MemberSignature Language="C#" Value="public void OnMessage (Action<Microsoft.ServiceBus.Messaging.BrokeredMessage> callback, Microsoft.ServiceBus.Messaging.OnMessageOptions onMessageOptions);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void OnMessage(class System.Action`1<class Microsoft.ServiceBus.Messaging.BrokeredMessage> callback, class Microsoft.ServiceBus.Messaging.OnMessageOptions onMessageOptions) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.OnMessage(System.Action{Microsoft.ServiceBus.Messaging.BrokeredMessage},Microsoft.ServiceBus.Messaging.OnMessageOptions)" /> <MemberSignature Language="VB.NET" Value="Public Sub OnMessage (callback As Action(Of BrokeredMessage), onMessageOptions As OnMessageOptions)" /> <MemberSignature Language="F#" Value="member this.OnMessage : Action<Microsoft.ServiceBus.Messaging.BrokeredMessage> * Microsoft.ServiceBus.Messaging.OnMessageOptions -> unit" Usage="queueClient.OnMessage (callback, onMessageOptions)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="callback" Type="System.Action<Microsoft.ServiceBus.Messaging.BrokeredMessage>" /> <Parameter Name="onMessageOptions" Type="Microsoft.ServiceBus.Messaging.OnMessageOptions" /> </Parameters> <Docs> <param name="callback">The method to invoke when the operation is complete.</param> <param name="onMessageOptions">Specifies the <see cref="T:Microsoft.ServiceBus.Messaging.OnMessageOptions" /> options with which to instantiate the message pump.</param> <summary>Processes a message in an event-driven message pump, with the given set of <see cref="T:Microsoft.ServiceBus.Messaging.OnMessageOptions" /> options.</summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="OnMessageAsync"> <MemberSignature Language="C#" Value="public void OnMessageAsync (Func<Microsoft.ServiceBus.Messaging.BrokeredMessage,System.Threading.Tasks.Task> callback);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void OnMessageAsync(class System.Func`2<class Microsoft.ServiceBus.Messaging.BrokeredMessage, class System.Threading.Tasks.Task> callback) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.OnMessageAsync(System.Func{Microsoft.ServiceBus.Messaging.BrokeredMessage,System.Threading.Tasks.Task})" /> <MemberSignature Language="VB.NET" Value="Public Sub OnMessageAsync (callback As Func(Of BrokeredMessage, Task))" /> <MemberSignature Language="F#" Value="member this.OnMessageAsync : Func<Microsoft.ServiceBus.Messaging.BrokeredMessage, System.Threading.Tasks.Task> -> unit" Usage="queueClient.OnMessageAsync callback" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="callback" Type="System.Func<Microsoft.ServiceBus.Messaging.BrokeredMessage,System.Threading.Tasks.Task>" /> </Parameters> <Docs> <param name="callback">The method to invoke when the operation is complete.</param> <summary>Asynchronously processes a message.</summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="OnMessageAsync"> <MemberSignature Language="C#" Value="public void OnMessageAsync (Func<Microsoft.ServiceBus.Messaging.BrokeredMessage,System.Threading.Tasks.Task> callback, Microsoft.ServiceBus.Messaging.OnMessageOptions onMessageOptions);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void OnMessageAsync(class System.Func`2<class Microsoft.ServiceBus.Messaging.BrokeredMessage, class System.Threading.Tasks.Task> callback, class Microsoft.ServiceBus.Messaging.OnMessageOptions onMessageOptions) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.OnMessageAsync(System.Func{Microsoft.ServiceBus.Messaging.BrokeredMessage,System.Threading.Tasks.Task},Microsoft.ServiceBus.Messaging.OnMessageOptions)" /> <MemberSignature Language="VB.NET" Value="Public Sub OnMessageAsync (callback As Func(Of BrokeredMessage, Task), onMessageOptions As OnMessageOptions)" /> <MemberSignature Language="F#" Value="member this.OnMessageAsync : Func<Microsoft.ServiceBus.Messaging.BrokeredMessage, System.Threading.Tasks.Task> * Microsoft.ServiceBus.Messaging.OnMessageOptions -> unit" Usage="queueClient.OnMessageAsync (callback, onMessageOptions)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="callback" Type="System.Func<Microsoft.ServiceBus.Messaging.BrokeredMessage,System.Threading.Tasks.Task>" /> <Parameter Name="onMessageOptions" Type="Microsoft.ServiceBus.Messaging.OnMessageOptions" /> </Parameters> <Docs> <param name="callback">The method to invoke when the operation is complete.</param> <param name="onMessageOptions">Calls a message option.</param> <summary>Asynchronously processes a message.</summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="Peek"> <MemberSignature Language="C#" Value="public Microsoft.ServiceBus.Messaging.BrokeredMessage Peek ();" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.ServiceBus.Messaging.BrokeredMessage Peek() cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.Peek" /> <MemberSignature Language="VB.NET" Value="Public Function Peek () As BrokeredMessage" /> <MemberSignature Language="F#" Value="abstract member Peek : unit -> Microsoft.ServiceBus.Messaging.BrokeredMessage
override this.Peek : unit -> Microsoft.ServiceBus.Messaging.BrokeredMessage" Usage="queueClient.Peek " /> <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>Returns without removing the first message in the queue.</summary> <returns>A brokered message. Returns all properties and the message body.</returns> <remarks>A Null can be return by this API if operation exceeded the timeout specified, or the operations succeeded but there are no more messages to be received.</remarks> </Docs> </Member> <Member MemberName="Peek"> <MemberSignature Language="C#" Value="public Microsoft.ServiceBus.Messaging.BrokeredMessage Peek (long fromSequenceNumber);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.ServiceBus.Messaging.BrokeredMessage Peek(int64 fromSequenceNumber) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.Peek(System.Int64)" /> <MemberSignature Language="VB.NET" Value="Public Function Peek (fromSequenceNumber As Long) As BrokeredMessage" /> <MemberSignature Language="F#" Value="abstract member Peek : int64 -> Microsoft.ServiceBus.Messaging.BrokeredMessage
override this.Peek : int64 -> Microsoft.ServiceBus.Messaging.BrokeredMessage" Usage="queueClient.Peek fromSequenceNumber" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Microsoft.ServiceBus.Messaging.BrokeredMessage</ReturnType> </ReturnValue> <Parameters> <Parameter Name="fromSequenceNumber" Type="System.Int64" /> </Parameters> <Docs> <param name="fromSequenceNumber">The starting point from which to browse a message.</param> <summary>Returns without removing the first message in the queue.</summary> <returns>The brokered message.</returns> <remarks>A Null can be return by this API if operation exceeded the timeout specified, or the operations succeeded but there are no more messages to be received.</remarks> </Docs> </Member> <Member MemberName="PeekAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.BrokeredMessage> PeekAsync ();" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.ServiceBus.Messaging.BrokeredMessage> PeekAsync() cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.PeekAsync" /> <MemberSignature Language="VB.NET" Value="Public Function PeekAsync () As Task(Of BrokeredMessage)" /> <MemberSignature Language="F#" Value="abstract member PeekAsync : unit -> System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.BrokeredMessage>
override this.PeekAsync : unit -> System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.BrokeredMessage>" Usage="queueClient.PeekAsync " /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.BrokeredMessage></ReturnType> </ReturnValue> <Parameters /> <Docs> <summary>Asynchronously returns without removing the first message in the queue.</summary> <returns>The asynchronous operation.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="PeekAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.BrokeredMessage> PeekAsync (long fromSequenceNumber);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.ServiceBus.Messaging.BrokeredMessage> PeekAsync(int64 fromSequenceNumber) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.PeekAsync(System.Int64)" /> <MemberSignature Language="VB.NET" Value="Public Function PeekAsync (fromSequenceNumber As Long) As Task(Of BrokeredMessage)" /> <MemberSignature Language="F#" Value="abstract member PeekAsync : int64 -> System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.BrokeredMessage>
override this.PeekAsync : int64 -> System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.BrokeredMessage>" Usage="queueClient.PeekAsync fromSequenceNumber" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.BrokeredMessage></ReturnType> </ReturnValue> <Parameters> <Parameter Name="fromSequenceNumber" Type="System.Int64" /> </Parameters> <Docs> <param name="fromSequenceNumber">The sequence number from where to peek a message.</param> <summary>Asynchronously returns without removing the first message in the queue.</summary> <returns>The asynchronous operation.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="PeekBatch"> <MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.BrokeredMessage> PeekBatch (int messageCount);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Collections.Generic.IEnumerable`1<class Microsoft.ServiceBus.Messaging.BrokeredMessage> PeekBatch(int32 messageCount) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.PeekBatch(System.Int32)" /> <MemberSignature Language="VB.NET" Value="Public Function PeekBatch (messageCount As Integer) As IEnumerable(Of BrokeredMessage)" /> <MemberSignature Language="F#" Value="abstract member PeekBatch : int -> seq<Microsoft.ServiceBus.Messaging.BrokeredMessage>
override this.PeekBatch : int -> seq<Microsoft.ServiceBus.Messaging.BrokeredMessage>" Usage="queueClient.PeekBatch messageCount" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.BrokeredMessage></ReturnType> </ReturnValue> <Parameters> <Parameter Name="messageCount" Type="System.Int32" /> </Parameters> <Docs> <param name="messageCount">The number of messages.</param> <summary>Peeks a batch of messages.</summary> <returns>A batch of messages peeked. Returns all properties and the message body.</returns> <remarks>A Null can be return by this API if operation exceeded the timeout specified, or the operations succeeded but there are no more messages to be received.</remarks> </Docs> </Member> <Member MemberName="PeekBatch"> <MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.BrokeredMessage> PeekBatch (long fromSequenceNumber, int messageCount);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Collections.Generic.IEnumerable`1<class Microsoft.ServiceBus.Messaging.BrokeredMessage> PeekBatch(int64 fromSequenceNumber, int32 messageCount) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.PeekBatch(System.Int64,System.Int32)" /> <MemberSignature Language="VB.NET" Value="Public Function PeekBatch (fromSequenceNumber As Long, messageCount As Integer) As IEnumerable(Of BrokeredMessage)" /> <MemberSignature Language="F#" Value="abstract member PeekBatch : int64 * int -> seq<Microsoft.ServiceBus.Messaging.BrokeredMessage>
override this.PeekBatch : int64 * int -> seq<Microsoft.ServiceBus.Messaging.BrokeredMessage>" Usage="queueClient.PeekBatch (fromSequenceNumber, messageCount)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.BrokeredMessage></ReturnType> </ReturnValue> <Parameters> <Parameter Name="fromSequenceNumber" Type="System.Int64" /> <Parameter Name="messageCount" Type="System.Int32" /> </Parameters> <Docs> <param name="fromSequenceNumber">The starting point from which to browse a batch of messages.</param> <param name="messageCount">The number of messages.</param> <summary>Peeks a batch of messages.</summary> <returns>A batch of messages peeked.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="PeekBatchAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.BrokeredMessage>> PeekBatchAsync (int messageCount);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class System.Collections.Generic.IEnumerable`1<class Microsoft.ServiceBus.Messaging.BrokeredMessage>> PeekBatchAsync(int32 messageCount) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.PeekBatchAsync(System.Int32)" /> <MemberSignature Language="VB.NET" Value="Public Function PeekBatchAsync (messageCount As Integer) As Task(Of IEnumerable(Of BrokeredMessage))" /> <MemberSignature Language="F#" Value="abstract member PeekBatchAsync : int -> System.Threading.Tasks.Task<seq<Microsoft.ServiceBus.Messaging.BrokeredMessage>>
override this.PeekBatchAsync : int -> System.Threading.Tasks.Task<seq<Microsoft.ServiceBus.Messaging.BrokeredMessage>>" Usage="queueClient.PeekBatchAsync messageCount" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.BrokeredMessage>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="messageCount" Type="System.Int32" /> </Parameters> <Docs> <param name="messageCount">The number of message.</param> <summary>Asynchronously peeks a batch of message.</summary> <returns>The asynchronous operation.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="PeekBatchAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.BrokeredMessage>> PeekBatchAsync (long fromSequenceNumber, int messageCount);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class System.Collections.Generic.IEnumerable`1<class Microsoft.ServiceBus.Messaging.BrokeredMessage>> PeekBatchAsync(int64 fromSequenceNumber, int32 messageCount) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.PeekBatchAsync(System.Int64,System.Int32)" /> <MemberSignature Language="VB.NET" Value="Public Function PeekBatchAsync (fromSequenceNumber As Long, messageCount As Integer) As Task(Of IEnumerable(Of BrokeredMessage))" /> <MemberSignature Language="F#" Value="abstract member PeekBatchAsync : int64 * int -> System.Threading.Tasks.Task<seq<Microsoft.ServiceBus.Messaging.BrokeredMessage>>
override this.PeekBatchAsync : int64 * int -> System.Threading.Tasks.Task<seq<Microsoft.ServiceBus.Messaging.BrokeredMessage>>" Usage="queueClient.PeekBatchAsync (fromSequenceNumber, messageCount)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.BrokeredMessage>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="fromSequenceNumber" Type="System.Int64" /> <Parameter Name="messageCount" Type="System.Int32" /> </Parameters> <Docs> <param name="fromSequenceNumber">The sequence number from where to peek a batch of message.</param> <param name="messageCount">The number of message.</param> <summary>Asynchronously peeks a batch of message.</summary> <returns>The asynchronous operation.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="PrefetchCount"> <MemberSignature Language="C#" Value="public int PrefetchCount { get; set; }" /> <MemberSignature Language="ILAsm" Value=".property instance int32 PrefetchCount" /> <MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.QueueClient.PrefetchCount" /> <MemberSignature Language="VB.NET" Value="Public Property PrefetchCount As Integer" /> <MemberSignature Language="F#" Value="member this.PrefetchCount : int with get, set" Usage="Microsoft.ServiceBus.Messaging.QueueClient.PrefetchCount" /> <MemberType>Property</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Int32</ReturnType> </ReturnValue> <Docs> <summary>Gets or sets the number of messages that the queue receiver can simultaneously request.</summary> <value>The number of messages that the queue receiver can simultaneously request.</value> <remarks> Takes effect on the next receive call to the server. </remarks> </Docs> </Member> <Member MemberName="Receive"> <MemberSignature Language="C#" Value="public Microsoft.ServiceBus.Messaging.BrokeredMessage Receive ();" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.ServiceBus.Messaging.BrokeredMessage Receive() cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.Receive" /> <MemberSignature Language="VB.NET" Value="Public Function Receive () As BrokeredMessage" /> <MemberSignature Language="F#" Value="abstract member Receive : unit -> Microsoft.ServiceBus.Messaging.BrokeredMessage
override this.Receive : unit -> Microsoft.ServiceBus.Messaging.BrokeredMessage" Usage="queueClient.Receive " /> <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>Receives a message using the <see cref="P:Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver" />.</summary> <returns>The <see cref="T:Microsoft.ServiceBus.Messaging.BrokeredMessage" /> that represents the received message. If no message is available to be received, the method returns NULL, and you can retry the operation at a later time.</returns> <remarks>A Null can be return by this API if operation exceeded the timeout specified, or the operations succeeded but there are no more messages to be received.</remarks> <exception cref="T:System.OperationCanceledException">Thrown if the client entity has been closed or aborted.</exception> <exception cref="T:System.TimeoutException">Thrown if the message receive operation times out.</exception> <exception cref="T:System.UnauthorizedAccessException">Thrown if an I/O or security error occurs.</exception> <exception cref="T:Microsoft.ServiceBus.Messaging.MessagingEntityNotFoundException">Thrown if the messaging entity associated with the operation does not exist or it has been deleted.</exception> <exception cref="T:Microsoft.ServiceBus.Messaging.MessagingException">Thrown if the user code has performed some unexpected operations, or the Service Bus gateway is down. Check the exception message for the actual error.</exception> </Docs> </Member> <Member MemberName="Receive"> <MemberSignature Language="C#" Value="public Microsoft.ServiceBus.Messaging.BrokeredMessage Receive (long sequenceNumber);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.ServiceBus.Messaging.BrokeredMessage Receive(int64 sequenceNumber) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.Receive(System.Int64)" /> <MemberSignature Language="VB.NET" Value="Public Function Receive (sequenceNumber As Long) As BrokeredMessage" /> <MemberSignature Language="F#" Value="abstract member Receive : int64 -> Microsoft.ServiceBus.Messaging.BrokeredMessage
override this.Receive : int64 -> Microsoft.ServiceBus.Messaging.BrokeredMessage" Usage="queueClient.Receive sequenceNumber" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Microsoft.ServiceBus.Messaging.BrokeredMessage</ReturnType> </ReturnValue> <Parameters> <Parameter Name="sequenceNumber" Type="System.Int64" /> </Parameters> <Docs> <param name="sequenceNumber">The sequence number of the deferred message to receive. </param> <summary>Receives a deferred message using the <see cref="P:Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver" />. This method only works for deferred message, not regular one.</summary> <returns>The <see cref="T:Microsoft.ServiceBus.Messaging.BrokeredMessage" /> that represents the received message. If no message is available to be received, the method returns NULL, and you can retry the operation at a later time.</returns> <remarks>A Null can be return by this API if operation exceeded the timeout specified, or the operations succeeded but the message with the requested sequenceNumber cannot be located.</remarks> <exception cref="T:System.OperationCanceledException">Thrown if the client entity has been closed or aborted.</exception> </Docs> </Member> <Member MemberName="Receive"> <MemberSignature Language="C#" Value="public Microsoft.ServiceBus.Messaging.BrokeredMessage Receive (TimeSpan serverWaitTime);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.ServiceBus.Messaging.BrokeredMessage Receive(valuetype System.TimeSpan serverWaitTime) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.Receive(System.TimeSpan)" /> <MemberSignature Language="VB.NET" Value="Public Function Receive (serverWaitTime As TimeSpan) As BrokeredMessage" /> <MemberSignature Language="F#" Value="abstract member Receive : TimeSpan -> Microsoft.ServiceBus.Messaging.BrokeredMessage
override this.Receive : TimeSpan -> Microsoft.ServiceBus.Messaging.BrokeredMessage" Usage="queueClient.Receive serverWaitTime" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Microsoft.ServiceBus.Messaging.BrokeredMessage</ReturnType> </ReturnValue> <Parameters> <Parameter Name="serverWaitTime" Type="System.TimeSpan" /> </Parameters> <Docs> <param name="serverWaitTime">The time span the server waits for receiving a message before it times out.</param> <summary>Receives a message using the <see cref="P:Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver" />.</summary> <returns>The <see cref="T:Microsoft.ServiceBus.Messaging.BrokeredMessage" /> that represents the received message. If no message is available to be received, the method returns NULL, and you can retry the operation at a later time.</returns> <remarks>A Null can be return by this API if operation exceeded the timeout specified, or the operations succeeded but there are no more messages to be received.</remarks> <exception cref="T:System.ArgumentOutOfRangeException">Thrown if the <paramref name="serverWaitTime" /> is negative.</exception> <exception cref="T:System.TimeoutException">Thrown if the message receive operation times out.</exception> <exception cref="T:System.OperationCanceledException">Thrown if the client entity has been closed or aborted.</exception> <exception cref="T:System.UnauthorizedAccessException">Thrown if an I/O or security error occurs.</exception> <exception cref="T:Microsoft.ServiceBus.Messaging.MessagingEntityNotFoundException">Thrown if the messaging entity associated with the operation does not exist or it has been deleted.</exception> <exception cref="T:Microsoft.ServiceBus.Messaging.MessagingException">Thrown if the user code has performed some unexpected operations, or the Service Bus gateway is down. Check the exception message for the actual error.</exception> </Docs> </Member> <Member MemberName="ReceiveAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.BrokeredMessage> ReceiveAsync ();" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.ServiceBus.Messaging.BrokeredMessage> ReceiveAsync() cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.ReceiveAsync" /> <MemberSignature Language="VB.NET" Value="Public Function ReceiveAsync () As Task(Of BrokeredMessage)" /> <MemberSignature Language="F#" Value="abstract member ReceiveAsync : unit -> System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.BrokeredMessage>
override this.ReceiveAsync : unit -> System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.BrokeredMessage>" Usage="queueClient.ReceiveAsync " /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.BrokeredMessage></ReturnType> </ReturnValue> <Parameters /> <Docs> <summary>Asynchronously receives a message using the <see cref="P:Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver" />.</summary> <returns>The asynchronous operation.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="ReceiveAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.BrokeredMessage> ReceiveAsync (long sequenceNumber);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.ServiceBus.Messaging.BrokeredMessage> ReceiveAsync(int64 sequenceNumber) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.ReceiveAsync(System.Int64)" /> <MemberSignature Language="VB.NET" Value="Public Function ReceiveAsync (sequenceNumber As Long) As Task(Of BrokeredMessage)" /> <MemberSignature Language="F#" Value="abstract member ReceiveAsync : int64 -> System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.BrokeredMessage>
override this.ReceiveAsync : int64 -> System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.BrokeredMessage>" Usage="queueClient.ReceiveAsync sequenceNumber" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.BrokeredMessage></ReturnType> </ReturnValue> <Parameters> <Parameter Name="sequenceNumber" Type="System.Int64" /> </Parameters> <Docs> <param name="sequenceNumber">The sequence number of the deferred message to receive.</param> <summary>Asynchronously receives a deferred message using the <see cref="P:Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver" />. This method only works for deferred message, not regular one.</summary> <returns>The asynchronous operation.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="ReceiveAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.BrokeredMessage> ReceiveAsync (TimeSpan serverWaitTime);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.ServiceBus.Messaging.BrokeredMessage> ReceiveAsync(valuetype System.TimeSpan serverWaitTime) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.ReceiveAsync(System.TimeSpan)" /> <MemberSignature Language="VB.NET" Value="Public Function ReceiveAsync (serverWaitTime As TimeSpan) As Task(Of BrokeredMessage)" /> <MemberSignature Language="F#" Value="abstract member ReceiveAsync : TimeSpan -> System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.BrokeredMessage>
override this.ReceiveAsync : TimeSpan -> System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.BrokeredMessage>" Usage="queueClient.ReceiveAsync serverWaitTime" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.BrokeredMessage></ReturnType> </ReturnValue> <Parameters> <Parameter Name="serverWaitTime" Type="System.TimeSpan" /> </Parameters> <Docs> <param name="serverWaitTime">The time span the server waits for receiving a message before it times out.</param> <summary>Asynchronously receives a message using the <see cref="P:Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver" />.</summary> <returns>The asynchronous operation.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="ReceiveBatch"> <MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.BrokeredMessage> ReceiveBatch (System.Collections.Generic.IEnumerable<long> sequenceNumbers);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Collections.Generic.IEnumerable`1<class Microsoft.ServiceBus.Messaging.BrokeredMessage> ReceiveBatch(class System.Collections.Generic.IEnumerable`1<int64> sequenceNumbers) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.ReceiveBatch(System.Collections.Generic.IEnumerable{System.Int64})" /> <MemberSignature Language="VB.NET" Value="Public Function ReceiveBatch (sequenceNumbers As IEnumerable(Of Long)) As IEnumerable(Of BrokeredMessage)" /> <MemberSignature Language="F#" Value="abstract member ReceiveBatch : seq<int64> -> seq<Microsoft.ServiceBus.Messaging.BrokeredMessage>
override this.ReceiveBatch : seq<int64> -> seq<Microsoft.ServiceBus.Messaging.BrokeredMessage>" Usage="queueClient.ReceiveBatch sequenceNumbers" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.BrokeredMessage></ReturnType> </ReturnValue> <Parameters> <Parameter Name="sequenceNumbers" Type="System.Collections.Generic.IEnumerable<System.Int64>" /> </Parameters> <Docs> <param name="sequenceNumbers">The sequence numbers associated with the messages in the batch.</param> <summary>Receives a message batch.</summary> <returns>A message batch.</returns> <remarks>A Null can be return by this API if operation exceeded the timeout specified, or the operations succeeded but the message with the requested sequenceNumber cannot be located.</remarks> </Docs> </Member> <Member MemberName="ReceiveBatch"> <MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.BrokeredMessage> ReceiveBatch (int messageCount);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Collections.Generic.IEnumerable`1<class Microsoft.ServiceBus.Messaging.BrokeredMessage> ReceiveBatch(int32 messageCount) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.ReceiveBatch(System.Int32)" /> <MemberSignature Language="VB.NET" Value="Public Function ReceiveBatch (messageCount As Integer) As IEnumerable(Of BrokeredMessage)" /> <MemberSignature Language="F#" Value="abstract member ReceiveBatch : int -> seq<Microsoft.ServiceBus.Messaging.BrokeredMessage>
override this.ReceiveBatch : int -> seq<Microsoft.ServiceBus.Messaging.BrokeredMessage>" Usage="queueClient.ReceiveBatch messageCount" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.BrokeredMessage></ReturnType> </ReturnValue> <Parameters> <Parameter Name="messageCount" Type="System.Int32" /> </Parameters> <Docs> <param name="messageCount">The number of messages to return in the batch. As this is an approximation, fewer or more messages than <paramref name="messageCount" /> may be returned.</param> <summary>Receives a message batch.</summary> <returns>A message batch.</returns> <remarks>A Null can be return by this API if operation exceeded the timeout specified, or the operations succeeded but there are no more messages to be received.</remarks> </Docs> </Member> <Member MemberName="ReceiveBatch"> <MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.BrokeredMessage> ReceiveBatch (int messageCount, TimeSpan serverWaitTime);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Collections.Generic.IEnumerable`1<class Microsoft.ServiceBus.Messaging.BrokeredMessage> ReceiveBatch(int32 messageCount, valuetype System.TimeSpan serverWaitTime) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.ReceiveBatch(System.Int32,System.TimeSpan)" /> <MemberSignature Language="VB.NET" Value="Public Function ReceiveBatch (messageCount As Integer, serverWaitTime As TimeSpan) As IEnumerable(Of BrokeredMessage)" /> <MemberSignature Language="F#" Value="abstract member ReceiveBatch : int * TimeSpan -> seq<Microsoft.ServiceBus.Messaging.BrokeredMessage>
override this.ReceiveBatch : int * TimeSpan -> seq<Microsoft.ServiceBus.Messaging.BrokeredMessage>" Usage="queueClient.ReceiveBatch (messageCount, serverWaitTime)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.BrokeredMessage></ReturnType> </ReturnValue> <Parameters> <Parameter Name="messageCount" Type="System.Int32" /> <Parameter Name="serverWaitTime" Type="System.TimeSpan" /> </Parameters> <Docs> <param name="messageCount">The number of messages to receive in a batch.As this is an approximation, fewer or more messages than <paramref name="messageCount" /> may be returned.</param> <param name="serverWaitTime">The time span that the server will wait for the message batch to arrive before it times out.</param> <summary>Receives a message batch.</summary> <returns>A message batch.</returns> <remarks>A Null can be return by this API if operation exceeded the timeout specified, or the operations succeeded but there are no more messages to be received.</remarks> </Docs> </Member> <Member MemberName="ReceiveBatchAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.BrokeredMessage>> ReceiveBatchAsync (System.Collections.Generic.IEnumerable<long> sequenceNumbers);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class System.Collections.Generic.IEnumerable`1<class Microsoft.ServiceBus.Messaging.BrokeredMessage>> ReceiveBatchAsync(class System.Collections.Generic.IEnumerable`1<int64> sequenceNumbers) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.ReceiveBatchAsync(System.Collections.Generic.IEnumerable{System.Int64})" /> <MemberSignature Language="VB.NET" Value="Public Function ReceiveBatchAsync (sequenceNumbers As IEnumerable(Of Long)) As Task(Of IEnumerable(Of BrokeredMessage))" /> <MemberSignature Language="F#" Value="abstract member ReceiveBatchAsync : seq<int64> -> System.Threading.Tasks.Task<seq<Microsoft.ServiceBus.Messaging.BrokeredMessage>>
override this.ReceiveBatchAsync : seq<int64> -> System.Threading.Tasks.Task<seq<Microsoft.ServiceBus.Messaging.BrokeredMessage>>" Usage="queueClient.ReceiveBatchAsync sequenceNumbers" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.BrokeredMessage>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="sequenceNumbers" Type="System.Collections.Generic.IEnumerable<System.Int64>" /> </Parameters> <Docs> <param name="sequenceNumbers">The sequence numbers associated with the messages in the batch.</param> <summary>Asynchronously receives a message batch.</summary> <returns>The asynchronous operation.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="ReceiveBatchAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.BrokeredMessage>> ReceiveBatchAsync (int messageCount);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class System.Collections.Generic.IEnumerable`1<class Microsoft.ServiceBus.Messaging.BrokeredMessage>> ReceiveBatchAsync(int32 messageCount) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.ReceiveBatchAsync(System.Int32)" /> <MemberSignature Language="VB.NET" Value="Public Function ReceiveBatchAsync (messageCount As Integer) As Task(Of IEnumerable(Of BrokeredMessage))" /> <MemberSignature Language="F#" Value="abstract member ReceiveBatchAsync : int -> System.Threading.Tasks.Task<seq<Microsoft.ServiceBus.Messaging.BrokeredMessage>>
override this.ReceiveBatchAsync : int -> System.Threading.Tasks.Task<seq<Microsoft.ServiceBus.Messaging.BrokeredMessage>>" Usage="queueClient.ReceiveBatchAsync messageCount" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.BrokeredMessage>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="messageCount" Type="System.Int32" /> </Parameters> <Docs> <param name="messageCount">The number of messages to return in the batch. As this is an approximation, fewer or more messages than <paramref name="messageCount" /> may be returned.</param> <summary>Asynchronously receives a message batch.</summary> <returns>The asynchronous operation.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="ReceiveBatchAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.BrokeredMessage>> ReceiveBatchAsync (int messageCount, TimeSpan serverWaitTime);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class System.Collections.Generic.IEnumerable`1<class Microsoft.ServiceBus.Messaging.BrokeredMessage>> ReceiveBatchAsync(int32 messageCount, valuetype System.TimeSpan serverWaitTime) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.ReceiveBatchAsync(System.Int32,System.TimeSpan)" /> <MemberSignature Language="VB.NET" Value="Public Function ReceiveBatchAsync (messageCount As Integer, serverWaitTime As TimeSpan) As Task(Of IEnumerable(Of BrokeredMessage))" /> <MemberSignature Language="F#" Value="abstract member ReceiveBatchAsync : int * TimeSpan -> System.Threading.Tasks.Task<seq<Microsoft.ServiceBus.Messaging.BrokeredMessage>>
override this.ReceiveBatchAsync : int * TimeSpan -> System.Threading.Tasks.Task<seq<Microsoft.ServiceBus.Messaging.BrokeredMessage>>" Usage="queueClient.ReceiveBatchAsync (messageCount, serverWaitTime)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.BrokeredMessage>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="messageCount" Type="System.Int32" /> <Parameter Name="serverWaitTime" Type="System.TimeSpan" /> </Parameters> <Docs> <param name="messageCount">The number of messages to return in the batch. As this is an approximation, fewer or more messages than <paramref name="messageCount" /> may be returned.</param> <param name="serverWaitTime">The time span that the server will wait for the message batch to arrive before it times out.</param> <summary>Asynchronously receives a message batch.</summary> <returns>The asynchronous operation.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="RegisterSessionHandler"> <MemberSignature Language="C#" Value="public void RegisterSessionHandler (Type handlerType);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void RegisterSessionHandler(class System.Type handlerType) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.RegisterSessionHandler(System.Type)" /> <MemberSignature Language="VB.NET" Value="Public Sub RegisterSessionHandler (handlerType As Type)" /> <MemberSignature Language="F#" Value="member this.RegisterSessionHandler : Type -> unit" Usage="queueClient.RegisterSessionHandler handlerType" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="handlerType" Type="System.Type" /> </Parameters> <Docs> <param name="handlerType">The handler type.</param> <summary>Registers the session handler with specific type.</summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="RegisterSessionHandler"> <MemberSignature Language="C#" Value="public void RegisterSessionHandler (Type handlerType, Microsoft.ServiceBus.Messaging.SessionHandlerOptions options);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void RegisterSessionHandler(class System.Type handlerType, class Microsoft.ServiceBus.Messaging.SessionHandlerOptions options) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.RegisterSessionHandler(System.Type,Microsoft.ServiceBus.Messaging.SessionHandlerOptions)" /> <MemberSignature Language="VB.NET" Value="Public Sub RegisterSessionHandler (handlerType As Type, options As SessionHandlerOptions)" /> <MemberSignature Language="F#" Value="member this.RegisterSessionHandler : Type * Microsoft.ServiceBus.Messaging.SessionHandlerOptions -> unit" Usage="queueClient.RegisterSessionHandler (handlerType, options)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="handlerType" Type="System.Type" /> <Parameter Name="options" Type="Microsoft.ServiceBus.Messaging.SessionHandlerOptions" /> </Parameters> <Docs> <param name="handlerType">The handler type.</param> <param name="options">The session handler options.</param> <summary>Registers the session handler with specific type and handler options.</summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="RegisterSessionHandlerAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task RegisterSessionHandlerAsync (Type handlerType);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task RegisterSessionHandlerAsync(class System.Type handlerType) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.RegisterSessionHandlerAsync(System.Type)" /> <MemberSignature Language="VB.NET" Value="Public Function RegisterSessionHandlerAsync (handlerType As Type) As Task" /> <MemberSignature Language="F#" Value="member this.RegisterSessionHandlerAsync : Type -> System.Threading.Tasks.Task" Usage="queueClient.RegisterSessionHandlerAsync handlerType" /> <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="handlerType" Type="System.Type" /> </Parameters> <Docs> <param name="handlerType">The handler type.</param> <summary>Asynchronously registers the session handler with specific type.</summary> <returns>The task object representing the asynchronous operation.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="RegisterSessionHandlerAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task RegisterSessionHandlerAsync (Type handlerType, Microsoft.ServiceBus.Messaging.SessionHandlerOptions options);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task RegisterSessionHandlerAsync(class System.Type handlerType, class Microsoft.ServiceBus.Messaging.SessionHandlerOptions options) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.RegisterSessionHandlerAsync(System.Type,Microsoft.ServiceBus.Messaging.SessionHandlerOptions)" /> <MemberSignature Language="VB.NET" Value="Public Function RegisterSessionHandlerAsync (handlerType As Type, options As SessionHandlerOptions) As Task" /> <MemberSignature Language="F#" Value="member this.RegisterSessionHandlerAsync : Type * Microsoft.ServiceBus.Messaging.SessionHandlerOptions -> System.Threading.Tasks.Task" Usage="queueClient.RegisterSessionHandlerAsync (handlerType, options)" /> <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="handlerType" Type="System.Type" /> <Parameter Name="options" Type="Microsoft.ServiceBus.Messaging.SessionHandlerOptions" /> </Parameters> <Docs> <param name="handlerType">The handler type.</param> <param name="options">The session handler options.</param> <summary>Asynchronously registers the session handler with specific type and handler options.</summary> <returns>The task object representing the asynchronous operation.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="RegisterSessionHandlerFactory"> <MemberSignature Language="C#" Value="public void RegisterSessionHandlerFactory (Microsoft.ServiceBus.Messaging.IMessageSessionAsyncHandlerFactory factory, Microsoft.ServiceBus.Messaging.SessionHandlerOptions options);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void RegisterSessionHandlerFactory(class Microsoft.ServiceBus.Messaging.IMessageSessionAsyncHandlerFactory factory, class Microsoft.ServiceBus.Messaging.SessionHandlerOptions options) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.RegisterSessionHandlerFactory(Microsoft.ServiceBus.Messaging.IMessageSessionAsyncHandlerFactory,Microsoft.ServiceBus.Messaging.SessionHandlerOptions)" /> <MemberSignature Language="VB.NET" Value="Public Sub RegisterSessionHandlerFactory (factory As IMessageSessionAsyncHandlerFactory, options As SessionHandlerOptions)" /> <MemberSignature Language="F#" Value="member this.RegisterSessionHandlerFactory : Microsoft.ServiceBus.Messaging.IMessageSessionAsyncHandlerFactory * Microsoft.ServiceBus.Messaging.SessionHandlerOptions -> unit" Usage="queueClient.RegisterSessionHandlerFactory (factory, options)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="factory" Type="Microsoft.ServiceBus.Messaging.IMessageSessionAsyncHandlerFactory" /> <Parameter Name="options" Type="Microsoft.ServiceBus.Messaging.SessionHandlerOptions" /> </Parameters> <Docs> <param name="factory">The handler factory to be registered.</param> <param name="options">The handler options.</param> <summary>Registers a message session handler factory with specified options.</summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="RegisterSessionHandlerFactory"> <MemberSignature Language="C#" Value="public void RegisterSessionHandlerFactory (Microsoft.ServiceBus.Messaging.IMessageSessionHandlerFactory factory, Microsoft.ServiceBus.Messaging.SessionHandlerOptions options);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void RegisterSessionHandlerFactory(class Microsoft.ServiceBus.Messaging.IMessageSessionHandlerFactory factory, class Microsoft.ServiceBus.Messaging.SessionHandlerOptions options) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.RegisterSessionHandlerFactory(Microsoft.ServiceBus.Messaging.IMessageSessionHandlerFactory,Microsoft.ServiceBus.Messaging.SessionHandlerOptions)" /> <MemberSignature Language="VB.NET" Value="Public Sub RegisterSessionHandlerFactory (factory As IMessageSessionHandlerFactory, options As SessionHandlerOptions)" /> <MemberSignature Language="F#" Value="member this.RegisterSessionHandlerFactory : Microsoft.ServiceBus.Messaging.IMessageSessionHandlerFactory * Microsoft.ServiceBus.Messaging.SessionHandlerOptions -> unit" Usage="queueClient.RegisterSessionHandlerFactory (factory, options)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="factory" Type="Microsoft.ServiceBus.Messaging.IMessageSessionHandlerFactory" /> <Parameter Name="options" Type="Microsoft.ServiceBus.Messaging.SessionHandlerOptions" /> </Parameters> <Docs> <param name="factory">The handler factory to be registered.</param> <param name="options">The handler options.</param> <summary>Registers a message session handler factory with specified options.</summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="RegisterSessionHandlerFactoryAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task RegisterSessionHandlerFactoryAsync (Microsoft.ServiceBus.Messaging.IMessageSessionAsyncHandlerFactory factory, Microsoft.ServiceBus.Messaging.SessionHandlerOptions options);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task RegisterSessionHandlerFactoryAsync(class Microsoft.ServiceBus.Messaging.IMessageSessionAsyncHandlerFactory factory, class Microsoft.ServiceBus.Messaging.SessionHandlerOptions options) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.RegisterSessionHandlerFactoryAsync(Microsoft.ServiceBus.Messaging.IMessageSessionAsyncHandlerFactory,Microsoft.ServiceBus.Messaging.SessionHandlerOptions)" /> <MemberSignature Language="VB.NET" Value="Public Function RegisterSessionHandlerFactoryAsync (factory As IMessageSessionAsyncHandlerFactory, options As SessionHandlerOptions) As Task" /> <MemberSignature Language="F#" Value="member this.RegisterSessionHandlerFactoryAsync : Microsoft.ServiceBus.Messaging.IMessageSessionAsyncHandlerFactory * Microsoft.ServiceBus.Messaging.SessionHandlerOptions -> System.Threading.Tasks.Task" Usage="queueClient.RegisterSessionHandlerFactoryAsync (factory, options)" /> <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="factory" Type="Microsoft.ServiceBus.Messaging.IMessageSessionAsyncHandlerFactory" /> <Parameter Name="options" Type="Microsoft.ServiceBus.Messaging.SessionHandlerOptions" /> </Parameters> <Docs> <param name="factory">The handler factory to be registered.</param> <param name="options">The handler options.</param> <summary>Asynchronously registers a message session handler factory.</summary> <returns>The task object representing the asynchronous operation.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="RegisterSessionHandlerFactoryAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task RegisterSessionHandlerFactoryAsync (Microsoft.ServiceBus.Messaging.IMessageSessionHandlerFactory factory, Microsoft.ServiceBus.Messaging.SessionHandlerOptions options);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task RegisterSessionHandlerFactoryAsync(class Microsoft.ServiceBus.Messaging.IMessageSessionHandlerFactory factory, class Microsoft.ServiceBus.Messaging.SessionHandlerOptions options) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.RegisterSessionHandlerFactoryAsync(Microsoft.ServiceBus.Messaging.IMessageSessionHandlerFactory,Microsoft.ServiceBus.Messaging.SessionHandlerOptions)" /> <MemberSignature Language="VB.NET" Value="Public Function RegisterSessionHandlerFactoryAsync (factory As IMessageSessionHandlerFactory, options As SessionHandlerOptions) As Task" /> <MemberSignature Language="F#" Value="member this.RegisterSessionHandlerFactoryAsync : Microsoft.ServiceBus.Messaging.IMessageSessionHandlerFactory * Microsoft.ServiceBus.Messaging.SessionHandlerOptions -> System.Threading.Tasks.Task" Usage="queueClient.RegisterSessionHandlerFactoryAsync (factory, options)" /> <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="factory" Type="Microsoft.ServiceBus.Messaging.IMessageSessionHandlerFactory" /> <Parameter Name="options" Type="Microsoft.ServiceBus.Messaging.SessionHandlerOptions" /> </Parameters> <Docs> <param name="factory">The handler factory to be registered.</param> <param name="options">The handler options.</param> <summary>Asynchronously registers a message session handler factory.</summary> <returns>The task object representing the asynchronous operation.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="RenewMessageLock"> <MemberSignature Language="C#" Value="public DateTime RenewMessageLock (Guid lockToken);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype System.DateTime RenewMessageLock(valuetype System.Guid lockToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.RenewMessageLock(System.Guid)" /> <MemberSignature Language="VB.NET" Value="Public Function RenewMessageLock (lockToken As Guid) As DateTime" /> <MemberSignature Language="F#" Value="member this.RenewMessageLock : Guid -> DateTime" Usage="queueClient.RenewMessageLock lockToken" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.DateTime</ReturnType> </ReturnValue> <Parameters> <Parameter Name="lockToken" Type="System.Guid" /> </Parameters> <Docs> <param name="lockToken" /> <summary /> <returns>To be added.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="RenewMessageLockAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<DateTime> RenewMessageLockAsync (Guid lockToken);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<valuetype System.DateTime> RenewMessageLockAsync(valuetype System.Guid lockToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.RenewMessageLockAsync(System.Guid)" /> <MemberSignature Language="VB.NET" Value="Public Function RenewMessageLockAsync (lockToken As Guid) As Task(Of DateTime)" /> <MemberSignature Language="F#" Value="member this.RenewMessageLockAsync : Guid -> System.Threading.Tasks.Task<DateTime>" Usage="queueClient.RenewMessageLockAsync lockToken" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<System.DateTime></ReturnType> </ReturnValue> <Parameters> <Parameter Name="lockToken" Type="System.Guid" /> </Parameters> <Docs> <param name="lockToken" /> <summary /> <returns>To be added.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="ScheduleMessageAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<long> ScheduleMessageAsync (Microsoft.ServiceBus.Messaging.BrokeredMessage message, DateTimeOffset scheduleEnqueueTimeUtc);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<int64> ScheduleMessageAsync(class Microsoft.ServiceBus.Messaging.BrokeredMessage message, valuetype System.DateTimeOffset scheduleEnqueueTimeUtc) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.ScheduleMessageAsync(Microsoft.ServiceBus.Messaging.BrokeredMessage,System.DateTimeOffset)" /> <MemberSignature Language="VB.NET" Value="Public Function ScheduleMessageAsync (message As BrokeredMessage, scheduleEnqueueTimeUtc As DateTimeOffset) As Task(Of Long)" /> <MemberSignature Language="F#" Value="member this.ScheduleMessageAsync : Microsoft.ServiceBus.Messaging.BrokeredMessage * DateTimeOffset -> System.Threading.Tasks.Task<int64>" Usage="queueClient.ScheduleMessageAsync (message, scheduleEnqueueTimeUtc)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<System.Int64></ReturnType> </ReturnValue> <Parameters> <Parameter Name="message" Type="Microsoft.ServiceBus.Messaging.BrokeredMessage" /> <Parameter Name="scheduleEnqueueTimeUtc" Type="System.DateTimeOffset" /> </Parameters> <Docs> <param name="message">Message to be scheduled</param> <param name="scheduleEnqueueTimeUtc">Time of enqueue</param> <summary> Sends a scheduled message </summary> <returns>Sequence number that is needed for cancelling.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="Send"> <MemberSignature Language="C#" Value="public void Send (Microsoft.ServiceBus.Messaging.BrokeredMessage message);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Send(class Microsoft.ServiceBus.Messaging.BrokeredMessage message) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.Send(Microsoft.ServiceBus.Messaging.BrokeredMessage)" /> <MemberSignature Language="VB.NET" Value="Public Sub Send (message As BrokeredMessage)" /> <MemberSignature Language="F#" Value="abstract member Send : Microsoft.ServiceBus.Messaging.BrokeredMessage -> unit
override this.Send : Microsoft.ServiceBus.Messaging.BrokeredMessage -> unit" Usage="queueClient.Send message" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="message" Type="Microsoft.ServiceBus.Messaging.BrokeredMessage" /> </Parameters> <Docs> <param name="message">The message to send.</param> <summary>Sends a message using the <see cref="P:Microsoft.ServiceBus.Messaging.QueueClient.InternalSender" />.</summary> <remarks>To be added.</remarks> <exception cref="T:System.TimeoutException">Thrown when operation times out. Timeout period is initialized through the <see cref="T:Microsoft.ServiceBus.Messaging.MessagingFactorySettings" /> 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:System.ArgumentException">Thrown when the <paramref name="message" /> is null.</exception> <exception cref="T:System.InvalidOperationException">Thrown if the topic/subscription pointed to does not support the send operation. That is, Deadletter queue does not support send operations.</exception> <exception cref="T:System.OperationCanceledException">Thrown if the client entity has been closed or aborted.</exception> <exception cref="T:System.UnauthorizedAccessException">Thrown if there is an I/O or security error.</exception> <exception cref="T:System.Runtime.Serialization.SerializationException">Thrown when an error occurs during serialization or deserialization.</exception> <exception cref="T:Microsoft.ServiceBus.Messaging.MessagingEntityNotFoundException">Thrown if the queue does not exist.</exception> <exception cref="T:Microsoft.ServiceBus.Messaging.MessagingException">Thrown if there is a messaging error.</exception> </Docs> </Member> <Member MemberName="SendAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task SendAsync (Microsoft.ServiceBus.Messaging.BrokeredMessage message);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task SendAsync(class Microsoft.ServiceBus.Messaging.BrokeredMessage message) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.SendAsync(Microsoft.ServiceBus.Messaging.BrokeredMessage)" /> <MemberSignature Language="VB.NET" Value="Public Function SendAsync (message As BrokeredMessage) As Task" /> <MemberSignature Language="F#" Value="abstract member SendAsync : Microsoft.ServiceBus.Messaging.BrokeredMessage -> System.Threading.Tasks.Task
override this.SendAsync : Microsoft.ServiceBus.Messaging.BrokeredMessage -> System.Threading.Tasks.Task" Usage="queueClient.SendAsync message" /> <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="message" Type="Microsoft.ServiceBus.Messaging.BrokeredMessage" /> </Parameters> <Docs> <param name="message">The message to send.</param> <summary>Asynchronously sends a message using the <see cref="P:Microsoft.ServiceBus.Messaging.QueueClient.InternalSender" />.</summary> <returns>The asynchronous operation.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="SendBatch"> <MemberSignature Language="C#" Value="public void SendBatch (System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.BrokeredMessage> messages);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void SendBatch(class System.Collections.Generic.IEnumerable`1<class Microsoft.ServiceBus.Messaging.BrokeredMessage> messages) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.SendBatch(System.Collections.Generic.IEnumerable{Microsoft.ServiceBus.Messaging.BrokeredMessage})" /> <MemberSignature Language="VB.NET" Value="Public Sub SendBatch (messages As IEnumerable(Of BrokeredMessage))" /> <MemberSignature Language="F#" Value="abstract member SendBatch : seq<Microsoft.ServiceBus.Messaging.BrokeredMessage> -> unit
override this.SendBatch : seq<Microsoft.ServiceBus.Messaging.BrokeredMessage> -> unit" Usage="queueClient.SendBatch messages" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.ServiceBus</AssemblyName> <AssemblyVersion>3.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="messages" Type="System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.BrokeredMessage>" /> </Parameters> <Docs> <param name="messages">The collection of brokered messages to send.</param> <summary>Sends a set of brokered messages (for batch processing).</summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="SendBatchAsync"> <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task SendBatchAsync (System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.BrokeredMessage> messages);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task SendBatchAsync(class System.Collections.Generic.IEnumerable`1<class Microsoft.ServiceBus.Messaging.BrokeredMessage> messages) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueClient.SendBatchAsync(System.Collections.Generic.IEnumerable{Microsoft.ServiceBus.Messaging.BrokeredMessage})" /> <MemberSignature Language="VB.NET" Value="Public Function SendBatchAsync (messages As IEnumerable(Of BrokeredMessage)) As Task" /> <MemberSignature Language="F#" Value="abstract member SendBatchAsync : seq<Microsoft.ServiceBus.Messaging.BrokeredMessage> -> System.Threading.Tasks.Task
override this.SendBatchAsync : seq<Microsoft.ServiceBus.Messaging.BrokeredMessage> -> System.Threading.Tasks.Task" Usage="queueClient.SendBatchAsync messages" /> <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="messages" Type="System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.BrokeredMessage>" /> </Parameters> <Docs> <param name="messages">The collection of brokered messages to send.</param> <summary>Asynchronously sends a set of brokered messages (for batch processing).</summary> <returns>The asynchronous operation.</returns> <remarks>To be added.</remarks> </Docs> </Member> </Members> </Type>

xml/Microsoft.ServiceBus.Messaging/QueueClient.xml (2,893 lines of code) (raw):