ServiceHooksRestClient class

Paket:

azure-devops-extension-api

VSS REST api'lerine istekte bulunmak için kullanılması gereken (türetilen) temel sınıf

Extends

RestClientBase

Oluşturucular

ServiceHooksRestClient(IVssRestClientOptions)

Yöntemler

createSubscription(Subscription)	Abonelik oluşturma.
createSubscriptionsQuery(SubscriptionsQuery)	Hizmet kancası aboneliklerini sorgulama.
createTestNotification(Notification, boolean)	Bir test bildirimi gönderir. Bu, güncelleştirilmiş veya yeni bir hizmet kancaları aboneliğinin yapılandırmasını doğrulamak için kullanışlıdır.
deleteSubscription(string)	Belirli bir hizmet kancası aboneliğini silin.
getConsumer(string, string)	Belirli bir tüketici hizmeti alın. İsteğe bağlı olarak, belirtilen yayımcı için herhangi bir olay türünü desteklemeyen tüketici eylemlerini filtreleyin.
getConsumerAction(string, string, string)	Belirli bir tüketici işlemi hakkında ayrıntılı bilgi edinin.
getEventType(string, string)	Belirli bir olay türünü alın.
getNotification(string, number)	Bir abonelik için belirli bir bildirim alın.
getNotifications(string, number, NotificationStatus, NotificationResult)	Belirli bir abonelik için bildirimlerin listesini alın. Bir bildirim, olayla ilgili ayrıntıları, tüketici hizmetlerine yapılan isteği ve yanıtı içerir.
getPublisher(string)	Belirli bir hizmet kancaları yayımcısı edinin.
getSubscription(string)	Belirli bir hizmet kancaları aboneliği alın.
getSubscriptionDiagnostics(string)
listConsumerActions(string, string)	Belirli bir tüketici için tüketici eylemlerinin bir listesini alın.
listConsumers(string)	Mevcut hizmet kancası tüketici hizmetlerinin bir listesini alın. İsteğe bağlı olarak, belirli bir yayıncıdan en az bir etkinlik türünü destekleyen tüketicilere göre filtreleyin.
listEventTypes(string)	Belirli bir yayıncı için etkinlik türlerini alın.
listPublishers()	Yayıncıların listesini alın.
listSubscriptions(string, string, string, string)	Aboneliklerin listesini alın.
publishExternalEvent(string, string)	Harici bir etkinlik yayınlayın.
queryInputValues(InputValuesQuery, string)
queryNotifications(NotificationsQuery)	Bildirimler için sorgu. Bir bildirim, olayla ilgili ayrıntıları, tüketici hizmetlerine yapılan isteği ve yanıtı içerir.
queryPublishers(PublishersQuery)	Hizmet kancası yayımcıları için sorgu.
replaceSubscription(Subscription, string)	Aboneliği güncelleştirme. <güncelleştirmek istediğiniz bir abonelik için param name="subscriptionId">ID.</param>
updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)

Oluşturucu Ayrıntıları

ServiceHooksRestClient(IVssRestClientOptions)

new ServiceHooksRestClient(options: IVssRestClientOptions)

Parametreler

options

IVssRestClientOptions

Yöntem Ayrıntıları

createSubscription(Subscription)

Abonelik oluşturma.

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

Parametreler

subscription

Subscription

Abonelik oluşturulacak.

Döndürülenler

Promise<Subscription>

createSubscriptionsQuery(SubscriptionsQuery)

Hizmet kancası aboneliklerini sorgulama.

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

Parametreler

query

SubscriptionsQuery

Döndürülenler

Promise<SubscriptionsQuery>

createTestNotification(Notification, boolean)

Bir test bildirimi gönderir. Bu, güncelleştirilmiş veya yeni bir hizmet kancaları aboneliğinin yapılandırmasını doğrulamak için kullanışlıdır.

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

Parametreler

testNotification

Notification

useRealData

boolean

Yalnızca mevcut aboneliklerde gerçek verilerle teste izin verin.

Döndürülenler

Promise<Notification>

deleteSubscription(string)

Belirli bir hizmet kancası aboneliğini silin.

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

Parametreler

subscriptionId

string

Abonelik kimliği.

Döndürülenler

Promise<void>

getConsumer(string, string)

Belirli bir tüketici hizmeti alın. İsteğe bağlı olarak, belirtilen yayımcı için herhangi bir olay türünü desteklemeyen tüketici eylemlerini filtreleyin.

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

Parametreler

consumerId

string

Tüketici için kimlik.

publisherId

string

Döndürülenler

Promise<Consumer>

getConsumerAction(string, string, string)

