NotificationRestClient class

Pakket:

azure-devops-extension-api

Basisklasse die moet worden gebruikt (afgeleid van) om aanvragen te doen voor VSS REST API's

Extends

RestClientBase

Constructors

NotificationRestClient(IVssRestClientOptions)

Methoden

createSubscription(NotificationSubscriptionCreateParameters)	Maak een nieuw abonnement.
deleteSubscription(string)	Een abonnement verwijderen.
getEventType(string)	Een specifiek gebeurtenistype ophalen.
getNotificationReasons(number)
getSettings()
getSubscriber(string)	Ontvang de bezorgingsvoorkeuren van een meldingsabonnee.
getSubscription(string, SubscriptionQueryFlags)	Ontvang een meldingsabonnement op basis van de id.
getSubscriptionDiagnostics(string)	De diagnostische instellingen voor een abonnement ophalen.
getSubscriptionTemplates()	Beschikbare abonnementssjablonen ophalen.
listEventTypes(string)	Lijst met beschikbare gebeurtenistypen voor deze service. U kunt eventueel filteren op alleen gebeurtenistypen voor de opgegeven uitgever.
listLogs(string, string, Date, Date)	Een lijst met diagnostische logboeken voor deze service ophalen.
listNotificationReasons(number)
listSubscriptions(string, string[], SubscriptionQueryFlags)	Een lijst met meldingsabonnementen ophalen, op abonnements-id's of op basis van alle abonnementen voor een bepaalde gebruiker of groep.
performBatchNotificationOperations(BatchNotificationOperation)
publishEvent(VssNotificationEvent)	Een gebeurtenis publiceren. Deze aanvraag moet worden doorgestuurd naar de service 'extmgmt'.
publishTokenEvent(VssNotificationEvent)	Een gebeurtenis publiceren. Deze aanvraag is alleen bedoeld voor de Token-service, omdat het een service is die alleen wordt geïmplementeerd.
queryEventTypes(FieldValuesQuery, string)
querySubscriptions(SubscriptionQuery)	Query's uitvoeren op abonnementen. Een abonnement wordt geretourneerd als het overeenkomt met een of meer van de opgegeven voorwaarden.
transformEvent(EventTransformRequest)	Een meldingsgebeurtenis tranformen.
updateSettings(NotificationAdminSettingsUpdateParameters)
updateSubscriber(NotificationSubscriberUpdateParameters, string)	De bezorgingsvoorkeuren van een meldingsabonnee bijwerken.
updateSubscription(NotificationSubscriptionUpdateParameters, string)	Een bestaand abonnement bijwerken. Afhankelijk van het type abonnement en machtigingen kan de beller de beschrijving, filterinstellingen, kanaalinstellingen (levering) en meer bijwerken.
updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)	De diagnostische instellingen voor een abonnement bijwerken.
updateSubscriptionUserSettings(SubscriptionUserSettings, string, string)	Werk de opgegeven gebruikersinstellingen voor het opgegeven abonnement bij. Deze API wordt doorgaans gebruikt om u aan of uit te melden voor een gedeeld abonnement. Gebruikersinstellingen kunnen alleen worden toegepast op gedeelde abonnementen, zoals teamabonnementen of standaardabonnementen.

Constructordetails

NotificationRestClient(IVssRestClientOptions)

new NotificationRestClient(options: IVssRestClientOptions)

Parameters

options

IVssRestClientOptions

Methodedetails

createSubscription(NotificationSubscriptionCreateParameters)

Maak een nieuw abonnement.

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

Parameters

createParameters

NotificationSubscriptionCreateParameters

Retouren

Promise<NotificationSubscription>

deleteSubscription(string)

Een abonnement verwijderen.

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

Parameters

subscriptionId

string

Retouren

Promise<void>

getEventType(string)

Een specifiek gebeurtenistype ophalen.

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

Parameters

eventType

string

De id van het gebeurtenistype.

Retouren

Promise<NotificationEventType>

getNotificationReasons(number)

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

Parameters

notificationId

number

Retouren

Promise<NotificationReason>

getSettings()

function getSettings(): Promise<NotificationAdminSettings>

Retouren

Promise<NotificationAdminSettings>

getSubscriber(string)

Ontvang de bezorgingsvoorkeuren van een meldingsabonnee.

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

Parameters

subscriberId

string

Id van de gebruiker of groep.

Retouren

Promise<NotificationSubscriber>

getSubscription(string, SubscriptionQueryFlags)

Ontvang een meldingsabonnement op basis van de id.

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

Parameters

subscriptionId

string

queryFlags

SubscriptionQueryFlags

Retouren

Promise<NotificationSubscription>

getSubscriptionDiagnostics(string)

De diagnostische instellingen voor een abonnement ophalen.

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

Parameters

subscriptionId

string

De id van het meldingenabonnement.

Retouren

Promise<SubscriptionDiagnostics>

getSubscriptionTemplates()

