NotificationRestClient class

Pakiet:

azure-devops-extension-api

Klasa bazowa, która powinna być używana (pochodna) do tworzenia żądań do interfejsów API REST usługi VSS

Rozszerzenie

RestClientBase

Konstruktory

NotificationRestClient(IVssRestClientOptions)

Metody

createSubscription(NotificationSubscriptionCreateParameters)	Utwórz nową subskrypcję.
deleteSubscription(string)	Usuwanie subskrypcji.
getEventType(string)	Pobierz określony typ zdarzenia.
getNotificationReasons(number)
getSettings()
getSubscriber(string)	Uzyskaj preferencje dostarczania subskrybenta powiadomień.
getSubscription(string, SubscriptionQueryFlags)	Pobierz subskrypcję powiadomień według jego identyfikatora.
getSubscriptionDiagnostics(string)	Pobierz ustawienia diagnostyczne dla subskrypcji.
getSubscriptionTemplates()	Pobierz dostępne szablony subskrypcji.
listEventTypes(string)	Wyświetl listę dostępnych typów zdarzeń dla tej usługi. Opcjonalnie filtruj według tylko typów zdarzeń dla określonego wydawcy.
listLogs(string, string, Date, Date)	Pobierz listę dzienników diagnostycznych dla tej usługi.
listNotificationReasons(number)
listSubscriptions(string, string[], SubscriptionQueryFlags)	Pobierz listę subskrypcji powiadomień według identyfikatorów subskrypcji lub wszystkich subskrypcji dla danego użytkownika lub grupy.
performBatchNotificationOperations(BatchNotificationOperation)
publishEvent(VssNotificationEvent)	Publikowanie zdarzenia. To żądanie musi zostać skierowane do usługi "extmgmt".
publishTokenEvent(VssNotificationEvent)	Publikowanie zdarzenia. To żądanie dotyczy tylko usługi tokenu, ponieważ jest to usługa tylko do wdrażania.
queryEventTypes(FieldValuesQuery, string)
querySubscriptions(SubscriptionQuery)	Wykonywanie zapytań o subskrypcje. Subskrypcja jest zwracana, jeśli jest zgodna z co najmniej jednym z określonych warunków.
transformEvent(EventTransformRequest)	Transformuj zdarzenie powiadomienia.
updateSettings(NotificationAdminSettingsUpdateParameters)
updateSubscriber(NotificationSubscriberUpdateParameters, string)	Aktualizowanie preferencji dostarczania subskrybenta powiadomień.
updateSubscription(NotificationSubscriptionUpdateParameters, string)	Zaktualizuj istniejącą subskrypcję. W zależności od typu subskrypcji i uprawnień obiekt wywołujący może zaktualizować opis, ustawienia filtru, ustawienia kanału (dostarczania) i nie tylko.
updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)	Zaktualizuj ustawienia diagnostyczne subskrypcji.
updateSubscriptionUserSettings(SubscriptionUserSettings, string, string)	Zaktualizuj ustawienia określonego użytkownika dla określonej subskrypcji. Ten interfejs API jest zwykle używany do rezygnacji lub rezygnacji z subskrypcji udostępnionej. Ustawienia użytkownika można stosować tylko do subskrypcji udostępnionych, takich jak subskrypcje zespołu lub domyślne subskrypcje.

Szczegóły konstruktora

NotificationRestClient(IVssRestClientOptions)

new NotificationRestClient(options: IVssRestClientOptions)

Parametry

options

IVssRestClientOptions

Szczegóły metody

createSubscription(NotificationSubscriptionCreateParameters)

Utwórz nową subskrypcję.

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

Parametry

createParameters

NotificationSubscriptionCreateParameters

Zwraca

Promise<NotificationSubscription>

deleteSubscription(string)

Usuwanie subskrypcji.

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

Parametry

subscriptionId

string

Zwraca

Promise<void>

getEventType(string)

Pobierz określony typ zdarzenia.

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

Parametry

eventType

string

Identyfikator typu zdarzenia.

Zwraca

Promise<NotificationEventType>

getNotificationReasons(number)

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

Parametry

notificationId

number

Zwraca

Promise<NotificationReason>

getSettings()

function getSettings(): Promise<NotificationAdminSettings>

Zwraca

Promise<NotificationAdminSettings>

getSubscriber(string)

Uzyskaj preferencje dostarczania subskrybenta powiadomień.

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

Parametry

subscriberId

string

Identyfikator użytkownika lub grupy.

Zwraca

Promise<NotificationSubscriber>

getSubscription(string, SubscriptionQueryFlags)

Pobierz subskrypcję powiadomień według jego identyfikatora.

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

Parametry

subscriptionId

string

queryFlags

SubscriptionQueryFlags

Zwraca

Promise<NotificationSubscription>

getSubscriptionDiagnostics(string)

Pobierz ustawienia diagnostyczne dla subskrypcji.

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

Parametry

subscriptionId

string

Identyfikator subskrypcji powiadomień.

Zwraca

Promise<SubscriptionDiagnostics>

