ServiceBusReceiver interface

Sökväg till den entitet som mottagaren har skapats för.

entityPath: string

Egenskapsvärde

Ett namn som används för att identifiera mottagaren. Detta kan användas för att korrelera loggar och undantag. Om det inte anges eller är tomt genereras en slumpmässig unik.

identifier: string

Egenskapsvärde

Returnerar true om mottagaren eller klienten som skapade den har stängts.

isClosed: boolean

Egenskapsvärde

Mottagningsläget som används för att skapa mottagaren.

receiveMode: "peekLock" | "receiveAndDelete"

Egenskapsvärde

Låset som hålls på meddelandet av mottagaren släpps, vilket gör meddelandet tillgängligt igen i Service Bus för en annan mottagningsåtgärd.

function abandonMessage(message: ServiceBusReceivedMessage, propertiesToModify?: {[key: string]: number | boolean | string | Date | null}): Promise<void>

Parametrar

Returer

Stänger mottagaren. När mottagaren har stängts kan den inte användas för ytterligare åtgärder. Använd metoden createReceiver() på ServiceBusClient för att skapa en ny mottagare.

function close(): Promise<void>

Returer

Tar bort meddelandet från Service Bus.

function completeMessage(message: ServiceBusReceivedMessage): Promise<void>

Parametrar

Returer

Flyttar meddelandet till underkön deadletter. Om du vill ta emot ett deadletted-meddelande skapar du en ny QueueClient/SubscriptionClient med hjälp av sökvägen för underkön deadletter.

function deadLetterMessage(message: ServiceBusReceivedMessage, options?: DeadLetterOptions & {[key: string]: number | boolean | string | Date | null}): Promise<void>

Parametrar

Returer

Defers bearbetningen av meddelandet. Spara meddelandets sequenceNumber för att kunna ta emot meddelandet igen i framtiden med hjälp av metoden receiveDeferredMessage.

function deferMessage(message: ServiceBusReceivedMessage, propertiesToModify?: {[key: string]: number | boolean | string | Date | null}): Promise<void>

Parametrar

Returer

Returnerar en iterator som kan användas för att ta emot meddelanden från Service Bus.

function getMessageIterator(options?: GetMessageIteratorOptions): AsyncIterableIterator<ServiceBusReceivedMessage>

Parametrar

Returer

Granska nästa batch med aktiva meddelanden (inklusive uppskjutna men inte döda meddelanden) i kön eller prenumerationen utan att ändra dem.

• Det första anropet till peekMessages() hämtar det första aktiva meddelandet. Varje efterföljande anrop hämtar det efterföljande meddelandet.
• Till skillnad från ett "mottaget" meddelande är "peeked"-meddelandet en skrivskyddad version av meddelandet. Det kan inte vara Completed/Abandoned/Deferred/Deadlettered.

function peekMessages(maxMessageCount: number, options?: PeekMessagesOptions): Promise<ServiceBusReceivedMessage[]>

Parametrar

Returer

Returnerar ett löfte som matchar en matris med uppskjutna meddelanden som identifieras av angiven sequenceNumbers.

function receiveDeferredMessages(sequenceNumbers: Long | Long[], options?: OperationOptionsBase): Promise<ServiceBusReceivedMessage[]>

Parametrar

Returer

En lista över meddelanden som identifieras av den angivna sekvensenNumbers eller en tom lista om inga meddelanden hittas.

Returnerar ett löfte som matchar en matris med meddelanden som tas emot från Service Bus.

function receiveMessages(maxMessageCount: number, options?: ReceiveMessagesOptions): Promise<ServiceBusReceivedMessage[]>

Parametrar

Returer

Ett löfte som matchar med en matris med meddelanden.

Förnyar låset på meddelandet under den tid som anges när kön/prenumerationen skapas.

• Kontrollera lockedUntilUtc-egenskapen i meddelandet för den tid då låset upphör att gälla.
• Om ett meddelande inte har lösts (med antingen complete(), defer() eller deadletter(), innan låset upphör att gälla, hamnar meddelandet i kön/prenumerationen för nästa mottagningsåtgärd.

function renewMessageLock(message: ServiceBusReceivedMessage): Promise<Date>

Parametrar

Returer

Nytt datum och tid för förfallodatum för låstoken i UTC-format.

Strömmar meddelanden till meddelandehanterare.

function subscribe(handlers: MessageHandlers, options?: SubscribeOptions): { close() => Promise<void> }

Parametrar

Returer

Ett objekt som kan stängas, skicka eventuella återstående meddelanden till handlers och stoppa nya meddelanden från att komma in.