NotificationRestClient class

Paket:

azure-devops-extension-api

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

Memperluas

RestClientBase

Konstruktor

NotificationRestClient(IVssRestClientOptions)

Metode

createSubscription(NotificationSubscriptionCreateParameters)	Buat langganan baru.
deleteSubscription(string)	Menghapus langganan.
getEventType(string)	Dapatkan jenis peristiwa tertentu.
getNotificationReasons(number)
getSettings()
getSubscriber(string)	Dapatkan preferensi pengiriman pelanggan pemberitahuan.
getSubscription(string, SubscriptionQueryFlags)	Dapatkan langganan pemberitahuan dengan ID-nya.
getSubscriptionDiagnostics(string)	Dapatkan pengaturan diagnostik untuk langganan.
getSubscriptionTemplates()	Dapatkan templat langganan yang tersedia.
listEventTypes(string)	Cantumkan jenis kejadian yang tersedia untuk layanan ini. Secara opsional hanya memfilter berdasarkan jenis peristiwa untuk penerbit yang ditentukan.
listLogs(string, string, Date, Date)	Dapatkan daftar log diagnostik untuk layanan ini.
listNotificationReasons(number)
listSubscriptions(string, string[], SubscriptionQueryFlags)	Dapatkan daftar langganan pemberitahuan, baik berdasarkan ID langganan atau oleh semua langganan untuk pengguna atau grup tertentu.
performBatchNotificationOperations(BatchNotificationOperation)
publishEvent(VssNotificationEvent)	Menerbitkan peristiwa. Permintaan ini harus diarahkan ke layanan "extmgmt".
publishTokenEvent(VssNotificationEvent)	Menerbitkan peristiwa. Permintaan ini hanya untuk layanan Token karena ini hanya layanan penyebaran.
queryEventTypes(FieldValuesQuery, string)
querySubscriptions(SubscriptionQuery)	Kueri untuk langganan. Langganan dikembalikan jika cocok dengan satu atau beberapa kondisi yang ditentukan.
transformEvent(EventTransformRequest)	Tranform peristiwa pemberitahuan.
updateSettings(NotificationAdminSettingsUpdateParameters)
updateSubscriber(NotificationSubscriberUpdateParameters, string)	Memperbarui preferensi pengiriman pelanggan pemberitahuan.
updateSubscription(NotificationSubscriptionUpdateParameters, string)	Perbarui langganan yang sudah ada. Bergantung pada jenis langganan dan izin, pemanggil dapat memperbarui deskripsi, pengaturan filter, pengaturan saluran (pengiriman) dan banyak lagi.
updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)	Perbarui pengaturan diagnostik untuk langganan.
updateSubscriptionUserSettings(SubscriptionUserSettings, string, string)	Perbarui pengaturan pengguna yang ditentukan untuk langganan yang ditentukan. API ini biasanya digunakan untuk ikut serta atau keluar dari langganan bersama. Pengaturan pengguna hanya dapat diterapkan ke langganan bersama, seperti langganan tim atau langganan default.

Detail Konstruktor

NotificationRestClient(IVssRestClientOptions)

new NotificationRestClient(options: IVssRestClientOptions)

Parameter

options

IVssRestClientOptions

Detail Metode

createSubscription(NotificationSubscriptionCreateParameters)

Buat langganan baru.

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

Parameter

createParameters

NotificationSubscriptionCreateParameters

Mengembalikan

Promise<NotificationSubscription>

deleteSubscription(string)

Menghapus langganan.

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

Parameter

subscriptionId

string

Mengembalikan

Promise<void>

getEventType(string)

Dapatkan jenis peristiwa tertentu.

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

Parameter

eventType

string

ID jenis peristiwa.

Mengembalikan

Promise<NotificationEventType>

getNotificationReasons(number)

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

Parameter

notificationId

number

Mengembalikan

Promise<NotificationReason>

getSettings()

function getSettings(): Promise<NotificationAdminSettings>

Mengembalikan

Promise<NotificationAdminSettings>

getSubscriber(string)

Dapatkan preferensi pengiriman pelanggan pemberitahuan.

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

Parameter

subscriberId

string

ID pengguna atau grup.

Mengembalikan

Promise<NotificationSubscriber>

getSubscription(string, SubscriptionQueryFlags)

Dapatkan langganan pemberitahuan dengan ID-nya.

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

Parameter

subscriptionId

string

queryFlags

SubscriptionQueryFlags

Mengembalikan

Promise<NotificationSubscription>

getSubscriptionDiagnostics(string)

Dapatkan pengaturan diagnostik untuk langganan.

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

Parameter

subscriptionId

string

Id langganan pemberitahuan.

Mengembalikan

Promise<SubscriptionDiagnostics>

getSubscriptionTemplates()

Dapatkan templat langganan yang tersedia.

