NotificationRestClient class

Paket:

azure-devops-extension-api

Basisklasse, die zum Senden von Anforderungen an VSS-REST-APIs verwendet werden soll (abgeleitet von).

Extends

RestClientBase

Konstruktoren

NotificationRestClient(IVssRestClientOptions)

Methoden

createSubscription(NotificationSubscriptionCreateParameters)	Erstellen Sie ein neues Abonnement.
deleteSubscription(string)	Löschen eines Abonnements.
getEventType(string)	Rufen Sie einen bestimmten Ereignistyp ab.
getNotificationReasons(number)
getSettings()
getSubscriber(string)	Abrufen der Übermittlungseinstellungen eines Benachrichtigungsabonnents.
getSubscription(string, SubscriptionQueryFlags)	Rufen Sie ein Benachrichtigungsabonnement nach seiner ID ab.
getSubscriptionDiagnostics(string)	Rufen Sie die Diagnose Einstellungen für ein Abonnement ab.
getSubscriptionTemplates()	Rufen Sie verfügbare Abonnementvorlagen ab.
listEventTypes(string)	Liste der verfügbaren Ereignistypen für diesen Dienst auf. Filtern Sie optional nur nach Ereignistypen für den angegebenen Herausgeber.
listLogs(string, string, Date, Date)	Rufen Sie eine Liste der Diagnoseprotokolle für diesen Dienst ab.
listNotificationReasons(number)
listSubscriptions(string, string[], SubscriptionQueryFlags)	Rufen Sie eine Liste der Benachrichtigungsabonnements ab, entweder nach Abonnement-IDs oder nach allen Abonnements für einen bestimmten Benutzer oder eine bestimmte Gruppe.
performBatchNotificationOperations(BatchNotificationOperation)
publishEvent(VssNotificationEvent)	Veröffentlichen eines Ereignisses. Diese Anforderung muss an den Dienst "extmgmt" weitergeleitet werden.
publishTokenEvent(VssNotificationEvent)	Veröffentlichen eines Ereignisses. Diese Anforderung gilt nur für den Tokendienst, da es sich um einen bereitstellungsgeschützten Dienst handelt.
queryEventTypes(FieldValuesQuery, string)
querySubscriptions(SubscriptionQuery)	Abfrage für Abonnements. Ein Abonnement wird zurückgegeben, wenn es einer oder mehreren der angegebenen Bedingungen entspricht.
transformEvent(EventTransformRequest)	Transformieren eines Benachrichtigungsereignisses.
updateSettings(NotificationAdminSettingsUpdateParameters)
updateSubscriber(NotificationSubscriberUpdateParameters, string)	Aktualisieren sie die Übermittlungseinstellungen eines Benachrichtigungsabonnents.
updateSubscription(NotificationSubscriptionUpdateParameters, string)	Aktualisieren Sie ein vorhandenes Abonnement. Je nach Abonnementtyp und Berechtigungen kann der Aufrufer die Beschreibung, Filtereinstellungen, Kanaleinstellungen (Übermittlung) und vieles mehr aktualisieren.
updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)	Aktualisieren Sie die Diagnose Einstellungen für ein Abonnement.
updateSubscriptionUserSettings(SubscriptionUserSettings, string, string)	Aktualisieren Sie die Einstellungen des angegebenen Benutzers für das angegebene Abonnement. Diese API wird in der Regel verwendet, um ein freigegebenes Abonnement zu aktivieren oder zu deaktivieren. Benutzereinstellungen können nur auf freigegebene Abonnements angewendet werden, z. B. Teamabonnements oder Standardabonnements.

Details zum Konstruktor

NotificationRestClient(IVssRestClientOptions)

new NotificationRestClient(options: IVssRestClientOptions)

Parameter

options

IVssRestClientOptions

Details zur Methode

createSubscription(NotificationSubscriptionCreateParameters)

Erstellen Sie ein neues Abonnement.

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

Parameter

createParameters

NotificationSubscriptionCreateParameters

Gibt zurück

Promise<NotificationSubscription>

deleteSubscription(string)

Löschen eines Abonnements.

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

Parameter

subscriptionId

string

Gibt zurück

Promise<void>

getEventType(string)

Rufen Sie einen bestimmten Ereignistyp ab.

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

Parameter

eventType

string

Die ID des Ereignistyps.

Gibt zurück

Promise<NotificationEventType>

getNotificationReasons(number)

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

Parameter

notificationId

number

Gibt zurück

Promise<NotificationReason>

getSettings()

function getSettings(): Promise<NotificationAdminSettings>

Gibt zurück

Promise<NotificationAdminSettings>

getSubscriber(string)

Abrufen der Übermittlungseinstellungen eines Benachrichtigungsabonnents.

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

Parameter

subscriberId

string

ID des Benutzers oder der Gruppe.

Gibt zurück

Promise<NotificationSubscriber>

getSubscription(string, SubscriptionQueryFlags)

Rufen Sie ein Benachrichtigungsabonnement nach seiner ID ab.

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

Parameter

subscriptionId

string

queryFlags

SubscriptionQueryFlags

Gibt zurück

Promise<NotificationSubscription>

getSubscriptionDiagnostics(string)

Rufen Sie die Diagnose Einstellungen für ein Abonnement ab.

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

Parameter

subscriptionId

string

Die ID des Benachrichtigungsabonnements.

Gibt zurück

