@azure/web-pubsub-client package

الفصول

InvocationError

يحدث خطأ عندما يفشل الاستدعاء أو يلغى.
SendMessageError

خطأ عند فشل إرسال الرسالة
WebPubSubClient

عميل WebPubSub

الواجهات

AbortGroupStreamOptions

إلغاء خيارات البث الجماعي.
AckMessage

رسالة ack
AckMessageError

تفاصيل الخطأ في AckMessage
CancelInvocationMessage

إلغاء رسالة الاستدعاء
ConnectedMessage

رسالة متصلة
DisconnectedMessage

رسالة غير متصلة
EndGroupStreamOptions

خيارات البث الجماعي النهائي.
GetClientAccessUrlOptions

خيارات البدء
GroupDataMessage

رسالة بيانات المجموعة
GroupStateItem

مدخل حالة الاتصال الواحد داخل مجموعة
GroupStateSnapshotMessage

رسالة لقطة حالة المجموعة، أرسلت بعد اشتراك ناجح في GroupState
GroupStateUpdateMessage

رسالة تحديث حالة المجموعة، تدفع عند تغير حالة الاتصال
GroupStream

تدفق مجموعة واحد داخل.
GroupStreamMessage

جزء واحد من تدفق جماعي داخل واحد.
GroupStreamSubscription

تم إعادة الاشتراك بواسطة client.onGroupStream(...).
GroupStreamWriteOptions

خيارات كتابة التدفق الجماعي.
GroupStreamWriter

تجريد كاتب تدفق المجموعة لإرسال تدفق منطقي واحد إلى مجموعة.
InvocationErrorOptions
InvokeEventOptions

خيارات تشغيل الأحداث Invoke
InvokeEventResult

نتيجة حدث الاستدعاء
InvokeMessage

استدعاء رسالة
InvokeResponseError

تفاصيل أخطاء الاستجابة الاستدعاء
InvokeResponseMessage

استدعاء رسالة الاستجابة
JoinGroupMessage

الانضمام إلى رسالة المجموعة
JoinGroupOptions

الانضمام إلى خيارات عملية المجموعة
LeaveGroupMessage

مغادرة رسالة المجموعة
LeaveGroupOptions

ترك خيارات عملية المجموعة
OnConnectedArgs

معلمة رد الاتصال OnConnected
OnDisconnectedArgs

معلمة رد الاتصال OnDisconnected
OnGroupDataMessageArgs

معلمة رد اتصال OnGroupDataMessage
OnGroupStreamOptions

خيارات تتحكم في كيفية تتبع وإرسال تدفقات المجموعة الواردة لمكالمة واحدة مسجلة عبر client.onGroupStream(callback, options).

التفصيل ذو مستويين:

  • قيم الخيارات محددة النطاق حسب التسجيل (أي لكل معالج): كل onGroupStream نداء يحمل قيمه الخاصة، وقد يستخدم المعالجون المختلفون قيما مختلفة.
  • يتم تطبيق تأثيرات الخيار بشكل مستقل على كل تدفق، يتم تحديدها بواسطة زوجه (group, streamId) . التدفقات المتزامنة — حتى تدفقان في نفس المجموعة يلاحظهما نفس المدرب — كل منها يحصل على مؤقت خمول خاص به وبوابه الخاصة handleFromStart . لا يتم مشاركة أو تجميع أي شيء عبر البثوث أو عبر المجموعات.
OnRejoinGroupFailedArgs

معلمة رد الاتصال RejoinGroupFailed
OnServerDataMessageArgs

معلمة رد اتصال OnDataMessage
OnStoppedArgs

معلمة رد الاتصال OnStopped
OpenGroupStreamOptions

خيارات تشغيل openGroupStream.
PingMessage

رسالة ping
PongMessage

رسالة البونغ
SendEventMessage

إرسال رسالة حدث مخصصة
SendEventOptions

إرسال خيارات عملية الحدث
SendMessageErrorOptions
SendToGroupMessage

إرسال إلى رسالة المجموعة
SendToGroupOptions

خيارات عملية الإرسال إلى المجموعة
SequenceAckMessage

رسالة ack التسلسل
ServerDataMessage

رسالة بيانات الخادم
SetGroupStateMessage

تعيين رسالة حالة المجموعة
StartOptions

خيارات البدء
StartStreamOptions

واصف التدفق مرتبط بإطار تحكم sendToGroup الذي يفتح تدفقا.
StreamAckMessage

بث رسالة التأكيد.
StreamClosedMessage

تم بث رسالة مغلقة.
StreamDataError

تفصيل خطأ في البث.
StreamDataMessage

إرسال رسالة بيانات. الحمولة التي تمثل فقط streamId البقاء.
StreamEndError

خطأ في نهاية البث يمكن أن يرسله تدفق مخرج إلى الخدمة. تقرر الخدمة تصنيف أسماء الأخطاء على المستوى العالي.
StreamEndMessage

بث رسالة نهاية اللعب.
StreamInfo

تدفق البيانات الوصفية المرفقة برسالة بيانات لاحقة.
StreamNackMessage

استمع إلى رسالة nack.
SubscribeGroupStateMessage

اشتراك في رسالة الحالة الجماعية
UnsubscribeGroupStateMessage

إلغاء الاشتراك في رسالة حالة المجموعة
WebPubSubClientCredential

بيانات اعتماد WebPubSubClient
WebPubSubClientOptions

خيارات العميل
WebPubSubClientProtocol

الواجهة التي سيتم تنفيذها للبروتوكول الفرعي web pubsub
WebPubSubMessageBase

رسالة pubsub الشائعة على الويب
WebPubSubResult

نتيجة ack
WebPubSubRetryOptions

خيارات إعادة المحاولة

النوع أسماء مستعارة

DownstreamMessageType

أنواع رسائل انتقال البيانات من الخادم
JSONTypes

الأنواع التي يمكن تسلسلها وإرسالها ك JSON.
RetryMode

يصف نوع وضع إعادة المحاولة
UpstreamMessageType

أنواع الرسائل المصدر
WebPubSubDataType

نوع البيانات
WebPubSubMessage

رسالة web pubsub

الوظائف

WebPubSubJsonProtocol()

إرجاع بروتوكول "json.webpubsub.azure.v1"
WebPubSubJsonReliableProtocol()

إرجاع بروتوكول "json.reliable.webpubsub.azure.v1"

تفاصيل الوظيفة

WebPubSubJsonProtocol()

إرجاع بروتوكول "json.webpubsub.azure.v1"

function WebPubSubJsonProtocol(): WebPubSubClientProtocol

المرتجعات

WebPubSubClientProtocol

WebPubSubJsonReliableProtocol()

إرجاع بروتوكول "json.reliable.webpubsub.azure.v1"

function WebPubSubJsonReliableProtocol(): WebPubSubClientProtocol

المرتجعات

WebPubSubClientProtocol