NotificationRestClient 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

NotificationRestClient(IVssRestClientOptions)

Yöntemler

createSubscription(NotificationSubscriptionCreateParameters)	Yeni bir abonelik oluşturun.
deleteSubscription(string)	Aboneliği silme.
getEventType(string)	Belirli bir olay türünü alın.
getNotificationReasons(number)
getSettings()
getSubscriber(string)	Bildirim abonesinin teslim tercihlerini alma.
getSubscription(string, SubscriptionQueryFlags)	Kimliğine göre bildirim aboneliği alın.
getSubscriptionDiagnostics(string)	Aboneliğin tanılama ayarlarını alın.
getSubscriptionTemplates()	Kullanılabilir abonelik şablonlarını edinin.
listEventTypes(string)	Bu hizmet için kullanılabilir olay türlerini listeleyin. İsteğe bağlı olarak, yalnızca belirtilen yayımcı için olay türlerine göre filtreleyin.
listLogs(string, string, Date, Date)	Bu hizmet için tanılama günlüklerinin listesini alın.
listNotificationReasons(number)
listSubscriptions(string, string[], SubscriptionQueryFlags)	Abonelik kimliklerine veya belirli bir kullanıcı veya grup için tüm aboneliklere göre bildirim aboneliklerinin listesini alın.
performBatchNotificationOperations(BatchNotificationOperation)
publishEvent(VssNotificationEvent)	Olay yayımlama. Bu istek "extmgmt" hizmetine yönlendirilmelidir.
publishTokenEvent(VssNotificationEvent)	Olay yayımlama. Yalnızca dağıtım hizmeti olduğundan bu istek yalnızca Belirteç hizmeti içindir.
queryEventTypes(FieldValuesQuery, string)
querySubscriptions(SubscriptionQuery)	Abonelikleri sorgulama. Belirtilen koşullardan biri veya daha fazlası ile eşleşiyorsa bir abonelik döndürülür.
transformEvent(EventTransformRequest)	Bildirim olayını biçimlendirin.
updateSettings(NotificationAdminSettingsUpdateParameters)
updateSubscriber(NotificationSubscriberUpdateParameters, string)	Bildirim abonesinin teslim tercihlerini güncelleştirme.
updateSubscription(NotificationSubscriptionUpdateParameters, string)	Mevcut aboneliği güncelleştirin. Abonelik türüne ve izinlere bağlı olarak, arayan açıklamayı, filtre ayarlarını, kanal (teslim) ayarlarını ve daha fazlasını güncelleştirebilir.
updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)	Aboneliğin tanılama ayarlarını güncelleştirin.
updateSubscriptionUserSettings(SubscriptionUserSettings, string, string)	Belirtilen abonelik için belirtilen kullanıcının ayarlarını güncelleştirin. Bu API genellikle paylaşılan bir aboneliği kabul etmek veya aboneliği geri çevirmek için kullanılır. Kullanıcı ayarları yalnızca ekip abonelikleri veya varsayılan abonelikler gibi paylaşılan aboneliklere uygulanabilir.

Oluşturucu Ayrıntıları

NotificationRestClient(IVssRestClientOptions)

new NotificationRestClient(options: IVssRestClientOptions)

Parametreler

options

IVssRestClientOptions

Yöntem Ayrıntıları

createSubscription(NotificationSubscriptionCreateParameters)

Yeni bir abonelik oluşturun.

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

Parametreler

createParameters

NotificationSubscriptionCreateParameters

Döndürülenler

Promise<NotificationSubscription>

deleteSubscription(string)

Aboneliği silme.

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

Parametreler

subscriptionId

string

Döndürülenler

Promise<void>

getEventType(string)

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

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

Parametreler

eventType

string

Olay türünün kimliği.

Döndürülenler

Promise<NotificationEventType>

getNotificationReasons(number)

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

Parametreler

notificationId

number

Döndürülenler

Promise<NotificationReason>

getSettings()

function getSettings(): Promise<NotificationAdminSettings>

Döndürülenler

Promise<NotificationAdminSettings>

getSubscriber(string)

Bildirim abonesinin teslim tercihlerini alma.

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

Parametreler

subscriberId

string

Kullanıcı veya grubun kimliği.

Döndürülenler

Promise<NotificationSubscriber>

getSubscription(string, SubscriptionQueryFlags)

Kimliğine göre bildirim aboneliği alın.

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

Parametreler

subscriptionId

string

queryFlags

SubscriptionQueryFlags

Döndürülenler

Promise<NotificationSubscription>

getSubscriptionDiagnostics(string)

Aboneliğin tanılama ayarlarını alın.

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

Parametreler

subscriptionId

string

Bildirimler aboneliğinin kimliği.

Döndürülenler

Promise<SubscriptionDiagnostics>

getSubscriptionTemplates()

Kullanılabilir abonelik şablonlarını edinin.

function getSubscriptionTemplates(): Promise<NotificationSubscriptionTemplate[]>

