NotificationSubscription interface
يحدد الاشتراك معايير مطابقة الأحداث وكيفية إعلام مشترك الاشتراك بهذه الأحداث.
الخصائص
| admin |
الإعدادات المدارة من قبل المسؤول للاشتراك. ينطبق فقط عندما يكون المشترك مجموعة. |
| channel | قناة لتسليم الإشعارات التي يتم تشغيلها بواسطة الاشتراك. |
| description | وصف الاشتراك. عادة ما يصف معايير التصفية التي تساعد في تحديد الاشتراك. |
| diagnostics | تشخيصات هذا الاشتراك. |
| extended |
أي خصائص إضافية مثل الوصف التفصيلي للسياقات المختلفة وسياقات المستخدم/المجموعة |
| filter | معايير المطابقة للاشتراك. مرشح ExpressionFilter |
| flags | مؤشرات للقراءة فقط تصف الاشتراك بشكل أكبر. |
| id | معرف الاشتراك. |
| last |
المستخدم الذي قام بتعديل (أو إنشاء) الاشتراك آخر مرة. |
| modified |
تاريخ آخر تعديل للاشتراك. إذا لم يتم تحديث الاشتراك منذ إنشائه، فستشير هذه القيمة إلى وقت إنشاء الاشتراك. |
| permissions | الأذونات التي يمتلكها المستخدم لهذه الاشتراكات. |
| scope | الحاوية التي يجب نشر الأحداث منها حتى تتم مطابقتها مع الاشتراك. إذا كان فارغا، يكون النطاق هو المضيف الحالي (عادة ما يكون حسابا أو مجموعة مشروع). على سبيل المثال، لن ينتج عن الاشتراك الذي تم تحديد نطاقه للمشروع "أ" إعلامات للأحداث المنشورة من المشروع "ب". |
| status | حالة الاشتراك. يشير عادة إلى ما إذا كان الاشتراك ممكنا أم لا. |
| status |
رسالة توفر مزيدا من التفاصيل حول حالة الاشتراك. |
| subscriber | المستخدم أو المجموعة التي ستتلقى إشعارات بالأحداث التي تتوافق مع معايير فلتر الاشتراك. |
| url | عنوان URL لواجهة برمجة تطبيقات REST للاشتراك. |
| user |
الإعدادات المدارة من قبل المستخدم للاشتراك. ينطبق فقط عندما يكون المشترك مجموعة. تستخدم عادة للإشارة إلى ما إذا كان المستخدم المتصل قد تم تمجيزه أو إلغاء اشتراك المجموعة. |
تفاصيل الخاصية
adminSettings
الإعدادات المدارة من قبل المسؤول للاشتراك. ينطبق فقط عندما يكون المشترك مجموعة.
adminSettings: SubscriptionAdminSettings
قيمة الخاصية
channel
قناة لتسليم الإشعارات التي يتم تشغيلها بواسطة الاشتراك.
channel: ISubscriptionChannel
قيمة الخاصية
description
وصف الاشتراك. عادة ما يصف معايير التصفية التي تساعد في تحديد الاشتراك.
description: string
قيمة الخاصية
string
diagnostics
extendedProperties
أي خصائص إضافية مثل الوصف التفصيلي للسياقات المختلفة وسياقات المستخدم/المجموعة
extendedProperties: {[key: string]: string}
قيمة الخاصية
{[key: string]: string}
filter
معايير المطابقة للاشتراك. مرشح ExpressionFilter
filter: ISubscriptionFilter
قيمة الخاصية
flags
id
معرف الاشتراك.
id: string
قيمة الخاصية
string
lastModifiedBy
المستخدم الذي قام بتعديل (أو إنشاء) الاشتراك آخر مرة.
lastModifiedBy: IdentityRef
قيمة الخاصية
modifiedDate
تاريخ آخر تعديل للاشتراك. إذا لم يتم تحديث الاشتراك منذ إنشائه، فستشير هذه القيمة إلى وقت إنشاء الاشتراك.
modifiedDate: Date
قيمة الخاصية
Date
permissions
الأذونات التي يمتلكها المستخدم لهذه الاشتراكات.
permissions: SubscriptionPermissions
قيمة الخاصية
scope
الحاوية التي يجب نشر الأحداث منها حتى تتم مطابقتها مع الاشتراك. إذا كان فارغا، يكون النطاق هو المضيف الحالي (عادة ما يكون حسابا أو مجموعة مشروع). على سبيل المثال، لن ينتج عن الاشتراك الذي تم تحديد نطاقه للمشروع "أ" إعلامات للأحداث المنشورة من المشروع "ب".
scope: SubscriptionScope
قيمة الخاصية
status
حالة الاشتراك. يشير عادة إلى ما إذا كان الاشتراك ممكنا أم لا.
status: SubscriptionStatus
قيمة الخاصية
statusMessage
رسالة توفر مزيدا من التفاصيل حول حالة الاشتراك.
statusMessage: string
قيمة الخاصية
string
subscriber
المستخدم أو المجموعة التي ستتلقى إشعارات بالأحداث التي تتوافق مع معايير فلتر الاشتراك.
subscriber: IdentityRef
قيمة الخاصية
url
عنوان URL لواجهة برمجة تطبيقات REST للاشتراك.
url: string
قيمة الخاصية
string
userSettings
الإعدادات المدارة من قبل المستخدم للاشتراك. ينطبق فقط عندما يكون المشترك مجموعة. تستخدم عادة للإشارة إلى ما إذا كان المستخدم المتصل قد تم تمجيزه أو إلغاء اشتراك المجموعة.
userSettings: SubscriptionUserSettings