ServiceBusReceiver interface

Пакет:

@azure/service-bus

Получатель, который не обрабатывает сеансы.

Свойства

entityPath	Путь к сущности, для которой был создан получатель.
identifier	Имя, используемое для идентификации получателя. Это можно использовать для сопоставления журналов и исключений. Если он не указан или пуст, будет создан случайный уникальный.
isClosed	Возвращает значение true , если получатель или клиент, создавший его, был закрыт.
receiveMode	Режим получения, используемый для создания получателя.

Методы

abandonMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})	Блокировка сообщения, удерживаемая получателем, отпустит, что снова делает сообщение доступным в служебной шине для другой операции получения.
close()	Закрывает приемник. После закрытия приемник нельзя использовать для дальнейших операций. createReceiver() Используйте метод в ServiceBusClient, чтобы создать приемник.
completeMessage(ServiceBusReceivedMessage)	Удаляет сообщение из служебной шины.
deadLetterMessage(ServiceBusReceivedMessage, DeadLetterOptions & {[key: string]: number | boolean | string | Date | null})	Перемещает сообщение во вложенную очередь недоставленных сообщений. Чтобы получить сообщение о недоставке, создайте новый QueueClient/SubscriptionClient, используя путь для подзадачной очереди недоставки.
deferMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})	Откладывает обработку сообщения. Сохраните sequenceNumber сообщение, чтобы получить его снова в будущем с помощью receiveDeferredMessage метода .
getMessageIterator(GetMessageIteratorOptions)	Возвращает итератор, который можно использовать для получения сообщений из служебной шины.
peekMessages(number, PeekMessagesOptions)	Просматривайте следующий пакет активных сообщений (включая отложенные, но не недоставленные сообщения) в очереди или подписке, не изменяя их. Первый вызов для peekMessages() получения первого активного сообщения. При каждом последующем вызове извлекается следующее сообщение. В отличие от сообщения "получено", "просматриваемое" сообщение является версией сообщения только для чтения. Не может иметь значение Completed/Abandoned/Deferred/Deadlettered.
receiveDeferredMessages(Long | Long[], OperationOptionsBase)	Возвращает обещание, разрешающееся в массив отложенных сообщений, определенных заданным sequenceNumbers.
receiveMessages(number, ReceiveMessagesOptions)	Возвращает обещание, разрешающееся в массив сообщений, полученных из служебной шины.
renewMessageLock(ServiceBusReceivedMessage)	Продлевает блокировку сообщения на период, указанный во время создания очереди или подписки. lockedUntilUtc Проверьте свойство сообщения на время истечения срока действия блокировки. Если сообщение не урегулировано (с помощью complete()или defer() , или deadletter()до истечения срока действия блокировки), сообщение возвращается в очередь или подписку для следующей операции получения.
subscribe(MessageHandlers, SubscribeOptions)	Передает сообщения в обработчики сообщений.

Сведения о свойстве

entityPath

Путь к сущности, для которой был создан получатель.

entityPath: string

Значение свойства

string

identifier

Имя, используемое для идентификации получателя. Это можно использовать для сопоставления журналов и исключений. Если он не указан или пуст, будет создан случайный уникальный.

identifier: string

Значение свойства

string

isClosed

Возвращает значение true , если получатель или клиент, создавший его, был закрыт.

isClosed: boolean

Значение свойства

boolean

receiveMode

Режим получения, используемый для создания получателя.

receiveMode: "peekLock" | "receiveAndDelete"

Значение свойства

"peekLock" | "receiveAndDelete"

Сведения о методе

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

Блокировка сообщения, удерживаемая получателем, отпустит, что снова делает сообщение доступным в служебной шине для другой операции получения.

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

Параметры

message

ServiceBusReceivedMessage

propertiesToModify

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

Свойства сообщения, которые необходимо изменить при отказе от сообщения.

Возвращаемое значение

Promise<void>

close()

Закрывает приемник. После закрытия приемник нельзя использовать для дальнейших операций. createReceiver() Используйте метод в ServiceBusClient, чтобы создать приемник.

function close(): Promise<void>

Возвращаемое значение

Promise<void>

completeMessage(ServiceBusReceivedMessage)

Удаляет сообщение из служебной шины.

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

Параметры

message

ServiceBusReceivedMessage

