GenerateClientTokenOptions interface

الحزمة:: @azure/web-pubsub

خيارات لإنشاء رمز مميز لتوصيل عميل بخدمة Azure Web Pubsub.

يمتد: OperationOptions

الخصائص

clientProtocol	نوع بروتوكول العميل `default`: عميل WebPubSub الافتراضي. مثال عنوان URL لاتصال العميل: wss://exampleHost.com/client/hubs/exampleHub `mqtt`: عميل MQTT. مثال عنوان URL لاتصال العميل: wss://exampleHost.com/client/mqtt/hubs/exampleHub
expirationTimeInMinutes	دقائق حتى تنتهي صلاحية الرمز المميز.
groups	المجموعات التي يجب الانضمام إليها عند اتصال العميل
roles	الأدوار التي سيكون لها الاتصال بالرمز المميز الذي تم إنشاؤه. تمنح الأدوار العميل أذونات أولية لمغادرة المجموعات أو الانضمام إليها أو نشرها عند استخدام PubSub subprotocol `webpubsub.joinLeaveGroup`: يمكن للعميل الانضمام إلى أي مجموعة أو مغادرتها `webpubsub.sendToGroup`: يمكن للعميل إرسال رسائل إلى أي مجموعة `webpubsub.joinLeaveGroup.<group>`: يمكن للعميل الانضمام إلى المجموعة أو مغادرتها `<group>` `webpubsub.sendToGroup.<group>`: يمكن للعميل إرسال رسائل إلى `<group>` المجموعة https://azure.github.io/azure-webpubsub/references/pubsub-websocket-subprotocol#permissions
userId	معرف المستخدم للعميل.

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

abortSignal	الإشارة التي يمكن استخدامها لإجهاض الطلبات.
onResponse	دالة سيتم استدعاؤها في كل مرة يتم فيها تلقي استجابة من الخادم أثناء تنفيذ العملية المطلوبة. قد يتم استدعاؤه عدة مرات.
requestOptions	الخيارات المستخدمة عند إنشاء طلبات HTTP وإرسالها لهذه العملية.
serializerOptions	خيارات لتجاوز سلوك التسلسل/إلغاء التسلسل.
tracingOptions	الخيارات المستخدمة عند تمكين التتبع.

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

clientProtocol

نوع بروتوكول العميل

default: عميل WebPubSub الافتراضي. مثال عنوان URL لاتصال العميل: wss://exampleHost.com/client/hubs/exampleHub
mqtt: عميل MQTT. مثال عنوان URL لاتصال العميل: wss://exampleHost.com/client/mqtt/hubs/exampleHub

clientProtocol?: WebPubSubClientProtocol

قيمة الخاصية

WebPubSubClientProtocol

expirationTimeInMinutes

دقائق حتى تنتهي صلاحية الرمز المميز.

expirationTimeInMinutes?: number

قيمة الخاصية

number

groups

المجموعات التي يجب الانضمام إليها عند اتصال العميل

groups?: string[]

قيمة الخاصية

string[]

roles

الأدوار التي سيكون لها الاتصال بالرمز المميز الذي تم إنشاؤه. تمنح الأدوار العميل أذونات أولية لمغادرة المجموعات أو الانضمام إليها أو نشرها عند استخدام PubSub subprotocol

webpubsub.joinLeaveGroup: يمكن للعميل الانضمام إلى أي مجموعة أو مغادرتها
webpubsub.sendToGroup: يمكن للعميل إرسال رسائل إلى أي مجموعة
webpubsub.joinLeaveGroup.<group>: يمكن للعميل الانضمام إلى المجموعة أو مغادرتها <group>
webpubsub.sendToGroup.<group>: يمكن للعميل إرسال رسائل إلى <group> المجموعة

https://azure.github.io/azure-webpubsub/references/pubsub-websocket-subprotocol#permissions

roles?: string[]

قيمة الخاصية

string[]

userId

معرف المستخدم للعميل.

userId?: string

قيمة الخاصية

string

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

abortSignal

الإشارة التي يمكن استخدامها لإجهاض الطلبات.

abortSignal?: AbortSignalLike

قيمة الخاصية

AbortSignalLike

موروث من OperationOptions.abortSignal

onResponse

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

onResponse?: RawResponseCallback

قيمة الخاصية

RawResponseCallback

موروث من OperationOptions.onResponse

requestOptions

الخيارات المستخدمة عند إنشاء طلبات HTTP وإرسالها لهذه العملية.

requestOptions?: OperationRequestOptions

قيمة الخاصية

OperationRequestOptions

موروثة من OperationOptions.requestOptions

serializerOptions

خيارات لتجاوز سلوك التسلسل/إلغاء التسلسل.

serializerOptions?: SerializerOptions

قيمة الخاصية

SerializerOptions

موروثة من OperationOptions.serializerOptions

tracingOptions

الخيارات المستخدمة عند تمكين التتبع.

tracingOptions?: OperationTracingOptions

قيمة الخاصية

OperationTracingOptions

موروث من OperationOptions.tracingOptions