ServiceHooksRestClient class
VSS REST API에 대한 요청을 만드는 데 사용해야 하는 기본 클래스(파생)입니다.
- Extends
생성자
| Service |
메서드
생성자 세부 정보
ServiceHooksRestClient(IVssRestClientOptions)
메서드 세부 정보
createSubscription(Subscription)
구독 생성
function createSubscription(subscription: Subscription): Promise<Subscription>매개 변수
- subscription
- Subscription
만들 구독입니다.
반환
Promise<Subscription>
createSubscriptionsQuery(SubscriptionsQuery)
서비스 후크 구독을 쿼리합니다.
function createSubscriptionsQuery(query: SubscriptionsQuery): Promise<SubscriptionsQuery>매개 변수
- query
- SubscriptionsQuery
반환
Promise<SubscriptionsQuery>
createTestNotification(Notification, boolean)
테스트 알림을 보냅니다. 이는 업데이트된 서비스 후크 구독 또는 새 서비스 후크 구독의 구성을 확인하는 데 유용합니다.
function createTestNotification(testNotification: Notification, useRealData?: boolean): Promise<Notification>매개 변수
- testNotification
- Notification
- useRealData
-
boolean
기존 구독에서 실제 데이터로만 테스트를 허용합니다.
반환
Promise<Notification>
deleteSubscription(string)
특정 서비스 후크 구독을 삭제합니다.
function deleteSubscription(subscriptionId: string): Promise<void>매개 변수
- subscriptionId
-
string
구독의 ID입니다.
반환
Promise<void>
getConsumer(string, string)
특정 소비자 서비스를 가져옵니다. 필요에 따라 지정된 게시자에 대한 이벤트 유형을 지원하지 않는 소비자 작업을 필터링합니다.
function getConsumer(consumerId: string, publisherId?: string): Promise<Consumer>매개 변수
- consumerId
-
string
소비자의 ID입니다.
- publisherId
-
string
반환
Promise<Consumer>
getConsumerAction(string, string, string)
특정 소비자 작업에 대한 세부 정보를 가져옵니다.
function getConsumerAction(consumerId: string, consumerActionId: string, publisherId?: string): Promise<ConsumerAction>매개 변수
- consumerId
-
string
소비자의 ID입니다.
- consumerActionId
-
string
consumerActionId의 ID입니다.
- publisherId
-
string
반환
Promise<ConsumerAction>
getEventType(string, string)
특정 이벤트 유형을 가져옵니다.
function getEventType(publisherId: string, eventTypeId: string): Promise<EventTypeDescriptor>매개 변수
- publisherId
-
string
게시자의 ID입니다.
- eventTypeId
-
string
반환
Promise<EventTypeDescriptor>
getNotification(string, number)
구독에 대한 특정 알림을 가져옵니다.
function getNotification(subscriptionId: string, notificationId: number): Promise<Notification>매개 변수
- subscriptionId
-
string
구독의 ID입니다.
- notificationId
-
number
반환
Promise<Notification>
getNotifications(string, number, NotificationStatus, NotificationResult)
특정 구독에 대한 알림 목록을 가져옵니다. 알림에는 이벤트, 요청 및 소비자 서비스의 응답에 대한 세부 정보가 포함됩니다.
function getNotifications(subscriptionId: string, maxResults?: number, status?: NotificationStatus, result?: NotificationResult): Promise<Notification[]>매개 변수
- subscriptionId
-
string
구독의 ID입니다.
- maxResults
-
number
반환할 최대 알림 수입니다. 기본값은 100입니다.
- status
- NotificationStatus
이 상태 사용하여 알림만 가져옵니다.
- result
- NotificationResult
이 결과 형식의 알림만 가져옵니다.
반환
Promise<Notification[]>
getPublisher(string)
특정 서비스 후크 게시자를 가져옵니다.
function getPublisher(publisherId: string): Promise<Publisher>매개 변수
- publisherId
-
string
게시자의 ID입니다.
반환
Promise<Publisher>
getSubscription(string)
특정 서비스 후크 구독을 가져옵니다.
function getSubscription(subscriptionId: string): Promise<Subscription>매개 변수
- subscriptionId
-
string
구독의 ID입니다.
반환
Promise<Subscription>
getSubscriptionDiagnostics(string)
function getSubscriptionDiagnostics(subscriptionId: string): Promise<SubscriptionDiagnostics>매개 변수
- subscriptionId
-
string
반환
Promise<SubscriptionDiagnostics>
listConsumerActions(string, string)
특정 소비자에 대한 소비자 작업 목록을 가져옵니다.
function listConsumerActions(consumerId: string, publisherId?: string): Promise<ConsumerAction[]>매개 변수
- consumerId
-
string
소비자의 ID입니다.
- publisherId
-
string
반환
Promise<ConsumerAction[]>
listConsumers(string)
사용 가능한 서비스 후크 소비자 서비스 목록을 가져옵니다. 필요에 따라 특정 게시자에서 하나 이상의 이벤트 유형을 지원하는 소비자를 기준으로 필터링합니다.
function listConsumers(publisherId?: string): Promise<Consumer[]>매개 변수
- publisherId
-
string
반환
Promise<Consumer[]>
listEventTypes(string)
특정 게시자에 대한 이벤트 유형을 가져옵니다.
function listEventTypes(publisherId: string): Promise<EventTypeDescriptor[]>매개 변수
- publisherId
-
string
게시자의 ID입니다.
반환
Promise<EventTypeDescriptor[]>
listPublishers()
listSubscriptions(string, string, string, string)
구독 목록을 가져옵니다.
function listSubscriptions(publisherId?: string, eventType?: string, consumerId?: string, consumerActionId?: string): Promise<Subscription[]>매개 변수
- publisherId
-
string
구독의 ID입니다.
- eventType
-
string
필터링할 이벤트 유형입니다(있는 경우).
- consumerId
-
string
소비자의 ID입니다.
- consumerActionId
-
string
consumerActionId의 ID입니다.
반환
Promise<Subscription[]>
publishExternalEvent(string, string)
외부 이벤트를 게시합니다.
function publishExternalEvent(publisherId: string, channelId?: string): Promise<PublisherEvent[]>매개 변수
- publisherId
-
string
- channelId
-
string
반환
Promise<PublisherEvent[]>
queryInputValues(InputValuesQuery, string)
function queryInputValues(inputValuesQuery: InputValuesQuery, publisherId: string): Promise<InputValuesQuery>매개 변수
- inputValuesQuery
- InputValuesQuery
- publisherId
-
string
반환
Promise<InputValuesQuery>
queryNotifications(NotificationsQuery)
알림을 쿼리합니다. 알림에는 이벤트, 요청 및 소비자 서비스의 응답에 대한 세부 정보가 포함됩니다.
function queryNotifications(query: NotificationsQuery): Promise<NotificationsQuery>매개 변수
- query
- NotificationsQuery
반환
Promise<NotificationsQuery>
queryPublishers(PublishersQuery)
서비스 후크 게시자를 쿼리합니다.
function queryPublishers(query: PublishersQuery): Promise<PublishersQuery>매개 변수
- query
- PublishersQuery
반환
Promise<PublishersQuery>
replaceSubscription(Subscription, string)
구독을 업데이트합니다. <param name="subscriptionId">업데이트하려는 구독의 ID입니다.< /Param>
function replaceSubscription(subscription: Subscription, subscriptionId?: string): Promise<Subscription>매개 변수
- subscription
- Subscription
- subscriptionId
-
string
반환
Promise<Subscription>
updateSubscriptionDiagnostics(UpdateSubscripitonDiagnosticsParameters, string)
function updateSubscriptionDiagnostics(updateParameters: UpdateSubscripitonDiagnosticsParameters, subscriptionId: string): Promise<SubscriptionDiagnostics>매개 변수
- updateParameters
- UpdateSubscripitonDiagnosticsParameters
- subscriptionId
-
string
반환
Promise<SubscriptionDiagnostics>