NotificationRestClient class

Balíček:

azure-devops-extension-api

Základní třída, která by se měla použít (odvozená) k provádění požadavků na rozhraní REST API služby VSS

Extends

RestClientBase

Konstruktory

NotificationRestClient(IVssRestClientOptions)

Metody

createSubscription(NotificationSubscriptionCreateParameters)	Vytvořte nové předplatné.
deleteSubscription(string)	Odstraňte předplatné.
getEventType(string)	Získejte konkrétní typ události.
getNotificationReasons(number)
getSettings()
getSubscriber(string)	Získejte předvolby doručování odběratele oznámení.
getSubscription(string, SubscriptionQueryFlags)	Získejte odběr oznámení podle jeho ID.
getSubscriptionDiagnostics(string)	Získejte nastavení diagnostiky pro předplatné.
getSubscriptionTemplates()	Získejte dostupné šablony předplatného.
listEventTypes(string)	Seznam dostupných typů událostí pro tuto službu. Volitelně můžete filtrovat pouze podle typů událostí pro určeného vydavatele.
listLogs(string, string, Date, Date)	Získejte seznam diagnostických protokolů pro tuto službu.
listNotificationReasons(number)
listSubscriptions(string, string[], SubscriptionQueryFlags)	Získejte seznam odběrů oznámení, a to buď podle ID předplatného, nebo podle všech předplatných pro daného uživatele nebo skupinu.
performBatchNotificationOperations(BatchNotificationOperation)
publishEvent(VssNotificationEvent)	Publikujte událost. Tento požadavek musí být směrován na službu "extmgmt".
publishTokenEvent(VssNotificationEvent)	Publikujte událost. Tento požadavek je určen pouze pro službu tokenů, protože se jedná o službu pouze pro nasazení.
queryEventTypes(FieldValuesQuery, string)
querySubscriptions(SubscriptionQuery)	Dotaz na předplatná. Předplatné je vráceno, pokud splňuje jednu nebo více zadaných podmínek.
transformEvent(EventTransformRequest)	Tranform událost oznámení.
updateSettings(NotificationAdminSettingsUpdateParameters)
updateSubscriber(NotificationSubscriberUpdateParameters, string)	Aktualizujte předvolby doručování odběratele oznámení.
updateSubscription(NotificationSubscriptionUpdateParameters, string)	Aktualizujte stávající předplatné. V závislosti na typu předplatného a oprávněních může volající aktualizovat popis, nastavení filtru, nastavení kanálu (doručování) a další.
updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)	Aktualizujte nastavení diagnostiky pro předplatné.
updateSubscriptionUserSettings(SubscriptionUserSettings, string, string)	Aktualizujte nastavení zadaného uživatele pro zadané předplatné. Toto rozhraní API se obvykle používá k vyjádření souhlasu nebo odhlášení ze sdíleného předplatného. Uživatelská nastavení lze použít pouze u sdílených předplatných, jako jsou týmová předplatná nebo výchozí předplatná.

Podrobnosti konstruktoru

NotificationRestClient(IVssRestClientOptions)

new NotificationRestClient(options: IVssRestClientOptions)

Parametry

options

IVssRestClientOptions

Podrobnosti metody

createSubscription(NotificationSubscriptionCreateParameters)

Vytvořte nové předplatné.

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

Parametry

createParameters

NotificationSubscriptionCreateParameters

Návraty

Promise<NotificationSubscription>

deleteSubscription(string)

Odstraňte předplatné.

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

Parametry

subscriptionId

string

Návraty

Promise<void>

getEventType(string)

Získejte konkrétní typ události.

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

Parametry

eventType

string

ID typu události.

Návraty

Promise<NotificationEventType>

getNotificationReasons(number)

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

Parametry

notificationId

number

Návraty

Promise<NotificationReason>

getSettings()

function getSettings(): Promise<NotificationAdminSettings>

Návraty

Promise<NotificationAdminSettings>

getSubscriber(string)

Získejte předvolby doručování odběratele oznámení.

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

Parametry

subscriberId

string

ID uživatele nebo skupiny.

Návraty

Promise<NotificationSubscriber>

getSubscription(string, SubscriptionQueryFlags)

Získejte odběr oznámení podle jeho ID.

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

Parametry

subscriptionId

string

queryFlags

SubscriptionQueryFlags

Návraty

Promise<NotificationSubscription>

getSubscriptionDiagnostics(string)

Získejte nastavení diagnostiky pro předplatné.

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

Parametry

subscriptionId

string

ID odběru oznámení.

Návraty

Promise<SubscriptionDiagnostics>

getSubscriptionTemplates()

