ServiceHooksRestClient class

Csomag:

azure-devops-extension-api

Alaposztály, amelyet a VSS REST API-k kéréseinek igényléséhez (származtatásából) kell használni

Extends

RestClientBase

Konstruktorok

ServiceHooksRestClient(IVssRestClientOptions)

Metódusok

createSubscription(Subscription)	Hozzon létre egy előfizetést.
createSubscriptionsQuery(SubscriptionsQuery)	Szolgáltatáshook-előfizetések lekérdezése.
createTestNotification(Notification, boolean)	Tesztértesítést küld. Ez hasznos egy frissített vagy új szolgáltatáshook-előfizetés konfigurációjának ellenőrzéséhez.
deleteSubscription(string)	Töröljön egy adott szolgáltatáshook-előfizetést.
getConsumer(string, string)	Adott fogyasztói szolgáltatás lekérése. Igény szerint kiszűrheti azokat a felhasználói műveleteket, amelyek nem támogatják a megadott közzétevő eseménytípusát.
getConsumerAction(string, string, string)	Egy adott fogyasztói művelet részleteinek lekérése.
getEventType(string, string)	Adott eseménytípus lekérése.
getNotification(string, number)	Adott értesítés kérése egy előfizetésről.
getNotifications(string, number, NotificationStatus, NotificationResult)	Lekérheti egy adott előfizetés értesítéseinek listáját. Az értesítés tartalmazza az esemény, a kérelem és a fogyasztói szolgáltatás válaszának részleteit.
getPublisher(string)	Adott szolgáltatáshook-közzétevő lekérése.
getSubscription(string)	Adott szolgáltatáshook-előfizetés lekérése.
getSubscriptionDiagnostics(string)
listConsumerActions(string, string)	Egy adott fogyasztóra vonatkozó fogyasztói műveletek listájának lekérése.
listConsumers(string)	Szerezze be az elérhető szolgáltatáshook fogyasztói szolgáltatásainak listáját. Igény szerint szűrheti azokat a felhasználókat, amelyek legalább egy eseménytípust támogatnak az adott közzétevőtől.
listEventTypes(string)	Egy adott közzétevő eseménytípusainak lekérése.
listPublishers()	A közzétevők listájának lekérése.
listSubscriptions(string, string, string, string)	Előfizetések listájának lekérése.
publishExternalEvent(string, string)	Külső esemény közzététele.
queryInputValues(InputValuesQuery, string)
queryNotifications(NotificationsQuery)	Értesítések lekérdezése. Az értesítés tartalmazza az esemény, a kérelem és a fogyasztói szolgáltatás válaszának részleteit.
queryPublishers(PublishersQuery)	Szolgáltatáshook-közzétevők lekérdezése.
replaceSubscription(Subscription, string)	Előfizetés frissítése. <param name="subscriptionId">frissíteni kívánt előfizetés azonosítója.</param>
updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)

Konstruktor adatai

ServiceHooksRestClient(IVssRestClientOptions)

new ServiceHooksRestClient(options: IVssRestClientOptions)

Paraméterek

options

IVssRestClientOptions

Metódus adatai

createSubscription(Subscription)

Hozzon létre egy előfizetést.

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

Paraméterek

subscription

Subscription

Létrehozandó előfizetés.

Válaszok

Promise<Subscription>

createSubscriptionsQuery(SubscriptionsQuery)

Szolgáltatáshook-előfizetések lekérdezése.

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

Paraméterek

query

SubscriptionsQuery

Válaszok

Promise<SubscriptionsQuery>

createTestNotification(Notification, boolean)

Tesztértesítést küld. Ez hasznos egy frissített vagy új szolgáltatáshook-előfizetés konfigurációjának ellenőrzéséhez.

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

Paraméterek

testNotification

Notification

useRealData

boolean

Csak valós adatokkal való tesztelés engedélyezése meglévő előfizetésekben.

Válaszok

Promise<Notification>

deleteSubscription(string)

Töröljön egy adott szolgáltatáshook-előfizetést.

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

Paraméterek

subscriptionId

string

Előfizetés azonosítója.

Válaszok

Promise<void>

getConsumer(string, string)

Adott fogyasztói szolgáltatás lekérése. Igény szerint kiszűrheti azokat a felhasználói műveleteket, amelyek nem támogatják a megadott közzétevő eseménytípusát.

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

Paraméterek

consumerId

string

Egy fogyasztó azonosítója.

publisherId

string

Válaszok

Promise<Consumer>

getConsumerAction(string, string, string)

