WebPubSubFunctionOptions interface
- يمتد
-
WebPubSubTriggerOptions,Partial<FunctionOptions>
الخصائص
| handler | الكود الذي سيتم تنفيذه عند تفعيل وظيفتك |
| trigger | تكوين الإدخال الأساسي إلى الدالة، المعروف أيضا باسم سبب تشغيله هذا هو الإدخال الوحيد الذي يتم تمريره كوسيطة إلى معالج الدالة أثناء استدعاء |
الخصائص الموروثة
| client |
اختياري - يحدد أي بروتوكول عميل يمكنه تفعيل وظائف مشغل Web PubSub الافتراضي هو 'all' |
| connection | اختياري - اسم إعداد التطبيق الذي يحتوي على Web PubSub Service سلسلة الاتصال. يتم الإعداد الافتراضي إلى "WebPubSubConnectionString" إذا لم يتم تحديده. |
| connections | اختياري - أسماء إعدادات التطبيق أو مجموعات الإعدادات التي تحدد خدمات Azure Web PubSub المستخدمة للتحقق من صحة التوقيع تكون افتراضيا "WebPubSubConnectionString" إذا لم يتم تحديدها |
| event |
مطلوب - اسم الحدث الذي يجب أن تستجيب له الدالة لنوع حدث النظام: 'اتصال'، 'متصل'، أو 'غير متصل' للبروتوكولات الفرعية المعرفة من قبل المستخدم: 'رسالة' للبروتوكول الفرعي المدعوم من النظام json.webpubsub.azure.v1: اسم الحدث المعرف من قبل المستخدم |
| event |
مطلوب - نوع الحدث الذي يجب أن تستجيب له الدالة يجب أن يكون إما 'مستخدم' أو 'نظام' |
| extra |
تكوين مجموعة اختيارية من المدخلات الثانوية أثناء استدعاء، احصل على هذه القيم مع |
| extra |
تكوين مجموعة اختيارية من المخرجات الثانوية أثناء استدعاء، قم بتعيين هذه القيم مع |
| hub | مطلوب - اسم المحور الذي ترتبط به الدالة |
| name | مطلوب - اسم المتغير المستخدم في كود الدالة للمعلمة التي تستقبل بيانات الحدث |
| return | تكوين الإخراج الأساسي الاختياري للدالة هذا هو الإخراج الرئيسي الذي يجب تعيينه كقيمة إرجاع لمعالج الدالة أثناء استدعاء |
تفاصيل الخاصية
handler
الكود الذي سيتم تنفيذه عند تفعيل وظيفتك
handler: WebPubSubHandler<T>
قيمة الخاصية
trigger
تكوين الإدخال الأساسي إلى الدالة، المعروف أيضا باسم سبب تشغيله هذا هو الإدخال الوحيد الذي يتم تمريره كوسيطة إلى معالج الدالة أثناء استدعاء
trigger?: WebPubSubTrigger
قيمة الخاصية
تفاصيل الخاصية الموروثة
clientProtocols
اختياري - يحدد أي بروتوكول عميل يمكنه تفعيل وظائف مشغل Web PubSub الافتراضي هو 'all'
clientProtocols?: "all" | "webPubSub" | "mqtt"
قيمة الخاصية
"all" | "webPubSub" | "mqtt"
connection
تحذير
واجهة برمجة التطبيقات هذه مهملة الآن.
Use connections instead.
اختياري - اسم إعداد التطبيق الذي يحتوي على Web PubSub Service سلسلة الاتصال. يتم الإعداد الافتراضي إلى "WebPubSubConnectionString" إذا لم يتم تحديده.
connection?: string
قيمة الخاصية
string
connections
اختياري - أسماء إعدادات التطبيق أو مجموعات الإعدادات التي تحدد خدمات Azure Web PubSub المستخدمة للتحقق من صحة التوقيع تكون افتراضيا "WebPubSubConnectionString" إذا لم يتم تحديدها
connections?: string[]
قيمة الخاصية
string[]
eventName
مطلوب - اسم الحدث الذي يجب أن تستجيب له الدالة لنوع حدث النظام: 'اتصال'، 'متصل'، أو 'غير متصل' للبروتوكولات الفرعية المعرفة من قبل المستخدم: 'رسالة' للبروتوكول الفرعي المدعوم من النظام json.webpubsub.azure.v1: اسم الحدث المعرف من قبل المستخدم
eventName: string
قيمة الخاصية
string
eventType
مطلوب - نوع الحدث الذي يجب أن تستجيب له الدالة يجب أن يكون إما 'مستخدم' أو 'نظام'
eventType: "user" | "system"
قيمة الخاصية
"user" | "system"
extraInputs
تكوين مجموعة اختيارية من المدخلات الثانوية أثناء استدعاء، احصل على هذه القيم مع context.extraInputs.get()
extraInputs?: FunctionInput[]
قيمة الخاصية
موروث من Partial.extraInputs
extraOutputs
تكوين مجموعة اختيارية من المخرجات الثانوية أثناء استدعاء، قم بتعيين هذه القيم مع context.extraOutputs.set()
extraOutputs?: FunctionOutput[]
قيمة الخاصية
مأخوذ من Partial.extraOutputs
hub
مطلوب - اسم المحور الذي ترتبط به الدالة
hub: string
قيمة الخاصية
string
موروث منWebPubSubTriggerOptions.hub
name
مطلوب - اسم المتغير المستخدم في كود الدالة للمعلمة التي تستقبل بيانات الحدث
name: string
قيمة الخاصية
string
موروث منWebPubSubTriggerOptions.name
return
تكوين الإخراج الأساسي الاختياري للدالة هذا هو الإخراج الرئيسي الذي يجب تعيينه كقيمة إرجاع لمعالج الدالة أثناء استدعاء
return?: FunctionOutput
قيمة الخاصية
موروث من جزئي.عودة