Získejte dostupné šablony předplatného.

function getSubscriptionTemplates(): Promise<NotificationSubscriptionTemplate[]>

Návraty

Promise<NotificationSubscriptionTemplate[]>

listEventTypes(string)

Seznam dostupných typů událostí pro tuto službu. Volitelně můžete filtrovat pouze podle typů událostí pro určeného vydavatele.

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

Parametry

publisherId

string

Omezení na typy událostí pro tohoto vydavatele

Návraty

Promise<NotificationEventType[]>

listLogs(string, string, Date, Date)

Získejte seznam diagnostických protokolů pro tuto službu.

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

Parametry

source

string

ID určující, pro který typ protokolů se má diagnostika kontrolovat.

entryId

string

ID konkrétního protokolu, na který se má dotazovat.

startTime

Date

Čas spuštění časového rozsahu pro dotazování.

endTime

Date

Koncový čas časového rozsahu dotazu.

Návraty

Promise<INotificationDiagnosticLog[]>

listNotificationReasons(number)

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

Parametry

notificationIds

number

Návraty

Promise<NotificationReason[]>

listSubscriptions(string, string[], SubscriptionQueryFlags)

Získejte seznam odběrů oznámení, a to buď podle ID předplatného, nebo podle všech předplatných pro daného uživatele nebo skupinu.

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

Parametry

targetId

string

ID uživatele nebo skupiny

ids

string[]

Seznam ID předplatných

queryFlags

SubscriptionQueryFlags

Návraty

Promise<NotificationSubscription[]>

performBatchNotificationOperations(BatchNotificationOperation)

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

Parametry

operation

BatchNotificationOperation

Návraty

Promise<void>

publishEvent(VssNotificationEvent)

Publikujte událost. Tento požadavek musí být směrován na službu "extmgmt".

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

Parametry

notificationEvent

VssNotificationEvent

Návraty

Promise<VssNotificationEvent>

publishTokenEvent(VssNotificationEvent)

Publikujte událost. Tento požadavek je určen pouze pro službu tokenů, protože se jedná o službu pouze pro nasazení.

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

Parametry

notificationEvent

VssNotificationEvent

Návraty

Promise<VssNotificationEvent>

queryEventTypes(FieldValuesQuery, string)

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

Parametry

inputValuesQuery

FieldValuesQuery

eventType

string

Návraty

Promise<NotificationEventField[]>

querySubscriptions(SubscriptionQuery)

Dotaz na předplatná. Předplatné je vráceno, pokud splňuje jednu nebo více zadaných podmínek.

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

Parametry

subscriptionQuery

SubscriptionQuery

Návraty

Promise<NotificationSubscription[]>

transformEvent(EventTransformRequest)

Tranform událost oznámení.

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

Parametry

transformRequest

EventTransformRequest

Objekt, který má být transformován.

Návraty

Promise<EventTransformResult>

updateSettings(NotificationAdminSettingsUpdateParameters)

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

Parametry

updateParameters

NotificationAdminSettingsUpdateParameters

Návraty

Promise<NotificationAdminSettings>

updateSubscriber(NotificationSubscriberUpdateParameters, string)

Aktualizujte předvolby doručování odběratele oznámení.

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

Parametry

updateParameters

NotificationSubscriberUpdateParameters

subscriberId

string

ID uživatele nebo skupiny.

Návraty

Promise<NotificationSubscriber>

updateSubscription(NotificationSubscriptionUpdateParameters, string)

Aktualizujte stávající předplatné. V závislosti na typu předplatného a oprávněních může volající aktualizovat popis, nastavení filtru, nastavení kanálu (doručování) a další.

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

Parametry

updateParameters

NotificationSubscriptionUpdateParameters

subscriptionId

string

Návraty

Promise<NotificationSubscription>

updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)

Aktualizujte nastavení diagnostiky pro předplatné.

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

Parametry

updateParameters

UpdateSubscripitonDiagnosticsParameters

subscriptionId

string

ID odběru oznámení.

Návraty

Promise<SubscriptionDiagnostics>

updateSubscriptionUserSettings(SubscriptionUserSettings, string, string)

Aktualizujte nastavení zadaného uživatele pro zadané předplatné. Toto rozhraní API se obvykle používá k vyjádření souhlasu nebo odhlášení ze sdíleného předplatného. Uživatelská nastavení lze použít pouze u sdílených předplatných, jako jsou týmová předplatná nebo výchozí předplatná.

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

Parametry

userSettings

SubscriptionUserSettings

subscriptionId

string

userId

string

ID uživatele

Návraty

Promise<SubscriptionUserSettings>