NotificationRestClient class

Paket:

azure-devops-extension-api

Basklass som ska användas (härledd från) för att göra begäranden till VSS REST API:erna

Extends

RestClientBase

Konstruktorer

NotificationRestClient(IVssRestClientOptions)

Metoder

createSubscription(NotificationSubscriptionCreateParameters)	Skapa en ny prenumeration.
deleteSubscription(string)	Ta bort en prenumeration.
getEventType(string)	Hämta en specifik händelsetyp.
getNotificationReasons(number)
getSettings()
getSubscriber(string)	Hämta leveransinställningar för en aviseringsprenumerant.
getSubscription(string, SubscriptionQueryFlags)	Hämta en meddelandeprenumeration med dess ID.
getSubscriptionDiagnostics(string)	Hämta diagnostikinställningarna för en prenumeration.
getSubscriptionTemplates()	Hämta tillgängliga prenumerationsmallar.
listEventTypes(string)	Lista tillgängliga händelsetyper för den här tjänsten. Du kan också filtrera efter endast händelsetyper för den angivna utgivaren.
listLogs(string, string, Date, Date)	Hämta en lista över diagnostikloggar för den här tjänsten.
listNotificationReasons(number)
listSubscriptions(string, string[], SubscriptionQueryFlags)	Hämta en lista över aviseringsprenumerationer, antingen efter prenumerations-ID eller efter alla prenumerationer för en viss användare eller grupp.
performBatchNotificationOperations(BatchNotificationOperation)
publishEvent(VssNotificationEvent)	Publicera en händelse. Den här begäran måste dirigeras till tjänsten "extmgmt".
publishTokenEvent(VssNotificationEvent)	Publicera en händelse. Den här begäran gäller endast för tokentjänsten eftersom det är en endast distribuerad tjänst.
queryEventTypes(FieldValuesQuery, string)
querySubscriptions(SubscriptionQuery)	Fråga efter prenumerationer. En prenumeration returneras om den matchar ett eller flera av de angivna villkoren.
transformEvent(EventTransformRequest)	Transformera en meddelandehändelse.
updateSettings(NotificationAdminSettingsUpdateParameters)
updateSubscriber(NotificationSubscriberUpdateParameters, string)	Uppdatera leveransinställningarna för en aviseringsprenumerant.
updateSubscription(NotificationSubscriptionUpdateParameters, string)	Uppdatera en befintlig prenumeration. Beroende på typen av prenumeration och behörigheter kan anroparen uppdatera beskrivningen, filterinställningarna, kanalinställningarna (leverans) med mera.
updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)	Uppdatera diagnostikinställningarna för en prenumeration.
updateSubscriptionUserSettings(SubscriptionUserSettings, string, string)	Uppdatera den angivna användarens inställningar för den angivna prenumerationen. Det här API:et används vanligtvis för att välja in eller ut från en delad prenumeration. Användarinställningar kan endast tillämpas på delade prenumerationer, till exempel teamprenumerationer eller standardprenumerationer.

Konstruktorinformation

NotificationRestClient(IVssRestClientOptions)

new NotificationRestClient(options: IVssRestClientOptions)

Parametrar

options

IVssRestClientOptions

Metodinformation

createSubscription(NotificationSubscriptionCreateParameters)

Skapa en ny prenumeration.

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

Parametrar

createParameters

NotificationSubscriptionCreateParameters

Returer

Promise<NotificationSubscription>

deleteSubscription(string)

Ta bort en prenumeration.

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

Parametrar

subscriptionId

string

Returer

Promise<void>

getEventType(string)

Hämta en specifik händelsetyp.

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

Parametrar

eventType

string

Händelsetypens ID.

Returer

Promise<NotificationEventType>

getNotificationReasons(number)

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

Parametrar

notificationId

number

Returer

Promise<NotificationReason>

getSettings()

function getSettings(): Promise<NotificationAdminSettings>

Returer

Promise<NotificationAdminSettings>

getSubscriber(string)

Hämta leveransinställningar för en aviseringsprenumerant.

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

Parametrar

subscriberId

string

ID för användaren eller gruppen.

Returer

Promise<NotificationSubscriber>

getSubscription(string, SubscriptionQueryFlags)

Hämta en meddelandeprenumeration med dess ID.

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

Parametrar

subscriptionId

string

queryFlags

SubscriptionQueryFlags

Returer

Promise<NotificationSubscription>

getSubscriptionDiagnostics(string)

Hämta diagnostikinställningarna för en prenumeration.

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

Parametrar

subscriptionId

string

ID för prenumerationen på meddelanden.

Returer

Promise<SubscriptionDiagnostics>

getSubscriptionTemplates()