Döndürülenler

Promise<NotificationSubscriptionTemplate[]>

listEventTypes(string)

Bu hizmet için kullanılabilir olay türlerini listeleyin. İsteğe bağlı olarak, yalnızca belirtilen yayımcı için olay türlerine göre filtreleyin.

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

Parametreler

publisherId

string

Bu yayımcı için olay türleriyle sınırla

Döndürülenler

Promise<NotificationEventType[]>

listLogs(string, string, Date, Date)

Bu hizmet için tanılama günlüklerinin listesini alın.

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

Parametreler

source

string

Tanılamanın denetlenecek günlük türünü belirten kimlik.

entryId

string

Sorgu için belirli bir günlüğün kimliği.

startTime

Date

Sorgulanması gereken zaman aralığı için başlangıç zamanı.

endTime

Date

Sorgu için zaman aralığının bitiş saati.

Döndürülenler

Promise<INotificationDiagnosticLog[]>

listNotificationReasons(number)

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

Parametreler

notificationIds

number

Döndürülenler

Promise<NotificationReason[]>

listSubscriptions(string, string[], SubscriptionQueryFlags)

Abonelik kimliklerine veya belirli bir kullanıcı veya grup için tüm aboneliklere göre bildirim aboneliklerinin listesini alın.

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

Parametreler

targetId

string

Kullanıcı veya Grup Kimliği

ids

string[]

Abonelik kimliklerinin listesi

queryFlags

SubscriptionQueryFlags

Döndürülenler

Promise<NotificationSubscription[]>

performBatchNotificationOperations(BatchNotificationOperation)

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

Parametreler

operation

BatchNotificationOperation

Döndürülenler

Promise<void>

publishEvent(VssNotificationEvent)

Olay yayımlama. Bu istek "extmgmt" hizmetine yönlendirilmelidir.

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

Parametreler

notificationEvent

VssNotificationEvent

Döndürülenler

Promise<VssNotificationEvent>

publishTokenEvent(VssNotificationEvent)

Olay yayımlama. Yalnızca dağıtım hizmeti olduğundan bu istek yalnızca Belirteç hizmeti içindir.

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

Parametreler

notificationEvent

VssNotificationEvent

Döndürülenler

Promise<VssNotificationEvent>

queryEventTypes(FieldValuesQuery, string)

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

Parametreler

inputValuesQuery

FieldValuesQuery

eventType

string

Döndürülenler

Promise<NotificationEventField[]>

querySubscriptions(SubscriptionQuery)

Abonelikleri sorgulama. Belirtilen koşullardan biri veya daha fazlası ile eşleşiyorsa bir abonelik döndürülür.

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

Parametreler

subscriptionQuery

SubscriptionQuery

Döndürülenler

Promise<NotificationSubscription[]>

transformEvent(EventTransformRequest)

Bildirim olayını biçimlendirin.

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

Parametreler

transformRequest

EventTransformRequest

Dönüştürülecek nesne.

Döndürülenler

Promise<EventTransformResult>

updateSettings(NotificationAdminSettingsUpdateParameters)

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

Parametreler

updateParameters

NotificationAdminSettingsUpdateParameters

Döndürülenler

Promise<NotificationAdminSettings>

updateSubscriber(NotificationSubscriberUpdateParameters, string)

Bildirim abonesinin teslim tercihlerini güncelleştirme.

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

Parametreler

updateParameters

NotificationSubscriberUpdateParameters

subscriberId

string

Kullanıcı veya grubun kimliği.

Döndürülenler

Promise<NotificationSubscriber>

updateSubscription(NotificationSubscriptionUpdateParameters, string)

Mevcut aboneliği güncelleştirin. Abonelik türüne ve izinlere bağlı olarak, arayan açıklamayı, filtre ayarlarını, kanal (teslim) ayarlarını ve daha fazlasını güncelleştirebilir.

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

Parametreler

updateParameters

NotificationSubscriptionUpdateParameters

subscriptionId

string

Döndürülenler

Promise<NotificationSubscription>

updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)

Aboneliğin tanılama ayarlarını güncelleştirin.

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

Parametreler

updateParameters

UpdateSubscripitonDiagnosticsParameters

subscriptionId

string

Bildirimler aboneliğinin kimliği.

Döndürülenler

Promise<SubscriptionDiagnostics>

updateSubscriptionUserSettings(SubscriptionUserSettings, string, string)

Belirtilen abonelik için belirtilen kullanıcının ayarlarını güncelleştirin. Bu API genellikle paylaşılan bir aboneliği kabul etmek veya aboneliği geri çevirmek için kullanılır. Kullanıcı ayarları yalnızca ekip abonelikleri veya varsayılan abonelikler gibi paylaşılan aboneliklere uygulanabilir.

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

Parametreler

userSettings

SubscriptionUserSettings

subscriptionId

string

userId

string

Kullanıcının kimliği

Döndürülenler

Promise<SubscriptionUserSettings>