ServiceHooksRestClient class

الحزمة:

azure-devops-extension-api

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

Extends

RestClientBase

المنشئون

ServiceHooksRestClient(IVssRestClientOptions)

الأساليب

createSubscription(Subscription)	إنشاء اشتراك.
createSubscriptionsQuery(SubscriptionsQuery)	الاستعلام عن اشتراكات ربط الخدمة.
createTestNotification(Notification, boolean)	إرسال إعلام اختبار. هذا مفيد للتحقق من تكوين اشتراك خطافات الخدمة المحدثة أو الجديدة.
deleteSubscription(string)	حذف اشتراك خطافات خدمة معينة.
getConsumer(string, string)	احصل على خدمة مستهلك محددة. تصفية إجراءات المستهلك التي لا تدعم أي أنواع أحداث للناشر المحدد اختياريا.
getConsumerAction(string, string, string)	احصل على تفاصيل حول إجراء مستهلك معين.
getEventType(string, string)	احصل على نوع حدث معين.
getNotification(string, number)	احصل على إعلام محدد للاشتراك.
getNotifications(string, number, NotificationStatus, NotificationResult)	احصل على قائمة الإعلامات لاشتراك معين. يتضمن الإعلام تفاصيل حول الحدث والطلب إلى والاستجابة من خدمة المستهلك.
getPublisher(string)	احصل على ناشر خطافات خدمة معين.
getSubscription(string)	احصل على اشتراك محدد في خطافات الخدمة.
getSubscriptionDiagnostics(string)
listConsumerActions(string, string)	احصل على قائمة بإجراءات المستهلك لمستهلك معين.
listConsumers(string)	احصل على قائمة بخدمات مستهلكي ربط الخدمة المتوفرة. تصفية اختياريا حسب المستهلكين الذين يدعمون نوع حدث واحد على الأقل من الناشر المحدد.
listEventTypes(string)	احصل على أنواع الأحداث لناشر معين.
listPublishers()	احصل على قائمة بالناشرين.
listSubscriptions(string, string, string, string)	احصل على قائمة الاشتراكات.
publishExternalEvent(string, string)	نشر حدث خارجي.
queryInputValues(InputValuesQuery, string)
queryNotifications(NotificationsQuery)	الاستعلام عن الإعلامات. يتضمن الإعلام تفاصيل حول الحدث والطلب إلى والاستجابة من خدمة المستهلك.
queryPublishers(PublishersQuery)	الاستعلام عن ناشري ربط الخدمة.
replaceSubscription(Subscription, string)	تحديث اشتراك. <param name="subscriptionId">ID للاشتراك الذي ترغب في تحديثه.< /بارام>
updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)

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

ServiceHooksRestClient(IVssRestClientOptions)

new ServiceHooksRestClient(options: IVssRestClientOptions)

المعلمات

options

IVssRestClientOptions

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

createSubscription(Subscription)

إنشاء اشتراك.

function createSubscription(subscription: Subscription): Promise<Subscription>

المعلمات

subscription

Subscription

الاشتراك الذي سيتم إنشاؤه.

المرتجعات

Promise<Subscription>

createSubscriptionsQuery(SubscriptionsQuery)

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

function createSubscriptionsQuery(query: SubscriptionsQuery): Promise<SubscriptionsQuery>

المعلمات

query

SubscriptionsQuery

المرتجعات

Promise<SubscriptionsQuery>

createTestNotification(Notification, boolean)

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

function createTestNotification(testNotification: Notification, useRealData?: boolean): Promise<Notification>

المعلمات

testNotification

Notification

useRealData

boolean

السماح فقط بالاختبار مع البيانات الحقيقية في الاشتراكات الموجودة.

المرتجعات

Promise<Notification>

deleteSubscription(string)

حذف اشتراك خطافات خدمة معينة.

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

المعلمات

subscriptionId

string

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

المرتجعات

Promise<void>

getConsumer(string, string)

احصل على خدمة مستهلك محددة. تصفية إجراءات المستهلك التي لا تدعم أي أنواع أحداث للناشر المحدد اختياريا.

function getConsumer(consumerId: string, publisherId?: string): Promise<Consumer>

المعلمات

consumerId

string

معرف للمستهلك.

publisherId

string

المرتجعات

Promise<Consumer>

getConsumerAction(string, string, string)

احصل على تفاصيل حول إجراء مستهلك معين.

function getConsumerAction(consumerId: string, consumerActionId: string, publisherId?: string): Promise<ConsumerAction>

المعلمات

consumerId

string

معرف للمستهلك.

consumerActionId

string

معرف ل consumerActionId.

publisherId

string

المرتجعات

Promise<ConsumerAction>

