ServiceHooksRestClient class

Paket:

azure-devops-extension-api

Kelas dasar yang harus digunakan (berasal dari) untuk membuat permintaan ke VSS REST api

Memperluas

RestClientBase

Konstruktor

ServiceHooksRestClient(IVssRestClientOptions)

Metode

createSubscription(Subscription)	Buat langganan.
createSubscriptionsQuery(SubscriptionsQuery)	Kueri untuk langganan hook layanan.
createTestNotification(Notification, boolean)	Mengirim notifikasi pengujian. Ini berguna untuk memverifikasi konfigurasi langganan kait layanan yang diperbarui atau baru.
deleteSubscription(string)	Menghapus langganan hook layanan tertentu.
getConsumer(string, string)	Dapatkan layanan konsumen tertentu. Secara opsional, filter tindakan konsumen yang tidak mendukung jenis peristiwa apa pun untuk penayang yang ditentukan.
getConsumerAction(string, string, string)	Dapatkan detail tentang tindakan konsumen tertentu.
getEventType(string, string)	Dapatkan jenis peristiwa tertentu.
getNotification(string, number)	Dapatkan pemberitahuan khusus untuk langganan.
getNotifications(string, number, NotificationStatus, NotificationResult)	Dapatkan daftar pemberitahuan untuk langganan tertentu. Pemberitahuan mencakup detail tentang peristiwa, permintaan ke, dan respons dari layanan konsumen.
getPublisher(string)	Dapatkan penerbit pengait layanan tertentu.
getSubscription(string)	Dapatkan langganan hook layanan tertentu.
getSubscriptionDiagnostics(string)
listConsumerActions(string, string)	Dapatkan daftar tindakan konsumen untuk konsumen tertentu.
listConsumers(string)	Dapatkan daftar layanan kait layanan konsumen yang tersedia. Filter secara opsional berdasarkan konsumen yang mendukung setidaknya satu jenis peristiwa dari penerbit tertentu.
listEventTypes(string)	Dapatkan jenis peristiwa untuk penayang tertentu.
listPublishers()	Dapatkan daftar penayang.
listSubscriptions(string, string, string, string)	Dapatkan daftar langganan.
publishExternalEvent(string, string)	Publikasikan peristiwa eksternal.
queryInputValues(InputValuesQuery, string)
queryNotifications(NotificationsQuery)	Kueri untuk pemberitahuan. Pemberitahuan mencakup detail tentang peristiwa, permintaan ke, dan respons dari layanan konsumen.
queryPublishers(PublishersQuery)	Kueri untuk penerbit kait layanan.
replaceSubscription(Subscription, string)	Memperbarui langganan. <nama param="subscriptionId">ID untuk langganan yang ingin Anda perbarui.</Param>
updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)

Detail Konstruktor

ServiceHooksRestClient(IVssRestClientOptions)

new ServiceHooksRestClient(options: IVssRestClientOptions)

Parameter

options

IVssRestClientOptions

Detail Metode

createSubscription(Subscription)

Buat langganan.

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

Parameter

subscription

Subscription

Langganan akan dibuat.

Mengembalikan

Promise<Subscription>

createSubscriptionsQuery(SubscriptionsQuery)

Kueri untuk langganan hook layanan.

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

Parameter

query

SubscriptionsQuery

Mengembalikan

Promise<SubscriptionsQuery>

createTestNotification(Notification, boolean)

Mengirim notifikasi pengujian. Ini berguna untuk memverifikasi konfigurasi langganan kait layanan yang diperbarui atau baru.

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

Parameter

testNotification

Notification

useRealData

boolean

Hanya izinkan pengujian dengan data nyata dalam langganan yang ada.

Mengembalikan

Promise<Notification>

deleteSubscription(string)

Menghapus langganan hook layanan tertentu.

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

Parameter

subscriptionId

string

ID untuk langganan.

Mengembalikan

Promise<void>

getConsumer(string, string)

Dapatkan layanan konsumen tertentu. Secara opsional, filter tindakan konsumen yang tidak mendukung jenis peristiwa apa pun untuk penayang yang ditentukan.

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

Parameter

consumerId

string

ID untuk konsumen.

publisherId

string

Mengembalikan

Promise<Consumer>

getConsumerAction(string, string, string)

Dapatkan detail tentang tindakan konsumen tertentu.

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

Parameter

consumerId

