NotificationRestClient class

الحزمة:

azure-devops-extension-api

الفئة الأساسية التي يجب استخدامها (مشتقة من) لتقديم طلبات إلى VSS REST apis

يمتد

RestClientBase

المنشئون

NotificationRestClient(IVssRestClientOptions)

الأساليب

createSubscription(NotificationSubscriptionCreateParameters)	إنشاء اشتراك جديد.
deleteSubscription(string)	حذف اشتراك.
getEventType(string)	الحصول على نوع حدث معين.
getNotificationReasons(number)
getSettings()
getSubscriber(string)	احصل على تفضيلات التسليم لمشترك الإعلامات.
getSubscription(string, SubscriptionQueryFlags)	احصل على اشتراك إعلام بواسطة معرفه.
getSubscriptionDiagnostics(string)	احصل على إعدادات التشخيص للاشتراك.
getSubscriptionTemplates()	احصل على قوالب الاشتراك المتوفرة.
listEventTypes(string)	سرد أنواع الأحداث المتوفرة لهذه الخدمة. تصفية اختياريا حسب أنواع الأحداث فقط للناشر المحدد.
listLogs(string, string, Date, Date)	احصل على قائمة بسجلات التشخيص لهذه الخدمة.
listNotificationReasons(number)
listSubscriptions(string, string[], SubscriptionQueryFlags)	احصل على قائمة باشتراكات الإعلامات، إما بواسطة معرفات الاشتراك أو بواسطة جميع الاشتراكات لمستخدم أو مجموعة معينة.
performBatchNotificationOperations(BatchNotificationOperation)
publishEvent(VssNotificationEvent)	نشر حدث. يجب توجيه هذا الطلب إلى الخدمة "extmgmt".
publishTokenEvent(VssNotificationEvent)	نشر حدث. هذا الطلب مخصص فقط لخدمة الرمز المميز لأنها خدمة نشر فقط.
queryEventTypes(FieldValuesQuery, string)
querySubscriptions(SubscriptionQuery)	الاستعلام عن الاشتراكات. يتم إرجاع الاشتراك إذا كان يطابق شرطا واحدا أو أكثر من الشروط المحددة.
transformEvent(EventTransformRequest)	تكوين حدث إعلام.
updateSettings(NotificationAdminSettingsUpdateParameters)
updateSubscriber(NotificationSubscriberUpdateParameters, string)	تحديث تفضيلات التسليم لمشترك الإعلامات.
updateSubscription(NotificationSubscriptionUpdateParameters, string)	تحديث اشتراك موجود. اعتمادا على نوع الاشتراك والأذونات، يمكن للمتصل تحديث الوصف وإعدادات التصفية وإعدادات القناة (التسليم) والمزيد.
updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)	تحديث إعدادات التشخيص للاشتراك.
updateSubscriptionUserSettings(SubscriptionUserSettings, string, string)	تحديث إعدادات المستخدم المحدد للاشتراك المحدد. عادة ما يتم استخدام واجهة برمجة التطبيقات هذه للاشتراك في اشتراك مشترك أو خارجه. يمكن تطبيق إعدادات المستخدم فقط على الاشتراكات المشتركة، مثل اشتراكات الفريق أو الاشتراكات الافتراضية.

تفاصيل المنشئ

NotificationRestClient(IVssRestClientOptions)

new NotificationRestClient(options: IVssRestClientOptions)

المعلمات

options

IVssRestClientOptions

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

createSubscription(NotificationSubscriptionCreateParameters)

إنشاء اشتراك جديد.

function createSubscription(createParameters: NotificationSubscriptionCreateParameters): Promise<NotificationSubscription>

المعلمات

createParameters

NotificationSubscriptionCreateParameters

المرتجعات

Promise<NotificationSubscription>

deleteSubscription(string)

حذف اشتراك.

function deleteSubscription(subscriptionId: string): Promise<void>

المعلمات

subscriptionId

string

المرتجعات

Promise<void>

getEventType(string)

الحصول على نوع حدث معين.

function getEventType(eventType: string): Promise<NotificationEventType>

المعلمات

eventType

