NotificationRestClient class

Paquet:

azure-devops-extension-api

Classe de base qui doit être utilisée (dérivée de) pour effectuer des requêtes à des API REST VSS

Extends

RestClientBase

Constructeurs

NotificationRestClient(IVssRestClientOptions)

Méthodes

createSubscription(NotificationSubscriptionCreateParameters)	Créez un abonnement.
deleteSubscription(string)	Supprimez un abonnement.
getEventType(string)	Obtenir un type d’événement spécifique.
getNotificationReasons(number)
getSettings()
getSubscriber(string)	Obtenir les préférences de remise d’un abonné aux notifications.
getSubscription(string, SubscriptionQueryFlags)	Obtenez un abonnement de notification par son ID.
getSubscriptionDiagnostics(string)	Obtenez les paramètres de diagnostic d’un abonnement.
getSubscriptionTemplates()	Obtenir les modèles d’abonnement disponibles.
listEventTypes(string)	Répertorier les types d’événements disponibles pour ce service. Filtrez éventuellement uniquement les types d’événements pour l’éditeur spécifié.
listLogs(string, string, Date, Date)	Obtenez la liste des journaux de diagnostic pour ce service.
listNotificationReasons(number)
listSubscriptions(string, string[], SubscriptionQueryFlags)	Obtenez la liste des abonnements aux notifications, soit par ID d’abonnement, soit par tous les abonnements pour un utilisateur ou un groupe donné.
performBatchNotificationOperations(BatchNotificationOperation)
publishEvent(VssNotificationEvent)	Publiez un événement. Cette demande doit être dirigée vers le service « extmgmt ».
publishTokenEvent(VssNotificationEvent)	Publiez un événement. Cette requête concerne uniquement le service Jeton, car il s’agit d’un service de déploiement uniquement.
queryEventTypes(FieldValuesQuery, string)
querySubscriptions(SubscriptionQuery)	Rechercher des abonnements. Un abonnement est retourné s’il correspond à une ou plusieurs des conditions spécifiées.
transformEvent(EventTransformRequest)	Transformez un événement de notification.
updateSettings(NotificationAdminSettingsUpdateParameters)
updateSubscriber(NotificationSubscriberUpdateParameters, string)	Mettre à jour les préférences de remise d’un abonné aux notifications.
updateSubscription(NotificationSubscriptionUpdateParameters, string)	Mettez à jour un abonnement existant. En fonction du type d’abonnement et d’autorisations, l’appelant peut mettre à jour la description, les paramètres de filtre, les paramètres de canal (remise), etc.
updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)	Mettez à jour les paramètres de diagnostic d’un abonnement.
updateSubscriptionUserSettings(SubscriptionUserSettings, string, string)	Mettez à jour les paramètres de l’utilisateur spécifiés pour l’abonnement spécifié. Cette API est généralement utilisée pour refuser ou refuser un abonnement partagé. Les paramètres utilisateur ne peuvent être appliqués qu’aux abonnements partagés, tels que les abonnements d’équipe ou les abonnements par défaut.

Détails du constructeur

NotificationRestClient(IVssRestClientOptions)

new NotificationRestClient(options: IVssRestClientOptions)

Paramètres

options

IVssRestClientOptions

Détails de la méthode

createSubscription(NotificationSubscriptionCreateParameters)

Créez un abonnement.

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

Paramètres

createParameters

NotificationSubscriptionCreateParameters

Retours

Promise<NotificationSubscription>

deleteSubscription(string)

Supprimez un abonnement.

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

Paramètres

subscriptionId

string

Retours

Promise<void>

getEventType(string)

Obtenir un type d’événement spécifique.

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

Paramètres

eventType

string

ID du type d’événement.

Retours

Promise<NotificationEventType>

getNotificationReasons(number)

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

Paramètres

notificationId

number

Retours

Promise<NotificationReason>

getSettings()

function getSettings(): Promise<NotificationAdminSettings>

Retours

Promise<NotificationAdminSettings>

getSubscriber(string)

Obtenir les préférences de remise d’un abonné aux notifications.

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

Paramètres

subscriberId

string

ID de l’utilisateur ou du groupe.

Retours

Promise<NotificationSubscriber>

getSubscription(string, SubscriptionQueryFlags)

Obtenez un abonnement de notification par son ID.

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

Paramètres

subscriptionId

string

queryFlags

SubscriptionQueryFlags

Retours

Promise<NotificationSubscription>

getSubscriptionDiagnostics(string)

Obtenez les paramètres de diagnostic d’un abonnement.

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

Paramètres

subscriptionId

string

ID de l’abonnement aux notifications.

Retours

Promise<SubscriptionDiagnostics>