getEventType(string, string)

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

function getEventType(publisherId: string, eventTypeId: string): Promise<EventTypeDescriptor>

المعلمات

publisherId

string

معرف الناشر.

eventTypeId

string

المرتجعات

Promise<EventTypeDescriptor>

getNotification(string, number)

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

function getNotification(subscriptionId: string, notificationId: number): Promise<Notification>

المعلمات

subscriptionId

string

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

notificationId

number

المرتجعات

Promise<Notification>

getNotifications(string, number, NotificationStatus, NotificationResult)

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

function getNotifications(subscriptionId: string, maxResults?: number, status?: NotificationStatus, result?: NotificationResult): Promise<Notification[]>

المعلمات

subscriptionId

string

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

maxResults

number

الحد الأقصى لعدد الإعلامات التي يجب إرجاعها. الافتراضي هو 100.

status

NotificationStatus

احصل على إعلامات بهذه الحالة فقط.

result

NotificationResult

احصل على إعلامات بهذا النوع من النتيجة فقط.

المرتجعات

Promise<Notification[]>

getPublisher(string)

احصل على ناشر خطافات خدمة معين.

function getPublisher(publisherId: string): Promise<Publisher>

المعلمات

publisherId

string

معرف الناشر.

المرتجعات

Promise<Publisher>

getSubscription(string)

احصل على اشتراك محدد في خطافات الخدمة.

function getSubscription(subscriptionId: string): Promise<Subscription>

المعلمات

subscriptionId

string

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

المرتجعات

Promise<Subscription>

getSubscriptionDiagnostics(string)

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

المعلمات

subscriptionId

string

المرتجعات

Promise<SubscriptionDiagnostics>

listConsumerActions(string, string)

احصل على قائمة بإجراءات المستهلك لمستهلك معين.

function listConsumerActions(consumerId: string, publisherId?: string): Promise<ConsumerAction[]>

المعلمات

consumerId

string

معرف للمستهلك.

publisherId

string

المرتجعات

Promise<ConsumerAction[]>

listConsumers(string)

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

function listConsumers(publisherId?: string): Promise<Consumer[]>

المعلمات

publisherId

string

المرتجعات

Promise<Consumer[]>

listEventTypes(string)

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

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

المعلمات

publisherId

string

معرف الناشر.

المرتجعات

Promise<EventTypeDescriptor[]>

listPublishers()

احصل على قائمة بالناشرين.

function listPublishers(): Promise<Publisher[]>

المرتجعات

Promise<Publisher[]>

listSubscriptions(string, string, string, string)

احصل على قائمة الاشتراكات.

function listSubscriptions(publisherId?: string, eventType?: string, consumerId?: string, consumerActionId?: string): Promise<Subscription[]>

المعلمات

publisherId

string

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

eventType

string

نوع الحدث المراد تصفيته (إن وجد).

consumerId

string

معرف للمستهلك.

consumerActionId

string

معرف ل consumerActionId.

المرتجعات

Promise<Subscription[]>

publishExternalEvent(string, string)

نشر حدث خارجي.

function publishExternalEvent(publisherId: string, channelId?: string): Promise<PublisherEvent[]>

المعلمات

publisherId

string

channelId

string

المرتجعات

Promise<PublisherEvent[]>

queryInputValues(InputValuesQuery, string)

function queryInputValues(inputValuesQuery: InputValuesQuery, publisherId: string): Promise<InputValuesQuery>

المعلمات

inputValuesQuery

InputValuesQuery

publisherId

string

المرتجعات

Promise<InputValuesQuery>

queryNotifications(NotificationsQuery)

الاستعلام عن الإعلامات. يتضمن الإعلام تفاصيل حول الحدث والطلب إلى والاستجابة من خدمة المستهلك.

function queryNotifications(query: NotificationsQuery): Promise<NotificationsQuery>

المعلمات

query

NotificationsQuery

المرتجعات

Promise<NotificationsQuery>

queryPublishers(PublishersQuery)

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

function queryPublishers(query: PublishersQuery): Promise<PublishersQuery>

المعلمات

query

PublishersQuery

المرتجعات

Promise<PublishersQuery>

replaceSubscription(Subscription, string)

تحديث اشتراك. <param name="subscriptionId">ID للاشتراك الذي ترغب في تحديثه.< /بارام>

function replaceSubscription(subscription: Subscription, subscriptionId?: string): Promise<Subscription>

المعلمات

subscription

Subscription

subscriptionId

string

المرتجعات

Promise<Subscription>

updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)

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

المعلمات

updateParameters

UpdateSubscripitonDiagnosticsParameters

subscriptionId

string

المرتجعات

Promise<SubscriptionDiagnostics>