ServiceBusReceiver interface

Paket:

@azure/service-bus

En mottagare som inte hanterar sessioner.

Egenskaper

entityPath	Sökvägen till entiteten som mottagaren har skapats för.
identifier	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.
isClosed	Returnerar true om mottagaren eller klienten som skapade den har stängts.
receiveMode	Mottagningsläget som används för att skapa mottagaren.

Metoder

abandonMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})	Låset som hålls kvar på meddelandet av mottagaren släpps, vilket gör meddelandet tillgängligt igen i Service Bus för en annan mottagningsåtgärd.
close()	Stänger mottagaren. När den har stängts kan mottagaren inte användas för ytterligare åtgärder. createReceiver() Använd metoden på ServiceBusClient för att skapa en ny mottagare.
completeMessage(ServiceBusReceivedMessage)	Tar bort meddelandet från Service Bus.
deadLetterMessage(ServiceBusReceivedMessage, DeadLetterOptions & {[key: string]: number | boolean | string | Date | null})	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 till underkön deadletter.
deferMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})	Skjuter upp bearbetningen av meddelandet. sequenceNumber Spara meddelandet för att kunna ta emot det igen i framtiden med hjälp av receiveDeferredMessage metoden .
getMessageIterator(GetMessageIteratorOptions)	Returnerar en iterator som kan användas för att ta emot meddelanden från Service Bus.
peekMessages(number, PeekMessagesOptions)	Granska nästa batch med aktiva meddelanden (inklusive uppskjutna men inte obeställbara 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 får inte vara Completed/Abandoned/Deferred/Deadlettered.
receiveDeferredMessages(Long | Long[], OperationOptionsBase)	Returnerar ett löfte som matchar till en matris med uppskjutna meddelanden som identifieras av angivet sequenceNumbers.
receiveMessages(number, ReceiveMessagesOptions)	Returnerar ett löfte som matchar en matris med meddelanden som tas emot från Service Bus.
renewMessageLock(ServiceBusReceivedMessage)	Förnyar låset på meddelandet under den tid som anges när kön/prenumerationen skapas. lockedUntilUtc Kontrollera egenskapen för 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.
subscribe(MessageHandlers, SubscribeOptions)	Strömmar meddelanden till meddelandehanterare.

Egenskapsinformation

entityPath

Sökvägen till entiteten som mottagaren har skapats för.

entityPath: string

Egenskapsvärde

string

identifier

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

string

isClosed

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

isClosed: boolean

Egenskapsvärde

boolean

receiveMode

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

receiveMode: "peekLock" | "receiveAndDelete"

Egenskapsvärde

"peekLock" | "receiveAndDelete"

Metodinformation

abandonMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})

Låset som hålls kvar 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

message

ServiceBusReceivedMessage

propertiesToModify

{[key: string]: number | boolean | string | Date | null}

Egenskaperna för meddelandet som ska ändras när meddelandet överges.

Returer

Promise<void>

close()

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

function close(): Promise<void>

Returer

Promise<void>

completeMessage(ServiceBusReceivedMessage)

Tar bort meddelandet från Service Bus.

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

Parametrar

message

ServiceBusReceivedMessage

Returer

Promise<void>

deadLetterMessage(ServiceBusReceivedMessage, DeadLetterOptions & {[key: string]: number | boolean | string | Date | null})

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 till underkön deadletter.

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

Parametrar

message

ServiceBusReceivedMessage

options

DeadLetterOptions & {[key: string]: number | boolean | string | Date | null}

De DeadLetter-alternativ som kan anges när meddelandet avvisas.

Returer

Promise<void>

deferMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})

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

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

Parametrar

message

ServiceBusReceivedMessage

propertiesToModify

{[key: string]: number | boolean | string | Date | null}

Egenskaperna för meddelandet som ska ändras när meddelandet skjuts upp

Returer

Promise<void>

getMessageIterator(GetMessageIteratorOptions)

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

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

Parametrar

options

GetMessageIteratorOptions

En uppsättning alternativ för att styra mottagningsåtgärden.

• abortSignal: Signalen som ska användas för att avbryta den pågående åtgärden.

Returer

AsyncIterableIterator<ServiceBusReceivedMessage>

peekMessages(number, PeekMessagesOptions)

Granska nästa batch med aktiva meddelanden (inklusive uppskjutna men inte obeställbara 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 får inte vara Completed/Abandoned/Deferred/Deadlettered.

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

Parametrar

maxMessageCount

number

Det maximala antalet meddelanden att granska.

options

PeekMessagesOptions

Alternativ som gör det möjligt att ange det maximala antalet meddelanden att granska, sekvensNumber att börja granska från eller en abortSignal för att avbryta åtgärden.

Returer

Promise<ServiceBusReceivedMessage[]>

receiveDeferredMessages(Long | Long[], OperationOptionsBase)

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

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

Parametrar

sequenceNumbers

Long | Long[]

Sekvensnumret eller en matris med sekvensnummer för de meddelanden som måste tas emot.

options

OperationOptionsBase

Alternativ påse för att skicka en avbruten signal eller spårningsalternativ.

Returer

Promise<ServiceBusReceivedMessage[]>

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

receiveMessages(number, ReceiveMessagesOptions)

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

maxMessageCount

number

Det maximala antalet meddelanden som ska ta emot.

options

ReceiveMessagesOptions

En uppsättning alternativ för att styra mottagningsåtgärden.

• maxWaitTimeInMs: Den maximala väntetiden för det första meddelandet innan du returnerar en tom matris om inga meddelanden är tillgängliga.
• abortSignal: Signalen som ska användas för att avbryta den pågående åtgärden.

Returer

Promise<ServiceBusReceivedMessage[]>

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

renewMessageLock(ServiceBusReceivedMessage)

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

• lockedUntilUtc Kontrollera egenskapen för 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

message

ServiceBusReceivedMessage

Returer

Promise<Date>

Nytt utgångsdatum och tid för låstoken i UTC-format.

subscribe(MessageHandlers, SubscribeOptions)

Strömmar meddelanden till meddelandehanterare.

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

Parametrar

handlers

MessageHandlers

En hanterare som anropas för meddelanden och fel.

options

SubscribeOptions

Alternativ för prenumeration.

Returer

{ close() => Promise<void> }

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