Beschikbare abonnementssjablonen ophalen.

function getSubscriptionTemplates(): Promise<NotificationSubscriptionTemplate[]>

Retouren

Promise<NotificationSubscriptionTemplate[]>

listEventTypes(string)

Lijst met beschikbare gebeurtenistypen voor deze service. U kunt eventueel filteren op alleen gebeurtenistypen voor de opgegeven uitgever.

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

Parameters

publisherId

string

Beperken tot gebeurtenistypen voor deze uitgever

Retouren

Promise<NotificationEventType[]>

listLogs(string, string, Date, Date)

Een lijst met diagnostische logboeken voor deze service ophalen.

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

Parameters

source

string

Id die aangeeft op welk type logboeken diagnostische gegevens moeten worden gecontroleerd.

entryId

string

De id van het specifieke logboek waarvoor een query moet worden uitgevoerd.

startTime

Date

Begintijd voor het tijdsbereik waarin een query moet worden uitgevoerd.

endTime

Date

Eindtijd voor het tijdsbereik waarin een query moet worden uitgevoerd.

Retouren

Promise<INotificationDiagnosticLog[]>

listNotificationReasons(number)

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

Parameters

notificationIds

number

Retouren

Promise<NotificationReason[]>

listSubscriptions(string, string[], SubscriptionQueryFlags)

Een lijst met meldingsabonnementen ophalen, op abonnements-id's of op basis van alle abonnementen voor een bepaalde gebruiker of groep.

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

Parameters

targetId

string

Gebruikers- of groeps-id

ids

string[]

Lijst met abonnements-id's

queryFlags

SubscriptionQueryFlags

Retouren

Promise<NotificationSubscription[]>

performBatchNotificationOperations(BatchNotificationOperation)

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

Parameters

operation

BatchNotificationOperation

Retouren

Promise<void>

publishEvent(VssNotificationEvent)

Een gebeurtenis publiceren. Deze aanvraag moet worden doorgestuurd naar de service 'extmgmt'.

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

Parameters

notificationEvent

VssNotificationEvent

Retouren

Promise<VssNotificationEvent>

publishTokenEvent(VssNotificationEvent)

Een gebeurtenis publiceren. Deze aanvraag is alleen bedoeld voor de Token-service, omdat het een service is die alleen wordt geïmplementeerd.

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

Parameters

notificationEvent

VssNotificationEvent

Retouren

Promise<VssNotificationEvent>

queryEventTypes(FieldValuesQuery, string)

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

Parameters

inputValuesQuery

FieldValuesQuery

eventType

string

Retouren

Promise<NotificationEventField[]>

querySubscriptions(SubscriptionQuery)

Query's uitvoeren op abonnementen. Een abonnement wordt geretourneerd als het overeenkomt met een of meer van de opgegeven voorwaarden.

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

Parameters

subscriptionQuery

SubscriptionQuery

Retouren

Promise<NotificationSubscription[]>

transformEvent(EventTransformRequest)

Een meldingsgebeurtenis tranformen.

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

Parameters

transformRequest

EventTransformRequest

Object dat moet worden getransformeerd.

Retouren

Promise<EventTransformResult>

updateSettings(NotificationAdminSettingsUpdateParameters)

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

Parameters

updateParameters

NotificationAdminSettingsUpdateParameters

Retouren

Promise<NotificationAdminSettings>

updateSubscriber(NotificationSubscriberUpdateParameters, string)

De bezorgingsvoorkeuren van een meldingsabonnee bijwerken.

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

Parameters

updateParameters

NotificationSubscriberUpdateParameters

subscriberId

string

Id van de gebruiker of groep.

Retouren

Promise<NotificationSubscriber>

updateSubscription(NotificationSubscriptionUpdateParameters, string)

Een bestaand abonnement bijwerken. Afhankelijk van het type abonnement en machtigingen kan de beller de beschrijving, filterinstellingen, kanaalinstellingen (levering) en meer bijwerken.

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

Parameters

updateParameters

NotificationSubscriptionUpdateParameters

subscriptionId

string

Retouren

Promise<NotificationSubscription>

updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)

De diagnostische instellingen voor een abonnement bijwerken.

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

Parameters

updateParameters

UpdateSubscripitonDiagnosticsParameters

subscriptionId

string

De id van het meldingenabonnement.

Retouren

Promise<SubscriptionDiagnostics>

updateSubscriptionUserSettings(SubscriptionUserSettings, string, string)

Werk de opgegeven gebruikersinstellingen voor het opgegeven abonnement bij. Deze API wordt doorgaans gebruikt om u aan of uit te melden voor een gedeeld abonnement. Gebruikersinstellingen kunnen alleen worden toegepast op gedeelde abonnementen, zoals teamabonnementen of standaardabonnementen.

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

Parameters

userSettings

SubscriptionUserSettings

subscriptionId

string

userId

string

Id van de gebruiker

Retouren

Promise<SubscriptionUserSettings>