NotificationRestClient class

Пакет:

azure-devops-extension-api

Базовый класс, который должен использоваться (производный от) для выполнения запросов к REST API VSS

Extends

RestClientBase

Конструкторы

NotificationRestClient(IVssRestClientOptions)

Методы

createSubscription(NotificationSubscriptionCreateParameters)	Создайте новую подписку.
deleteSubscription(string)	Удаление подписки.
getEventType(string)	Получение определенного типа события.
getNotificationReasons(number)
getSettings()
getSubscriber(string)	Получение настроек доставки подписчика уведомлений.
getSubscription(string, SubscriptionQueryFlags)	Получение подписки на уведомление по его идентификатору.
getSubscriptionDiagnostics(string)	Получите параметры диагностики для подписки.
getSubscriptionTemplates()	Получение доступных шаблонов подписок.
listEventTypes(string)	Список доступных типов событий для этой службы. При необходимости фильтруйте только типы событий для указанного издателя.
listLogs(string, string, Date, Date)	Получите список журналов диагностики для этой службы.
listNotificationReasons(number)
listSubscriptions(string, string[], SubscriptionQueryFlags)	Получение списка подписок на уведомления по идентификаторам подписок или по всем подпискам для определенного пользователя или группы.
performBatchNotificationOperations(BatchNotificationOperation)
publishEvent(VssNotificationEvent)	Публикация события. Этот запрос должен быть направлен в службу extmgmt.
publishTokenEvent(VssNotificationEvent)	Публикация события. Этот запрос предназначен только для службы токенов, так как это только служба развертывания.
queryEventTypes(FieldValuesQuery, string)
querySubscriptions(SubscriptionQuery)	Запрос подписок. Подписка возвращается, если она соответствует одному или нескольким указанным условиям.
transformEvent(EventTransformRequest)	Трансформируйте событие уведомления.
updateSettings(NotificationAdminSettingsUpdateParameters)
updateSubscriber(NotificationSubscriberUpdateParameters, string)	Обновите настройки доставки подписчика уведомлений.
updateSubscription(NotificationSubscriptionUpdateParameters, string)	Обновите существующую подписку. В зависимости от типа подписки и разрешений вызывающий объект может обновлять описание, параметры фильтра, параметры канала (доставка) и многое другое.
updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)	Обновите параметры диагностики для подписки.
updateSubscriptionUserSettings(SubscriptionUserSettings, string, string)	Обновите параметры указанного пользователя для указанной подписки. Обычно этот API используется для отказа от общей подписки или выхода из нее. Параметры пользователя можно применять только к общим подпискам, таким как подписки группы или подписки по умолчанию.

Сведения о конструкторе

NotificationRestClient(IVssRestClientOptions)

new NotificationRestClient(options: IVssRestClientOptions)

Параметры

options

IVssRestClientOptions

Сведения о методе

createSubscription(NotificationSubscriptionCreateParameters)

Создайте новую подписку.

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

Параметры

createParameters

NotificationSubscriptionCreateParameters

Возвращаемое значение

Promise<NotificationSubscription>

deleteSubscription(string)

Удаление подписки.

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

Параметры

subscriptionId

string

Возвращаемое значение

Promise<void>

getEventType(string)

Получение определенного типа события.

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

Параметры

eventType

string

Идентификатор типа события.

Возвращаемое значение

Promise<NotificationEventType>

getNotificationReasons(number)

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

Параметры

notificationId

number

Возвращаемое значение

Promise<NotificationReason>

getSettings()

function getSettings(): Promise<NotificationAdminSettings>

Возвращаемое значение

Promise<NotificationAdminSettings>

getSubscriber(string)

Получение настроек доставки подписчика уведомлений.

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

Параметры

subscriberId

string

Идентификатор пользователя или группы.

Возвращаемое значение

Promise<NotificationSubscriber>

getSubscription(string, SubscriptionQueryFlags)

Получение подписки на уведомление по его идентификатору.

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

Параметры

subscriptionId

string

queryFlags

SubscriptionQueryFlags

Возвращаемое значение

Promise<NotificationSubscription>

getSubscriptionDiagnostics(string)

Получите параметры диагностики для подписки.

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

Параметры

subscriptionId

string

Идентификатор подписки на уведомления.

Возвращаемое значение

Promise<SubscriptionDiagnostics>

getSubscriptionTemplates()

Получение доступных шаблонов подписок.