function getSubscriptionTemplates(): Promise<NotificationSubscriptionTemplate[]>

Mengembalikan

Promise<NotificationSubscriptionTemplate[]>

listEventTypes(string)

Cantumkan jenis kejadian yang tersedia untuk layanan ini. Secara opsional hanya memfilter berdasarkan jenis peristiwa untuk penerbit yang ditentukan.

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

Parameter

publisherId

string

Batasi jenis peristiwa untuk penerbit ini

Mengembalikan

Promise<NotificationEventType[]>

listLogs(string, string, Date, Date)

Dapatkan daftar log diagnostik untuk layanan ini.

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

Parameter

source

string

ID yang menentukan jenis log mana yang akan diperiksa diagnostiknya.

entryId

string

ID log tertentu yang akan dikueri.

startTime

Date

Waktu mulai untuk rentang waktu yang akan dikueri.

endTime

Date

Waktu akhir untuk rentang waktu yang akan dikueri.

Mengembalikan

Promise<INotificationDiagnosticLog[]>

listNotificationReasons(number)

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

Parameter

notificationIds

number

Mengembalikan

Promise<NotificationReason[]>

listSubscriptions(string, string[], SubscriptionQueryFlags)

Dapatkan daftar langganan pemberitahuan, baik berdasarkan ID langganan atau oleh semua langganan untuk pengguna atau grup tertentu.

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

Parameter

targetId

string

ID Pengguna atau Grup

ids

string[]

Daftar ID langganan

queryFlags

SubscriptionQueryFlags

Mengembalikan

Promise<NotificationSubscription[]>

performBatchNotificationOperations(BatchNotificationOperation)

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

Parameter

operation

BatchNotificationOperation

Mengembalikan

Promise<void>

publishEvent(VssNotificationEvent)

Menerbitkan peristiwa. Permintaan ini harus diarahkan ke layanan "extmgmt".

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

Parameter

notificationEvent

VssNotificationEvent

Mengembalikan

Promise<VssNotificationEvent>

publishTokenEvent(VssNotificationEvent)

Menerbitkan peristiwa. Permintaan ini hanya untuk layanan Token karena ini hanya layanan penyebaran.

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

Parameter

notificationEvent

VssNotificationEvent

Mengembalikan

Promise<VssNotificationEvent>

queryEventTypes(FieldValuesQuery, string)

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

Parameter

inputValuesQuery

FieldValuesQuery

eventType

string

Mengembalikan

Promise<NotificationEventField[]>

querySubscriptions(SubscriptionQuery)

Kueri untuk langganan. Langganan dikembalikan jika cocok dengan satu atau beberapa kondisi yang ditentukan.

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

Parameter

subscriptionQuery

SubscriptionQuery

Mengembalikan

Promise<NotificationSubscription[]>

transformEvent(EventTransformRequest)

Tranform peristiwa pemberitahuan.

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

Parameter

transformRequest

EventTransformRequest

Objek yang akan diubah.

Mengembalikan

Promise<EventTransformResult>

updateSettings(NotificationAdminSettingsUpdateParameters)

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

Parameter

updateParameters

NotificationAdminSettingsUpdateParameters

Mengembalikan

Promise<NotificationAdminSettings>

updateSubscriber(NotificationSubscriberUpdateParameters, string)

Memperbarui preferensi pengiriman pelanggan pemberitahuan.

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

Parameter

updateParameters

NotificationSubscriberUpdateParameters

subscriberId

string

ID pengguna atau grup.

Mengembalikan

Promise<NotificationSubscriber>

updateSubscription(NotificationSubscriptionUpdateParameters, string)

Perbarui langganan yang sudah ada. Bergantung pada jenis langganan dan izin, pemanggil dapat memperbarui deskripsi, pengaturan filter, pengaturan saluran (pengiriman) dan banyak lagi.

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

Parameter

updateParameters

NotificationSubscriptionUpdateParameters

subscriptionId

string

Mengembalikan

Promise<NotificationSubscription>

updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)

Perbarui pengaturan diagnostik untuk langganan.

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

Parameter

updateParameters

UpdateSubscripitonDiagnosticsParameters

subscriptionId

string

Id langganan pemberitahuan.

Mengembalikan

Promise<SubscriptionDiagnostics>

updateSubscriptionUserSettings(SubscriptionUserSettings, string, string)

Perbarui pengaturan pengguna yang ditentukan untuk langganan yang ditentukan. API ini biasanya digunakan untuk ikut serta atau keluar dari langganan bersama. Pengaturan pengguna hanya dapat diterapkan ke langganan bersama, seperti langganan tim atau langganan default.

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

Parameter

userSettings

SubscriptionUserSettings

subscriptionId

string

userId

string

ID pengguna

Mengembalikan

Promise<SubscriptionUserSettings>