UserEventResponseHandler interface

الحزمة:

@azure/web-pubsub-express

المعالج لتعيين استجابة حدث المستخدم

الأساليب

fail(400 | 401 | 500, string)	إرجاع الاستجابة الفاشلة وستقوم الخدمة بإغلاق اتصال WebSocket العميل.
setState(string, unknown)	تعيين حالة الاتصال
success(string | ArrayBuffer, "binary" | "text" | "json")	إرجاع استجابة النجاح مع البيانات التي سيتم تسليمها إلى اتصال WebSocket العميل.

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

fail(400 | 401 | 500, string)

إرجاع الاستجابة الفاشلة وستقوم الخدمة بإغلاق اتصال WebSocket العميل.

function fail(code: 400 | 401 | 500, detail?: string)

المعلمات

code

400 | 401 | 500

يمكن أن تكون التعليمات البرمجية 400 خطأ مستخدم و401 خطأ غير مصرح به و500 خادم.

detail

string

تفاصيل الخطأ.

setState(string, unknown)

تعيين حالة الاتصال

function setState(name: string, value: unknown)

المعلمات

name

string

اسم الحالة

value

unknown

قيمة الحالة

success(string | ArrayBuffer, "binary" | "text" | "json")

إرجاع استجابة النجاح مع البيانات التي سيتم تسليمها إلى اتصال WebSocket العميل.

function success(data?: string | ArrayBuffer, dataType?: "binary" | "text" | "json")

المعلمات

data

string | ArrayBuffer

بيانات الحمولة التي سيتم إرجاعها إلى العميل. تكبير الرسالة إذا كان كائن JSON.

dataType

"binary" | "text" | "json"

نوع بيانات الحمولة.