string

معرف نوع الحدث.

المرتجعات

Promise<NotificationEventType>

getNotificationReasons(number)

function getNotificationReasons(notificationId: number): Promise<NotificationReason>

المعلمات

notificationId

number

المرتجعات

Promise<NotificationReason>

getSettings()

function getSettings(): Promise<NotificationAdminSettings>

المرتجعات

Promise<NotificationAdminSettings>

getSubscriber(string)

احصل على تفضيلات التسليم لمشترك الإعلامات.

function getSubscriber(subscriberId: string): Promise<NotificationSubscriber>

المعلمات

subscriberId

string

معرف المستخدم أو المجموعة.

المرتجعات

Promise<NotificationSubscriber>

getSubscription(string, SubscriptionQueryFlags)

احصل على اشتراك إعلام بواسطة معرفه.

function getSubscription(subscriptionId: string, queryFlags?: SubscriptionQueryFlags): Promise<NotificationSubscription>

المعلمات

subscriptionId

string

queryFlags

SubscriptionQueryFlags

المرتجعات

Promise<NotificationSubscription>

getSubscriptionDiagnostics(string)

احصل على إعدادات التشخيص للاشتراك.

function getSubscriptionDiagnostics(subscriptionId: string): Promise<SubscriptionDiagnostics>

المعلمات

subscriptionId

string

معرف اشتراك الإعلامات.

المرتجعات

Promise<SubscriptionDiagnostics>

getSubscriptionTemplates()

احصل على قوالب الاشتراك المتوفرة.

function getSubscriptionTemplates(): Promise<NotificationSubscriptionTemplate[]>

المرتجعات

Promise<NotificationSubscriptionTemplate[]>

listEventTypes(string)

سرد أنواع الأحداث المتوفرة لهذه الخدمة. تصفية اختياريا حسب أنواع الأحداث فقط للناشر المحدد.

function listEventTypes(publisherId?: string): Promise<NotificationEventType[]>

المعلمات

publisherId

string

تقييد أنواع الأحداث لهذا الناشر

المرتجعات

Promise<NotificationEventType[]>

listLogs(string, string, Date, Date)

احصل على قائمة بسجلات التشخيص لهذه الخدمة.

function listLogs(source: string, entryId?: string, startTime?: Date, endTime?: Date): Promise<INotificationDiagnosticLog[]>

المعلمات

source

string

معرف يحدد نوع السجلات التي يجب التحقق من التشخيص لها.

entryId

string

معرف السجل المحدد للاستعلام عن.

startTime

Date

وقت البدء للنطاق الزمني للاستعلام فيه.

endTime

Date

وقت الانتهاء للنطاق الزمني للاستعلام فيه.

المرتجعات

Promise<INotificationDiagnosticLog[]>

listNotificationReasons(number)

function listNotificationReasons(notificationIds?: number): Promise<NotificationReason[]>

المعلمات

notificationIds

number

المرتجعات

Promise<NotificationReason[]>

listSubscriptions(string, string[], SubscriptionQueryFlags)

احصل على قائمة باشتراكات الإعلامات، إما بواسطة معرفات الاشتراك أو بواسطة جميع الاشتراكات لمستخدم أو مجموعة معينة.

function listSubscriptions(targetId?: string, ids?: string[], queryFlags?: SubscriptionQueryFlags): Promise<NotificationSubscription[]>

المعلمات

targetId

string

معرف المستخدم أو المجموعة

ids

string[]

قائمة معرفات الاشتراك

queryFlags

SubscriptionQueryFlags

المرتجعات

Promise<NotificationSubscription[]>

performBatchNotificationOperations(BatchNotificationOperation)

function performBatchNotificationOperations(operation: BatchNotificationOperation): Promise<void>

المعلمات

operation

BatchNotificationOperation

المرتجعات

Promise<void>

publishEvent(VssNotificationEvent)

نشر حدث. يجب توجيه هذا الطلب إلى الخدمة "extmgmt".

function publishEvent(notificationEvent: VssNotificationEvent): Promise<VssNotificationEvent>

المعلمات

notificationEvent

VssNotificationEvent