Egy adott fogyasztói művelet részleteinek lekérése.

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

Paraméterek

consumerId

string

Egy fogyasztó azonosítója.

consumerActionId

string

ConsumerActionId azonosító.

publisherId

string

Válaszok

Promise<ConsumerAction>

getEventType(string, string)

Adott eseménytípus lekérése.

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

Paraméterek

publisherId

string

Közzétevő azonosítója.

eventTypeId

string

Válaszok

Promise<EventTypeDescriptor>

getNotification(string, number)

Adott értesítés kérése egy előfizetésről.

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

Paraméterek

subscriptionId

string

Előfizetés azonosítója.

notificationId

number

Válaszok

Promise<Notification>

getNotifications(string, number, NotificationStatus, NotificationResult)

Lekérheti egy adott előfizetés értesítéseinek listáját. Az értesítés tartalmazza az esemény, a kérelem és a fogyasztói szolgáltatás válaszának részleteit.

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

Paraméterek

subscriptionId

string

Előfizetés azonosítója.

maxResults

number

A visszaadandó értesítések maximális száma. Az alapértelmezett érték 100.

status

NotificationStatus

Csak ilyen állapotú értesítéseket kaphat.

result

NotificationResult

Csak ezzel az eredménytípussal kapcsolatos értesítéseket kaphat.

Válaszok

Promise<Notification[]>

getPublisher(string)

Adott szolgáltatáshook-közzétevő lekérése.

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

Paraméterek

publisherId

string

Közzétevő azonosítója.

Válaszok

Promise<Publisher>

getSubscription(string)

Adott szolgáltatáshook-előfizetés lekérése.

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

Paraméterek

subscriptionId

string

Előfizetés azonosítója.

Válaszok

Promise<Subscription>

getSubscriptionDiagnostics(string)

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

Paraméterek

subscriptionId

string

Válaszok

Promise<SubscriptionDiagnostics>

listConsumerActions(string, string)

Egy adott fogyasztóra vonatkozó fogyasztói műveletek listájának lekérése.

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

Paraméterek

consumerId

string

Egy fogyasztó azonosítója.

publisherId

string

Válaszok

Promise<ConsumerAction[]>

listConsumers(string)

Szerezze be az elérhető szolgáltatáshook fogyasztói szolgáltatásainak listáját. Igény szerint szűrheti azokat a felhasználókat, amelyek legalább egy eseménytípust támogatnak az adott közzétevőtől.

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

Paraméterek

publisherId

string

Válaszok

Promise<Consumer[]>

listEventTypes(string)

Egy adott közzétevő eseménytípusainak lekérése.

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

Paraméterek

publisherId

string

Közzétevő azonosítója.

Válaszok

Promise<EventTypeDescriptor[]>

listPublishers()

A közzétevők listájának lekérése.

function listPublishers(): Promise<Publisher[]>

Válaszok

Promise<Publisher[]>

listSubscriptions(string, string, string, string)

Előfizetések listájának lekérése.

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

Paraméterek

publisherId

string

Előfizetés azonosítója.

eventType

string

A szűrni kívánt esemény típusa (ha van ilyen).

consumerId

string

Egy fogyasztó azonosítója.

consumerActionId

string

ConsumerActionId azonosító.

Válaszok

Promise<Subscription[]>

publishExternalEvent(string, string)

Külső esemény közzététele.

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

Paraméterek

publisherId

string

channelId

string

Válaszok

Promise<PublisherEvent[]>

queryInputValues(InputValuesQuery, string)

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

Paraméterek

inputValuesQuery

InputValuesQuery

publisherId

string

Válaszok

Promise<InputValuesQuery>

queryNotifications(NotificationsQuery)

Értesítések lekérdezése. Az értesítés tartalmazza az esemény, a kérelem és a fogyasztói szolgáltatás válaszának részleteit.

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

Paraméterek

query

NotificationsQuery

Válaszok

Promise<NotificationsQuery>

queryPublishers(PublishersQuery)

Szolgáltatáshook-közzétevők lekérdezése.

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

Paraméterek

query

PublishersQuery

Válaszok

Promise<PublishersQuery>

replaceSubscription(Subscription, string)

Előfizetés frissítése. <param name="subscriptionId">frissíteni kívánt előfizetés azonosítója.</param>

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

Paraméterek

subscription

Subscription

subscriptionId

string

Válaszok

Promise<Subscription>

updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)

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

Paraméterek

updateParameters

UpdateSubscripitonDiagnosticsParameters

subscriptionId

string

Válaszok

Promise<SubscriptionDiagnostics>