xml/Azure.Messaging.ServiceBus/ServiceBusReceiver.xml

<Type Name="ServiceBusReceiver" FullName="Azure.Messaging.ServiceBus.ServiceBusReceiver"> <TypeSignature Language="C#" Value="public class ServiceBusReceiver : IAsyncDisposable" /> <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ServiceBusReceiver extends System.Object implements class System.IAsyncDisposable" /> <TypeSignature Language="DocId" Value="T:Azure.Messaging.ServiceBus.ServiceBusReceiver" /> <TypeSignature Language="VB.NET" Value="Public Class ServiceBusReceiver
Implements IAsyncDisposable" /> <TypeSignature Language="F#" Value="type ServiceBusReceiver = class
 interface IAsyncDisposable" /> <AssemblyInfo> <AssemblyName>Azure.Messaging.ServiceBus</AssemblyName> <AssemblyVersion>7.1.2.0</AssemblyVersion> <AssemblyVersion>7.2.0.0</AssemblyVersion> <AssemblyVersion>7.2.1.0</AssemblyVersion> <AssemblyVersion>7.3.0.0</AssemblyVersion> <AssemblyVersion>7.4.0.0</AssemblyVersion> <AssemblyVersion>7.5.0.0</AssemblyVersion> <AssemblyVersion>7.5.1.0</AssemblyVersion> <AssemblyVersion>7.6.0.0</AssemblyVersion> <AssemblyVersion>7.7.0.0</AssemblyVersion> <AssemblyVersion>7.8.0.0</AssemblyVersion> <AssemblyVersion>7.8.1.0</AssemblyVersion> <AssemblyVersion>7.9.0.0</AssemblyVersion> <AssemblyVersion>7.10.0.0</AssemblyVersion> <AssemblyVersion>7.11.0.0</AssemblyVersion> <AssemblyVersion>7.11.1.0</AssemblyVersion> <AssemblyVersion>7.12.0.0</AssemblyVersion> <AssemblyVersion>7.13.0.0</AssemblyVersion> <AssemblyVersion>7.13.1.0</AssemblyVersion> <AssemblyVersion>7.14.0.0</AssemblyVersion> <AssemblyVersion>7.15.0.0</AssemblyVersion> <AssemblyVersion>7.16.0.0</AssemblyVersion> <AssemblyVersion>7.16.1.0</AssemblyVersion> <AssemblyVersion>7.16.2.0</AssemblyVersion> <AssemblyVersion>7.17.0.0</AssemblyVersion> <AssemblyVersion>7.17.1.0</AssemblyVersion> <AssemblyVersion>7.17.2.0</AssemblyVersion> <AssemblyVersion>7.17.3.0</AssemblyVersion> <AssemblyVersion>7.17.4.0</AssemblyVersion> <AssemblyVersion>7.17.5.0</AssemblyVersion> <AssemblyVersion>7.18.0.0</AssemblyVersion> <AssemblyVersion>7.18.1.0</AssemblyVersion> <AssemblyVersion>7.18.2.0</AssemblyVersion> <AssemblyVersion>7.18.3.0</AssemblyVersion> <AssemblyVersion>7.18.4.0</AssemblyVersion> <AssemblyVersion>7.19.0.0</AssemblyVersion> </AssemblyInfo> <Base> <BaseTypeName>System.Object</BaseTypeName> </Base> <Interfaces> <Interface> <InterfaceName>System.IAsyncDisposable</InterfaceName> </Interface> </Interfaces> <Docs> <summary> The <see cref="T:Azure.Messaging.ServiceBus.ServiceBusReceiver" /> is responsible for receiving <see cref="T:Azure.Messaging.ServiceBus.ServiceBusReceivedMessage" /> and settling messages from Queues and Subscriptions. It is constructed by calling <see cref="M:Azure.Messaging.ServiceBus.ServiceBusClient.CreateReceiver(System.String,Azure.Messaging.ServiceBus.ServiceBusReceiverOptions)" />. </summary> <remarks> The <see cref="T:Azure.Messaging.ServiceBus.ServiceBusReceiver" /> is safe to cache and use for the lifetime of an application or until the <see cref="T:Azure.Messaging.ServiceBus.ServiceBusClient" /> that it was created by is disposed. Caching the receiver is recommended when the application is consuming messages regularly or semi-regularly. The receiver is responsible for ensuring efficient network, CPU, and memory use. Calling <see cref="M:Azure.Messaging.ServiceBus.ServiceBusReceiver.DisposeAsync" /> on the associated <see cref="T:Azure.Messaging.ServiceBus.ServiceBusClient" /> as the application is shutting down will ensure that network resources and other unmanaged objects used by the receiver are properly cleaned up. </remarks> </Docs> <Members> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="protected ServiceBusReceiver ();" /> <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.ServiceBus.ServiceBusReceiver.#ctor" /> <MemberSignature Language="VB.NET" Value="Protected Sub New ()" /> <MemberType>Constructor</MemberType> <AssemblyInfo> <AssemblyName>Azure.Messaging.ServiceBus</AssemblyName> <AssemblyVersion>7.18.0.0</AssemblyVersion> <AssemblyVersion>7.19.0.0</AssemblyVersion> </AssemblyInfo> <Parameters /> <Docs> <summary> Initializes a new instance of the <see cref="T:Azure.Messaging.ServiceBus.ServiceBusReceiver" /> class for mocking. </summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="protected ServiceBusReceiver (Azure.Messaging.ServiceBus.ServiceBusClient client, string queueName, Azure.Messaging.ServiceBus.ServiceBusReceiverOptions options);" /> <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(class Azure.Messaging.ServiceBus.ServiceBusClient client, string queueName, class Azure.Messaging.ServiceBus.ServiceBusReceiverOptions options) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.ServiceBus.ServiceBusReceiver.#ctor(Azure.Messaging.ServiceBus.ServiceBusClient,System.String,Azure.Messaging.ServiceBus.ServiceBusReceiverOptions)" /> <MemberSignature Language="VB.NET" Value="Protected Sub New (client As ServiceBusClient, queueName As String, options As ServiceBusReceiverOptions)" /> <MemberSignature Language="F#" Value="new Azure.Messaging.ServiceBus.ServiceBusReceiver : Azure.Messaging.ServiceBus.ServiceBusClient * string * Azure.Messaging.ServiceBus.ServiceBusReceiverOptions -> Azure.Messaging.ServiceBus.ServiceBusReceiver" Usage="new Azure.Messaging.ServiceBus.ServiceBusReceiver (client, queueName, options)" /> <MemberType>Constructor</MemberType> <AssemblyInfo> <AssemblyName>Azure.Messaging.ServiceBus</AssemblyName> <AssemblyVersion>7.18.0.0</AssemblyVersion> <AssemblyVersion>7.19.0.0</AssemblyVersion> </AssemblyInfo> <Parameters> <Parameter Name="client" Type="Azure.Messaging.ServiceBus.ServiceBusClient" /> <Parameter Name="queueName" Type="System.String" /> <Parameter Name="options" Type="Azure.Messaging.ServiceBus.ServiceBusReceiverOptions" /> </Parameters> <Docs> <param name="client">The client instance to use for the receiver.</param> <param name="queueName">The name of the queue to receive from.</param> <param name="options">The set of options to use when configuring the receiver.</param> <summary> Initializes a new instance of the <see cref="T:Azure.Messaging.ServiceBus.ServiceBusReceiver" /> class for use with derived types. </summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="protected ServiceBusReceiver (Azure.Messaging.ServiceBus.ServiceBusClient client, string topicName, string subscriptionName, Azure.Messaging.ServiceBus.ServiceBusReceiverOptions options);" /> <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(class Azure.Messaging.ServiceBus.ServiceBusClient client, string topicName, string subscriptionName, class Azure.Messaging.ServiceBus.ServiceBusReceiverOptions options) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.ServiceBus.ServiceBusReceiver.#ctor(Azure.Messaging.ServiceBus.ServiceBusClient,System.String,System.String,Azure.Messaging.ServiceBus.ServiceBusReceiverOptions)" /> <MemberSignature Language="VB.NET" Value="Protected Sub New (client As ServiceBusClient, topicName As String, subscriptionName As String, options As ServiceBusReceiverOptions)" /> <MemberSignature Language="F#" Value="new Azure.Messaging.ServiceBus.ServiceBusReceiver : Azure.Messaging.ServiceBus.ServiceBusClient * string * string * Azure.Messaging.ServiceBus.ServiceBusReceiverOptions -> Azure.Messaging.ServiceBus.ServiceBusReceiver" Usage="new Azure.Messaging.ServiceBus.ServiceBusReceiver (client, topicName, subscriptionName, options)" /> <MemberType>Constructor</MemberType> <AssemblyInfo> <AssemblyName>Azure.Messaging.ServiceBus</AssemblyName> <AssemblyVersion>7.18.0.0</AssemblyVersion> <AssemblyVersion>7.19.0.0</AssemblyVersion> </AssemblyInfo> <Parameters> <Parameter Name="client" Type="Azure.Messaging.ServiceBus.ServiceBusClient" /> <Parameter Name="topicName" Type="System.String" /> <Parameter Name="subscriptionName" Type="System.String" /> <Parameter Name="options" Type="Azure.Messaging.ServiceBus.ServiceBusReceiverOptions" /> </Parameters> <Docs> <param name="client">The client instance to use for the receiver.</param> <param name="topicName">The topic to create a receiver for.</param> <param name="subscriptionName">The subscription to create a receiver for.</param> <param name="options">The set of options to use when configuring the receiver.</param> <summary> Initializes a new instance of the <see cref="T:Azure.Messaging.ServiceBus.ServiceBusReceiver" /> class for use with derived types. </summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="AbandonMessageAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task AbandonMessageAsync (Azure.Messaging.ServiceBus.ServiceBusReceivedMessage message, System.Collections.Generic.IDictionary<string,object> propertiesToModify = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task AbandonMessageAsync(class Azure.Messaging.ServiceBus.ServiceBusReceivedMessage message, class System.Collections.Generic.IDictionary`2<string, object> propertiesToModify, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.ServiceBus.ServiceBusReceiver.AbandonMessageAsync(Azure.Messaging.ServiceBus.ServiceBusReceivedMessage,System.Collections.Generic.IDictionary{System.String,System.Object},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AbandonMessageAsync (message As ServiceBusReceivedMessage, Optional propertiesToModify As IDictionary(Of String, Object) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task" /> <MemberSignature Language="F#" Value="abstract member AbandonMessageAsync : Azure.Messaging.ServiceBus.ServiceBusReceivedMessage * System.Collections.Generic.IDictionary<string, obj> * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.AbandonMessageAsync : Azure.Messaging.ServiceBus.ServiceBusReceivedMessage * System.Collections.Generic.IDictionary<string, obj> * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="serviceBusReceiver.AbandonMessageAsync (message, propertiesToModify, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Messaging.ServiceBus</AssemblyName> <AssemblyVersion>7.18.0.0</AssemblyVersion> <AssemblyVersion>7.19.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task</ReturnType> </ReturnValue> <Parameters> <Parameter Name="message" Type="Azure.Messaging.ServiceBus.ServiceBusReceivedMessage" /> <Parameter Name="propertiesToModify" Type="System.Collections.Generic.IDictionary<System.String,System.Object>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="message">The <see cref="T:Azure.Messaging.ServiceBus.ServiceBusReceivedMessage" /> to abandon.</param> <param name="propertiesToModify">The properties of the message to modify while abandoning the message.</param> <param name="cancellationToken">An optional <see cref="T:System.Threading.CancellationToken" /> instance to signal the request to cancel the operation.</param> <summary> Abandons a <see cref="T:Azure.Messaging.ServiceBus.ServiceBusReceivedMessage" />.This will make the message available again for immediate processing as the lock on the message held by the receiver will be released. </summary> <returns>A task to be resolved on when the operation has completed.</returns> <remarks> Abandoning a message will increase the delivery count on the message. This operation can only be performed on messages that were received by this receiver when <see cref="P:Azure.Messaging.ServiceBus.ServiceBusReceiver.ReceiveMode" /> is set to <see cref="F:Azure.Messaging.ServiceBus.ServiceBusReceiveMode.PeekLock" />. </remarks> <exception cref="T:Azure.Messaging.ServiceBus.ServiceBusException"> <list type="bullet"> <item> <description> The lock for the message has expired or the message has already been completed. This does not apply for session-enabled entities. The <see cref="P:Azure.Messaging.ServiceBus.ServiceBusException.Reason" /> will be set to <see cref="F:Azure.Messaging.ServiceBus.ServiceBusFailureReason.MessageLockLost" /> in this case. </description> </item> <item> <description> The lock for the session has expired or the message has already been completed. This only applies for session-enabled entities. The <see cref="P:Azure.Messaging.ServiceBus.ServiceBusException.Reason" /> will be set to <see cref="F:Azure.Messaging.ServiceBus.ServiceBusFailureReason.SessionLockLost" /> in this case. </description> </item> </list> </exception> </Docs> </Member> <Member MemberName="CloseAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task CloseAsync (System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task CloseAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.ServiceBus.ServiceBusReceiver.CloseAsync(System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function CloseAsync (Optional cancellationToken As CancellationToken = Nothing) As Task" /> <MemberSignature Language="F#" Value="abstract member CloseAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.CloseAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="serviceBusReceiver.CloseAsync cancellationToken" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Messaging.ServiceBus</AssemblyName> <AssemblyVersion>7.18.0.0</AssemblyVersion> <AssemblyVersion>7.19.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task</ReturnType> </ReturnValue> <Parameters> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="cancellationToken"> An optional<see cref="T:System.Threading.CancellationToken" /> instance to signal the request to cancel the operation.</param> <summary> Performs the task needed to clean up resources used by the <see cref="T:Azure.Messaging.ServiceBus.ServiceBusReceiver" />. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="CompleteMessageAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task CompleteMessageAsync (Azure.Messaging.ServiceBus.ServiceBusReceivedMessage message, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task CompleteMessageAsync(class Azure.Messaging.ServiceBus.ServiceBusReceivedMessage message, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.ServiceBus.ServiceBusReceiver.CompleteMessageAsync(Azure.Messaging.ServiceBus.ServiceBusReceivedMessage,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function CompleteMessageAsync (message As ServiceBusReceivedMessage, Optional cancellationToken As CancellationToken = Nothing) As Task" /> <MemberSignature Language="F#" Value="abstract member CompleteMessageAsync : Azure.Messaging.ServiceBus.ServiceBusReceivedMessage * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.CompleteMessageAsync : Azure.Messaging.ServiceBus.ServiceBusReceivedMessage * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="serviceBusReceiver.CompleteMessageAsync (message, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Messaging.ServiceBus</AssemblyName> <AssemblyVersion>7.18.0.0</AssemblyVersion> <AssemblyVersion>7.19.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task</ReturnType> </ReturnValue> <Parameters> <Parameter Name="message" Type="Azure.Messaging.ServiceBus.ServiceBusReceivedMessage" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="message">The message to complete.</param> <param name="cancellationToken">An optional <see cref="T:System.Threading.CancellationToken" /> instance to signal the request to cancel the operation.</param> <summary> Completes a <see cref="T:Azure.Messaging.ServiceBus.ServiceBusReceivedMessage" />. This will delete the message from the service. </summary> <returns>A task to be resolved on when the operation has completed.</returns> <remarks> This operation can only be performed on a message that was received by this receiver when <see cref="P:Azure.Messaging.ServiceBus.ServiceBusReceiver.ReceiveMode" /> is set to <see cref="F:Azure.Messaging.ServiceBus.ServiceBusReceiveMode.PeekLock" />. </remarks> <exception cref="T:Azure.Messaging.ServiceBus.ServiceBusException"> <list type="bullet"> <item> <description> The lock for the message has expired or the message has already been completed. This does not apply for session-enabled entities. The <see cref="P:Azure.Messaging.ServiceBus.ServiceBusException.Reason" /> will be set to <see cref="F:Azure.Messaging.ServiceBus.ServiceBusFailureReason.MessageLockLost" /> in this case. </description> </item> <item> <description> The lock for the session has expired or the message has already been completed. This only applies for session-enabled entities. The <see cref="P:Azure.Messaging.ServiceBus.ServiceBusException.Reason" /> will be set to <see cref="F:Azure.Messaging.ServiceBus.ServiceBusFailureReason.SessionLockLost" /> in this case. </description> </item> </list> </exception> </Docs> </Member> <Member MemberName="DeadLetterMessageAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task DeadLetterMessageAsync (Azure.Messaging.ServiceBus.ServiceBusReceivedMessage message, System.Collections.Generic.IDictionary<string,object> propertiesToModify = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task DeadLetterMessageAsync(class Azure.Messaging.ServiceBus.ServiceBusReceivedMessage message, class System.Collections.Generic.IDictionary`2<string, object> propertiesToModify, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.ServiceBus.ServiceBusReceiver.DeadLetterMessageAsync(Azure.Messaging.ServiceBus.ServiceBusReceivedMessage,System.Collections.Generic.IDictionary{System.String,System.Object},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function DeadLetterMessageAsync (message As ServiceBusReceivedMessage, Optional propertiesToModify As IDictionary(Of String, Object) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task" /> <MemberSignature Language="F#" Value="abstract member DeadLetterMessageAsync : Azure.Messaging.ServiceBus.ServiceBusReceivedMessage * System.Collections.Generic.IDictionary<string, obj> * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.DeadLetterMessageAsync : Azure.Messaging.ServiceBus.ServiceBusReceivedMessage * System.Collections.Generic.IDictionary<string, obj> * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="serviceBusReceiver.DeadLetterMessageAsync (message, propertiesToModify, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Messaging.ServiceBus</AssemblyName> <AssemblyVersion>7.18.0.0</AssemblyVersion> <AssemblyVersion>7.19.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task</ReturnType> </ReturnValue> <Parameters> <Parameter Name="message" Type="Azure.Messaging.ServiceBus.ServiceBusReceivedMessage" /> <Parameter Name="propertiesToModify" Type="System.Collections.Generic.IDictionary<System.String,System.Object>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="message">The <see cref="T:Azure.Messaging.ServiceBus.ServiceBusReceivedMessage" /> to dead-letter.</param> <param name="propertiesToModify">The properties of the message to modify while moving to subqueue.</param> <param name="cancellationToken">An optional <see cref="T:System.Threading.CancellationToken" /> instance to signal the request to cancel the operation.</param> <summary> Moves a message to the dead-letter subqueue. </summary> <returns>To be added.</returns> <remarks> In order to receive a message from the dead-letter queue or transfer dead-letter queue, set the <see cref="P:Azure.Messaging.ServiceBus.ServiceBusReceiverOptions.SubQueue" /> property to <see cref="F:Azure.Messaging.ServiceBus.SubQueue.DeadLetter" /> or <see cref="F:Azure.Messaging.ServiceBus.SubQueue.TransferDeadLetter" /> when calling <see cref="M:Azure.Messaging.ServiceBus.ServiceBusClient.CreateReceiver(System.String,Azure.Messaging.ServiceBus.ServiceBusReceiverOptions)" /> or <see cref="M:Azure.Messaging.ServiceBus.ServiceBusClient.CreateReceiver(System.String,System.String,Azure.Messaging.ServiceBus.ServiceBusReceiverOptions)" />. This operation can only be performed when <see cref="P:Azure.Messaging.ServiceBus.ServiceBusReceiver.ReceiveMode" /> is set to <see cref="F:Azure.Messaging.ServiceBus.ServiceBusReceiveMode.PeekLock" />. </remarks> <exception cref="T:Azure.Messaging.ServiceBus.ServiceBusException"> <list type="bullet"> <item> <description> The lock for the message has expired or the message has already been completed. This does not apply for session-enabled entities. The <see cref="P:Azure.Messaging.ServiceBus.ServiceBusException.Reason" /> will be set to <see cref="F:Azure.Messaging.ServiceBus.ServiceBusFailureReason.MessageLockLost" /> in this case. </description> </item> <item> <description> The lock for the session has expired or the message has already been completed. This only applies for session-enabled entities. The <see cref="P:Azure.Messaging.ServiceBus.ServiceBusException.Reason" /> will be set to <see cref="F:Azure.Messaging.ServiceBus.ServiceBusFailureReason.SessionLockLost" /> in this case. </description> </item> </list> </exception> </Docs> </Member> <Member MemberName="DeadLetterMessageAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task DeadLetterMessageAsync (Azure.Messaging.ServiceBus.ServiceBusReceivedMessage message, string deadLetterReason, string deadLetterErrorDescription = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task DeadLetterMessageAsync(class Azure.Messaging.ServiceBus.ServiceBusReceivedMessage message, string deadLetterReason, string deadLetterErrorDescription, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.ServiceBus.ServiceBusReceiver.DeadLetterMessageAsync(Azure.Messaging.ServiceBus.ServiceBusReceivedMessage,System.String,System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function DeadLetterMessageAsync (message As ServiceBusReceivedMessage, deadLetterReason As String, Optional deadLetterErrorDescription As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task" /> <MemberSignature Language="F#" Value="abstract member DeadLetterMessageAsync : Azure.Messaging.ServiceBus.ServiceBusReceivedMessage * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.DeadLetterMessageAsync : Azure.Messaging.ServiceBus.ServiceBusReceivedMessage * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="serviceBusReceiver.DeadLetterMessageAsync (message, deadLetterReason, deadLetterErrorDescription, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Messaging.ServiceBus</AssemblyName> <AssemblyVersion>7.18.0.0</AssemblyVersion> <AssemblyVersion>7.19.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task</ReturnType> </ReturnValue> <Parameters> <Parameter Name="message" Type="Azure.Messaging.ServiceBus.ServiceBusReceivedMessage" /> <Parameter Name="deadLetterReason" Type="System.String" /> <Parameter Name="deadLetterErrorDescription" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="message">The <see cref="T:Azure.Messaging.ServiceBus.ServiceBusReceivedMessage" /> to dead-letter.</param> <param name="deadLetterReason">The reason for dead-lettering the message.</param> <param name="deadLetterErrorDescription">The error description for dead-lettering the message.</param> <param name="cancellationToken">An optional <see cref="T:System.Threading.CancellationToken" /> instance to signal the request to cancel the operation.</param> <summary> Moves a message to the dead-letter subqueue. </summary> <returns>To be added.</returns> <remarks> In order to receive a message from the dead-letter queue or transfer dead-letter queue, set the <see cref="P:Azure.Messaging.ServiceBus.ServiceBusReceiverOptions.SubQueue" /> property to <see cref="F:Azure.Messaging.ServiceBus.SubQueue.DeadLetter" /> or <see cref="F:Azure.Messaging.ServiceBus.SubQueue.TransferDeadLetter" /> when calling <see cref="M:Azure.Messaging.ServiceBus.ServiceBusClient.CreateReceiver(System.String,Azure.Messaging.ServiceBus.ServiceBusReceiverOptions)" /> or <see cref="M:Azure.Messaging.ServiceBus.ServiceBusClient.CreateReceiver(System.String,System.String,Azure.Messaging.ServiceBus.ServiceBusReceiverOptions)" />. This operation can only be performed when <see cref="P:Azure.Messaging.ServiceBus.ServiceBusReceiver.ReceiveMode" /> is set to <see cref="F:Azure.Messaging.ServiceBus.ServiceBusReceiveMode.PeekLock" />. </remarks> <exception cref="T:Azure.Messaging.ServiceBus.ServiceBusException"> <list type="bullet"> <item> <description> The lock for the message has expired or the message has already been completed. This does not apply for session-enabled entities. The <see cref="P:Azure.Messaging.ServiceBus.ServiceBusException.Reason" /> will be set to <see cref="F:Azure.Messaging.ServiceBus.ServiceBusFailureReason.MessageLockLost" /> in this case. </description> </item> <item> <description> The lock for the session has expired or the message has already been completed. This only applies for session-enabled entities. The <see cref="P:Azure.Messaging.ServiceBus.ServiceBusException.Reason" /> will be set to <see cref="F:Azure.Messaging.ServiceBus.ServiceBusFailureReason.SessionLockLost" /> in this case. </description> </item> </list> </exception> <exception cref="T:System.ArgumentOutOfRangeException"> <list type="bullet"> <item> <description> The dead letter reason or dead letter error description exceeded the maximum length of 4096. </description> </item> </list> </exception> </Docs> </Member> <Member MemberName="DeadLetterMessageAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task DeadLetterMessageAsync (Azure.Messaging.ServiceBus.ServiceBusReceivedMessage message, System.Collections.Generic.IDictionary<string,object> propertiesToModify, string deadLetterReason, string deadLetterErrorDescription = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task DeadLetterMessageAsync(class Azure.Messaging.ServiceBus.ServiceBusReceivedMessage message, class System.Collections.Generic.IDictionary`2<string, object> propertiesToModify, string deadLetterReason, string deadLetterErrorDescription, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.ServiceBus.ServiceBusReceiver.DeadLetterMessageAsync(Azure.Messaging.ServiceBus.ServiceBusReceivedMessage,System.Collections.Generic.IDictionary{System.String,System.Object},System.String,System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function DeadLetterMessageAsync (message As ServiceBusReceivedMessage, propertiesToModify As IDictionary(Of String, Object), deadLetterReason As String, Optional deadLetterErrorDescription As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task" /> <MemberSignature Language="F#" Value="abstract member DeadLetterMessageAsync : Azure.Messaging.ServiceBus.ServiceBusReceivedMessage * System.Collections.Generic.IDictionary<string, obj> * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.DeadLetterMessageAsync : Azure.Messaging.ServiceBus.ServiceBusReceivedMessage * System.Collections.Generic.IDictionary<string, obj> * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="serviceBusReceiver.DeadLetterMessageAsync (message, propertiesToModify, deadLetterReason, deadLetterErrorDescription, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Messaging.ServiceBus</AssemblyName> <AssemblyVersion>7.18.0.0</AssemblyVersion> <AssemblyVersion>7.19.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task</ReturnType> </ReturnValue> <Parameters> <Parameter Name="message" Type="Azure.Messaging.ServiceBus.ServiceBusReceivedMessage" /> <Parameter Name="propertiesToModify" Type="System.Collections.Generic.IDictionary<System.String,System.Object>" /> <Parameter Name="deadLetterReason" Type="System.String" /> <Parameter Name="deadLetterErrorDescription" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="message">The <see cref="T:Azure.Messaging.ServiceBus.ServiceBusReceivedMessage" /> to dead-letter.</param> <param name="propertiesToModify">The properties of the message to modify while moving to subqueue.</param> <param name="deadLetterReason">The reason for dead-lettering the message.</param> <param name="deadLetterErrorDescription">The error description for dead-lettering the message.</param> <param name="cancellationToken">An optional <see cref="T:System.Threading.CancellationToken" /> instance to signal the request to cancel the operation.</param> <summary> Moves a message to the dead-letter subqueue. </summary> <returns>To be added.</returns> <remarks> In order to receive a message from the dead-letter queue or transfer dead-letter queue, set the <see cref="P:Azure.Messaging.ServiceBus.ServiceBusReceiverOptions.SubQueue" /> property to <see cref="F:Azure.Messaging.ServiceBus.SubQueue.DeadLetter" /> or <see cref="F:Azure.Messaging.ServiceBus.SubQueue.TransferDeadLetter" /> when calling <see cref="M:Azure.Messaging.ServiceBus.ServiceBusClient.CreateReceiver(System.String,Azure.Messaging.ServiceBus.ServiceBusReceiverOptions)" /> or <see cref="M:Azure.Messaging.ServiceBus.ServiceBusClient.CreateReceiver(System.String,System.String,Azure.Messaging.ServiceBus.ServiceBusReceiverOptions)" />. This operation can only be performed when <see cref="P:Azure.Messaging.ServiceBus.ServiceBusReceiver.ReceiveMode" /> is set to <see cref="F:Azure.Messaging.ServiceBus.ServiceBusReceiveMode.PeekLock" />. The dead letter reason and error description can only be specified either through the method parameters or hard coded using this properties. </remarks> <exception cref="T:Azure.Messaging.ServiceBus.ServiceBusException"> <list type="bullet"> <item> <description> The lock for the message has expired or the message has already been completed. This does not apply for session-enabled entities. The <see cref="P:Azure.Messaging.ServiceBus.ServiceBusException.Reason" /> will be set to <see cref="F:Azure.Messaging.ServiceBus.ServiceBusFailureReason.MessageLockLost" /> in this case. </description> </item> <item> <description> The lock for the session has expired or the message has already been completed. This only applies for session-enabled entities. The <see cref="P:Azure.Messaging.ServiceBus.ServiceBusException.Reason" /> will be set to <see cref="F:Azure.Messaging.ServiceBus.ServiceBusFailureReason.SessionLockLost" /> in this case. </description> </item> </list> </exception> <exception cref="T:System.InvalidOperationException"> <list type="bullet"> <item> <description> The dead letter reason or dead letter error exception was specified in both the parameter and the properties dictionary. </description> </item> </list> </exception> <exception cref="T:System.ArgumentOutOfRangeException"> <list type="bullet"> <item> <description> The dead letter reason or dead letter error description exceeded the maximum length of 4096. </description> </item> </list> </exception> </Docs> </Member> <Member MemberName="DeferMessageAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task DeferMessageAsync (Azure.Messaging.ServiceBus.ServiceBusReceivedMessage message, System.Collections.Generic.IDictionary<string,object> propertiesToModify = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task DeferMessageAsync(class Azure.Messaging.ServiceBus.ServiceBusReceivedMessage message, class System.Collections.Generic.IDictionary`2<string, object> propertiesToModify, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.ServiceBus.ServiceBusReceiver.DeferMessageAsync(Azure.Messaging.ServiceBus.ServiceBusReceivedMessage,System.Collections.Generic.IDictionary{System.String,System.Object},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function DeferMessageAsync (message As ServiceBusReceivedMessage, Optional propertiesToModify As IDictionary(Of String, Object) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task" /> <MemberSignature Language="F#" Value="abstract member DeferMessageAsync : Azure.Messaging.ServiceBus.ServiceBusReceivedMessage * System.Collections.Generic.IDictionary<string, obj> * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.DeferMessageAsync : Azure.Messaging.ServiceBus.ServiceBusReceivedMessage * System.Collections.Generic.IDictionary<string, obj> * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="serviceBusReceiver.DeferMessageAsync (message, propertiesToModify, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Messaging.ServiceBus</AssemblyName> <AssemblyVersion>7.18.0.0</AssemblyVersion> <AssemblyVersion>7.19.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task</ReturnType> </ReturnValue> <Parameters> <Parameter Name="message" Type="Azure.Messaging.ServiceBus.ServiceBusReceivedMessage" /> <Parameter Name="propertiesToModify" Type="System.Collections.Generic.IDictionary<System.String,System.Object>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="message">The <see cref="T:Azure.Messaging.ServiceBus.ServiceBusReceivedMessage" /> to defer.</param> <param name="propertiesToModify">The properties of the message to modify while deferring the message.</param> <param name="cancellationToken">An optional <see cref="T:System.Threading.CancellationToken" /> instance to signal the request to cancel the operation.</param> <summary> Indicates that the receiver wants to defer the processing for the message.</summary> <returns>A task to be resolved on when the operation has completed.</returns> <remarks> In order to receive this message again in the future, you will need to save the <see cref="P:Azure.Messaging.ServiceBus.ServiceBusReceivedMessage.SequenceNumber" /> and receive it using <see cref="M:Azure.Messaging.ServiceBus.ServiceBusReceiver.ReceiveDeferredMessageAsync(System.Int64,System.Threading.CancellationToken)" />. Deferring messages does not impact message's expiration, meaning that deferred messages can still expire. This operation can only be performed on messages that were received by this receiver. </remarks> <exception cref="T:Azure.Messaging.ServiceBus.ServiceBusException"> <list type="bullet"> <item> <description> The lock for the message has expired or the message has already been completed. This does not apply for session-enabled entities. The <see cref="P:Azure.Messaging.ServiceBus.ServiceBusException.Reason" /> will be set to <see cref="F:Azure.Messaging.ServiceBus.ServiceBusFailureReason.MessageLockLost" /> in this case. </description> </item> <item> <description> The lock for the session has expired or the message has already been completed. This only applies for session-enabled entities. The <see cref="P:Azure.Messaging.ServiceBus.ServiceBusException.Reason" /> will be set to <see cref="F:Azure.Messaging.ServiceBus.ServiceBusFailureReason.SessionLockLost" /> in this case. </description> </item> </list> </exception> </Docs> </Member> <Member MemberName="DeleteMessagesAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<int> DeleteMessagesAsync (int messageCount, DateTimeOffset? beforeEnqueueTime = default, System.Threading.CancellationToken cancellationToken = default);" FrameworkAlternate="azure-dotnet-preview" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<int32> DeleteMessagesAsync(int32 messageCount, valuetype System.Nullable`1<valuetype System.DateTimeOffset> beforeEnqueueTime, valuetype System.Threading.CancellationToken cancellationToken) cil managed" FrameworkAlternate="azure-dotnet-preview" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.ServiceBus.ServiceBusReceiver.DeleteMessagesAsync(System.Int32,System.Nullable{System.DateTimeOffset},System.Threading.CancellationToken)" FrameworkAlternate="azure-dotnet-preview" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function DeleteMessagesAsync (messageCount As Integer, Optional beforeEnqueueTime As Nullable(Of DateTimeOffset) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Integer)" FrameworkAlternate="azure-dotnet-preview" /> <MemberSignature Language="F#" Value="abstract member DeleteMessagesAsync : int * Nullable<DateTimeOffset> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>
