NotificationRestClient class

Csomag:

azure-devops-extension-api

Alaposztály, amelyet a VSS REST API-k felé irányuló kérések küldéséhez (származtatásából) kell használni

Extends

RestClientBase

Konstruktorok

NotificationRestClient(IVssRestClientOptions)

Metódusok

createSubscription(NotificationSubscriptionCreateParameters)	Hozzon létre egy új előfizetést.
deleteSubscription(string)	Előfizetés törlése.
getEventType(string)	Adott eseménytípus lekérése.
getNotificationReasons(number)
getSettings()
getSubscriber(string)	Az értesítés-előfizető kézbesítési beállításainak lekérése.
getSubscription(string, SubscriptionQueryFlags)	Értesítési előfizetés lekérése az azonosítójuk alapján.
getSubscriptionDiagnostics(string)	Az előfizetés diagnosztikai beállításainak lekérése.
getSubscriptionTemplates()	Szerezze be az elérhető előfizetési sablonokat.
listEventTypes(string)	A szolgáltatáshoz elérhető eseménytípusok listázása. Igény szerint szűrheti csak a megadott közzétevő eseménytípusai alapján.
listLogs(string, string, Date, Date)	A szolgáltatás diagnosztikai naplóinak listájának lekérése.
listNotificationReasons(number)
listSubscriptions(string, string[], SubscriptionQueryFlags)	Lekérheti az értesítési előfizetések listáját, akár előfizetés-azonosítók, akár egy adott felhasználó vagy csoport összes előfizetése alapján.
performBatchNotificationOperations(BatchNotificationOperation)
publishEvent(VssNotificationEvent)	Esemény közzététele. Ezt a kérést az "extmgmt" szolgáltatáshoz kell irányítani.
publishTokenEvent(VssNotificationEvent)	Esemény közzététele. Ez a kérés csak a Token szolgáltatásra vonatkozik, mivel csak üzembe helyezési szolgáltatás.
queryEventTypes(FieldValuesQuery, string)
querySubscriptions(SubscriptionQuery)	Előfizetések lekérdezése. Az előfizetés akkor lesz visszaadva, ha megfelel egy vagy több megadott feltételnek.
transformEvent(EventTransformRequest)	Értesítési esemény átformázása.
updateSettings(NotificationAdminSettingsUpdateParameters)
updateSubscriber(NotificationSubscriberUpdateParameters, string)	Értesítés-előfizető kézbesítési beállításainak frissítése.
updateSubscription(NotificationSubscriptionUpdateParameters, string)	Meglévő előfizetés frissítése. Az előfizetés típusától és az engedélyektől függően a hívó frissítheti a leírást, a szűrési beállításokat, a csatorna (kézbesítés) beállításait és egyebeket.
updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)	Frissítse az előfizetés diagnosztikai beállításait.
updateSubscriptionUserSettings(SubscriptionUserSettings, string, string)	Frissítse a megadott felhasználó beállításait a megadott előfizetéshez. Ezt az API-t általában egy megosztott előfizetésbe való be- vagy kilépésre használják. A felhasználói beállítások csak megosztott előfizetésekre alkalmazhatók, például csoport-előfizetésekre vagy alapértelmezett előfizetésekre.

Konstruktor adatai

NotificationRestClient(IVssRestClientOptions)

new NotificationRestClient(options: IVssRestClientOptions)

Paraméterek

options

IVssRestClientOptions

Metódus adatai

createSubscription(NotificationSubscriptionCreateParameters)

Hozzon létre egy új előfizetést.

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

Paraméterek

createParameters

NotificationSubscriptionCreateParameters

Válaszok

Promise<NotificationSubscription>

deleteSubscription(string)

Előfizetés törlése.

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

Paraméterek

subscriptionId

string

Válaszok

Promise<void>

getEventType(string)

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

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

Paraméterek

eventType

string

Az eseménytípus azonosítója.

Válaszok

Promise<NotificationEventType>

getNotificationReasons(number)

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

Paraméterek

notificationId

number

Válaszok

Promise<NotificationReason>

getSettings()

function getSettings(): Promise<NotificationAdminSettings>

Válaszok

Promise<NotificationAdminSettings>

getSubscriber(string)

Az értesítés-előfizető kézbesítési beállításainak lekérése.

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

Paraméterek

subscriberId

string

A felhasználó vagy csoport azonosítója.

Válaszok

Promise<NotificationSubscriber>

getSubscription(string, SubscriptionQueryFlags)

Értesítési előfizetés lekérése az azonosítójuk alapján.

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

Paraméterek

subscriptionId

string

queryFlags

SubscriptionQueryFlags

Válaszok

Promise<NotificationSubscription>

getSubscriptionDiagnostics(string)

Az előfizetés diagnosztikai beállításainak lekérése.

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

Paraméterek

subscriptionId

string

Az értesítési előfizetés azonosítója.

Válaszok

Promise<SubscriptionDiagnostics>

getSubscriptionTemplates()