function getSubscriptionTemplates(): Promise<NotificationSubscriptionTemplate[]>

Возвращаемое значение

Promise<NotificationSubscriptionTemplate[]>

listEventTypes(string)

Список доступных типов событий для этой службы. При необходимости фильтруйте только типы событий для указанного издателя.

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

Параметры

publisherId

string

Ограничение на типы событий для этого издателя

Возвращаемое значение

Promise<NotificationEventType[]>

listLogs(string, string, Date, Date)

Получите список журналов диагностики для этой службы.

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

Параметры

source

string

Идентификатор, указывающий тип журналов для проверки диагностики.

entryId

string

Идентификатор конкретного журнала для запроса.

startTime

Date

Время начала выполнения запроса в диапазоне времени.

endTime

Date

Время окончания диапазона времени для запроса.

Возвращаемое значение

Promise<INotificationDiagnosticLog[]>

listNotificationReasons(number)

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

Параметры

notificationIds

number

Возвращаемое значение

Promise<NotificationReason[]>

listSubscriptions(string, string[], SubscriptionQueryFlags)

Получение списка подписок на уведомления по идентификаторам подписок или по всем подпискам для определенного пользователя или группы.

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

Параметры

targetId

string

Идентификатор пользователя или группы

ids

string[]

Список идентификаторов подписок

queryFlags

SubscriptionQueryFlags

Возвращаемое значение

Promise<NotificationSubscription[]>

performBatchNotificationOperations(BatchNotificationOperation)

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

Параметры

operation

BatchNotificationOperation

Возвращаемое значение

Promise<void>

publishEvent(VssNotificationEvent)

Публикация события. Этот запрос должен быть направлен в службу extmgmt.

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

Параметры

notificationEvent

VssNotificationEvent

Возвращаемое значение

Promise<VssNotificationEvent>

publishTokenEvent(VssNotificationEvent)

Публикация события. Этот запрос предназначен только для службы токенов, так как это только служба развертывания.

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

Параметры

notificationEvent

VssNotificationEvent

Возвращаемое значение

Promise<VssNotificationEvent>

queryEventTypes(FieldValuesQuery, string)

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

Параметры

inputValuesQuery

FieldValuesQuery

eventType

string

Возвращаемое значение

Promise<NotificationEventField[]>

querySubscriptions(SubscriptionQuery)

Запрос подписок. Подписка возвращается, если она соответствует одному или нескольким указанным условиям.

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

Параметры

subscriptionQuery

SubscriptionQuery

Возвращаемое значение

Promise<NotificationSubscription[]>

transformEvent(EventTransformRequest)

Трансформируйте событие уведомления.

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

Параметры

transformRequest

EventTransformRequest

Объект для преобразования.

Возвращаемое значение

Promise<EventTransformResult>

updateSettings(NotificationAdminSettingsUpdateParameters)

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

Параметры

updateParameters

NotificationAdminSettingsUpdateParameters

Возвращаемое значение

Promise<NotificationAdminSettings>

updateSubscriber(NotificationSubscriberUpdateParameters, string)

Обновите настройки доставки подписчика уведомлений.

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

Параметры

updateParameters

NotificationSubscriberUpdateParameters

subscriberId

string

Идентификатор пользователя или группы.

Возвращаемое значение

Promise<NotificationSubscriber>

updateSubscription(NotificationSubscriptionUpdateParameters, string)

Обновите существующую подписку. В зависимости от типа подписки и разрешений вызывающий объект может обновлять описание, параметры фильтра, параметры канала (доставка) и многое другое.

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

Параметры

updateParameters

NotificationSubscriptionUpdateParameters

subscriptionId

string

Возвращаемое значение

Promise<NotificationSubscription>

updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)

Обновите параметры диагностики для подписки.

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

Параметры

updateParameters

UpdateSubscripitonDiagnosticsParameters

subscriptionId

string

Идентификатор подписки на уведомления.

Возвращаемое значение

Promise<SubscriptionDiagnostics>

updateSubscriptionUserSettings(SubscriptionUserSettings, string, string)

Обновите параметры указанного пользователя для указанной подписки. Обычно этот API используется для отказа от общей подписки или выхода из нее. Параметры пользователя можно применять только к общим подпискам, таким как подписки группы или подписки по умолчанию.

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

Параметры

userSettings

SubscriptionUserSettings

subscriptionId

string

userId

string

Идентификатор пользователя

Возвращаемое значение

Promise<SubscriptionUserSettings>