string

ID untuk konsumen.

consumerActionId

string

ID untuk consumerActionId.

publisherId

string

Mengembalikan

Promise<ConsumerAction>

getEventType(string, string)

Dapatkan jenis peristiwa tertentu.

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

Parameter

publisherId

string

ID untuk penerbit.

eventTypeId

string

Mengembalikan

Promise<EventTypeDescriptor>

getNotification(string, number)

Dapatkan pemberitahuan khusus untuk langganan.

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

Parameter

subscriptionId

string

ID untuk langganan.

notificationId

number

Mengembalikan

Promise<Notification>

getNotifications(string, number, NotificationStatus, NotificationResult)

Dapatkan daftar pemberitahuan untuk langganan tertentu. Pemberitahuan mencakup detail tentang peristiwa, permintaan ke, dan respons dari layanan konsumen.

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

Parameter

subscriptionId

string

ID untuk langganan.

maxResults

number

Jumlah maksimum notifikasi yang akan dikembalikan. Defaultnya adalah 100.

status

NotificationStatus

Hanya mendapatkan notifikasi dengan status ini.

result

NotificationResult

Hanya mendapatkan notifikasi dengan jenis hasil ini.

Mengembalikan

Promise<Notification[]>

getPublisher(string)

Dapatkan penerbit pengait layanan tertentu.

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

Parameter

publisherId

string

ID untuk penerbit.

Mengembalikan

Promise<Publisher>

getSubscription(string)

Dapatkan langganan hook layanan tertentu.

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

Parameter

subscriptionId

string

ID untuk langganan.

Mengembalikan

Promise<Subscription>

getSubscriptionDiagnostics(string)

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

Parameter

subscriptionId

string

Mengembalikan

Promise<SubscriptionDiagnostics>

listConsumerActions(string, string)

Dapatkan daftar tindakan konsumen untuk konsumen tertentu.

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

Parameter

consumerId

string

ID untuk konsumen.

publisherId

string

Mengembalikan

Promise<ConsumerAction[]>

listConsumers(string)

Dapatkan daftar layanan kait layanan konsumen yang tersedia. Filter secara opsional berdasarkan konsumen yang mendukung setidaknya satu jenis peristiwa dari penerbit tertentu.

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

Parameter

publisherId

string

Mengembalikan

Promise<Consumer[]>

listEventTypes(string)

Dapatkan jenis peristiwa untuk penayang tertentu.

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

Parameter

publisherId

string

ID untuk penerbit.

Mengembalikan

Promise<EventTypeDescriptor[]>

listPublishers()

Dapatkan daftar penayang.

function listPublishers(): Promise<Publisher[]>

Mengembalikan

Promise<Publisher[]>

listSubscriptions(string, string, string, string)

Dapatkan daftar langganan.

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

Parameter

publisherId

string

ID untuk langganan.

eventType

string

Jenis peristiwa yang akan difilter (jika ada).

consumerId

string

ID untuk konsumen.

consumerActionId

string

ID untuk consumerActionId.

Mengembalikan

Promise<Subscription[]>

publishExternalEvent(string, string)

Publikasikan peristiwa eksternal.

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

Parameter

publisherId

string

channelId

string

Mengembalikan

Promise<PublisherEvent[]>

queryInputValues(InputValuesQuery, string)

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

Parameter

inputValuesQuery

InputValuesQuery

publisherId

string

Mengembalikan

Promise<InputValuesQuery>

queryNotifications(NotificationsQuery)

Kueri untuk pemberitahuan. Pemberitahuan mencakup detail tentang peristiwa, permintaan ke, dan respons dari layanan konsumen.

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

Parameter

query

NotificationsQuery

Mengembalikan

Promise<NotificationsQuery>

queryPublishers(PublishersQuery)

Kueri untuk penerbit kait layanan.

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

Parameter

query

PublishersQuery

Mengembalikan

Promise<PublishersQuery>

replaceSubscription(Subscription, string)

Memperbarui langganan. <nama param="subscriptionId">ID untuk langganan yang ingin Anda perbarui.</Param>

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

Parameter

subscription

Subscription

subscriptionId

string

Mengembalikan

Promise<Subscription>

updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)

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

Parameter

updateParameters

UpdateSubscripitonDiagnosticsParameters

subscriptionId

string

Mengembalikan

Promise<SubscriptionDiagnostics>