Promise<SubscriptionDiagnostics>

getSubscriptionTemplates()

Rufen Sie verfügbare Abonnementvorlagen ab.

function getSubscriptionTemplates(): Promise<NotificationSubscriptionTemplate[]>

Gibt zurück

Promise<NotificationSubscriptionTemplate[]>

listEventTypes(string)

Liste der verfügbaren Ereignistypen für diesen Dienst auf. Filtern Sie optional nur nach Ereignistypen für den angegebenen Herausgeber.

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

Parameter

publisherId

string

Beschränken auf Ereignistypen für diesen Herausgeber

Gibt zurück

Promise<NotificationEventType[]>

listLogs(string, string, Date, Date)

Rufen Sie eine Liste der Diagnoseprotokolle für diesen Dienst ab.

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

Parameter

source

string

ID, die angibt, auf welchen Protokolltyp Diagnose überprüft werden soll.

entryId

string

Die ID des spezifischen Protokolls, für das eine Abfrage ausgeführt werden soll.

startTime

Date

Startzeit für den Abzufragenden Zeitbereich.

endTime

Date

Endzeit für den Abfragezeitbereich.

Gibt zurück

Promise<INotificationDiagnosticLog[]>

listNotificationReasons(number)

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

Parameter

notificationIds

number

Gibt zurück

Promise<NotificationReason[]>

listSubscriptions(string, string[], SubscriptionQueryFlags)

Rufen Sie eine Liste der Benachrichtigungsabonnements ab, entweder nach Abonnement-IDs oder nach allen Abonnements für einen bestimmten Benutzer oder eine bestimmte Gruppe.

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

Parameter

targetId

string

Benutzer- oder Gruppen-ID

ids

string[]

Liste der Abonnement-IDs

queryFlags

SubscriptionQueryFlags

Gibt zurück

Promise<NotificationSubscription[]>

performBatchNotificationOperations(BatchNotificationOperation)

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

Parameter

operation

BatchNotificationOperation

Gibt zurück

Promise<void>

publishEvent(VssNotificationEvent)

Veröffentlichen eines Ereignisses. Diese Anforderung muss an den Dienst "extmgmt" weitergeleitet werden.

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

Parameter

notificationEvent

VssNotificationEvent

Gibt zurück

Promise<VssNotificationEvent>

publishTokenEvent(VssNotificationEvent)

Veröffentlichen eines Ereignisses. Diese Anforderung gilt nur für den Tokendienst, da es sich um einen bereitstellungsgeschützten Dienst handelt.

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

Parameter

notificationEvent

VssNotificationEvent

Gibt zurück

Promise<VssNotificationEvent>

queryEventTypes(FieldValuesQuery, string)

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

Parameter

inputValuesQuery

FieldValuesQuery

eventType

string

Gibt zurück

Promise<NotificationEventField[]>

querySubscriptions(SubscriptionQuery)

Abfrage für Abonnements. Ein Abonnement wird zurückgegeben, wenn es einer oder mehreren der angegebenen Bedingungen entspricht.

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

Parameter

subscriptionQuery

SubscriptionQuery

Gibt zurück

Promise<NotificationSubscription[]>

transformEvent(EventTransformRequest)

Transformieren eines Benachrichtigungsereignisses.

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

Parameter

transformRequest

EventTransformRequest

Objekt, das transformiert werden soll.

Gibt zurück

Promise<EventTransformResult>

updateSettings(NotificationAdminSettingsUpdateParameters)

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

Parameter

updateParameters

NotificationAdminSettingsUpdateParameters

Gibt zurück

Promise<NotificationAdminSettings>

updateSubscriber(NotificationSubscriberUpdateParameters, string)

Aktualisieren sie die Übermittlungseinstellungen eines Benachrichtigungsabonnents.

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

Parameter

updateParameters

NotificationSubscriberUpdateParameters

subscriberId

string

ID des Benutzers oder der Gruppe.

Gibt zurück

Promise<NotificationSubscriber>

updateSubscription(NotificationSubscriptionUpdateParameters, string)

Aktualisieren Sie ein vorhandenes Abonnement. Je nach Abonnementtyp und Berechtigungen kann der Aufrufer die Beschreibung, Filtereinstellungen, Kanaleinstellungen (Übermittlung) und vieles mehr aktualisieren.

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

Parameter

updateParameters

NotificationSubscriptionUpdateParameters

subscriptionId

string

Gibt zurück

Promise<NotificationSubscription>

updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)

Aktualisieren Sie die Diagnose Einstellungen für ein Abonnement.

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

Parameter

updateParameters

UpdateSubscripitonDiagnosticsParameters

subscriptionId

string

Die ID des Benachrichtigungsabonnements.

Gibt zurück

Promise<SubscriptionDiagnostics>

updateSubscriptionUserSettings(SubscriptionUserSettings, string, string)

Aktualisieren Sie die Einstellungen des angegebenen Benutzers für das angegebene Abonnement. Diese API wird in der Regel verwendet, um ein freigegebenes Abonnement zu aktivieren oder zu deaktivieren. Benutzereinstellungen können nur auf freigegebene Abonnements angewendet werden, z. B. Teamabonnements oder Standardabonnements.

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

Parameter

userSettings

SubscriptionUserSettings

subscriptionId

string

userId

string

ID des Benutzers

Gibt zurück

Promise<SubscriptionUserSettings>