NotificationRestClient class

패키지:

azure-devops-extension-api

VSS REST API에 대한 요청을 만드는 데 사용해야 하는 기본 클래스(파생)입니다.

Extends

RestClientBase

생성자

NotificationRestClient(IVssRestClientOptions)

메서드

createSubscription(NotificationSubscriptionCreateParameters)	새 구독을 만듭니다.
deleteSubscription(string)	구독을 삭제합니다.
getEventType(string)	특정 이벤트 유형을 가져옵니다.
getNotificationReasons(number)
getSettings()
getSubscriber(string)	알림 구독자의 배달 기본 설정을 가져옵니다.
getSubscription(string, SubscriptionQueryFlags)	ID로 알림 구독을 가져옵니다.
getSubscriptionDiagnostics(string)	구독에 대한 진단 설정을 가져옵니다.
getSubscriptionTemplates()	사용 가능한 구독 템플릿을 가져옵니다.
listEventTypes(string)	이 서비스에 사용 가능한 이벤트 유형을 나열합니다. 필요에 따라 지정된 게시자에 대한 이벤트 유형으로만 필터링합니다.
listLogs(string, string, Date, Date)	이 서비스에 대한 진단 로그 목록을 가져옵니다.
listNotificationReasons(number)
listSubscriptions(string, string[], SubscriptionQueryFlags)	구독 ID 또는 지정된 사용자 또는 그룹에 대한 모든 구독별로 알림 구독 목록을 가져옵니다.
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

이벤트 유형의 ID입니다.

반환

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

사용자 또는 그룹의 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>