getSubscriptionTemplates()

Pobierz dostępne szablony subskrypcji.

function getSubscriptionTemplates(): Promise<NotificationSubscriptionTemplate[]>

Zwraca

Promise<NotificationSubscriptionTemplate[]>

listEventTypes(string)

Wyświetl listę dostępnych typów zdarzeń dla tej usługi. Opcjonalnie filtruj według tylko typów zdarzeń dla określonego wydawcy.

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

Parametry

publisherId

string

Ogranicz do typów zdarzeń dla tego wydawcy

Zwraca

Promise<NotificationEventType[]>

listLogs(string, string, Date, Date)

Pobierz listę dzienników diagnostycznych dla tej usługi.

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

Parametry

source

string

Identyfikator określający typ dzienników do sprawdzenia diagnostyki.

entryId

string

Identyfikator określonego dziennika do odpytowania.

startTime

Date

Godzina rozpoczęcia dla zakresu czasu, w ramach których ma być uruchamiane zapytanie.

endTime

Date

Godzina zakończenia zakresu czasu do uruchomienia zapytania.

Zwraca

Promise<INotificationDiagnosticLog[]>

listNotificationReasons(number)

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

Parametry

notificationIds

number

Zwraca

Promise<NotificationReason[]>

listSubscriptions(string, string[], SubscriptionQueryFlags)

Pobierz listę subskrypcji powiadomień według identyfikatorów subskrypcji lub wszystkich subskrypcji dla danego użytkownika lub grupy.

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

Parametry

targetId

string

Identyfikator użytkownika lub grupy

ids

string[]

Lista identyfikatorów subskrypcji

queryFlags

SubscriptionQueryFlags

Zwraca

Promise<NotificationSubscription[]>

performBatchNotificationOperations(BatchNotificationOperation)

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

Parametry

operation

BatchNotificationOperation

Zwraca

Promise<void>

publishEvent(VssNotificationEvent)

Publikowanie zdarzenia. To żądanie musi zostać skierowane do usługi "extmgmt".

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

Parametry

notificationEvent

VssNotificationEvent

Zwraca

Promise<VssNotificationEvent>

publishTokenEvent(VssNotificationEvent)

Publikowanie zdarzenia. To żądanie dotyczy tylko usługi tokenu, ponieważ jest to usługa tylko do wdrażania.

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

Parametry

notificationEvent

VssNotificationEvent

Zwraca

Promise<VssNotificationEvent>

queryEventTypes(FieldValuesQuery, string)

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

Parametry

inputValuesQuery

FieldValuesQuery

eventType

string

Zwraca

Promise<NotificationEventField[]>

querySubscriptions(SubscriptionQuery)

Wykonywanie zapytań o subskrypcje. Subskrypcja jest zwracana, jeśli jest zgodna z co najmniej jednym z określonych warunków.

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

Parametry

subscriptionQuery

SubscriptionQuery

Zwraca

Promise<NotificationSubscription[]>

transformEvent(EventTransformRequest)

Transformuj zdarzenie powiadomienia.

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

Parametry

transformRequest

EventTransformRequest

Obiekt, który ma zostać przekształcony.

Zwraca

Promise<EventTransformResult>

updateSettings(NotificationAdminSettingsUpdateParameters)

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

Parametry

updateParameters

NotificationAdminSettingsUpdateParameters

Zwraca

Promise<NotificationAdminSettings>

updateSubscriber(NotificationSubscriberUpdateParameters, string)

Aktualizowanie preferencji dostarczania subskrybenta powiadomień.

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

Parametry

updateParameters

NotificationSubscriberUpdateParameters

subscriberId

string

Identyfikator użytkownika lub grupy.

Zwraca

Promise<NotificationSubscriber>

updateSubscription(NotificationSubscriptionUpdateParameters, string)

Zaktualizuj istniejącą subskrypcję. W zależności od typu subskrypcji i uprawnień obiekt wywołujący może zaktualizować opis, ustawienia filtru, ustawienia kanału (dostarczania) i nie tylko.

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

Parametry

updateParameters

NotificationSubscriptionUpdateParameters

subscriptionId

string

Zwraca

Promise<NotificationSubscription>

updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)

Zaktualizuj ustawienia diagnostyczne subskrypcji.

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

Parametry

updateParameters

UpdateSubscripitonDiagnosticsParameters

subscriptionId

string

Identyfikator subskrypcji powiadomień.

Zwraca

Promise<SubscriptionDiagnostics>

updateSubscriptionUserSettings(SubscriptionUserSettings, string, string)

Zaktualizuj ustawienia określonego użytkownika dla określonej subskrypcji. Ten interfejs API jest zwykle używany do rezygnacji lub rezygnacji z subskrypcji udostępnionej. Ustawienia użytkownika można stosować tylko do subskrypcji udostępnionych, takich jak subskrypcje zespołu lub domyślne subskrypcje.

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

Parametry

userSettings

SubscriptionUserSettings

subscriptionId

string

userId

string

Identyfikator użytkownika

Zwraca

Promise<SubscriptionUserSettings>