المرتجعات

Promise<VssNotificationEvent>

publishTokenEvent(VssNotificationEvent)

نشر حدث. هذا الطلب مخصص فقط لخدمة الرمز المميز لأنها خدمة نشر فقط.

function publishTokenEvent(notificationEvent: VssNotificationEvent): Promise<VssNotificationEvent>

المعلمات

notificationEvent

VssNotificationEvent

المرتجعات

Promise<VssNotificationEvent>

queryEventTypes(FieldValuesQuery, string)

function queryEventTypes(inputValuesQuery: FieldValuesQuery, eventType: string): Promise<NotificationEventField[]>

المعلمات

inputValuesQuery

FieldValuesQuery

eventType

string

المرتجعات

Promise<NotificationEventField[]>

querySubscriptions(SubscriptionQuery)

الاستعلام عن الاشتراكات. يتم إرجاع الاشتراك إذا كان يطابق شرطا واحدا أو أكثر من الشروط المحددة.

function querySubscriptions(subscriptionQuery: SubscriptionQuery): Promise<NotificationSubscription[]>

المعلمات

subscriptionQuery

SubscriptionQuery

المرتجعات

Promise<NotificationSubscription[]>

transformEvent(EventTransformRequest)

تكوين حدث إعلام.

function transformEvent(transformRequest: EventTransformRequest): Promise<EventTransformResult>

المعلمات

transformRequest

EventTransformRequest

الكائن الذي سيتم تحويله.

المرتجعات

Promise<EventTransformResult>

updateSettings(NotificationAdminSettingsUpdateParameters)

function updateSettings(updateParameters: NotificationAdminSettingsUpdateParameters): Promise<NotificationAdminSettings>

المعلمات

updateParameters

NotificationAdminSettingsUpdateParameters

المرتجعات

Promise<NotificationAdminSettings>

updateSubscriber(NotificationSubscriberUpdateParameters, string)

تحديث تفضيلات التسليم لمشترك الإعلامات.

function updateSubscriber(updateParameters: NotificationSubscriberUpdateParameters, subscriberId: string): Promise<NotificationSubscriber>

المعلمات

updateParameters

NotificationSubscriberUpdateParameters

subscriberId

string

معرف المستخدم أو المجموعة.

المرتجعات

Promise<NotificationSubscriber>

updateSubscription(NotificationSubscriptionUpdateParameters, string)

تحديث اشتراك موجود. اعتمادا على نوع الاشتراك والأذونات، يمكن للمتصل تحديث الوصف وإعدادات التصفية وإعدادات القناة (التسليم) والمزيد.

function updateSubscription(updateParameters: NotificationSubscriptionUpdateParameters, subscriptionId: string): Promise<NotificationSubscription>

المعلمات

updateParameters

NotificationSubscriptionUpdateParameters

subscriptionId

string

المرتجعات

Promise<NotificationSubscription>

updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)

تحديث إعدادات التشخيص للاشتراك.

function updateSubscriptionDiagnostics(updateParameters: UpdateSubscripitonDiagnosticsParameters, subscriptionId: string): Promise<SubscriptionDiagnostics>

المعلمات

updateParameters

UpdateSubscripitonDiagnosticsParameters

subscriptionId

string

معرف اشتراك الإعلامات.

المرتجعات

Promise<SubscriptionDiagnostics>

updateSubscriptionUserSettings(SubscriptionUserSettings, string, string)

تحديث إعدادات المستخدم المحدد للاشتراك المحدد. عادة ما يتم استخدام واجهة برمجة التطبيقات هذه للاشتراك في اشتراك مشترك أو خارجه. يمكن تطبيق إعدادات المستخدم فقط على الاشتراكات المشتركة، مثل اشتراكات الفريق أو الاشتراكات الافتراضية.

function updateSubscriptionUserSettings(userSettings: SubscriptionUserSettings, subscriptionId: string, userId: string): Promise<SubscriptionUserSettings>

المعلمات

userSettings

SubscriptionUserSettings

subscriptionId

string

userId

string

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

المرتجعات

Promise<SubscriptionUserSettings>