Возвращаемое значение

Promise<void>

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

Перемещает сообщение во вложенную очередь недоставленных сообщений. Чтобы получить сообщение о недоставке, создайте новый QueueClient/SubscriptionClient, используя путь для подзадачной очереди недоставки.

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

Параметры

message

ServiceBusReceivedMessage

options

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

Параметры DeadLetter, которые можно указать при отклонении сообщения.

Возвращаемое значение

Promise<void>

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

Откладывает обработку сообщения. Сохраните sequenceNumber сообщение, чтобы получить его снова в будущем с помощью receiveDeferredMessage метода .

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

Параметры

message

ServiceBusReceivedMessage

propertiesToModify

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

Свойства сообщения для изменения при отсрочке сообщения

Возвращаемое значение

Promise<void>

getMessageIterator(GetMessageIteratorOptions)

Возвращает итератор, который можно использовать для получения сообщений из служебной шины.

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

Параметры

options

GetMessageIteratorOptions

Набор параметров для управления операцией получения.

• abortSignal: сигнал, используемый для прерывания текущей операции.

Возвращаемое значение

AsyncIterableIterator<ServiceBusReceivedMessage>

peekMessages(number, PeekMessagesOptions)

Просматривайте следующий пакет активных сообщений (включая отложенные, но не недоставленные сообщения) в очереди или подписке, не изменяя их.

• Первый вызов для peekMessages() получения первого активного сообщения. При каждом последующем вызове извлекается следующее сообщение.
• В отличие от сообщения "получено", "просматриваемое" сообщение является версией сообщения только для чтения. Не может иметь значение Completed/Abandoned/Deferred/Deadlettered.

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

Параметры

maxMessageCount

number

Максимальное количество сообщений для просмотра.

options

PeekMessagesOptions

Параметры, позволяющие указать максимальное количество сообщений для просмотра, sequenceNumber для начала просмотра или abortSignal для прерывания операции.

Возвращаемое значение

Promise<ServiceBusReceivedMessage[]>

receiveDeferredMessages(Long | Long[], OperationOptionsBase)

Возвращает обещание, разрешающееся в массив отложенных сообщений, определенных заданным sequenceNumbers.

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

Параметры

sequenceNumbers

Long | Long[]

Порядковый номер или массив порядковых номеров для сообщений, которые необходимо получить.

options

OperationOptionsBase

Контейнер параметров для передачи сигнала прерывания или параметров трассировки.

Возвращаемое значение

Promise<ServiceBusReceivedMessage[]>

Список сообщений, определенных заданной sequenceNumbers, или пустой список, если сообщения не найдены.

receiveMessages(number, ReceiveMessagesOptions)

Возвращает обещание, разрешающееся в массив сообщений, полученных из служебной шины.

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

Параметры

maxMessageCount

number

Максимальное количество получаемых сообщений.

options

ReceiveMessagesOptions

Набор параметров для управления операцией получения.

• maxWaitTimeInMs: максимальное время ожидания первого сообщения перед возвратом пустого массива, если нет доступных сообщений.
• abortSignal: сигнал, используемый для прерывания текущей операции.

Возвращаемое значение

Promise<ServiceBusReceivedMessage[]>

Обещание, разрешающееся с массивом сообщений.

renewMessageLock(ServiceBusReceivedMessage)

Продлевает блокировку сообщения на период, указанный во время создания очереди или подписки.

• lockedUntilUtc Проверьте свойство сообщения на время истечения срока действия блокировки.
• Если сообщение не урегулировано (с помощью complete()или defer() , или deadletter()до истечения срока действия блокировки), сообщение возвращается в очередь или подписку для следующей операции получения.

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

Параметры

message

ServiceBusReceivedMessage

Возвращаемое значение

Promise<Date>

Дата и время истечения срока действия маркера блокировки в формате UTC.

subscribe(MessageHandlers, SubscribeOptions)

Передает сообщения в обработчики сообщений.

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

Параметры

handlers

MessageHandlers

Обработчик, который вызывается для сообщений и ошибок.

options

SubscribeOptions

Параметры подписки.

Возвращаемое значение

{ close() => Promise<void> }

Объект, который можно закрыть, отправляя все оставшиеся сообщения в handlers и останавливая поступление новых сообщений.