override this.DeleteMessagesAsync : int * Nullable<DateTimeOffset> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>" Usage="serviceBusReceiver.DeleteMessagesAsync (messageCount, beforeEnqueueTime, cancellationToken)" FrameworkAlternate="azure-dotnet-preview" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Messaging.ServiceBus</AssemblyName> <AssemblyVersion>7.18.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType FrameworkAlternate="azure-dotnet-preview">System.Threading.Tasks.Task<System.Int32></ReturnType> </ReturnValue> <Parameters> <Parameter Name="messageCount" Type="System.Int32" Index="0" FrameworkAlternate="azure-dotnet-preview" /> <Parameter Name="beforeEnqueueTime" Type="System.Nullable<System.DateTimeOffset>" Index="1" FrameworkAlternate="azure-dotnet-preview" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="2" FrameworkAlternate="azure-dotnet-preview" /> </Parameters> <Docs> <param name="messageCount">The desired number of messages to delete. This value is limited by the service and governed <see href="https://learn.microsoft.com/azure/service-bus-messaging/service-bus-quotas">Service Bus quotas</see>. The service may delete fewer messages than this limit.</param> <param name="beforeEnqueueTime">An optional <see cref="T:System.DateTimeOffset" />, in UTC, representing the cutoff time for deletion. Only messages that were enqueued before this time will be deleted. If not specified, <see cref="P:System.DateTimeOffset.UtcNow" /> will be assumed.</param> <param name="cancellationToken">An optional <see cref="T:System.Threading.CancellationToken" /> instance to signal the request to cancel the operation.</param> <summary> Deletes up to <paramref name="messageCount" /> messages from the entity. The actual number of deleted messages may be less if there are fewer eligible messages in the entity. </summary> <returns>The number of messages that were deleted.</returns> <remarks>If the lock for a message is held by a receiver, it will be respected and the message will not be deleted.</remarks> <exception cref="T:System.ArgumentOutOfRangeException"> Occurs when the <paramref name="messageCount" /> is less than 1 or exceeds the maximum allowed, as determined by the Service Bus service. For more information on service limits, see <see href="https://learn.microsoft.com/azure/service-bus-messaging/service-bus-quotas#messaging-quotas" />. </exception> </Docs> </Member> <Member MemberName="DisposeAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.ValueTask DisposeAsync ();" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance valuetype System.Threading.Tasks.ValueTask DisposeAsync() cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.ServiceBus.ServiceBusReceiver.DisposeAsync" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function DisposeAsync () As ValueTask" /> <MemberSignature Language="F#" Value="abstract member DisposeAsync : unit -> System.Threading.Tasks.ValueTask
override this.DisposeAsync : unit -> System.Threading.Tasks.ValueTask" Usage="serviceBusReceiver.DisposeAsync " /> <MemberType>Method</MemberType> <Implements> <InterfaceMember>M:System.IAsyncDisposable.DisposeAsync</InterfaceMember> </Implements> <AssemblyInfo> <AssemblyName>Azure.Messaging.ServiceBus</AssemblyName> <AssemblyVersion>7.18.0.0</AssemblyVersion> <AssemblyVersion>7.19.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.ValueTask</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary> Performs the task needed to clean up resources used by the <see cref="T:Azure.Messaging.ServiceBus.ServiceBusReceiver" />. This is equivalent to calling <see cref="M:Azure.Messaging.ServiceBus.ServiceBusReceiver.CloseAsync(System.Threading.CancellationToken)" />. </summary> <returns>A task to be resolved on when the operation has completed.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="EntityPath"> <MemberSignature Language="C#" Value="public virtual string EntityPath { get; }" /> <MemberSignature Language="ILAsm" Value=".property instance string EntityPath" /> <MemberSignature Language="DocId" Value="P:Azure.Messaging.ServiceBus.ServiceBusReceiver.EntityPath" /> <MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property EntityPath As String" /> <MemberSignature Language="F#" Value="member this.EntityPath : string" Usage="Azure.Messaging.ServiceBus.ServiceBusReceiver.EntityPath" /> <MemberType>Property</MemberType> <AssemblyInfo> <AssemblyName>Azure.Messaging.ServiceBus</AssemblyName> <AssemblyVersion>7.18.0.0</AssemblyVersion> <AssemblyVersion>7.19.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> <summary> The path of the Service Bus entity that the receiver is connected to, specific to the Service Bus namespace that contains it. </summary> <value>To be added.</value> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="Equals"> <MemberSignature Language="C#" Value="public override bool Equals (object obj);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object obj) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.ServiceBus.ServiceBusReceiver.Equals(System.Object)" /> <MemberSignature Language="VB.NET" Value="Public Overrides Function Equals (obj As Object) As Boolean" /> <MemberSignature Language="F#" Value="override this.Equals : obj -> bool" Usage="serviceBusReceiver.Equals obj" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Messaging.ServiceBus</AssemblyName> <AssemblyVersion>7.18.0.0</AssemblyVersion> <AssemblyVersion>7.19.0.0</AssemblyVersion> </AssemblyInfo> <Attributes> <Attribute> <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName> <AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Parameters> <Parameter Name="obj" Type="System.Object" /> </Parameters> <Docs> <param name="obj">The <see cref="T:System.Object" /> to compare with this instance.</param> <summary> Determines whether the specified <see cref="T:System.Object" /> is equal to this instance. </summary> <returns> <c>true</c> if the specified <see cref="T:System.Object" /> is equal to this instance; otherwise, <c>false</c>.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="FullyQualifiedNamespace"> <MemberSignature Language="C#" Value="public virtual string FullyQualifiedNamespace { get; }" /> <MemberSignature Language="ILAsm" Value=".property instance string FullyQualifiedNamespace" /> <MemberSignature Language="DocId" Value="P:Azure.Messaging.ServiceBus.ServiceBusReceiver.FullyQualifiedNamespace" /> <MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property FullyQualifiedNamespace As String" /> <MemberSignature Language="F#" Value="member this.FullyQualifiedNamespace : string" Usage="Azure.Messaging.ServiceBus.ServiceBusReceiver.FullyQualifiedNamespace" /> <MemberType>Property</MemberType> <AssemblyInfo> <AssemblyName>Azure.Messaging.ServiceBus</AssemblyName> <AssemblyVersion>7.18.0.0</AssemblyVersion> <AssemblyVersion>7.19.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> <summary> The fully qualified Service Bus namespace that the receiver is associated with. This is likely to be similar to <c>{yournamespace}.servicebus.windows.net</c>. </summary> <value>To be added.</value> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="GetHashCode"> <MemberSignature Language="C#" Value="public override int GetHashCode ();" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 GetHashCode() cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.ServiceBus.ServiceBusReceiver.GetHashCode" /> <MemberSignature Language="VB.NET" Value="Public Overrides Function GetHashCode () As Integer" /> <MemberSignature Language="F#" Value="override this.GetHashCode : unit -> int" Usage="serviceBusReceiver.GetHashCode " /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Messaging.ServiceBus</AssemblyName> <AssemblyVersion>7.18.0.0</AssemblyVersion> <AssemblyVersion>7.19.0.0</AssemblyVersion> </AssemblyInfo> <Attributes> <Attribute> <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName> <AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>System.Int32</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary> Returns a hash code for this instance. </summary> <returns>A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="Identifier"> <MemberSignature Language="C#" Value="public virtual string Identifier { get; }" /> <MemberSignature Language="ILAsm" Value=".property instance string Identifier" /> <MemberSignature Language="DocId" Value="P:Azure.Messaging.ServiceBus.ServiceBusReceiver.Identifier" /> <MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property Identifier As String" /> <MemberSignature Language="F#" Value="member this.Identifier : string" Usage="Azure.Messaging.ServiceBus.ServiceBusReceiver.Identifier" /> <MemberType>Property</MemberType> <AssemblyInfo> <AssemblyName>Azure.Messaging.ServiceBus</AssemblyName> <AssemblyVersion>7.18.0.0</AssemblyVersion> <AssemblyVersion>7.19.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> <summary> A name used to identify the receiver client. If <c>null</c> or empty, a random unique value will be will be used. </summary> <value>To be added.</value> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="IsClosed"> <MemberSignature Language="C#" Value="public bool IsClosed { get; }" /> <MemberSignature Language="ILAsm" Value=".property instance bool IsClosed" /> <MemberSignature Language="DocId" Value="P:Azure.Messaging.ServiceBus.ServiceBusReceiver.IsClosed" /> <MemberSignature Language="VB.NET" Value="Public ReadOnly Property IsClosed As Boolean" /> <MemberSignature Language="F#" Value="member this.IsClosed : bool" Usage="Azure.Messaging.ServiceBus.ServiceBusReceiver.IsClosed" /> <MemberType>Property</MemberType> <AssemblyInfo> <AssemblyName>Azure.Messaging.ServiceBus</AssemblyName> <AssemblyVersion>7.18.0.0</AssemblyVersion> <AssemblyVersion>7.19.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> <summary> Indicates whether or not this <see cref="T:Azure.Messaging.ServiceBus.ServiceBusReceiver" /> has been closed. </summary> <value> <c>true</c> if the receiver is closed; otherwise, <c>false</c>. </value> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="PeekMessageAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage> PeekMessageAsync (long? fromSequenceNumber = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Messaging.ServiceBus.ServiceBusReceivedMessage> PeekMessageAsync(valuetype System.Nullable`1<int64> fromSequenceNumber, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.ServiceBus.ServiceBusReceiver.PeekMessageAsync(System.Nullable{System.Int64},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function PeekMessageAsync (Optional fromSequenceNumber As Nullable(Of Long) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ServiceBusReceivedMessage)" /> <MemberSignature Language="F#" Value="abstract member PeekMessageAsync : Nullable<int64> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>
override this.PeekMessageAsync : Nullable<int64> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>" Usage="serviceBusReceiver.PeekMessageAsync (fromSequenceNumber, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Messaging.ServiceBus</AssemblyName> <AssemblyVersion>7.18.0.0</AssemblyVersion> <AssemblyVersion>7.19.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage></ReturnType> </ReturnValue> <Parameters> <Parameter Name="fromSequenceNumber" Type="System.Nullable<System.Int64>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="fromSequenceNumber">An optional sequence number from where to peek the message. This corresponds to the <see cref="P:Azure.Messaging.ServiceBus.ServiceBusReceivedMessage.SequenceNumber" />.</param> <param name="cancellationToken">An optional <see cref="T:System.Threading.CancellationToken" /> instance to signal the request to cancel the operation.</param> <summary> Fetches the next active <see cref="T:Azure.Messaging.ServiceBus.ServiceBusReceivedMessage" /> without changing the state of the receiver or the message source. </summary> <returns>The <see cref="T:Azure.Messaging.ServiceBus.ServiceBusReceivedMessage" /> that represents the next message to be read. Returns null when nothing to peek.</returns> <remarks> The first call to <see cref="M:Azure.Messaging.ServiceBus.ServiceBusReceiver.PeekMessageAsync(System.Nullable{System.Int64},System.Threading.CancellationToken)" /> fetches the first active message for this receiver. Each subsequent call fetches the subsequent message in the entity. Unlike a received message, a peeked message will not have a lock token associated with it, and hence it cannot be Completed/Abandoned/Deferred/Deadlettered/Renewed. Also, unlike <see cref="M:Azure.Messaging.ServiceBus.ServiceBusReceiver.ReceiveMessageAsync(System.Nullable{System.TimeSpan},System.Threading.CancellationToken)" />, this method will fetch even Deferred messages (but not Deadlettered message). </remarks> </Docs> </Member> <Member MemberName="PeekMessagesAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>> PeekMessagesAsync (int maxMessages, long? fromSequenceNumber = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class System.Collections.Generic.IReadOnlyList`1<class Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>> PeekMessagesAsync(int32 maxMessages, valuetype System.Nullable`1<int64> fromSequenceNumber, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.ServiceBus.ServiceBusReceiver.PeekMessagesAsync(System.Int32,System.Nullable{System.Int64},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function PeekMessagesAsync (maxMessages As Integer, Optional fromSequenceNumber As Nullable(Of Long) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IReadOnlyList(Of ServiceBusReceivedMessage))" /> <MemberSignature Language="F#" Value="abstract member PeekMessagesAsync : int * Nullable<int64> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>>
override this.PeekMessagesAsync : int * Nullable<int64> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>>" Usage="serviceBusReceiver.PeekMessagesAsync (maxMessages, fromSequenceNumber, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Messaging.ServiceBus</AssemblyName> <AssemblyVersion>7.18.0.0</AssemblyVersion> <AssemblyVersion>7.19.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="maxMessages" Type="System.Int32" /> <Parameter Name="fromSequenceNumber" Type="System.Nullable<System.Int64>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="maxMessages">The maximum number of messages that will be fetched.</param> <param name="fromSequenceNumber">An optional sequence number from where to peek the message. This corresponds to the <see cref="P:Azure.Messaging.ServiceBus.ServiceBusReceivedMessage.SequenceNumber" />.</param> <param name="cancellationToken">An optional <see cref="T:System.Threading.CancellationToken" /> instance to signal the request to cancel the operation.</param> <summary> Fetches a list of active messages without changing the state of the receiver or the message source. </summary> <returns>An <see cref="T:System.Collections.Generic.IReadOnlyList`1" /> of messages that were peeked.</returns> <remarks> Unlike a received message, a peeked message will not have a lock token associated with it, and hence it cannot be Completed/Abandoned/Deferred/Deadlettered/Renewed. Also, unlike <see cref="M:Azure.Messaging.ServiceBus.ServiceBusReceiver.ReceiveMessageAsync(System.Nullable{System.TimeSpan},System.Threading.CancellationToken)" />, this method will fetch even Deferred messages (but not Deadlettered messages). </remarks> </Docs> </Member> <Member MemberName="PrefetchCount"> <MemberSignature Language="C#" Value="public virtual int PrefetchCount { get; }" /> <MemberSignature Language="ILAsm" Value=".property instance int32 PrefetchCount" /> <MemberSignature Language="DocId" Value="P:Azure.Messaging.ServiceBus.ServiceBusReceiver.PrefetchCount" /> <MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property PrefetchCount As Integer" /> <MemberSignature Language="F#" Value="member this.PrefetchCount : int" Usage="Azure.Messaging.ServiceBus.ServiceBusReceiver.PrefetchCount" /> <MemberType>Property</MemberType> <AssemblyInfo> <AssemblyName>Azure.Messaging.ServiceBus</AssemblyName> <AssemblyVersion>7.18.0.0</AssemblyVersion> <AssemblyVersion>7.19.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Int32</ReturnType> </ReturnValue> <Docs> <summary> The number of messages that will be eagerly requested from Queues or Subscriptions and queued locally without regard to whether a processing is currently active, intended to help maximize throughput by allowing the receiver to receive from a local cache rather than waiting on a service request </summary> <value> The option to auto complete messages is specified when creating the receiver using <see cref="P:Azure.Messaging.ServiceBus.ServiceBusReceiverOptions.PrefetchCount" /> and has a default value of 0. </value> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="PurgeMessagesAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<int> PurgeMessagesAsync (DateTimeOffset? beforeEnqueueTime = default, System.Threading.CancellationToken cancellationToken = default);" FrameworkAlternate="azure-dotnet-preview" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<int32> PurgeMessagesAsync(valuetype System.Nullable`1<valuetype System.DateTimeOffset> beforeEnqueueTime, valuetype System.Threading.CancellationToken cancellationToken) cil managed" FrameworkAlternate="azure-dotnet-preview" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.ServiceBus.ServiceBusReceiver.PurgeMessagesAsync(System.Nullable{System.DateTimeOffset},System.Threading.CancellationToken)" FrameworkAlternate="azure-dotnet-preview" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function PurgeMessagesAsync (Optional beforeEnqueueTime As Nullable(Of DateTimeOffset) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Integer)" FrameworkAlternate="azure-dotnet-preview" /> <MemberSignature Language="F#" Value="abstract member PurgeMessagesAsync : Nullable<DateTimeOffset> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>
override this.PurgeMessagesAsync : Nullable<DateTimeOffset> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>" Usage="serviceBusReceiver.PurgeMessagesAsync (beforeEnqueueTime, cancellationToken)" FrameworkAlternate="azure-dotnet-preview" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Messaging.ServiceBus</AssemblyName> <AssemblyVersion>7.18.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType FrameworkAlternate="azure-dotnet-preview">System.Threading.Tasks.Task<System.Int32></ReturnType> </ReturnValue> <Parameters> <Parameter Name="beforeEnqueueTime" Type="System.Nullable<System.DateTimeOffset>" Index="0" FrameworkAlternate="azure-dotnet-preview" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="azure-dotnet-preview" /> </Parameters> <Docs> <param name="beforeEnqueueTime">An optional <see cref="T:System.DateTimeOffset" />, in UTC, representing the cutoff time for deletion. Only messages that were enqueued before this time will be deleted. If not specified, <see cref="P:System.DateTimeOffset.UtcNow" /> will be assumed.</param> <param name="cancellationToken">An optional <see cref="T:System.Threading.CancellationToken" /> instance to signal the request to cancel the operation.</param> <summary> Attempts to purge all messages from an entity. Locked messages are not eligible for removal and will remain in the entity. </summary> <returns>The number of messages that were deleted.</returns> <remarks> If the lock for a message is held by a receiver, it will be respected and the message will not be deleted. This method may invoke multiple service requests to delete all messages. As a result, it may exceed the configured <see cref="P:Azure.Messaging.ServiceBus.ServiceBusRetryOptions.TryTimeout" />. If you need control over the amount of time the operation takes, it is recommended that you pass a <paramref name="cancellationToken" /> with the desired timeout set for cancellation. Because multiple service requests may be made, the possibility of partial success exists. In this scenario, the method will stop attempting to delete additional messages and throw the exception that was encountered. It is recommended to evaluate this exception and determine which messages may not have been deleted. </remarks> </Docs> </Member> <Member MemberName="ReceiveDeferredMessageAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage> ReceiveDeferredMessageAsync (long sequenceNumber, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Messaging.ServiceBus.ServiceBusReceivedMessage> ReceiveDeferredMessageAsync(int64 sequenceNumber, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.ServiceBus.ServiceBusReceiver.ReceiveDeferredMessageAsync(System.Int64,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function ReceiveDeferredMessageAsync (sequenceNumber As Long, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ServiceBusReceivedMessage)" /> <MemberSignature Language="F#" Value="abstract member ReceiveDeferredMessageAsync : int64 * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>
override this.ReceiveDeferredMessageAsync : int64 * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>" Usage="serviceBusReceiver.ReceiveDeferredMessageAsync (sequenceNumber, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Messaging.ServiceBus</AssemblyName> <AssemblyVersion>7.18.0.0</AssemblyVersion> <AssemblyVersion>7.19.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage></ReturnType> </ReturnValue> <Parameters> <Parameter Name="sequenceNumber" Type="System.Int64" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="sequenceNumber">The sequence number of the message to receive. This corresponds to the <see cref="P:Azure.Messaging.ServiceBus.ServiceBusReceivedMessage.SequenceNumber" />.</param> <param name="cancellationToken">An optional <see cref="T:System.Threading.CancellationToken" /> instance to signal the request to cancel the operation.</param> <summary> Receives a deferred message identified by <paramref name="sequenceNumber" />. </summary> <returns>The deferred message identified by the specified sequence number. Throws if the message has not been deferred.</returns> <remarks>To be added.</remarks> <altmember cref="M:Azure.Messaging.ServiceBus.ServiceBusReceiver.DeferMessageAsync(Azure.Messaging.ServiceBus.ServiceBusReceivedMessage,System.Collections.Generic.IDictionary{System.String,System.Object},System.Threading.CancellationToken)" /> <exception cref="T:Azure.Messaging.ServiceBus.ServiceBusException"> The specified sequence number does not correspond to a message that has been deferred. The <see cref="P:Azure.Messaging.ServiceBus.ServiceBusException.Reason" /> will be set to <see cref="F:Azure.Messaging.ServiceBus.ServiceBusFailureReason.MessageNotFound" /> in this case. </exception> </Docs> </Member> <Member MemberName="ReceiveDeferredMessagesAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>> ReceiveDeferredMessagesAsync (System.Collections.Generic.IEnumerable<long> sequenceNumbers, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class System.Collections.Generic.IReadOnlyList`1<class Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>> ReceiveDeferredMessagesAsync(class System.Collections.Generic.IEnumerable`1<int64> sequenceNumbers, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.ServiceBus.ServiceBusReceiver.ReceiveDeferredMessagesAsync(System.Collections.Generic.IEnumerable{System.Int64},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function ReceiveDeferredMessagesAsync (sequenceNumbers As IEnumerable(Of Long), Optional cancellationToken As CancellationToken = Nothing) As Task(Of IReadOnlyList(Of ServiceBusReceivedMessage))" /> <MemberSignature Language="F#" Value="abstract member ReceiveDeferredMessagesAsync : seq<int64> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>>
override this.ReceiveDeferredMessagesAsync : seq<int64> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>>" Usage="serviceBusReceiver.ReceiveDeferredMessagesAsync (sequenceNumbers, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Messaging.ServiceBus</AssemblyName> <AssemblyVersion>7.18.0.0</AssemblyVersion> <AssemblyVersion>7.19.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="sequenceNumbers" Type="System.Collections.Generic.IEnumerable<System.Int64>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="sequenceNumbers">An <see cref="T:System.Collections.Generic.IEnumerable`1" /> containing the sequence numbers to receive.</param> <param name="cancellationToken">An optional <see cref="T:System.Threading.CancellationToken" /> instance to signal the request to cancel the operation.</param> <summary> Receives a list of deferred messages identified by <paramref name="sequenceNumbers" />. </summary> <returns>Messages identified by sequence number are returned. Throws if the messages have not been deferred.</returns> <remarks>To be added.</remarks> <altmember cref="M:Azure.Messaging.ServiceBus.ServiceBusReceiver.DeferMessageAsync(Azure.Messaging.ServiceBus.ServiceBusReceivedMessage,System.Collections.Generic.IDictionary{System.String,System.Object},System.Threading.CancellationToken)" /> <exception cref="T:Azure.Messaging.ServiceBus.ServiceBusException"> The specified sequence number does not correspond to a message that has been deferred. The <see cref="P:Azure.Messaging.ServiceBus.ServiceBusException.Reason" /> will be set to <see cref="F:Azure.Messaging.ServiceBus.ServiceBusFailureReason.MessageNotFound" /> in this case. </exception> </Docs> </Member> <Member MemberName="ReceiveMessageAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage> ReceiveMessageAsync (TimeSpan? maxWaitTime = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Messaging.ServiceBus.ServiceBusReceivedMessage> ReceiveMessageAsync(valuetype System.Nullable`1<valuetype System.TimeSpan> maxWaitTime, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.ServiceBus.ServiceBusReceiver.ReceiveMessageAsync(System.Nullable{System.TimeSpan},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function ReceiveMessageAsync (Optional maxWaitTime As Nullable(Of TimeSpan) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ServiceBusReceivedMessage)" /> <MemberSignature Language="F#" Value="abstract member ReceiveMessageAsync : Nullable<TimeSpan> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>
override this.ReceiveMessageAsync : Nullable<TimeSpan> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>" Usage="serviceBusReceiver.ReceiveMessageAsync (maxWaitTime, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Messaging.ServiceBus</AssemblyName> <AssemblyVersion>7.18.0.0</AssemblyVersion> <AssemblyVersion>7.19.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage></ReturnType> </ReturnValue> <Parameters> <Parameter Name="maxWaitTime" Type="System.Nullable<System.TimeSpan>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="maxWaitTime">An optional <see cref="T:System.TimeSpan" /> specifying the maximum time to wait for a message before returning null if no messages are available. If not specified, the <see cref="P:Azure.Messaging.ServiceBus.ServiceBusRetryOptions.TryTimeout" /> will be used.</param> <param name="cancellationToken">An optional <see cref="T:System.Threading.CancellationToken" /> instance to signal the request to cancel the operation.</param> <summary> Receives a <see cref="T:Azure.Messaging.ServiceBus.ServiceBusReceivedMessage" /> from the entity using <see cref="P:Azure.Messaging.ServiceBus.ServiceBusReceiver.ReceiveMode" /> mode. <see cref="P:Azure.Messaging.ServiceBus.ServiceBusReceiver.ReceiveMode" /> defaults to PeekLock mode. </summary> <returns>The message received. Returns null if no message is found.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="ReceiveMessagesAsync"> <MemberSignature Language="C#" Value="public virtual System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage> ReceiveMessagesAsync (System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Collections.Generic.IAsyncEnumerable`1<class Azure.Messaging.ServiceBus.ServiceBusReceivedMessage> ReceiveMessagesAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.ServiceBus.ServiceBusReceiver.ReceiveMessagesAsync(System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function ReceiveMessagesAsync (Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of ServiceBusReceivedMessage)" /> <MemberSignature Language="F#" Value="abstract member ReceiveMessagesAsync : System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>
override this.ReceiveMessagesAsync : System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>" Usage="serviceBusReceiver.ReceiveMessagesAsync cancellationToken" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Messaging.ServiceBus</AssemblyName> <AssemblyVersion>7.18.0.0</AssemblyVersion> <AssemblyVersion>7.19.0.0</AssemblyVersion> </AssemblyInfo> <Attributes> <Attribute FrameworkAlternate="azure-dotnet"> <AttributeName Language="C#">[System.Runtime.CompilerServices.AsyncIteratorStateMachine(typeof(Azure.Messaging.ServiceBus.ServiceBusReceiver+<ReceiveMessagesAsync>d__45))]</AttributeName> <AttributeName Language="F#">[<System.Runtime.CompilerServices.AsyncIteratorStateMachine(typeof(Azure.Messaging.ServiceBus.ServiceBusReceiver+<ReceiveMessagesAsync>d__45))>]</AttributeName> </Attribute> <Attribute FrameworkAlternate="azure-dotnet-preview"> <AttributeName Language="C#">[System.Runtime.CompilerServices.AsyncIteratorStateMachine(typeof(Azure.Messaging.ServiceBus.ServiceBusReceiver+<ReceiveMessagesAsync>d__44))]</AttributeName> <AttributeName Language="F#">[<System.Runtime.CompilerServices.AsyncIteratorStateMachine(typeof(Azure.Messaging.ServiceBus.ServiceBusReceiver+<ReceiveMessagesAsync>d__44))>]</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage></ReturnType> </ReturnValue> <Parameters> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken"> <Attributes> <Attribute> <AttributeName Language="C#">[System.Runtime.CompilerServices.EnumeratorCancellation]</AttributeName> <AttributeName Language="F#">[<System.Runtime.CompilerServices.EnumeratorCancellation>]</AttributeName> </Attribute> </Attributes> </Parameter> </Parameters> <Docs> <param name="cancellationToken">An optional <see cref="T:System.Threading.CancellationToken" /> instance to signal the request to cancel the operation.</param> <summary> Receives messages as an asynchronous enumerable from the entity using <see cref="P:Azure.Messaging.ServiceBus.ServiceBusReceiver.ReceiveMode" /> mode. <see cref="P:Azure.Messaging.ServiceBus.ServiceBusReceiver.ReceiveMode" /> defaults to PeekLock mode. Messages will be received from the entity as the IAsyncEnumerable is iterated. If no messages are available, this method will continue polling until messages are available, i.e. it will never return null. </summary> <returns>The message received.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="ReceiveMessagesAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>> ReceiveMessagesAsync (int maxMessages, TimeSpan? maxWaitTime = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class System.Collections.Generic.IReadOnlyList`1<class Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>> ReceiveMessagesAsync(int32 maxMessages, valuetype System.Nullable`1<valuetype System.TimeSpan> maxWaitTime, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.ServiceBus.ServiceBusReceiver.ReceiveMessagesAsync(System.Int32,System.Nullable{System.TimeSpan},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function ReceiveMessagesAsync (maxMessages As Integer, Optional maxWaitTime As Nullable(Of TimeSpan) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IReadOnlyList(Of ServiceBusReceivedMessage))" /> <MemberSignature Language="F#" Value="abstract member ReceiveMessagesAsync : int * Nullable<TimeSpan> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>>
override this.ReceiveMessagesAsync : int * Nullable<TimeSpan> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>>" Usage="serviceBusReceiver.ReceiveMessagesAsync (maxMessages, maxWaitTime, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Messaging.ServiceBus</AssemblyName> <AssemblyVersion>7.18.0.0</AssemblyVersion> <AssemblyVersion>7.19.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="maxMessages" Type="System.Int32" /> <Parameter Name="maxWaitTime" Type="System.Nullable<System.TimeSpan>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="maxMessages">The maximum number of messages that will be received.</param> <param name="maxWaitTime">An optional <see cref="T:System.TimeSpan" /> specifying the maximum time to wait for the first message before returning an empty list if no messages are available. If not specified, the <see cref="P:Azure.Messaging.ServiceBus.ServiceBusRetryOptions.TryTimeout" /> will be used.</param> <param name="cancellationToken">An optional <see cref="T:System.Threading.CancellationToken" /> instance to signal the request to cancel the operation.</param> <summary> Receives a list of <see cref="T:Azure.Messaging.ServiceBus.ServiceBusReceivedMessage" /> from the entity using <see cref="P:Azure.Messaging.ServiceBus.ServiceBusReceiver.ReceiveMode" /> mode. <see cref="P:Azure.Messaging.ServiceBus.ServiceBusReceiver.ReceiveMode" /> defaults to PeekLock mode. This method doesn't guarantee to return exact `maxMessages` messages, even if there are `maxMessages` messages available in the queue or topic. </summary> <returns>List of messages received. Returns an empty list if no message is found.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="ReceiveMode"> <MemberSignature Language="C#" Value="public virtual Azure.Messaging.ServiceBus.ServiceBusReceiveMode ReceiveMode { get; }" /> <MemberSignature Language="ILAsm" Value=".property instance valuetype Azure.Messaging.ServiceBus.ServiceBusReceiveMode ReceiveMode" /> <MemberSignature Language="DocId" Value="P:Azure.Messaging.ServiceBus.ServiceBusReceiver.ReceiveMode" /> <MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property ReceiveMode As ServiceBusReceiveMode" /> <MemberSignature Language="F#" Value="member this.ReceiveMode : Azure.Messaging.ServiceBus.ServiceBusReceiveMode" Usage="Azure.Messaging.ServiceBus.ServiceBusReceiver.ReceiveMode" /> <MemberType>Property</MemberType> <AssemblyInfo> <AssemblyName>Azure.Messaging.ServiceBus</AssemblyName> <AssemblyVersion>7.18.0.0</AssemblyVersion> <AssemblyVersion>7.19.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Messaging.ServiceBus.ServiceBusReceiveMode</ReturnType> </ReturnValue> <Docs> <summary> The <see cref="P:Azure.Messaging.ServiceBus.ServiceBusReceiver.ReceiveMode" /> used to specify how messages are received. </summary> <value> The option to auto complete messages is specified when creating the receiver using <see cref="P:Azure.Messaging.ServiceBus.ServiceBusReceiverOptions.ReceiveMode" /> and has a default mode of <see cref="F:Azure.Messaging.ServiceBus.ServiceBusReceiveMode.PeekLock" />. </value> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="RenewMessageLockAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task RenewMessageLockAsync (Azure.Messaging.ServiceBus.ServiceBusReceivedMessage message, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task RenewMessageLockAsync(class Azure.Messaging.ServiceBus.ServiceBusReceivedMessage message, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.ServiceBus.ServiceBusReceiver.RenewMessageLockAsync(Azure.Messaging.ServiceBus.ServiceBusReceivedMessage,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function RenewMessageLockAsync (message As ServiceBusReceivedMessage, Optional cancellationToken As CancellationToken = Nothing) As Task" /> <MemberSignature Language="F#" Value="abstract member RenewMessageLockAsync : Azure.Messaging.ServiceBus.ServiceBusReceivedMessage * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.RenewMessageLockAsync : Azure.Messaging.ServiceBus.ServiceBusReceivedMessage * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="serviceBusReceiver.RenewMessageLockAsync (message, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Messaging.ServiceBus</AssemblyName> <AssemblyVersion>7.18.0.0</AssemblyVersion> <AssemblyVersion>7.19.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task</ReturnType> </ReturnValue> <Parameters> <Parameter Name="message" Type="Azure.Messaging.ServiceBus.ServiceBusReceivedMessage" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="message">The <see cref="T:Azure.Messaging.ServiceBus.ServiceBusReceivedMessage" /> to renew the lock for.</param> <param name="cancellationToken">An optional <see cref="T:System.Threading.CancellationToken" /> instance to signal the request to cancel the operation.</param> <summary> Renews the lock on the message. The lock will be renewed based on the setting specified on the queue. </summary> <returns>To be added.</returns> <remarks> When a message is received in <see cref="F:Azure.Messaging.ServiceBus.ServiceBusReceiveMode.PeekLock" /> mode, the message is locked on the server for this receiver instance for a duration as specified during the Queue/Subscription creation (LockDuration). If processing of the message requires longer than this duration, the lock needs to be renewed. For each renewal, it resets the time the message is locked by the LockDuration set on the Entity. </remarks> <exception cref="T:Azure.Messaging.ServiceBus.ServiceBusException"> The lock for the message has expired or the message has already been completed. The <see cref="P:Azure.Messaging.ServiceBus.ServiceBusException.Reason" /> will be set to <see cref="F:Azure.Messaging.ServiceBus.ServiceBusFailureReason.MessageLockLost" /> in this case. </exception> </Docs> </Member> <Member MemberName="ToString"> <MemberSignature Language="C#" Value="public override string ToString ();" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.ServiceBus.ServiceBusReceiver.ToString" /> <MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" /> <MemberSignature Language="F#" Value="override this.ToString : unit -> string" Usage="serviceBusReceiver.ToString " /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Messaging.ServiceBus</AssemblyName> <AssemblyVersion>7.18.0.0</AssemblyVersion> <AssemblyVersion>7.19.0.0</AssemblyVersion> </AssemblyInfo> <Attributes> <Attribute> <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName> <AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>System.String</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary> Converts the instance to string representation. </summary> <returns>A <see cref="T:System.String" /> that represents this instance.</returns> <remarks>To be added.</remarks> </Docs> </Member> </Members> </Type>

xml/Azure.Messaging.ServiceBus/ServiceBusReceiver.xml (1,161 lines of code) (raw):