Szerezze be az elérhető előfizetési sablonokat.

function getSubscriptionTemplates(): Promise<NotificationSubscriptionTemplate[]>

Válaszok

Promise<NotificationSubscriptionTemplate[]>

listEventTypes(string)

A szolgáltatáshoz elérhető eseménytípusok listázása. Igény szerint szűrheti csak a megadott közzétevő eseménytípusai alapján.

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

Paraméterek

publisherId

string

A közzétevő eseménytípusainak korlátozása

Válaszok

Promise<NotificationEventType[]>

listLogs(string, string, Date, Date)

A szolgáltatás diagnosztikai naplóinak listájának lekérése.

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

Paraméterek

source

string

Azonosító, amely megadja, hogy milyen típusú naplókhoz szeretné ellenőrizni a diagnosztikát.

entryId

string

A lekérdezendő napló azonosítója.

startTime

Date

A lekérdezéshez használt időtartomány kezdő időpontja.

endTime

Date

A lekérdezéshez használt időtartomány befejezési ideje.

Válaszok

Promise<INotificationDiagnosticLog[]>

listNotificationReasons(number)

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

Paraméterek

notificationIds

number

Válaszok

Promise<NotificationReason[]>

listSubscriptions(string, string[], SubscriptionQueryFlags)

Lekérheti az értesítési előfizetések listáját, akár előfizetés-azonosítók, akár egy adott felhasználó vagy csoport összes előfizetése alapján.

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

Paraméterek

targetId

string

Felhasználó- vagy csoportazonosító

ids

string[]

Előfizetés-azonosítók listája

queryFlags

SubscriptionQueryFlags

Válaszok

Promise<NotificationSubscription[]>

performBatchNotificationOperations(BatchNotificationOperation)

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

Paraméterek

operation

BatchNotificationOperation

Válaszok

Promise<void>

publishEvent(VssNotificationEvent)

Esemény közzététele. Ezt a kérést az "extmgmt" szolgáltatáshoz kell irányítani.

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

Paraméterek

notificationEvent

VssNotificationEvent

Válaszok

Promise<VssNotificationEvent>

publishTokenEvent(VssNotificationEvent)

Esemény közzététele. Ez a kérés csak a Token szolgáltatásra vonatkozik, mivel csak üzembe helyezési szolgáltatás.

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

Paraméterek

notificationEvent

VssNotificationEvent

Válaszok

Promise<VssNotificationEvent>

queryEventTypes(FieldValuesQuery, string)

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

Paraméterek

inputValuesQuery

FieldValuesQuery

eventType

string

Válaszok

Promise<NotificationEventField[]>

querySubscriptions(SubscriptionQuery)

Előfizetések lekérdezése. Az előfizetés akkor lesz visszaadva, ha megfelel egy vagy több megadott feltételnek.

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

Paraméterek

subscriptionQuery

SubscriptionQuery

Válaszok

Promise<NotificationSubscription[]>

transformEvent(EventTransformRequest)

Értesítési esemény átformázása.

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

Paraméterek

transformRequest

EventTransformRequest

Átalakítandó objektum.

Válaszok

Promise<EventTransformResult>

updateSettings(NotificationAdminSettingsUpdateParameters)

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

Paraméterek

updateParameters

NotificationAdminSettingsUpdateParameters

Válaszok

Promise<NotificationAdminSettings>

updateSubscriber(NotificationSubscriberUpdateParameters, string)

Értesítés-előfizető kézbesítési beállításainak frissítése.

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

Paraméterek

updateParameters

NotificationSubscriberUpdateParameters

subscriberId

string

A felhasználó vagy csoport azonosítója.

Válaszok

Promise<NotificationSubscriber>

updateSubscription(NotificationSubscriptionUpdateParameters, string)

Meglévő előfizetés frissítése. Az előfizetés típusától és az engedélyektől függően a hívó frissítheti a leírást, a szűrési beállításokat, a csatorna (kézbesítés) beállításait és egyebeket.

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

Paraméterek

updateParameters

NotificationSubscriptionUpdateParameters

subscriptionId

string

Válaszok

Promise<NotificationSubscription>

updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)

Frissítse az előfizetés diagnosztikai beállításait.

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

Paraméterek

updateParameters

UpdateSubscripitonDiagnosticsParameters

subscriptionId

string

Az értesítési előfizetés azonosítója.

Válaszok

Promise<SubscriptionDiagnostics>

updateSubscriptionUserSettings(SubscriptionUserSettings, string, string)

Frissítse a megadott felhasználó beállításait a megadott előfizetéshez. Ezt az API-t általában egy megosztott előfizetésbe való be- vagy kilépésre használják. A felhasználói beállítások csak megosztott előfizetésekre alkalmazhatók, például csoport-előfizetésekre vagy alapértelmezett előfizetésekre.

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

Paraméterek

userSettings

SubscriptionUserSettings

subscriptionId

string

userId

string

A felhasználó azonosítója

Válaszok

Promise<SubscriptionUserSettings>