ServiceBusReceiver interface

Pakiet:

@azure/service-bus

Odbiornik, który nie obsługuje sesji.

Właściwości

entityPath	Ścieżka jednostki, dla której utworzono odbiornik.
identifier	Nazwa używana do identyfikowania odbiorcy. Może to służyć do korelowania dzienników i wyjątków. Jeśli nie zostanie określony lub pusty, zostanie wygenerowany losowy unikatowy.
isClosed	Zwraca wartość true , jeśli odbiornik lub klient, który go utworzył, został zamknięty.
receiveMode	Tryb odbierania używany do tworzenia odbiornika.

Metody

abandonMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})	Blokada przechowywana w komunikacie przez odbiornik zostaje wypuszczana, co powoduje ponowne udostępnienie komunikatu w usłudze Service Bus dla innej operacji odbierania.
close()	Zamyka odbiornik. Po zamknięciu odbiornik nie może być używany do dalszych operacji. createReceiver() Użyj metody w obiekcie ServiceBusClient, aby utworzyć nowy odbiornik.
completeMessage(ServiceBusReceivedMessage)	Usuwa komunikat z usługi Service Bus.
deadLetterMessage(ServiceBusReceivedMessage, DeadLetterOptions & {[key: string]: number | boolean | string | Date | null})	Przenosi komunikat do kolejki podrzędnej deadletter. Aby otrzymać utracony komunikat, utwórz nowy element QueueClient/SubscriptionClient przy użyciu ścieżki dla kolejki podrzędnej deadletter.
deferMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})	Odchyli przetwarzanie komunikatu. sequenceNumber Zapisz komunikat w celu ponownego odebrania go w przyszłości przy użyciu receiveDeferredMessage metody .
getMessageIterator(GetMessageIteratorOptions)	Zwraca iterator, który może służyć do odbierania komunikatów z usługi Service Bus.
peekMessages(number, PeekMessagesOptions)	Zobacz następną partię aktywnych komunikatów (w tym odroczonych, ale nie utraconych komunikatów) w kolejce lub subskrypcji bez ich modyfikowania. Pierwsze wywołanie w celu peekMessages() pobrania pierwszej aktywnej wiadomości. Każde kolejne wywołanie pobiera kolejną wiadomość. W przeciwieństwie do komunikatu "odebranego", komunikat "podgląd" jest wersją komunikatu tylko do odczytu. Nie może to być Completed/Abandoned/Deferred/Deadlettered.
receiveDeferredMessages(Long | Long[], OperationOptionsBase)	Zwraca obietnicę, która jest rozpoznawana jako tablica odroczonych komunikatów zidentyfikowanych przez daną sequenceNumberswartość .
receiveMessages(number, ReceiveMessagesOptions)	Zwraca obietnicę, która jest rozpoznawana jako tablica komunikatów odebranych z usługi Service Bus.
renewMessageLock(ServiceBusReceivedMessage)	Odnawia blokadę komunikatu przez czas trwania określony podczas tworzenia kolejki/subskrypcji. lockedUntilUtc Sprawdź właściwość w komunikacie o czasie wygaśnięcia blokady. Jeśli komunikat nie zostanie rozstrzygnięty (przy użyciu complete()polecenia lub defer() , przed deadletter()wygaśnięciem blokady, komunikat zostanie ponownie wyświetlony w kolejce/subskrypcji dla następnej operacji odbierania.
subscribe(MessageHandlers, SubscribeOptions)	Przesyła strumieniowo komunikaty do programów obsługi komunikatów.

Szczegóły właściwości

entityPath

Ścieżka jednostki, dla której utworzono odbiornik.

entityPath: string

Wartość właściwości

string

identifier

Nazwa używana do identyfikowania odbiorcy. Może to służyć do korelowania dzienników i wyjątków. Jeśli nie zostanie określony lub pusty, zostanie wygenerowany losowy unikatowy.

identifier: string

Wartość właściwości

string

isClosed

Zwraca wartość true , jeśli odbiornik lub klient, który go utworzył, został zamknięty.

isClosed: boolean

Wartość właściwości

boolean

receiveMode

Tryb odbierania używany do tworzenia odbiornika.

receiveMode: "peekLock" | "receiveAndDelete"

Wartość właściwości

"peekLock" | "receiveAndDelete"

Szczegóły metody

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

Blokada przechowywana w komunikacie przez odbiornik zostaje wypuszczana, co powoduje ponowne udostępnienie komunikatu w usłudze Service Bus dla innej operacji odbierania.

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

Parametry

message

ServiceBusReceivedMessage

propertiesToModify

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

Właściwości komunikatu do zmodyfikowania podczas porzucania komunikatu.

Zwraca

Promise<void>

close()

Zamyka odbiornik. Po zamknięciu odbiornik nie może być używany do dalszych operacji. createReceiver() Użyj metody w obiekcie ServiceBusClient, aby utworzyć nowy odbiornik.

function close(): Promise<void>

Zwraca

Promise<void>

completeMessage(ServiceBusReceivedMessage)

Usuwa komunikat z usługi Service Bus.

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

Parametry

message

ServiceBusReceivedMessage

Zwraca

Promise<void>

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

Przenosi komunikat do kolejki podrzędnej deadletter. Aby otrzymać utracony komunikat, utwórz nowy element QueueClient/SubscriptionClient przy użyciu ścieżki dla kolejki podrzędnej deadletter.

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

Parametry

message

ServiceBusReceivedMessage

options

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

Opcje DeadLetter, które można podać podczas odrzucania wiadomości.

Zwraca

Promise<void>

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

Odchyli przetwarzanie komunikatu. sequenceNumber Zapisz komunikat w celu ponownego odebrania go w przyszłości przy użyciu receiveDeferredMessage metody .

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

Parametry

message

ServiceBusReceivedMessage

propertiesToModify

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

Właściwości komunikatu do zmodyfikowania podczas odroczenia komunikatu

Zwraca

Promise<void>

getMessageIterator(GetMessageIteratorOptions)

Zwraca iterator, który może służyć do odbierania komunikatów z usługi Service Bus.

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

Parametry

options

GetMessageIteratorOptions

Zestaw opcji do kontrolowania operacji odbierania.

• abortSignal: Sygnał używany do przerwania trwającej operacji.

Zwraca

AsyncIterableIterator<ServiceBusReceivedMessage>

peekMessages(number, PeekMessagesOptions)

Zobacz następną partię aktywnych komunikatów (w tym odroczonych, ale nie utraconych komunikatów) w kolejce lub subskrypcji bez ich modyfikowania.

• Pierwsze wywołanie w celu peekMessages() pobrania pierwszej aktywnej wiadomości. Każde kolejne wywołanie pobiera kolejną wiadomość.
• W przeciwieństwie do komunikatu "odebranego", komunikat "podgląd" jest wersją komunikatu tylko do odczytu. Nie może to być Completed/Abandoned/Deferred/Deadlettered.

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

Parametry

maxMessageCount

number

Maksymalna liczba komunikatów do wglądu.

options

PeekMessagesOptions

Opcje, które umożliwiają określenie maksymalnej liczby komunikatów do zajrzeć, sekwencjiNumber rozpocząć podgląd z lub przerwanieSignal przerwać operację.

Zwraca

Promise<ServiceBusReceivedMessage[]>

receiveDeferredMessages(Long | Long[], OperationOptionsBase)

Zwraca obietnicę, która jest rozpoznawana jako tablica odroczonych komunikatów zidentyfikowanych przez daną sequenceNumberswartość .

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

Parametry

sequenceNumbers

Long | Long[]

Numer sekwencji lub tablica numerów sekwencji dla komunikatów, które muszą zostać odebrane.

options

OperationOptionsBase

Opcje torbę do przekazania przerwania sygnału lub opcji śledzenia.

Zwraca

Promise<ServiceBusReceivedMessage[]>

Lista komunikatów zidentyfikowanych przez daną sekwencjęNumbers lub pusta lista, jeśli nie znaleziono żadnych komunikatów.

receiveMessages(number, ReceiveMessagesOptions)

Zwraca obietnicę, która jest rozpoznawana jako tablica komunikatów odebranych z usługi Service Bus.

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

Parametry

maxMessageCount

number

Maksymalna liczba komunikatów do odebrania.

options

ReceiveMessagesOptions

Zestaw opcji do kontrolowania operacji odbierania.

• maxWaitTimeInMs: maksymalny czas oczekiwania na pierwszy komunikat przed zwróceniem pustej tablicy, jeśli komunikaty nie są dostępne.
• abortSignal: Sygnał używany do przerwania trwającej operacji.

Zwraca

Promise<ServiceBusReceivedMessage[]>

Obietnica, która rozwiązuje problem z tablicą komunikatów.

renewMessageLock(ServiceBusReceivedMessage)

Odnawia blokadę komunikatu przez czas trwania określony podczas tworzenia kolejki/subskrypcji.

• lockedUntilUtc Sprawdź właściwość w komunikacie o czasie wygaśnięcia blokady.
• Jeśli komunikat nie zostanie rozstrzygnięty (przy użyciu complete()polecenia lub defer() , przed deadletter()wygaśnięciem blokady, komunikat zostanie ponownie wyświetlony w kolejce/subskrypcji dla następnej operacji odbierania.

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

Parametry

message

ServiceBusReceivedMessage

Zwraca

Promise<Date>

Nowa data i godzina wygaśnięcia tokenu blokady w formacie UTC.

subscribe(MessageHandlers, SubscribeOptions)

Przesyła strumieniowo komunikaty do programów obsługi komunikatów.

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

Parametry

handlers

MessageHandlers

Procedura obsługi, która jest wywoływana dla komunikatów i błędów.

options

SubscribeOptions

Opcje subskrypcji.

Zwraca

{ close() => Promise<void> }

Obiekt, który można zamknąć, wysyłając wszystkie pozostałe komunikaty do handlers i zatrzymując nowe komunikaty przed przybyciem.