WebPubSubClient class

إنشاء مثيل WebPubSubClient

new WebPubSubClient(clientAccessUrl: string, options?: WebPubSubClientOptions)

المعلمات

إنشاء مثيل WebPubSubClient

new WebPubSubClient(credential: WebPubSubClientCredential, options?: WebPubSubClientOptions)

المعلمات

استدعي حدث في التيار العلوي وانتظر الاستجابة المرتبطة.

function invokeEvent(eventName: string, content: JSONTypes | ArrayBuffer, dataType: WebPubSubDataType, options?: InvokeEventOptions): Promise<InvokeEventResult>

المعلمات

المرتجعات

ضم العميل إلى المجموعة

function joinGroup(groupName: string, options?: JoinGroupOptions): Promise<WebPubSubResult>

المعلمات

المرتجعات

اترك العميل من المجموعة

function leaveGroup(groupName: string, options?: LeaveGroupOptions): Promise<WebPubSubResult>

المعلمات

المرتجعات

إزالة معالج الحدث المتصل

function off(event: "connected", listener: (e: OnConnectedArgs) => void)

المعلمات

إزالة معالج الحدث غير المتصل

function off(event: "disconnected", listener: (e: OnDisconnectedArgs) => void)

المعلمات

إزالة معالج لرسالة المجموعة

function off(event: "group-message", listener: (e: OnGroupDataMessageArgs) => void)

المعلمات

فشل إزالة المعالج لإعادة الانضمام إلى المجموعة

function off(event: "rejoin-group-failed", listener: (e: OnRejoinGroupFailedArgs) => void)

المعلمات

إزالة معالج لرسالة الخادم

function off(event: "server-message", listener: (e: OnServerDataMessageArgs) => void)

المعلمات

إزالة معالج الحدث المتوقف

function off(event: "stopped", listener: (e: OnStoppedArgs) => void)

المعلمات

إضافة معالج للحدث المتصل

function on(event: "connected", listener: (e: OnConnectedArgs) => void)

المعلمات

إضافة معالج للحدث غير المتصل

function on(event: "disconnected", listener: (e: OnDisconnectedArgs) => void)

المعلمات

إضافة معالج لمراسلة المجموعة

function on(event: "group-message", listener: (e: OnGroupDataMessageArgs) => void)

المعلمات

فشل إضافة معالج لإعادة الانضمام إلى المجموعة

function on(event: "rejoin-group-failed", listener: (e: OnRejoinGroupFailedArgs) => void)

المعلمات

إضافة معالج لرسائل الخادم

function on(event: "server-message", listener: (e: OnServerDataMessageArgs) => void)

المعلمات

إضافة معالج للحدث المتوقف

function on(event: "stopped", listener: (e: OnStoppedArgs) => void)

المعلمات

اشترك في البث الجماعي الوارد. يتم استدعاء الاستدعاء مرة واحدة لكل تدفق يتم مراقبته حديثا.

function onGroupStream(callback: (stream: GroupStream) => void | Promise<void>, options?: OnGroupStreamOptions): GroupStreamSubscription

المعلمات

المرتجعات

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

function openGroupStream(groupName: string, options?: OpenGroupStreamOptions): Promise<GroupStreamWriter>

المعلمات

المرتجعات

إرسال حدث مخصص إلى الخادم.

function sendEvent(eventName: string, content: JSONTypes | ArrayBuffer, dataType: WebPubSubDataType, options?: SendEventOptions): Promise<WebPubSubResult>

المعلمات

المرتجعات

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

function sendToGroup(groupName: string, content: JSONTypes | ArrayBuffer, dataType: WebPubSubDataType, options?: SendToGroupOptions): Promise<WebPubSubResult>

المعلمات

المرتجعات

ابدأ في البدء بالخدمة.

function start(options?: StartOptions): Promise<void>

المعلمات

المرتجعات

أوقف العميل.

function stop()