ServiceBusSessionReceiver interface

الحزمة:

@azure/service-bus

جهاز استقبال يعالج جلسات العمل، بما في ذلك تجديد تأمين الجلسة.

يمتد

ServiceBusReceiver

الخصائص

sessionId	معرف جلسة العمل.
sessionLockedUntilUtc	الوقت في UTC حتى يتم تأمين الجلسة. في كل مرة يتم فيها استدعاء renewSessionLock()، يتم تحديث هذه المرة إلى الوقت الحالي بالإضافة إلى مدة التأمين كما هو محدد أثناء إنشاء قائمة الانتظار/الاشتراك. سيتم إرجاع غير معرف حتى يتم إعداد ارتباط مستقبل AMQP بنجاح لجلسة العمل.

الخصائص الموروثة

entityPath	مسار الكيان الذي تم إنشاء المتلقي له.
identifier	اسم يستخدم لتعريف المتلقي. يمكن استخدام هذا لربط السجلات والاستثناءات. إذا لم يتم تحديده أو إفراغه، إنشاء واحد فريد عشوائي.
isClosed	إرجاع true إذا تم إغلاق المتلقي أو العميل الذي أنشأه.
receiveMode	وضع الاستلام المستخدم لإنشاء المتلقي.

الأساليب

getSessionState(OperationOptionsBase)	الحصول على حالة الجلسة. لمزيد من الاطلاع على حالات جلسة العمل، راجع حالة جلسة العمل
renewSessionLock(OperationOptionsBase)	تجديد التأمين على جلسة العمل.
setSessionState(any, OperationOptionsBase)	تعيين الحالة على جلسة العمل. لمزيد من الاطلاع على حالات جلسة العمل، راجع حالة جلسة العمل
subscribe(MessageHandlers, SubscribeOptions)	دفق الرسائل إلى معالجات الرسائل.

الأساليب المتوارثة

abandonMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})	يتم ترك التأمين الذي يحتفظ به المتلقي على الرسالة، مما يجعل الرسالة متاحة مرة أخرى في ناقل خدمة Microsoft Azure لعملية تلقي أخرى.
close()	إغلاق المتلقي. بمجرد إغلاقه، لا يمكن استخدام المتلقي لأي عمليات أخرى. استخدم أسلوب createReceiver() على ServiceBusClient لإنشاء جهاز استقبال جديد.
completeMessage(ServiceBusReceivedMessage)	إزالة الرسالة من ناقل خدمة Microsoft Azure.
deadLetterMessage(ServiceBusReceivedMessage, DeadLetterOptions & {[key: string]: number | boolean | string | Date | null})	نقل الرسالة إلى قائمة الانتظار الفرعية غير المستخدمة. لتلقي رسالة deadletted، قم بإنشاء QueueClient/SubscriptionClient جديد باستخدام مسار قائمة الانتظار الفرعية غير المستخدمة.
deferMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})	تأجيل معالجة الرسالة. احفظ sequenceNumber الرسالة، لتلقي الرسالة مرة أخرى في المستقبل باستخدام أسلوب receiveDeferredMessage.
getMessageIterator(GetMessageIteratorOptions)	إرجاع مكرر يمكن استخدامه لتلقي الرسائل من ناقل خدمة Microsoft Azure.
peekMessages(number, PeekMessagesOptions)	ألق نظرة خاطفة على الدفعة التالية من الرسائل النشطة (بما في ذلك الرسائل المؤجلة ولكن غير الميتة) في قائمة الانتظار أو الاشتراك دون تعديلها. الاستدعاء الأول peekMessages() يجلب أول رسالة نشطة. كل استدعاء لاحق يجلب الرسالة التالية. على عكس الرسالة "المستلمة"، تكون الرسالة "خاطفة" هي نسخة للقراءة فقط من الرسالة. لا يمكن Completed/Abandoned/Deferred/Deadlettered.
receiveDeferredMessages(Long | Long[], OperationOptionsBase)	إرجاع وعد يحل إلى صفيف من الرسائل المؤجلة التي تم تحديدها بواسطة sequenceNumbers.
receiveMessages(number, ReceiveMessagesOptions)	إرجاع وعد يحل إلى صفيف من الرسائل المستلمة من ناقل خدمة Microsoft Azure.
renewMessageLock(ServiceBusReceivedMessage)	تجديد التأمين على الرسالة للمدة كما هو محدد أثناء إنشاء قائمة الانتظار/الاشتراك. تحقق من خاصية lockedUntilUtc على الرسالة للوقت الذي تنتهي فيه صلاحية التأمين. إذا لم تتم تسوية الرسالة (باستخدام إما complete()أو defer() أو deadletter()، قبل انتهاء صلاحية تأمينها، فستعود الرسالة مرة أخرى إلى قائمة الانتظار/الاشتراك لعملية الاستلام التالية.

تفاصيل الخاصية

sessionId

معرف جلسة العمل.

sessionId: string

قيمة الخاصية

string

sessionLockedUntilUtc

الوقت في UTC حتى يتم تأمين الجلسة. في كل مرة يتم فيها استدعاء renewSessionLock()، يتم تحديث هذه المرة إلى الوقت الحالي بالإضافة إلى مدة التأمين كما هو محدد أثناء إنشاء قائمة الانتظار/الاشتراك.

سيتم إرجاع غير معرف حتى يتم إعداد ارتباط مستقبل AMQP بنجاح لجلسة العمل.

sessionLockedUntilUtc: Date

قيمة الخاصية

Date

تفاصيل الخاصية الموروثة

entityPath

مسار الكيان الذي تم إنشاء المتلقي له.

entityPath: string

قيمة الخاصية

string

موروث منServiceBusReceiver.entityPath

identifier

اسم يستخدم لتعريف المتلقي. يمكن استخدام هذا لربط السجلات والاستثناءات. إذا لم يتم تحديده أو إفراغه، إنشاء واحد فريد عشوائي.

identifier: string

قيمة الخاصية

string

موروث منServiceBusReceiver.identifier

isClosed

إرجاع true إذا تم إغلاق المتلقي أو العميل الذي أنشأه.

isClosed: boolean

قيمة الخاصية

boolean

موروث منServiceBusReceiver.isClosed

receiveMode

وضع الاستلام المستخدم لإنشاء المتلقي.

receiveMode: "peekLock" | "receiveAndDelete"

قيمة الخاصية

"peekLock" | "receiveAndDelete"

موروث منServiceBusReceiver.receiveMode

تفاصيل الأسلوب

getSessionState(OperationOptionsBase)

الحصول على حالة الجلسة. لمزيد من الاطلاع على حالات جلسة العمل، راجع حالة جلسة العمل

function getSessionState(options?: OperationOptionsBase): Promise<any>

المعلمات

options

OperationOptionsBase

حقيبة خيارات لتمرير إشارة إحباط أو خيارات التتبع.

المرتجعات

Promise<any>

حالة جلسة العمل هذه

renewSessionLock(OperationOptionsBase)

تجديد التأمين على جلسة العمل.

function renewSessionLock(options?: OperationOptionsBase): Promise<Date>

المعلمات

options

OperationOptionsBase

المرتجعات

Promise<Date>

setSessionState(any, OperationOptionsBase)

تعيين الحالة على جلسة العمل. لمزيد من الاطلاع على حالات جلسة العمل، راجع حالة جلسة العمل

function setSessionState(state: any, options?: OperationOptionsBase): Promise<void>

المعلمات

state

any

الحالة التي يجب تعيينها.

options

OperationOptionsBase

حقيبة خيارات لتمرير إشارة إحباط أو خيارات التتبع.

المرتجعات

Promise<void>

subscribe(MessageHandlers, SubscribeOptions)

دفق الرسائل إلى معالجات الرسائل.

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

المعلمات

handlers

MessageHandlers

معالج يتم استدعاؤه للرسائل والأخطاء.

options

SubscribeOptions

خيارات الاشتراك.

المرتجعات

{ close() => Promise<void> }

كائن يمكن إغلاقه، وإرسال أي رسائل متبقية إلى handlers وإيقاف وصول رسائل جديدة.

تفاصيل الأساليب المتوارثة

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

يتم ترك التأمين الذي يحتفظ به المتلقي على الرسالة، مما يجعل الرسالة متاحة مرة أخرى في ناقل خدمة Microsoft Azure لعملية تلقي أخرى.

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>

موروث منServiceBusReceiver.abandonMessage

close()

إغلاق المتلقي. بمجرد إغلاقه، لا يمكن استخدام المتلقي لأي عمليات أخرى. استخدم أسلوب createReceiver() على ServiceBusClient لإنشاء جهاز استقبال جديد.

function close(): Promise<void>

المرتجعات

Promise<void>

موروث منServiceBusReceiver.close

completeMessage(ServiceBusReceivedMessage)

إزالة الرسالة من ناقل خدمة Microsoft Azure.

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

المعلمات

message

ServiceBusReceivedMessage

المرتجعات

Promise<void>

موروث منServiceBusReceiver.completeMessage

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

نقل الرسالة إلى قائمة الانتظار الفرعية غير المستخدمة. لتلقي رسالة deadletted، قم بإنشاء 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>

موروث منServiceBusReceiver.deadLetterMessage

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>

موروث منServiceBusReceiver.deferMessage

getMessageIterator(GetMessageIteratorOptions)

إرجاع مكرر يمكن استخدامه لتلقي الرسائل من ناقل خدمة Microsoft Azure.

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

المعلمات

options

GetMessageIteratorOptions

مجموعة من الخيارات للتحكم في عملية الاستلام.

• abortSignal: الإشارة التي يجب استخدامها لإجهاض العملية الجارية.

المرتجعات

AsyncIterableIterator<ServiceBusReceivedMessage>

موروث منServiceBusReceiver.getMessageIterator

peekMessages(number, PeekMessagesOptions)

ألق نظرة خاطفة على الدفعة التالية من الرسائل النشطة (بما في ذلك الرسائل المؤجلة ولكن غير الميتة) في قائمة الانتظار أو الاشتراك دون تعديلها.

• الاستدعاء الأول peekMessages() يجلب أول رسالة نشطة. كل استدعاء لاحق يجلب الرسالة التالية.
• على عكس الرسالة "المستلمة"، تكون الرسالة "خاطفة" هي نسخة للقراءة فقط من الرسالة. لا يمكن Completed/Abandoned/Deferred/Deadlettered.

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

المعلمات

maxMessageCount

number

الحد الأقصى لعدد الرسائل التي يجب النظر إليها خاطفة.

options

PeekMessagesOptions

الخيارات التي تسمح بتحديد الحد الأقصى لعدد الرسائل التي تريد خاطفتها، أو sequenceNumber لبدء النظرة الخاطفة من أو abortSignal لإجهاض العملية.

المرتجعات

Promise<ServiceBusReceivedMessage[]>

الموروثة منServiceBusReceiver.peekMessages

receiveDeferredMessages(Long | Long[], OperationOptionsBase)

إرجاع وعد يحل إلى صفيف من الرسائل المؤجلة التي تم تحديدها بواسطة sequenceNumbers.

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

المعلمات

sequenceNumbers

Long | Long[]

رقم التسلسل أو صفيف من أرقام التسلسل للرسائل التي يجب تلقيها.

options

OperationOptionsBase

حقيبة خيارات لتمرير إشارة إحباط أو خيارات التتبع.

المرتجعات

Promise<ServiceBusReceivedMessage[]>

قائمة بالرسائل التي تم تعريفها بواسطة التسلسل المحددNumbers أو قائمة فارغة إذا لم يتم العثور على رسائل.

موروث منServiceBusReceiver.receiveDeferredMessages

receiveMessages(number, ReceiveMessagesOptions)

إرجاع وعد يحل إلى صفيف من الرسائل المستلمة من ناقل خدمة Microsoft Azure.

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

المعلمات

maxMessageCount

number

الحد الأقصى لعدد الرسائل التي يجب تلقيها.

options

ReceiveMessagesOptions

مجموعة من الخيارات للتحكم في عملية الاستلام.

• maxWaitTimeInMs: الحد الأقصى لوقت انتظار الرسالة الأولى قبل إرجاع صفيف فارغ إذا لم تتوفر أي رسائل.
• abortSignal: الإشارة التي يجب استخدامها لإجهاض العملية الجارية.

المرتجعات

Promise<ServiceBusReceivedMessage[]>

وعد يحل بمجموعة من الرسائل.

موروث منServiceBusReceiver.receiveMessages

renewMessageLock(ServiceBusReceivedMessage)

تجديد التأمين على الرسالة للمدة كما هو محدد أثناء إنشاء قائمة الانتظار/الاشتراك.

• تحقق من خاصية lockedUntilUtc على الرسالة للوقت الذي تنتهي فيه صلاحية التأمين.
• إذا لم تتم تسوية الرسالة (باستخدام إما complete()أو defer() أو deadletter()، قبل انتهاء صلاحية تأمينها، فستعود الرسالة مرة أخرى إلى قائمة الانتظار/الاشتراك لعملية الاستلام التالية.

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

المعلمات

message

ServiceBusReceivedMessage

المرتجعات

Promise<Date>

تاريخ ووقت انتهاء صلاحية رمز التأمين الجديد بتنسيق UTC.

موروث منServiceBusReceiver.renewMessageLock