NotificationRestClient class
应使用的基类 (派生自) 以向 VSS REST API 发出请求
- Extends
构造函数
| Notification |
方法
构造函数详细信息
NotificationRestClient(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
事件类型的 ID。
返回
Promise<NotificationEventType>
getNotificationReasons(number)
function getNotificationReasons(notificationId: number): Promise<NotificationReason>参数
- notificationId
-
number
返回
Promise<NotificationReason>
getSettings()
getSubscriber(string)
获取通知订阅者的传递首选项。
function getSubscriber(subscriberId: string): Promise<NotificationSubscriber>参数
- subscriberId
-
string
用户或组的 ID。
返回
Promise<NotificationSubscriber>
getSubscription(string, SubscriptionQueryFlags)
按 ID 获取通知订阅。
function getSubscription(subscriptionId: string, queryFlags?: SubscriptionQueryFlags): Promise<NotificationSubscription>参数
- subscriptionId
-
string
- queryFlags
- SubscriptionQueryFlags
返回
Promise<NotificationSubscription>
getSubscriptionDiagnostics(string)
获取订阅的诊断设置。
function getSubscriptionDiagnostics(subscriptionId: string): Promise<SubscriptionDiagnostics>参数
- subscriptionId
-
string
通知订阅的 ID。
返回
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
指定要为其检查 诊断日志类型的 ID。
- entryId
-
string
要查询的特定日志的 ID。
- startTime
-
Date
要查询的时间范围的开始时间。
- endTime
-
Date
要查询的时间范围的结束时间。
返回
Promise<INotificationDiagnosticLog[]>
listNotificationReasons(number)
function listNotificationReasons(notificationIds?: number): Promise<NotificationReason[]>参数
- notificationIds
-
number
返回
Promise<NotificationReason[]>
listSubscriptions(string, string[], SubscriptionQueryFlags)
按订阅 ID 或给定用户或组的所有订阅获取通知订阅列表。
function listSubscriptions(targetId?: string, ids?: string[], queryFlags?: SubscriptionQueryFlags): Promise<NotificationSubscription[]>参数
- targetId
-
string
用户或组 ID
- ids
-
string[]
订阅 ID 列表
- 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
用户或组的 ID。
返回
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
通知订阅的 ID。
返回
Promise<SubscriptionDiagnostics>
updateSubscriptionUserSettings(SubscriptionUserSettings, string, string)
更新指定订阅的指定用户设置。 此 API 通常用于选择加入或退出共享订阅。 用户设置只能应用于共享订阅，如团队订阅或默认订阅。
function updateSubscriptionUserSettings(userSettings: SubscriptionUserSettings, subscriptionId: string, userId: string): Promise<SubscriptionUserSettings>参数
- userSettings
- SubscriptionUserSettings
- subscriptionId
-
string
- userId
-
string
用户的 ID
返回
Promise<SubscriptionUserSettings>