Hämta tillgängliga prenumerationsmallar.

function getSubscriptionTemplates(): Promise<NotificationSubscriptionTemplate[]>

Returer

Promise<NotificationSubscriptionTemplate[]>

listEventTypes(string)

Lista tillgängliga händelsetyper för den här tjänsten. Du kan också filtrera efter endast händelsetyper för den angivna utgivaren.

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

Parametrar

publisherId

string

Begränsa till händelsetyper för den här utgivaren

Returer

Promise<NotificationEventType[]>

listLogs(string, string, Date, Date)

Hämta en lista över diagnostikloggar för den här tjänsten.

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

Parametrar

source

string

ID som anger vilken typ av loggar som diagnostiken ska kontrolleras för.

entryId

string

ID:t för den specifika loggen som du vill fråga efter.

startTime

Date

Starttid för det tidsintervall som frågan ska köras i.

endTime

Date

Sluttid för tidsintervallet att fråga i.

Returer

Promise<INotificationDiagnosticLog[]>

listNotificationReasons(number)

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

Parametrar

notificationIds

number

Returer

Promise<NotificationReason[]>

listSubscriptions(string, string[], SubscriptionQueryFlags)

Hämta en lista över aviseringsprenumerationer, antingen efter prenumerations-ID eller efter alla prenumerationer för en viss användare eller grupp.

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

Parametrar

targetId

string

Användar- eller grupp-ID

ids

string[]

Lista över prenumerations-ID:t

queryFlags

SubscriptionQueryFlags

Returer

Promise<NotificationSubscription[]>

performBatchNotificationOperations(BatchNotificationOperation)

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

Parametrar

operation

BatchNotificationOperation

Returer

Promise<void>

publishEvent(VssNotificationEvent)

Publicera en händelse. Den här begäran måste dirigeras till tjänsten "extmgmt".

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

Parametrar

notificationEvent

VssNotificationEvent

Returer

Promise<VssNotificationEvent>

publishTokenEvent(VssNotificationEvent)

Publicera en händelse. Den här begäran gäller endast för tokentjänsten eftersom det är en endast distribuerad tjänst.

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

Parametrar

notificationEvent

VssNotificationEvent

Returer

Promise<VssNotificationEvent>

queryEventTypes(FieldValuesQuery, string)

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

Parametrar

inputValuesQuery

FieldValuesQuery

eventType

string

Returer

Promise<NotificationEventField[]>

querySubscriptions(SubscriptionQuery)

Fråga efter prenumerationer. En prenumeration returneras om den matchar ett eller flera av de angivna villkoren.

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

Parametrar

subscriptionQuery

SubscriptionQuery

Returer

Promise<NotificationSubscription[]>

transformEvent(EventTransformRequest)

Transformera en meddelandehändelse.

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

Parametrar

transformRequest

EventTransformRequest

Objekt som ska transformeras.

Returer

Promise<EventTransformResult>

updateSettings(NotificationAdminSettingsUpdateParameters)

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

Parametrar

updateParameters

NotificationAdminSettingsUpdateParameters

Returer

Promise<NotificationAdminSettings>

updateSubscriber(NotificationSubscriberUpdateParameters, string)

Uppdatera leveransinställningarna för en aviseringsprenumerant.

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

Parametrar

updateParameters

NotificationSubscriberUpdateParameters

subscriberId

string

ID för användaren eller gruppen.

Returer

Promise<NotificationSubscriber>

updateSubscription(NotificationSubscriptionUpdateParameters, string)

Uppdatera en befintlig prenumeration. Beroende på typen av prenumeration och behörigheter kan anroparen uppdatera beskrivningen, filterinställningarna, kanalinställningarna (leverans) med mera.

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

Parametrar

updateParameters

NotificationSubscriptionUpdateParameters

subscriptionId

string

Returer

Promise<NotificationSubscription>

updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)

Uppdatera diagnostikinställningarna för en prenumeration.

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

Parametrar

updateParameters

UpdateSubscripitonDiagnosticsParameters

subscriptionId

string

ID för prenumerationen på meddelanden.

Returer

Promise<SubscriptionDiagnostics>

updateSubscriptionUserSettings(SubscriptionUserSettings, string, string)

Uppdatera den angivna användarens inställningar för den angivna prenumerationen. Det här API:et används vanligtvis för att välja in eller ut från en delad prenumeration. Användarinställningar kan endast tillämpas på delade prenumerationer, till exempel teamprenumerationer eller standardprenumerationer.

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

Parametrar

userSettings

SubscriptionUserSettings

subscriptionId

string

userId

string

ID för användaren

Returer

Promise<SubscriptionUserSettings>