ServiceBusReceiver interface

Pakket:

@azure/service-bus

Een ontvanger die geen sessies afhandelt.

Eigenschappen

entityPath	Pad van de entiteit waarvoor de ontvanger is gemaakt.
identifier	Een naam die wordt gebruikt om de ontvanger te identificeren. Dit kan worden gebruikt om logboeken en uitzonderingen te correleren. Als dit niet is opgegeven of leeg is, wordt er een willekeurige unieke gegenereerd.
isClosed	Retourneert true als de ontvanger of de client die deze heeft gemaakt, is gesloten.
receiveMode	De ontvangstmodus die wordt gebruikt om de ontvanger te maken.

Methoden

abandonMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})	De vergrendeling die door de ontvanger op het bericht is vastgehouden, wordt losgelaten, waardoor het bericht weer beschikbaar is in Service Bus voor een andere ontvangstbewerking.
close()	Sluit de ontvanger. Eenmaal gesloten, kan de ontvanger niet meer worden gebruikt voor verdere bewerkingen. Gebruik de createReceiver() methode op de ServiceBusClient om een nieuwe ontvanger te maken.
completeMessage(ServiceBusReceivedMessage)	Hiermee verwijdert u het bericht uit Service Bus.
deadLetterMessage(ServiceBusReceivedMessage, DeadLetterOptions & {[key: string]: number | boolean | string | Date | null})	Hiermee verplaatst u het bericht naar de subwachtrij voor onbestelbare berichten. Als u een vastgelopen bericht wilt ontvangen, maakt u een nieuwe QueueClient/SubscriptionClient met behulp van het pad voor de subwachtrij voor deadletters.
deferMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})	De verwerking van het bericht wordt uitstellen. Sla de sequenceNumber van het bericht op om het bericht in de toekomst opnieuw te ontvangen met behulp van de receiveDeferredMessage -methode.
getMessageIterator(GetMessageIteratorOptions)	Retourneert een iterator die kan worden gebruikt om berichten van Service Bus te ontvangen.
peekMessages(number, PeekMessagesOptions)	Bekijk de volgende batch actieve berichten (inclusief uitgestelde maar niet-vastgelopen berichten) in de wachtrij of het abonnement zonder deze te wijzigen. Met de eerste aanroep wordt peekMessages() het eerste actieve bericht opgehaald. Bij elke volgende aanroep wordt het volgende bericht opgehaald. In tegenstelling tot een 'ontvangen' bericht is een 'gekeken' bericht een alleen-lezen versie van het bericht. Dit kan niet zijn Completed/Abandoned/Deferred/Deadlettered.
receiveDeferredMessages(Long | Long[], OperationOptionsBase)	Retourneert een belofte die wordt omgezet in een matrix met uitgestelde berichten die zijn geïdentificeerd door de opgegeven sequenceNumbers.
receiveMessages(number, ReceiveMessagesOptions)	Retourneert een belofte die wordt omgezet in een matrix van berichten die zijn ontvangen van Service Bus.
renewMessageLock(ServiceBusReceivedMessage)	Hiermee wordt de vergrendeling van het bericht verlengd voor de duur die is opgegeven tijdens het maken van de wachtrij/het abonnement. Controleer de lockedUntilUtc eigenschap in het bericht op het tijdstip waarop de vergrendeling verloopt. Als een bericht niet is vereffend (met behulp van complete(), defer() of deadletter(), voordat de vergrendeling verloopt, komt het bericht terug in de wachtrij/het abonnement voor de volgende ontvangstbewerking.
subscribe(MessageHandlers, SubscribeOptions)	Hiermee worden berichten naar berichtenhandlers gestreamd.

Eigenschapdetails

entityPath

Pad van de entiteit waarvoor de ontvanger is gemaakt.

entityPath: string

Waarde van eigenschap

string

identifier

Een naam die wordt gebruikt om de ontvanger te identificeren. Dit kan worden gebruikt om logboeken en uitzonderingen te correleren. Als dit niet is opgegeven of leeg is, wordt er een willekeurige unieke gegenereerd.

identifier: string

Waarde van eigenschap

string

isClosed

Retourneert true als de ontvanger of de client die deze heeft gemaakt, is gesloten.

isClosed: boolean

Waarde van eigenschap

boolean

receiveMode

De ontvangstmodus die wordt gebruikt om de ontvanger te maken.

receiveMode: "peekLock" | "receiveAndDelete"

Waarde van eigenschap

"peekLock" | "receiveAndDelete"

Methodedetails

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

De vergrendeling die door de ontvanger op het bericht is vastgehouden, wordt losgelaten, waardoor het bericht weer beschikbaar is in Service Bus voor een andere ontvangstbewerking.

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

Parameters

message

ServiceBusReceivedMessage

propertiesToModify

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

De eigenschappen van het bericht dat moet worden gewijzigd tijdens het verlaten van het bericht.

Retouren

Promise<void>

close()

Sluit de ontvanger. Eenmaal gesloten, kan de ontvanger niet meer worden gebruikt voor verdere bewerkingen. Gebruik de createReceiver() methode op de ServiceBusClient om een nieuwe ontvanger te maken.

function close(): Promise<void>

Retouren

Promise<void>

completeMessage(ServiceBusReceivedMessage)

Hiermee verwijdert u het bericht uit Service Bus.

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

Parameters

message

ServiceBusReceivedMessage

Retouren

Promise<void>

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

Hiermee verplaatst u het bericht naar de subwachtrij voor onbestelbare berichten. Als u een vastgelopen bericht wilt ontvangen, maakt u een nieuwe QueueClient/SubscriptionClient met behulp van het pad voor de subwachtrij voor deadletters.

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

Parameters

message

ServiceBusReceivedMessage

options

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

De DeadLetter-opties die kunnen worden opgegeven tijdens het weigeren van het bericht.

Retouren

Promise<void>

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

De verwerking van het bericht wordt uitstellen. Sla de sequenceNumber van het bericht op om het bericht in de toekomst opnieuw te ontvangen met behulp van de receiveDeferredMessage -methode.

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

Parameters

message

ServiceBusReceivedMessage

propertiesToModify

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

De eigenschappen van het bericht dat moet worden gewijzigd tijdens het uitstellen van het bericht

Retouren

Promise<void>

getMessageIterator(GetMessageIteratorOptions)

Retourneert een iterator die kan worden gebruikt om berichten van Service Bus te ontvangen.

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

Parameters

options

GetMessageIteratorOptions

Een set opties voor het beheren van de ontvangstbewerking.

• abortSignal: Het signaal dat moet worden gebruikt om de lopende bewerking af te breken.

Retouren

AsyncIterableIterator<ServiceBusReceivedMessage>

peekMessages(number, PeekMessagesOptions)

Bekijk de volgende batch actieve berichten (inclusief uitgestelde maar niet-vastgelopen berichten) in de wachtrij of het abonnement zonder deze te wijzigen.

• Met de eerste aanroep wordt peekMessages() het eerste actieve bericht opgehaald. Bij elke volgende aanroep wordt het volgende bericht opgehaald.
• In tegenstelling tot een 'ontvangen' bericht is een 'gekeken' bericht een alleen-lezen versie van het bericht. Dit kan niet zijn Completed/Abandoned/Deferred/Deadlettered.

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

Parameters

maxMessageCount

number

Het maximum aantal berichten om te bekijken.

options

PeekMessagesOptions

Opties waarmee u het maximum aantal berichten kunt opgeven om te bekijken, het sequenceNumber om te beginnen met het bekijken van of een abortSignal om de bewerking af te breken.

Retouren

Promise<ServiceBusReceivedMessage[]>

receiveDeferredMessages(Long | Long[], OperationOptionsBase)

Retourneert een belofte die wordt omgezet in een matrix met uitgestelde berichten die zijn geïdentificeerd door de opgegeven sequenceNumbers.

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

Parameters

sequenceNumbers

Long | Long[]

Het volgnummer of een matrix met volgnummers voor de berichten die moeten worden ontvangen.

options

OperationOptionsBase

Optieszak om een aortsignaal of traceringsopties door te geven.

Retouren

Promise<ServiceBusReceivedMessage[]>

Een lijst met berichten die worden geïdentificeerd door de opgegeven sequenceNumbers of een lege lijst als er geen berichten worden gevonden.

receiveMessages(number, ReceiveMessagesOptions)

Retourneert een belofte die wordt omgezet in een matrix van berichten die zijn ontvangen van Service Bus.

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

Parameters

maxMessageCount

number

Het maximum aantal berichten dat moet worden ontvangen.

options

ReceiveMessagesOptions

Een set opties voor het beheren van de ontvangstbewerking.

• maxWaitTimeInMs: de maximale tijd om te wachten op het eerste bericht voordat een lege matrix wordt geretourneerd als er geen berichten beschikbaar zijn.
• abortSignal: Het signaal dat moet worden gebruikt om de lopende bewerking af te breken.

Retouren

Promise<ServiceBusReceivedMessage[]>

Een belofte die wordt omgezet met een matrix van berichten.

renewMessageLock(ServiceBusReceivedMessage)

Hiermee wordt de vergrendeling van het bericht verlengd voor de duur die is opgegeven tijdens het maken van de wachtrij/het abonnement.

• Controleer de lockedUntilUtc eigenschap in het bericht op het tijdstip waarop de vergrendeling verloopt.
• Als een bericht niet is vereffend (met behulp van complete(), defer() of deadletter(), voordat de vergrendeling verloopt, komt het bericht terug in de wachtrij/het abonnement voor de volgende ontvangstbewerking.

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

Parameters

message

ServiceBusReceivedMessage

Retouren

Promise<Date>

De vervaldatum en -tijd van het nieuwe vergrendelingstoken in UTC-indeling.

subscribe(MessageHandlers, SubscribeOptions)

Hiermee worden berichten naar berichtenhandlers gestreamd.

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

Parameters

handlers

MessageHandlers

Een handler die wordt aangeroepen voor berichten en fouten.

options

SubscribeOptions

Opties voor abonneren.

Retouren

{ close() => Promise<void> }

Een object dat kan worden gesloten, eventuele resterende berichten naar handlers verzenden en voorkomen dat nieuwe berichten binnenkomen.