Belirli bir tüketici işlemi hakkında ayrıntılı bilgi edinin.

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

Parametreler

consumerId

string

Tüketici için kimlik.

consumerActionId

string

consumerActionId için kimlik.

publisherId

string

Döndürülenler

Promise<ConsumerAction>

getEventType(string, string)

Belirli bir olay türünü alın.

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

Parametreler

publisherId

string

Bir yayıncının kimliği.

eventTypeId

string

Döndürülenler

Promise<EventTypeDescriptor>

getNotification(string, number)

Bir abonelik için belirli bir bildirim alın.

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

Parametreler

subscriptionId

string

Abonelik kimliği.

notificationId

number

Döndürülenler

Promise<Notification>

getNotifications(string, number, NotificationStatus, NotificationResult)

Belirli bir abonelik için bildirimlerin listesini alın. Bir bildirim, olayla ilgili ayrıntıları, tüketici hizmetlerine yapılan isteği ve yanıtı içerir.

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

Parametreler

subscriptionId

string

Abonelik kimliği.

maxResults

number

Döndürülecek maksimum bildirim sayısı. Varsayılan değer 100'dür.

status

NotificationStatus

Yalnızca bu durumdaki bildirimleri alın.

result

NotificationResult

Yalnızca bu sonuç türüne sahip bildirimleri alın.

Döndürülenler

Promise<Notification[]>

getPublisher(string)

Belirli bir hizmet kancaları yayımcısı edinin.

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

Parametreler

publisherId

string

Bir yayıncının kimliği.

Döndürülenler

Promise<Publisher>

getSubscription(string)

Belirli bir hizmet kancaları aboneliği alın.

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

Parametreler

subscriptionId

string

Abonelik kimliği.

Döndürülenler

Promise<Subscription>

getSubscriptionDiagnostics(string)

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

Parametreler

subscriptionId

string

Döndürülenler

Promise<SubscriptionDiagnostics>

listConsumerActions(string, string)

Belirli bir tüketici için tüketici eylemlerinin bir listesini alın.

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

Parametreler

consumerId

string

Tüketici için kimlik.

publisherId

string

Döndürülenler

Promise<ConsumerAction[]>

listConsumers(string)

Mevcut hizmet kancası tüketici hizmetlerinin bir listesini alın. İsteğe bağlı olarak, belirli bir yayıncıdan en az bir etkinlik türünü destekleyen tüketicilere göre filtreleyin.

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

Parametreler

publisherId

string

Döndürülenler

Promise<Consumer[]>

listEventTypes(string)

Belirli bir yayıncı için etkinlik türlerini alın.

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

Parametreler

publisherId

string

Bir yayıncının kimliği.

Döndürülenler

Promise<EventTypeDescriptor[]>

listPublishers()

Yayıncıların listesini alın.

function listPublishers(): Promise<Publisher[]>

Döndürülenler

Promise<Publisher[]>

listSubscriptions(string, string, string, string)

Aboneliklerin listesini alın.

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

Parametreler

publisherId

string

Abonelik kimliği.

eventType

string

Filtrelenecek olay türü (varsa).

consumerId

string

Tüketici için kimlik.

consumerActionId

string

consumerActionId için kimlik.

Döndürülenler

Promise<Subscription[]>

publishExternalEvent(string, string)

Harici bir etkinlik yayınlayın.

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

Parametreler

publisherId

string

channelId

string

Döndürülenler

Promise<PublisherEvent[]>

queryInputValues(InputValuesQuery, string)

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

Parametreler

inputValuesQuery

InputValuesQuery

publisherId

string

Döndürülenler

Promise<InputValuesQuery>

queryNotifications(NotificationsQuery)

Bildirimler için sorgu. Bir bildirim, olayla ilgili ayrıntıları, tüketici hizmetlerine yapılan isteği ve yanıtı içerir.

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

Parametreler

query

NotificationsQuery

Döndürülenler

Promise<NotificationsQuery>

queryPublishers(PublishersQuery)

Hizmet kancası yayımcıları için sorgu.

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

Parametreler

query

PublishersQuery

Döndürülenler

Promise<PublishersQuery>

replaceSubscription(Subscription, string)

Aboneliği güncelleştirme. <güncelleştirmek istediğiniz bir abonelik için param name="subscriptionId">ID.</param>

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

Parametreler

subscription

Subscription

subscriptionId

string

Döndürülenler

Promise<Subscription>

updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)

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

Parametreler

updateParameters

UpdateSubscripitonDiagnosticsParameters

subscriptionId

string

Döndürülenler

Promise<SubscriptionDiagnostics>