NotificationRestClient class

new NotificationRestClient(options: IVssRestClientOptions)

Paramètres

Créez un abonnement.

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

Paramètres

Retours

Supprimer un abonnement.

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

Paramètres

Retours

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

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

Paramètres

Retours

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

Paramètres

Retours

function getSettings(): Promise<NotificationAdminSettings>

Retours

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

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

Paramètres

Retours

Obtenez un abonnement de notification par son ID.

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

Paramètres

Retours

Obtenez les paramètres diagnostics pour un abonnement.

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

Paramètres

Retours

Obtenir les modèles d’abonnement disponibles.

function getSubscriptionTemplates(): Promise<NotificationSubscriptionTemplate[]>

Retours

Répertorier les types d’événements disponibles pour ce service. Si vous le souhaitez, filtrez uniquement par types d’événements pour le serveur de publication spécifié.

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

Paramètres

Retours

Obtenez la liste des journaux de diagnostic pour ce service.

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

Paramètres

Retours

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

Paramètres

Retours

Obtenez la liste des abonnements de notification, par ID d’abonnement ou par tous les abonnements d’un utilisateur ou d’un groupe donné.

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

Paramètres

Retours

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

Paramètres

Retours

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

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

Paramètres

Retours

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

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

Paramètres

Retours

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

Paramètres

Retours

Requête pour les abonnements. Un abonnement est retourné s’il correspond à une ou plusieurs des conditions spécifiées.

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

Paramètres

Retours

Transformer un événement de notification.

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

Paramètres

Retours

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

Paramètres

Retours

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

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

Paramètres

Retours

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

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

Paramètres

Retours

Mettez à jour les paramètres de diagnostics pour un abonnement.

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

Paramètres

Retours

Mettez à jour les paramètres de l’utilisateur spécifié pour l’abonnement spécifié. Cette API est généralement utilisée pour accepter 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

Retours