@azure/web-pubsub package

الفصول

AzureKeyCredential	بيانات اعتماد مستندة إلى مفتاح ثابت تدعم تحديث قيمة المفتاح الأساسي.
WebPubSubServiceClient	عميل للاتصال بمركز Web PubSub

الواجهات

ClientTokenResponse	استجابة تحتوي على رمز العميل المميز.
GenerateClientTokenOptions	خيارات لإنشاء رمز مميز لتوصيل عميل بخدمة Azure Web Pubsub.
GroupAddConnectionOptions	خيارات لإضافة اتصال إلى مجموعة.
GroupAddUserOptions	خيارات لإضافة مستخدم إلى مجموعة.
GroupAdminClientOptions	خيارات لإنشاء عميل GroupAdmin.
GroupCloseAllConnectionsOptions	خيارات لإغلاق كافة الاتصالات بمجموعة.
GroupHasUserOptions	خيارات للتحقق مما إذا كان المستخدم في مجموعة
GroupListConnectionsOptions	خيارات لإدراج الاتصالات في مجموعة.
GroupRemoveConnectionOptions	خيارات لإزالة اتصال من مجموعة
GroupRemoveUserOptions	خيارات لإزالة مستخدم من مجموعة
GroupSendTextToAllOptions	خيارات لإرسال رسائل نصية إلى مجموعة.
GroupSendToAllOptions	خيارات لإرسال الرسائل إلى مجموعة.
HasConnectionOptions	خيارات للتحقق مما إذا كان هناك اتصال.
HubCloseAllConnectionsOptions	خيارات لإغلاق كافة الاتصالات بمركز.
HubCloseConnectionOptions	خيارات لإغلاق اتصال بمركز.
HubCloseUserConnectionsOptions	خيارات لإغلاق كافة اتصالات المستخدم بمركز.
HubGrantPermissionOptions	خيارات منح أذونات الاتصال
HubHasGroupOptions	خيارات للتحقق مما إذا كانت هناك مجموعة.
HubHasPermissionOptions	خيارات للتحقق مما إذا كان الاتصال لديه الإذن المحدد
HubHasUserOptions	خيارات للتحقق مما إذا كان المستخدم موجودا.
HubRemoveUserFromAllGroupsOptions	خيارات لإزالة مستخدم من جميع المجموعات.
HubRevokePermissionOptions	خيارات إبطال الأذونات من اتصال
HubSendTextToAllOptions	خيارات لإرسال الرسائل النصية إلى المراكز.
HubSendTextToConnectionOptions	خيارات لإرسال رسالة نصية إلى اتصال.
HubSendTextToUserOptions	خيارات لإرسال رسالة نصية إلى مستخدم.
HubSendToAllOptions	خيارات لإرسال الرسائل إلى المراكز.
HubSendToConnectionOptions	خيارات لإرسال رسالة إلى اتصال معين.
HubSendToUserOptions	خيارات لإرسال رسالة إلى مستخدم.
WebPubSubGroup
WebPubSubGroupMember	اتصال في مجموعة في خدمة Web PubSub.
WebPubSubServiceClientLogOptions	خيارات لتكوين خيارات التسجيل.
WebPubSubServiceClientOptions	خيارات لإنشاء عميل HubAdmin.

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

JSONTypes	الأنواع التي يمكن تسلسلها وإرسالها ك JSON.
Permission
WebPubSubClientProtocol	نوع نقطة نهاية العميل التي يتم طلبها.

الوظائف

odata(TemplateStringsArray, unknown[])

إلغاء تعبير عامل تصفية odata لتجنب الأخطاء مع القيم الحرفية لسلسلة الاقتباس. مثال على الاستخدام:

import { odata } from "@azure/web-pubsub";

const userId = "vic's";
const anonymous = null;
const length = 3;
const filter = odata`userId eq ${anonymous} or userId eq ${userId} or length(userId) > ${length}`;

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

odata(TemplateStringsArray, unknown[])

إلغاء تعبير عامل تصفية odata لتجنب الأخطاء مع القيم الحرفية لسلسلة الاقتباس. مثال على الاستخدام:

import { odata } from "@azure/web-pubsub";

const userId = "vic's";
const anonymous = null;
const length = 3;
const filter = odata`userId eq ${anonymous} or userId eq ${userId} or length(userId) > ${length}`;

function odata(strings: TemplateStringsArray, values: unknown[]): string

المعلمات

strings: TemplateStringsArray

صفيف سلاسل للتعبير

values: unknown[]

صفيف قيم التعبير

المرتجعات

string