getSubscriptionTemplates()

Obtenir les modèles d’abonnement disponibles.

function getSubscriptionTemplates(): Promise<NotificationSubscriptionTemplate[]>

Retours

Promise<NotificationSubscriptionTemplate[]>

listEventTypes(string)

Répertorier les types d’événements disponibles pour ce service. Filtrez éventuellement uniquement les types d’événements pour l’éditeur spécifié.

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

Paramètres

publisherId

string

Limite aux types d’événements pour cet éditeur

Retours

Promise<NotificationEventType[]>

listLogs(string, string, Date, Date)

Obtenez la liste des journaux de diagnostic pour ce service.

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

Paramètres

source

string

ID spécifiant le type de journaux pour lequel vérifier les diagnostics.

entryId

string

ID du journal spécifique à rechercher.

startTime

Date

Heure de début de l’intervalle de temps à interroger.

endTime

Date

Heure de fin de l’intervalle de temps à interroger.

Retours

Promise<INotificationDiagnosticLog[]>

listNotificationReasons(number)

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

Paramètres

notificationIds

number

Retours

Promise<NotificationReason[]>

listSubscriptions(string, string[], SubscriptionQueryFlags)

Obtenez la liste des abonnements aux notifications, soit par ID d’abonnement, soit par tous les abonnements pour un utilisateur ou un groupe donné.

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

Paramètres

targetId

string

ID d’utilisateur ou de groupe

ids

string[]

Liste des ID d’abonnement

queryFlags

SubscriptionQueryFlags

Retours

Promise<NotificationSubscription[]>

performBatchNotificationOperations(BatchNotificationOperation)

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

Paramètres

operation

BatchNotificationOperation

Retours

Promise<void>

publishEvent(VssNotificationEvent)

Publiez un événement. Cette demande doit être dirigée vers le service « extmgmt ».

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

Paramètres

notificationEvent

VssNotificationEvent

Retours

Promise<VssNotificationEvent>

publishTokenEvent(VssNotificationEvent)

Publiez un événement. Cette requête concerne uniquement le service Jeton, car il s’agit d’un service de déploiement uniquement.

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

Paramètres

notificationEvent

VssNotificationEvent

Retours

Promise<VssNotificationEvent>

queryEventTypes(FieldValuesQuery, string)

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

Paramètres

inputValuesQuery

FieldValuesQuery

eventType

string

Retours

Promise<NotificationEventField[]>

querySubscriptions(SubscriptionQuery)

Rechercher des abonnements. Un abonnement est retourné s’il correspond à une ou plusieurs des conditions spécifiées.

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

Paramètres

subscriptionQuery

SubscriptionQuery

Retours

Promise<NotificationSubscription[]>

transformEvent(EventTransformRequest)

Transformez un événement de notification.

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

Paramètres

transformRequest

EventTransformRequest

Objet à transformer.

Retours

Promise<EventTransformResult>

updateSettings(NotificationAdminSettingsUpdateParameters)

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

Paramètres

updateParameters

NotificationAdminSettingsUpdateParameters

Retours

Promise<NotificationAdminSettings>

updateSubscriber(NotificationSubscriberUpdateParameters, string)

Mettre à jour les préférences de remise d’un abonné aux notifications.

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

Paramètres

updateParameters

NotificationSubscriberUpdateParameters

subscriberId

string

ID de l’utilisateur ou du groupe.

Retours

Promise<NotificationSubscriber>

updateSubscription(NotificationSubscriptionUpdateParameters, string)

Mettez à jour un abonnement existant. En fonction du type d’abonnement et d’autorisations, l’appelant peut mettre à jour la description, les paramètres de filtre, les paramètres de canal (remise), etc.

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

Paramètres

updateParameters

NotificationSubscriptionUpdateParameters

subscriptionId

string

Retours

Promise<NotificationSubscription>

updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)

Mettez à jour les paramètres de diagnostic d’un abonnement.

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

Paramètres

updateParameters

UpdateSubscripitonDiagnosticsParameters

subscriptionId

string

ID de l’abonnement aux notifications.

Retours

Promise<SubscriptionDiagnostics>

updateSubscriptionUserSettings(SubscriptionUserSettings, string, string)

Mettez à jour les paramètres de l’utilisateur spécifiés pour l’abonnement spécifié. Cette API est généralement utilisée pour refuser ou refuser un abonnement partagé. Les paramètres utilisateur ne peuvent être appliqués qu’aux abonnements partagés, tels que les abonnements d’équipe ou les abonnements par défaut.

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

Paramètres

userSettings

SubscriptionUserSettings

subscriptionId

string

userId

string

ID de l’utilisateur

Retours

Promise<SubscriptionUserSettings>