### YamlMime:JavaType uid: "com.microsoft.azure.servicebus.IMessageReceiver" fullName: "com.microsoft.azure.servicebus.IMessageReceiver" name: "IMessageReceiver" nameWithType: "IMessageReceiver" summary: "Defines message receiver interface." syntax: "public interface **IMessageReceiver**
extends , " methods: - uid: "com.microsoft.azure.servicebus.IMessageReceiver.abandon(java.util.UUID)" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.abandon(UUID lockToken)" name: "abandon(UUID lockToken)" nameWithType: "IMessageReceiver.abandon(UUID lockToken)" summary: "Abandon with lock token." modifiers: - "abstract" parameters: - description: "Message lock token " name: "lockToken" type: "UUID" syntax: "public abstract void abandon(UUID lockToken)" exceptions: - description: "if the current thread was interrupted while waiting" type: "InterruptedException" - description: "if the current thread was interrupted while waiting" type: "" desc: "Abandon with lock token. This will make the message available again for processing. Abandoning a message will increase the delivery count on the message" - uid: "com.microsoft.azure.servicebus.IMessageReceiver.abandon(java.util.UUID,com.microsoft.azure.servicebus.TransactionContext)" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.abandon(UUID lockToken, TransactionContext transaction)" name: "abandon(UUID lockToken, TransactionContext transaction)" nameWithType: "IMessageReceiver.abandon(UUID lockToken, TransactionContext transaction)" summary: "Abandon with lock token." modifiers: - "abstract" parameters: - description: "Message lock token " name: "lockToken" type: "UUID" - description: " which this operation should enlist to." name: "transaction" type: "" syntax: "public abstract void abandon(UUID lockToken, TransactionContext transaction)" exceptions: - description: "if the current thread was interrupted while waiting" type: "InterruptedException" - description: "if the current thread was interrupted while waiting" type: "" desc: "Abandon with lock token. This will make the message available again for processing. Abandoning a message will increase the delivery count on the message" - uid: "com.microsoft.azure.servicebus.IMessageReceiver.abandon(java.util.UUID,java.util.Map)" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.abandon(UUID lockToken, Map propertiesToModify)" name: "abandon(UUID lockToken, Map propertiesToModify)" nameWithType: "IMessageReceiver.abandon(UUID lockToken, Map propertiesToModify)" summary: "Abandon with lock token and updated message property." modifiers: - "abstract" parameters: - description: "Message lock token " name: "lockToken" type: "UUID" - description: "Message properties to modify." name: "propertiesToModify" type: "Map<String,Object>" syntax: "public abstract void abandon(UUID lockToken, Map propertiesToModify)" exceptions: - description: "if the current thread was interrupted while waiting" type: "InterruptedException" - description: "if the current thread was interrupted while waiting" type: "" desc: "Abandon with lock token and updated message property. This will make the message available again for processing. Abandoning a message will increase the delivery count on the message" - uid: "com.microsoft.azure.servicebus.IMessageReceiver.abandon(java.util.UUID,java.util.Map,com.microsoft.azure.servicebus.TransactionContext)" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.abandon(UUID lockToken, Map propertiesToModify, TransactionContext transaction)" name: "abandon(UUID lockToken, Map propertiesToModify, TransactionContext transaction)" nameWithType: "IMessageReceiver.abandon(UUID lockToken, Map propertiesToModify, TransactionContext transaction)" summary: "Abandon with lock token and updated message property." modifiers: - "abstract" parameters: - description: "Message lock token " name: "lockToken" type: "UUID" - description: "Message properties to modify." name: "propertiesToModify" type: "Map<String,Object>" - description: " which this operation should enlist to." name: "transaction" type: "" syntax: "public abstract void abandon(UUID lockToken, Map propertiesToModify, TransactionContext transaction)" exceptions: - description: "if the current thread was interrupted while waiting" type: "InterruptedException" - description: "if the current thread was interrupted while waiting" type: "" desc: "Abandon with lock token and updated message property. This will make the message available again for processing. Abandoning a message will increase the delivery count on the message" - uid: "com.microsoft.azure.servicebus.IMessageReceiver.abandonAsync(java.util.UUID)" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.abandonAsync(UUID lockToken)" name: "abandonAsync(UUID lockToken)" nameWithType: "IMessageReceiver.abandonAsync(UUID lockToken)" summary: "Asynchronously abandon with lock token." modifiers: - "abstract" parameters: - description: "Message lock token " name: "lockToken" type: "UUID" syntax: "public abstract CompletableFuture abandonAsync(UUID lockToken)" desc: "Asynchronously abandon with lock token. This will make the message available again for processing. Abandoning a message will increase the delivery count on the message." returns: description: "a CompletableFuture representing the pending abandon." type: "CompletableFuture<Void>" - uid: "com.microsoft.azure.servicebus.IMessageReceiver.abandonAsync(java.util.UUID,com.microsoft.azure.servicebus.TransactionContext)" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.abandonAsync(UUID lockToken, TransactionContext transaction)" name: "abandonAsync(UUID lockToken, TransactionContext transaction)" nameWithType: "IMessageReceiver.abandonAsync(UUID lockToken, TransactionContext transaction)" summary: "Asynchronously abandon with lock token." modifiers: - "abstract" parameters: - description: "Message lock token " name: "lockToken" type: "UUID" - description: " which this operation should enlist to." name: "transaction" type: "" syntax: "public abstract CompletableFuture abandonAsync(UUID lockToken, TransactionContext transaction)" desc: "Asynchronously abandon with lock token. This will make the message available again for processing. Abandoning a message will increase the delivery count on the message." returns: description: "a CompletableFuture representing the pending abandon." type: "CompletableFuture<Void>" - uid: "com.microsoft.azure.servicebus.IMessageReceiver.abandonAsync(java.util.UUID,java.util.Map)" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.abandonAsync(UUID lockToken, Map propertiesToModify)" name: "abandonAsync(UUID lockToken, Map propertiesToModify)" nameWithType: "IMessageReceiver.abandonAsync(UUID lockToken, Map propertiesToModify)" summary: "Asynchronously abandon with lock token and updated message property." modifiers: - "abstract" parameters: - description: "Message lock token " name: "lockToken" type: "UUID" - description: "Message properties to modify." name: "propertiesToModify" type: "Map<String,Object>" syntax: "public abstract CompletableFuture abandonAsync(UUID lockToken, Map propertiesToModify)" desc: "Asynchronously abandon with lock token and updated message property. This will make the message available again for processing. Abandoning a message will increase the delivery count on the message." returns: description: "a CompletableFuture representing the pending abandon." type: "CompletableFuture<Void>" - uid: "com.microsoft.azure.servicebus.IMessageReceiver.abandonAsync(java.util.UUID,java.util.Map,com.microsoft.azure.servicebus.TransactionContext)" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.abandonAsync(UUID lockToken, Map propertiesToModify, TransactionContext transaction)" name: "abandonAsync(UUID lockToken, Map propertiesToModify, TransactionContext transaction)" nameWithType: "IMessageReceiver.abandonAsync(UUID lockToken, Map propertiesToModify, TransactionContext transaction)" summary: "Asynchronously abandon with lock token and updated message property." modifiers: - "abstract" parameters: - description: "Message lock token " name: "lockToken" type: "UUID" - description: "Message properties to modify." name: "propertiesToModify" type: "Map<String,Object>" - description: " which this operation should enlist to." name: "transaction" type: "" syntax: "public abstract CompletableFuture abandonAsync(UUID lockToken, Map propertiesToModify, TransactionContext transaction)" desc: "Asynchronously abandon with lock token and updated message property. This will make the message available again for processing. Abandoning a message will increase the delivery count on the message." returns: description: "a CompletableFuture representing the pending abandon." type: "CompletableFuture<Void>" - uid: "com.microsoft.azure.servicebus.IMessageReceiver.complete(java.util.UUID)" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.complete(UUID lockToken)" name: "complete(UUID lockToken)" nameWithType: "IMessageReceiver.complete(UUID lockToken)" summary: "Completes a using its lock token." modifiers: - "abstract" parameters: - description: "Message lock token " name: "lockToken" type: "UUID" syntax: "public abstract void complete(UUID lockToken)" exceptions: - description: "if the current thread was interrupted while waiting" type: "InterruptedException" - description: "if the current thread was interrupted while waiting" type: "" desc: "Completes a using its lock token. This will delete the message from the service." - uid: "com.microsoft.azure.servicebus.IMessageReceiver.complete(java.util.UUID,com.microsoft.azure.servicebus.TransactionContext)" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.complete(UUID lockToken, TransactionContext transaction)" name: "complete(UUID lockToken, TransactionContext transaction)" nameWithType: "IMessageReceiver.complete(UUID lockToken, TransactionContext transaction)" summary: "Completes a using its lock token." modifiers: - "abstract" parameters: - description: "Message lock token " name: "lockToken" type: "UUID" - description: " which this operation should enlist to." name: "transaction" type: "" syntax: "public abstract void complete(UUID lockToken, TransactionContext transaction)" exceptions: - description: "if the current thread was interrupted while waiting" type: "InterruptedException" - description: "if the current thread was interrupted while waiting" type: "" desc: "Completes a using its lock token. This will delete the message from the service." - uid: "com.microsoft.azure.servicebus.IMessageReceiver.completeAsync(java.util.UUID)" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.completeAsync(UUID lockToken)" name: "completeAsync(UUID lockToken)" nameWithType: "IMessageReceiver.completeAsync(UUID lockToken)" summary: "Asynchronously completes a using its lock token." modifiers: - "abstract" parameters: - description: "Message lock token " name: "lockToken" type: "UUID" syntax: "public abstract CompletableFuture completeAsync(UUID lockToken)" desc: "Asynchronously completes a using its lock token. This will delete the message from the service." returns: description: "a CompletableFuture representing the pending complete." type: "CompletableFuture<Void>" - uid: "com.microsoft.azure.servicebus.IMessageReceiver.completeAsync(java.util.UUID,com.microsoft.azure.servicebus.TransactionContext)" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.completeAsync(UUID lockToken, TransactionContext transaction)" name: "completeAsync(UUID lockToken, TransactionContext transaction)" nameWithType: "IMessageReceiver.completeAsync(UUID lockToken, TransactionContext transaction)" summary: "Asynchronously completes a using its lock token." modifiers: - "abstract" parameters: - description: "Message lock token " name: "lockToken" type: "UUID" - description: " which this operation should enlist to." name: "transaction" type: "" syntax: "public abstract CompletableFuture completeAsync(UUID lockToken, TransactionContext transaction)" desc: "Asynchronously completes a using its lock token. This will delete the message from the service." returns: description: "a CompletableFuture representing the pending complete." type: "CompletableFuture<Void>" - uid: "com.microsoft.azure.servicebus.IMessageReceiver.deadLetter(java.util.UUID)" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.deadLetter(UUID lockToken)" name: "deadLetter(UUID lockToken)" nameWithType: "IMessageReceiver.deadLetter(UUID lockToken)" summary: "Moves a to the deadletter sub-queue." modifiers: - "abstract" parameters: - description: "Message lock token " name: "lockToken" type: "UUID" syntax: "public abstract void deadLetter(UUID lockToken)" exceptions: - description: "if the current thread was interrupted while waiting" type: "InterruptedException" - description: "if the current thread was interrupted while waiting" type: "" desc: "Moves a to the deadletter sub-queue." - uid: "com.microsoft.azure.servicebus.IMessageReceiver.deadLetter(java.util.UUID,com.microsoft.azure.servicebus.TransactionContext)" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.deadLetter(UUID lockToken, TransactionContext transaction)" name: "deadLetter(UUID lockToken, TransactionContext transaction)" nameWithType: "IMessageReceiver.deadLetter(UUID lockToken, TransactionContext transaction)" summary: "Moves a to the deadletter sub-queue." modifiers: - "abstract" parameters: - description: "Message lock token " name: "lockToken" type: "UUID" - description: " which this operation should enlist to." name: "transaction" type: "" syntax: "public abstract void deadLetter(UUID lockToken, TransactionContext transaction)" exceptions: - description: "if the current thread was interrupted while waiting" type: "InterruptedException" - description: "if the current thread was interrupted while waiting" type: "" desc: "Moves a to the deadletter sub-queue." - uid: "com.microsoft.azure.servicebus.IMessageReceiver.deadLetter(java.util.UUID,java.lang.String,java.lang.String)" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.deadLetter(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription)" name: "deadLetter(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription)" nameWithType: "IMessageReceiver.deadLetter(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription)" summary: "Moves a to the deadletter sub-queue with deadletter reason and error description." modifiers: - "abstract" parameters: - description: "Message lock token " name: "lockToken" type: "UUID" - description: "The deadletter reason." name: "deadLetterReason" type: "String" - description: "The deadletter error description." name: "deadLetterErrorDescription" type: "String" syntax: "public abstract void deadLetter(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription)" exceptions: - description: "if the current thread was interrupted while waiting" type: "InterruptedException" - description: "if the current thread was interrupted while waiting" type: "" desc: "Moves a to the deadletter sub-queue with deadletter reason and error description." - uid: "com.microsoft.azure.servicebus.IMessageReceiver.deadLetter(java.util.UUID,java.lang.String,java.lang.String,com.microsoft.azure.servicebus.TransactionContext)" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.deadLetter(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, TransactionContext transaction)" name: "deadLetter(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, TransactionContext transaction)" nameWithType: "IMessageReceiver.deadLetter(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, TransactionContext transaction)" summary: "Moves a to the deadletter sub-queue with deadletter reason and error description." modifiers: - "abstract" parameters: - description: "Message lock token " name: "lockToken" type: "UUID" - description: "The deadletter reason." name: "deadLetterReason" type: "String" - description: "The deadletter error description." name: "deadLetterErrorDescription" type: "String" - description: " which this operation should enlist to." name: "transaction" type: "" syntax: "public abstract void deadLetter(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, TransactionContext transaction)" exceptions: - description: "if the current thread was interrupted while waiting" type: "InterruptedException" - description: "if the current thread was interrupted while waiting" type: "" desc: "Moves a to the deadletter sub-queue with deadletter reason and error description." - uid: "com.microsoft.azure.servicebus.IMessageReceiver.deadLetter(java.util.UUID,java.lang.String,java.lang.String,java.util.Map)" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.deadLetter(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, Map propertiesToModify)" name: "deadLetter(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, Map propertiesToModify)" nameWithType: "IMessageReceiver.deadLetter(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, Map propertiesToModify)" summary: "Moves a to the deadletter sub-queue with deadletter reason and error description and modified properties." modifiers: - "abstract" parameters: - description: "Message lock token " name: "lockToken" type: "UUID" - description: "The deadletter reason." name: "deadLetterReason" type: "String" - description: "The deadletter error description." name: "deadLetterErrorDescription" type: "String" - description: "Message properties to modify." name: "propertiesToModify" type: "Map<String,Object>" syntax: "public abstract void deadLetter(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, Map propertiesToModify)" exceptions: - description: "if the current thread was interrupted while waiting" type: "InterruptedException" - description: "if the current thread was interrupted while waiting" type: "" desc: "Moves a to the deadletter sub-queue with deadletter reason and error description and modified properties." - uid: "com.microsoft.azure.servicebus.IMessageReceiver.deadLetter(java.util.UUID,java.lang.String,java.lang.String,java.util.Map,com.microsoft.azure.servicebus.TransactionContext)" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.deadLetter(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, Map propertiesToModify, TransactionContext transaction)" name: "deadLetter(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, Map propertiesToModify, TransactionContext transaction)" nameWithType: "IMessageReceiver.deadLetter(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, Map propertiesToModify, TransactionContext transaction)" summary: "Moves a to the deadletter sub-queue with deadletter reason and error description and modified properties." modifiers: - "abstract" parameters: - description: "Message lock token " name: "lockToken" type: "UUID" - description: "The deadletter reason." name: "deadLetterReason" type: "String" - description: "The deadletter error description." name: "deadLetterErrorDescription" type: "String" - description: "Message properties to modify." name: "propertiesToModify" type: "Map<String,Object>" - description: " which this operation should enlist to." name: "transaction" type: "" syntax: "public abstract void deadLetter(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, Map propertiesToModify, TransactionContext transaction)" exceptions: - description: "if the current thread was interrupted while waiting" type: "InterruptedException" - description: "if the current thread was interrupted while waiting" type: "" desc: "Moves a to the deadletter sub-queue with deadletter reason and error description and modified properties." - uid: "com.microsoft.azure.servicebus.IMessageReceiver.deadLetter(java.util.UUID,java.util.Map)" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.deadLetter(UUID lockToken, Map propertiesToModify)" name: "deadLetter(UUID lockToken, Map propertiesToModify)" nameWithType: "IMessageReceiver.deadLetter(UUID lockToken, Map propertiesToModify)" summary: "Moves a to the deadletter sub-queue with modified message properties." modifiers: - "abstract" parameters: - description: "Message lock token " name: "lockToken" type: "UUID" - description: "Message properties to modify." name: "propertiesToModify" type: "Map<String,Object>" syntax: "public abstract void deadLetter(UUID lockToken, Map propertiesToModify)" exceptions: - description: "if the current thread was interrupted while waiting" type: "InterruptedException" - description: "if the current thread was interrupted while waiting" type: "" desc: "Moves a to the deadletter sub-queue with modified message properties." - uid: "com.microsoft.azure.servicebus.IMessageReceiver.deadLetter(java.util.UUID,java.util.Map,com.microsoft.azure.servicebus.TransactionContext)" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.deadLetter(UUID lockToken, Map propertiesToModify, TransactionContext transaction)" name: "deadLetter(UUID lockToken, Map propertiesToModify, TransactionContext transaction)" nameWithType: "IMessageReceiver.deadLetter(UUID lockToken, Map propertiesToModify, TransactionContext transaction)" summary: "Moves a to the deadletter sub-queue with modified message properties." modifiers: - "abstract" parameters: - description: "Message lock token " name: "lockToken" type: "UUID" - description: "Message properties to modify." name: "propertiesToModify" type: "Map<String,Object>" - description: " which this operation should enlist to." name: "transaction" type: "" syntax: "public abstract void deadLetter(UUID lockToken, Map propertiesToModify, TransactionContext transaction)" exceptions: - description: "if the current thread was interrupted while waiting" type: "InterruptedException" - description: "if the current thread was interrupted while waiting" type: "" desc: "Moves a to the deadletter sub-queue with modified message properties." - uid: "com.microsoft.azure.servicebus.IMessageReceiver.deadLetterAsync(java.util.UUID)" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.deadLetterAsync(UUID lockToken)" name: "deadLetterAsync(UUID lockToken)" nameWithType: "IMessageReceiver.deadLetterAsync(UUID lockToken)" summary: "Asynchronously moves a to the deadletter sub-queue with deadletter." modifiers: - "abstract" parameters: - description: "Message lock token " name: "lockToken" type: "UUID" syntax: "public abstract CompletableFuture deadLetterAsync(UUID lockToken)" desc: "Asynchronously moves a to the deadletter sub-queue with deadletter." returns: description: "a CompletableFuture representing the pending deadletter." type: "CompletableFuture<Void>" - uid: "com.microsoft.azure.servicebus.IMessageReceiver.deadLetterAsync(java.util.UUID,com.microsoft.azure.servicebus.TransactionContext)" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.deadLetterAsync(UUID lockToken, TransactionContext transaction)" name: "deadLetterAsync(UUID lockToken, TransactionContext transaction)" nameWithType: "IMessageReceiver.deadLetterAsync(UUID lockToken, TransactionContext transaction)" summary: "Asynchronously moves a to the deadletter sub-queue with deadletter." modifiers: - "abstract" parameters: - description: "Message lock token " name: "lockToken" type: "UUID" - description: " which this operation should enlist to." name: "transaction" type: "" syntax: "public abstract CompletableFuture deadLetterAsync(UUID lockToken, TransactionContext transaction)" desc: "Asynchronously moves a to the deadletter sub-queue with deadletter." returns: description: "a CompletableFuture representing the pending deadletter." type: "CompletableFuture<Void>" - uid: "com.microsoft.azure.servicebus.IMessageReceiver.deadLetterAsync(java.util.UUID,java.lang.String,java.lang.String)" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.deadLetterAsync(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription)" name: "deadLetterAsync(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription)" nameWithType: "IMessageReceiver.deadLetterAsync(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription)" summary: "Asynchronously moves a to the deadletter sub-queue with deadletter reason and error description." modifiers: - "abstract" parameters: - description: "Message lock token " name: "lockToken" type: "UUID" - description: "The deadletter reason." name: "deadLetterReason" type: "String" - description: "The deadletter error description." name: "deadLetterErrorDescription" type: "String" syntax: "public abstract CompletableFuture deadLetterAsync(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription)" desc: "Asynchronously moves a to the deadletter sub-queue with deadletter reason and error description." returns: description: "a CompletableFuture representing the pending deadletter." type: "CompletableFuture<Void>" - uid: "com.microsoft.azure.servicebus.IMessageReceiver.deadLetterAsync(java.util.UUID,java.lang.String,java.lang.String,com.microsoft.azure.servicebus.TransactionContext)" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.deadLetterAsync(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, TransactionContext transaction)" name: "deadLetterAsync(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, TransactionContext transaction)" nameWithType: "IMessageReceiver.deadLetterAsync(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, TransactionContext transaction)" summary: "Asynchronously moves a to the deadletter sub-queue with deadletter reason and error description." modifiers: - "abstract" parameters: - description: "Message lock token " name: "lockToken" type: "UUID" - description: "The deadletter reason." name: "deadLetterReason" type: "String" - description: "The deadletter error description." name: "deadLetterErrorDescription" type: "String" - description: " which this operation should enlist to." name: "transaction" type: "" syntax: "public abstract CompletableFuture deadLetterAsync(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, TransactionContext transaction)" desc: "Asynchronously moves a to the deadletter sub-queue with deadletter reason and error description." returns: description: "a CompletableFuture representing the pending deadletter." type: "CompletableFuture<Void>" - uid: "com.microsoft.azure.servicebus.IMessageReceiver.deadLetterAsync(java.util.UUID,java.lang.String,java.lang.String,java.util.Map)" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.deadLetterAsync(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, Map propertiesToModify)" name: "deadLetterAsync(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, Map propertiesToModify)" nameWithType: "IMessageReceiver.deadLetterAsync(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, Map propertiesToModify)" summary: "Asynchronously moves a to the deadletter sub-queue with deadletter reason and error description and modified properties." modifiers: - "abstract" parameters: - description: "Message lock token " name: "lockToken" type: "UUID" - description: "The deadletter reason." name: "deadLetterReason" type: "String" - description: "The deadletter error description." name: "deadLetterErrorDescription" type: "String" - description: "Message properties to modify." name: "propertiesToModify" type: "Map<String,Object>" syntax: "public abstract CompletableFuture deadLetterAsync(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, Map propertiesToModify)" desc: "Asynchronously moves a to the deadletter sub-queue with deadletter reason and error description and modified properties." returns: description: "a CompletableFuture representing the pending deadletter." type: "CompletableFuture<Void>" - uid: "com.microsoft.azure.servicebus.IMessageReceiver.deadLetterAsync(java.util.UUID,java.lang.String,java.lang.String,java.util.Map,com.microsoft.azure.servicebus.TransactionContext)" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.deadLetterAsync(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, Map propertiesToModify, TransactionContext transaction)" name: "deadLetterAsync(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, Map propertiesToModify, TransactionContext transaction)" nameWithType: "IMessageReceiver.deadLetterAsync(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, Map propertiesToModify, TransactionContext transaction)" summary: "Asynchronously moves a to the deadletter sub-queue with deadletter reason and error description and modified properties." modifiers: - "abstract" parameters: - description: "Message lock token " name: "lockToken" type: "UUID" - description: "The deadletter reason." name: "deadLetterReason" type: "String" - description: "The deadletter error description." name: "deadLetterErrorDescription" type: "String" - description: "Message properties to modify." name: "propertiesToModify" type: "Map<String,Object>" - description: " which this operation should enlist to." name: "transaction" type: "" syntax: "public abstract CompletableFuture deadLetterAsync(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, Map propertiesToModify, TransactionContext transaction)" desc: "Asynchronously moves a to the deadletter sub-queue with deadletter reason and error description and modified properties." returns: description: "a CompletableFuture representing the pending deadletter." type: "CompletableFuture<Void>" - uid: "com.microsoft.azure.servicebus.IMessageReceiver.deadLetterAsync(java.util.UUID,java.util.Map)" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.deadLetterAsync(UUID lockToken, Map propertiesToModify)" name: "deadLetterAsync(UUID lockToken, Map propertiesToModify)" nameWithType: "IMessageReceiver.deadLetterAsync(UUID lockToken, Map propertiesToModify)" summary: "Asynchronously moves a to the deadletter sub-queue with modified properties." modifiers: - "abstract" parameters: - description: "Message lock token " name: "lockToken" type: "UUID" - description: "Message properties to modify." name: "propertiesToModify" type: "Map<String,Object>" syntax: "public abstract CompletableFuture deadLetterAsync(UUID lockToken, Map propertiesToModify)" desc: "Asynchronously moves a to the deadletter sub-queue with modified properties." returns: description: "a CompletableFuture representing the pending deadletter." type: "CompletableFuture<Void>" - uid: "com.microsoft.azure.servicebus.IMessageReceiver.deadLetterAsync(java.util.UUID,java.util.Map,com.microsoft.azure.servicebus.TransactionContext)" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.deadLetterAsync(UUID lockToken, Map propertiesToModify, TransactionContext transaction)" name: "deadLetterAsync(UUID lockToken, Map propertiesToModify, TransactionContext transaction)" nameWithType: "IMessageReceiver.deadLetterAsync(UUID lockToken, Map propertiesToModify, TransactionContext transaction)" summary: "Asynchronously moves a to the deadletter sub-queue with modified properties." modifiers: - "abstract" parameters: - description: "Message lock token " name: "lockToken" type: "UUID" - description: "Message properties to modify." name: "propertiesToModify" type: "Map<String,Object>" - description: " which this operation should enlist to." name: "transaction" type: "" syntax: "public abstract CompletableFuture deadLetterAsync(UUID lockToken, Map propertiesToModify, TransactionContext transaction)" desc: "Asynchronously moves a to the deadletter sub-queue with modified properties." returns: description: "a CompletableFuture representing the pending deadletter." type: "CompletableFuture<Void>" - uid: "com.microsoft.azure.servicebus.IMessageReceiver.defer(java.util.UUID)" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.defer(UUID lockToken)" name: "defer(UUID lockToken)" nameWithType: "IMessageReceiver.defer(UUID lockToken)" summary: "Defers a using its lock token." modifiers: - "abstract" parameters: - description: "Message lock token " name: "lockToken" type: "UUID" syntax: "public abstract void defer(UUID lockToken)" exceptions: - description: "if the current thread was interrupted while waiting" type: "InterruptedException" - description: "if the current thread was interrupted while waiting" type: "" desc: "Defers a using its lock token. This will move message into deferred subqueue." - uid: "com.microsoft.azure.servicebus.IMessageReceiver.defer(java.util.UUID,com.microsoft.azure.servicebus.TransactionContext)" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.defer(UUID lockToken, TransactionContext transaction)" name: "defer(UUID lockToken, TransactionContext transaction)" nameWithType: "IMessageReceiver.defer(UUID lockToken, TransactionContext transaction)" summary: "Defers a using its lock token." modifiers: - "abstract" parameters: - description: "Message lock token " name: "lockToken" type: "UUID" - description: " which this operation should enlist to." name: "transaction" type: "" syntax: "public abstract void defer(UUID lockToken, TransactionContext transaction)" exceptions: - description: "if the current thread was interrupted while waiting" type: "InterruptedException" - description: "if the current thread was interrupted while waiting" type: "" desc: "Defers a using its lock token. This will move message into deferred subqueue." - uid: "com.microsoft.azure.servicebus.IMessageReceiver.defer(java.util.UUID,java.util.Map)" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.defer(UUID lockToken, Map propertiesToModify)" name: "defer(UUID lockToken, Map propertiesToModify)" nameWithType: "IMessageReceiver.defer(UUID lockToken, Map propertiesToModify)" summary: "Defers a using its lock token with modified message property." modifiers: - "abstract" parameters: - description: "Message lock token " name: "lockToken" type: "UUID" - description: "Message properties to modify." name: "propertiesToModify" type: "Map<String,Object>" syntax: "public abstract void defer(UUID lockToken, Map propertiesToModify)" exceptions: - description: "if the current thread was interrupted while waiting" type: "InterruptedException" - description: "if the current thread was interrupted while waiting" type: "" desc: "Defers a using its lock token with modified message property. This will move message into deferred subqueue." - uid: "com.microsoft.azure.servicebus.IMessageReceiver.defer(java.util.UUID,java.util.Map,com.microsoft.azure.servicebus.TransactionContext)" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.defer(UUID lockToken, Map propertiesToModify, TransactionContext transaction)" name: "defer(UUID lockToken, Map propertiesToModify, TransactionContext transaction)" nameWithType: "IMessageReceiver.defer(UUID lockToken, Map propertiesToModify, TransactionContext transaction)" summary: "Defers a using its lock token with modified message property." modifiers: - "abstract" parameters: - description: "Message lock token " name: "lockToken" type: "UUID" - description: "Message properties to modify." name: "propertiesToModify" type: "Map<String,Object>" - description: " which this operation should enlist to." name: "transaction" type: "" syntax: "public abstract void defer(UUID lockToken, Map propertiesToModify, TransactionContext transaction)" exceptions: - description: "if the current thread was interrupted while waiting" type: "InterruptedException" - description: "if the current thread was interrupted while waiting" type: "" desc: "Defers a using its lock token with modified message property. This will move message into deferred subqueue." - uid: "com.microsoft.azure.servicebus.IMessageReceiver.deferAsync(java.util.UUID)" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.deferAsync(UUID lockToken)" name: "deferAsync(UUID lockToken)" nameWithType: "IMessageReceiver.deferAsync(UUID lockToken)" summary: "Asynchronously defers a using its lock token." modifiers: - "abstract" parameters: - description: "Message lock token " name: "lockToken" type: "UUID" syntax: "public abstract CompletableFuture deferAsync(UUID lockToken)" desc: "Asynchronously defers a using its lock token. This will move message into deferred subqueue." returns: description: "a CompletableFuture representing the pending defer." type: "CompletableFuture<Void>" - uid: "com.microsoft.azure.servicebus.IMessageReceiver.deferAsync(java.util.UUID,com.microsoft.azure.servicebus.TransactionContext)" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.deferAsync(UUID lockToken, TransactionContext transaction)" name: "deferAsync(UUID lockToken, TransactionContext transaction)" nameWithType: "IMessageReceiver.deferAsync(UUID lockToken, TransactionContext transaction)" summary: "Asynchronously defers a using its lock token." modifiers: - "abstract" parameters: - description: "Message lock token " name: "lockToken" type: "UUID" - description: " which this operation should enlist to." name: "transaction" type: "" syntax: "public abstract CompletableFuture deferAsync(UUID lockToken, TransactionContext transaction)" desc: "Asynchronously defers a using its lock token. This will move message into deferred subqueue." returns: description: "a CompletableFuture representing the pending defer." type: "CompletableFuture<Void>" - uid: "com.microsoft.azure.servicebus.IMessageReceiver.deferAsync(java.util.UUID,java.util.Map)" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.deferAsync(UUID lockToken, Map propertiesToModify)" name: "deferAsync(UUID lockToken, Map propertiesToModify)" nameWithType: "IMessageReceiver.deferAsync(UUID lockToken, Map propertiesToModify)" summary: "Asynchronously defers a using its lock token with modified message propert." modifiers: - "abstract" parameters: - description: "Message lock token " name: "lockToken" type: "UUID" - description: "Message properties to modify." name: "propertiesToModify" type: "Map<String,Object>" syntax: "public abstract CompletableFuture deferAsync(UUID lockToken, Map propertiesToModify)" desc: "Asynchronously defers a using its lock token with modified message propert. This will move message into deferred subqueue." returns: description: "a CompletableFuture representing the pending defer." type: "CompletableFuture<Void>" - uid: "com.microsoft.azure.servicebus.IMessageReceiver.deferAsync(java.util.UUID,java.util.Map,com.microsoft.azure.servicebus.TransactionContext)" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.deferAsync(UUID lockToken, Map propertiesToModify, TransactionContext transaction)" name: "deferAsync(UUID lockToken, Map propertiesToModify, TransactionContext transaction)" nameWithType: "IMessageReceiver.deferAsync(UUID lockToken, Map propertiesToModify, TransactionContext transaction)" summary: "Asynchronously defers a using its lock token with modified message propert." modifiers: - "abstract" parameters: - description: "Message lock token " name: "lockToken" type: "UUID" - description: "Message properties to modify." name: "propertiesToModify" type: "Map<String,Object>" - description: " which this operation should enlist to." name: "transaction" type: "" syntax: "public abstract CompletableFuture deferAsync(UUID lockToken, Map propertiesToModify, TransactionContext transaction)" desc: "Asynchronously defers a using its lock token with modified message propert. This will move message into deferred subqueue." returns: description: "a CompletableFuture representing the pending defer." type: "CompletableFuture<Void>" - uid: "com.microsoft.azure.servicebus.IMessageReceiver.getPrefetchCount()" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.getPrefetchCount()" name: "getPrefetchCount()" nameWithType: "IMessageReceiver.getPrefetchCount()" summary: "Get the prefetch value set." modifiers: - "abstract" syntax: "public abstract int getPrefetchCount()" desc: "Get the prefetch value set." returns: description: "The set prefetch count value." type: "" - uid: "com.microsoft.azure.servicebus.IMessageReceiver.getReceiveMode()" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.getReceiveMode()" name: "getReceiveMode()" nameWithType: "IMessageReceiver.getReceiveMode()" summary: "Get current receiver's ." modifiers: - "abstract" syntax: "public abstract ReceiveMode getReceiveMode()" desc: "Get current receiver's ." returns: description: "" type: "" - uid: "com.microsoft.azure.servicebus.IMessageReceiver.receive()" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.receive()" name: "receive()" nameWithType: "IMessageReceiver.receive()" summary: "Receives a with default server wait time." modifiers: - "abstract" syntax: "public abstract IMessage receive()" exceptions: - description: "if the current thread was interrupted while waiting" type: "InterruptedException" - description: "if the current thread was interrupted while waiting" type: "" desc: "Receives a with default server wait time." returns: description: "The received or null if there is no message." type: "" - uid: "com.microsoft.azure.servicebus.IMessageReceiver.receive(java.time.Duration)" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.receive(Duration serverWaitTime)" name: "receive(Duration serverWaitTime)" nameWithType: "IMessageReceiver.receive(Duration serverWaitTime)" summary: "Receives a with specified server wait time." modifiers: - "abstract" parameters: - description: "The server wait time" name: "serverWaitTime" type: "Duration" syntax: "public abstract IMessage receive(Duration serverWaitTime)" exceptions: - description: "if the current thread was interrupted while waiting" type: "InterruptedException" - description: "if the current thread was interrupted while waiting" type: "" desc: "Receives a with specified server wait time." returns: description: "The received or null if there is no message." type: "" - uid: "com.microsoft.azure.servicebus.IMessageReceiver.receiveAsync()" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.receiveAsync()" name: "receiveAsync()" nameWithType: "IMessageReceiver.receiveAsync()" summary: "Receives a from Azure Service Bus." modifiers: - "abstract" syntax: "public abstract CompletableFuture receiveAsync()" desc: "Receives a from Azure Service Bus." returns: description: "The message received. Returns null if no message is found" type: "CompletableFuture<>" - uid: "com.microsoft.azure.servicebus.IMessageReceiver.receiveAsync(java.time.Duration)" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.receiveAsync(Duration serverWaitTime)" name: "receiveAsync(Duration serverWaitTime)" nameWithType: "IMessageReceiver.receiveAsync(Duration serverWaitTime)" summary: "Receives a from Azure Service Bus with server wait time." modifiers: - "abstract" parameters: - description: "The time the client waits for receiving a message before it times out." name: "serverWaitTime" type: "Duration" syntax: "public abstract CompletableFuture receiveAsync(Duration serverWaitTime)" desc: "Receives a from Azure Service Bus with server wait time." returns: description: "The message received. Returns null if no message is found" type: "CompletableFuture<>" - uid: "com.microsoft.azure.servicebus.IMessageReceiver.receiveBatch(int)" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.receiveBatch(int maxMessageCount)" name: "receiveBatch(int maxMessageCount)" nameWithType: "IMessageReceiver.receiveBatch(int maxMessageCount)" summary: "Receives a maximum of maxMessageCount from Azure Service Bus." modifiers: - "abstract" parameters: - description: "The maximum number of messages that will be received." name: "maxMessageCount" type: "" syntax: "public abstract Collection receiveBatch(int maxMessageCount)" exceptions: - description: "if the current thread was interrupted while waiting" type: "InterruptedException" - description: "if the current thread was interrupted while waiting" type: "" desc: "Receives a maximum of maxMessageCount from Azure Service Bus." returns: description: "List of messages received. Returns null if no message is found." type: "Collection<>" - uid: "com.microsoft.azure.servicebus.IMessageReceiver.receiveBatch(int,java.time.Duration)" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.receiveBatch(int maxMessageCount, Duration serverWaitTime)" name: "receiveBatch(int maxMessageCount, Duration serverWaitTime)" nameWithType: "IMessageReceiver.receiveBatch(int maxMessageCount, Duration serverWaitTime)" summary: "Receives a maximum of maxMessageCount from Azure Service Bus with server wait time." modifiers: - "abstract" parameters: - description: "The maximum number of messages that will be received." name: "maxMessageCount" type: "" - description: "The time the client waits for receiving a message before it times out." name: "serverWaitTime" type: "Duration" syntax: "public abstract Collection receiveBatch(int maxMessageCount, Duration serverWaitTime)" exceptions: - description: "if the current thread was interrupted while waiting" type: "InterruptedException" - description: "if the current thread was interrupted while waiting" type: "" desc: "Receives a maximum of maxMessageCount from Azure Service Bus with server wait time." returns: description: "List of messages received. Returns null if no message is found." type: "Collection<>" - uid: "com.microsoft.azure.servicebus.IMessageReceiver.receiveBatchAsync(int)" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.receiveBatchAsync(int maxMessageCount)" name: "receiveBatchAsync(int maxMessageCount)" nameWithType: "IMessageReceiver.receiveBatchAsync(int maxMessageCount)" summary: "Asynchronously receives a maximum of maxMessageCount from the entity." modifiers: - "abstract" parameters: - description: "The maximum number of messages that will be received." name: "maxMessageCount" type: "" syntax: "public abstract CompletableFuture> receiveBatchAsync(int maxMessageCount)" desc: "Asynchronously receives a maximum of maxMessageCount from the entity." returns: description: "a CompletableFuture representing the pending receive." type: "CompletableFuture<Collection<>>" - uid: "com.microsoft.azure.servicebus.IMessageReceiver.receiveBatchAsync(int,java.time.Duration)" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.receiveBatchAsync(int maxMessageCount, Duration serverWaitTime)" name: "receiveBatchAsync(int maxMessageCount, Duration serverWaitTime)" nameWithType: "IMessageReceiver.receiveBatchAsync(int maxMessageCount, Duration serverWaitTime)" summary: "Asynchronously receives a maximum of maxMessageCount from Azure Service Bus with server wait time." modifiers: - "abstract" parameters: - description: "The maximum number of messages that will be received." name: "maxMessageCount" type: "" - description: "The time the client waits for receiving a message before it times out." name: "serverWaitTime" type: "Duration" syntax: "public abstract CompletableFuture> receiveBatchAsync(int maxMessageCount, Duration serverWaitTime)" desc: "Asynchronously receives a maximum of maxMessageCount from Azure Service Bus with server wait time." returns: description: "a CompletableFuture representing the pending receive." type: "CompletableFuture<Collection<>>" - uid: "com.microsoft.azure.servicebus.IMessageReceiver.receiveDeferredMessage(long)" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.receiveDeferredMessage(long sequenceNumber)" name: "receiveDeferredMessage(long sequenceNumber)" nameWithType: "IMessageReceiver.receiveDeferredMessage(long sequenceNumber)" summary: "Receives a deferred ." modifiers: - "abstract" parameters: - description: "The ." name: "sequenceNumber" type: "" syntax: "public abstract IMessage receiveDeferredMessage(long sequenceNumber)" exceptions: - description: "if the current thread was interrupted while waiting" type: "InterruptedException" - description: "if the current thread was interrupted while waiting" type: "" desc: "Receives a deferred . Deferred messages can only be received by using sequence number." returns: description: "The received or null if there is no message for given sequence number." type: "" - uid: "com.microsoft.azure.servicebus.IMessageReceiver.receiveDeferredMessageAsync(long)" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.receiveDeferredMessageAsync(long sequenceNumber)" name: "receiveDeferredMessageAsync(long sequenceNumber)" nameWithType: "IMessageReceiver.receiveDeferredMessageAsync(long sequenceNumber)" summary: "Asynchronously receives a specific deferred identified by sequence number." modifiers: - "abstract" parameters: - description: "The sequence number of the message that will be received." name: "sequenceNumber" type: "" syntax: "public abstract CompletableFuture receiveDeferredMessageAsync(long sequenceNumber)" desc: "Asynchronously receives a specific deferred identified by sequence number." returns: description: "a CompletableFuture representing the pending receive." type: "CompletableFuture<>" - uid: "com.microsoft.azure.servicebus.IMessageReceiver.receiveDeferredMessageBatch(java.util.Collection)" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.receiveDeferredMessageBatch(Collection sequenceNumbers)" name: "receiveDeferredMessageBatch(Collection sequenceNumbers)" nameWithType: "IMessageReceiver.receiveDeferredMessageBatch(Collection sequenceNumbers)" summary: "Receives a batch of deferred ." modifiers: - "abstract" parameters: - description: "The sequence numbers of desired deferred messages." name: "sequenceNumbers" type: "Collection<Long>" syntax: "public abstract Collection receiveDeferredMessageBatch(Collection sequenceNumbers)" exceptions: - description: "if the current thread was interrupted while waiting" type: "InterruptedException" - description: "if the current thread was interrupted while waiting" type: "" desc: "Receives a batch of deferred ." returns: description: "List of messages received. Returns null if no message is found." type: "Collection<>" - uid: "com.microsoft.azure.servicebus.IMessageReceiver.receiveDeferredMessageBatchAsync(java.util.Collection)" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.receiveDeferredMessageBatchAsync(Collection sequenceNumbers)" name: "receiveDeferredMessageBatchAsync(Collection sequenceNumbers)" nameWithType: "IMessageReceiver.receiveDeferredMessageBatchAsync(Collection sequenceNumbers)" summary: "Asynchronously receives a set of deferred from the entity." modifiers: - "abstract" parameters: - description: "The sequence numbers of the message that will be received." name: "sequenceNumbers" type: "Collection<Long>" syntax: "public abstract CompletableFuture> receiveDeferredMessageBatchAsync(Collection sequenceNumbers)" desc: "Asynchronously receives a set of deferred from the entity." returns: description: "a CompletableFuture representing the pending receive." type: "CompletableFuture<Collection<>>" - uid: "com.microsoft.azure.servicebus.IMessageReceiver.renewMessageLock(com.microsoft.azure.servicebus.IMessage)" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.renewMessageLock(IMessage message)" name: "renewMessageLock(IMessage message)" nameWithType: "IMessageReceiver.renewMessageLock(IMessage message)" summary: "Renews the lock on the message specified by the lock token." modifiers: - "abstract" parameters: - description: "The to be renewed" name: "message" type: "" syntax: "public abstract Instant renewMessageLock(IMessage message)" exceptions: - description: "if the current thread was interrupted while waiting" type: "InterruptedException" - description: "if the current thread was interrupted while waiting" type: "" desc: "Renews the lock on the message specified by the lock token. The lock will be renewed based on the setting specified on the entity. When a message is received in 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, the lock is reset to the entity's LockDuration value." returns: description: "The new locked until UTC time." type: "Instant" - uid: "com.microsoft.azure.servicebus.IMessageReceiver.renewMessageLock(java.util.UUID)" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.renewMessageLock(UUID lockToken)" name: "renewMessageLock(UUID lockToken)" nameWithType: "IMessageReceiver.renewMessageLock(UUID lockToken)" summary: "Renews the lock on the message specified by the lock token." modifiers: - "abstract" parameters: - description: "Message lock token " name: "lockToken" type: "UUID" syntax: "public abstract Instant renewMessageLock(UUID lockToken)" exceptions: - description: "if the current thread was interrupted while waiting" type: "InterruptedException" - description: "if the current thread was interrupted while waiting" type: "" desc: "Renews the lock on the message specified by the lock token. The lock will be renewed based on the setting specified on the entity. When a message is received in 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, the lock is reset to the entity's LockDuration value. Note - calling this will not update and updated lockedUntilUtc must be tracked by the application." returns: description: "The new locked until UTC time." type: "Instant" - uid: "com.microsoft.azure.servicebus.IMessageReceiver.renewMessageLockAsync(com.microsoft.azure.servicebus.IMessage)" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.renewMessageLockAsync(IMessage message)" name: "renewMessageLockAsync(IMessage message)" nameWithType: "IMessageReceiver.renewMessageLockAsync(IMessage message)" summary: "Asynchronously renews the lock on the message specified by the lock token." modifiers: - "abstract" parameters: - description: "The to be renewed" name: "message" type: "" syntax: "public abstract CompletableFuture renewMessageLockAsync(IMessage message)" desc: "Asynchronously renews the lock on the message specified by the lock token. The lock will be renewed based on the setting specified on the entity. When a message is received in 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, the lock is reset to the entity's LockDuration value." returns: description: "a CompletableFuture representing the pending renew." type: "CompletableFuture<Instant>" - uid: "com.microsoft.azure.servicebus.IMessageReceiver.renewMessageLockAsync(java.util.UUID)" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.renewMessageLockAsync(UUID lockToken)" name: "renewMessageLockAsync(UUID lockToken)" nameWithType: "IMessageReceiver.renewMessageLockAsync(UUID lockToken)" summary: "Renews the lock on the message specified by the lock token." modifiers: - "abstract" parameters: - description: "Message lock token " name: "lockToken" type: "UUID" syntax: "public abstract CompletableFuture renewMessageLockAsync(UUID lockToken)" desc: "Renews the lock on the message specified by the lock token. The lock will be renewed based on the setting specified on the entity. When a message is received in 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, the lock is reset to the entity's LockDuration value. Note - calling this will not update and updated lockedUntilUtc must be tracked by the application." returns: description: "a CompletableFuture representing the pending renew." type: "CompletableFuture<Instant>" - uid: "com.microsoft.azure.servicebus.IMessageReceiver.setPrefetchCount(int)" fullName: "com.microsoft.azure.servicebus.IMessageReceiver.setPrefetchCount(int prefetchCount)" name: "setPrefetchCount(int prefetchCount)" nameWithType: "IMessageReceiver.setPrefetchCount(int prefetchCount)" summary: "Set the prefetch count of the receiver." modifiers: - "abstract" parameters: - description: "The desired prefetch count." name: "prefetchCount" type: "" syntax: "public abstract void setPrefetchCount(int prefetchCount)" exceptions: - description: "if sets the value failed" type: "" desc: "Set the prefetch count of the receiver. Prefetch speeds up the message flow by aiming to have a message readily available for local retrieval when and before the application asks for one using Receive. Setting a non-zero value prefetches PrefetchCount number of messages. Setting the value to zero turns prefetch off. For both PEEKLOCK mode and RECEIVEANDDELETE mode, the default value is 0.\n\nThe value cannot be set until the receiver is created." type: "interface" desc: "Defines message receiver interface. The MessageReceiver can be used to receive messages from Queues and Subscriptions and acknowledge them." implements: - "" - "" metadata: {} package: "com.microsoft.azure.servicebus" artifact: com.microsoft.azure:azure-servicebus:3.6.7