FeatureManagementRestClient class
VSS REST API에 대한 요청을 만드는 데 사용해야 하는 기본 클래스(파생)입니다.
- Extends
생성자
| Feature |
메서드
| get |
ID로 특정 기능 가져오기 |
| get |
정의된 모든 기능 목록 가져오기 |
| get |
지정된 사용자/모든 사용자 scope 대해 지정된 기능의 상태를 가져옵니다. |
| get |
지정된 명명된 scope 지정된 기능의 상태를 가져옵니다. |
| query |
기능 ID 목록에 대한 유효 상태 가져오기 |
| query |
기본 scope 대해 지정된 기능의 상태를 가져옵니다. |
| query |
특정 명명된 scope 대해 지정된 기능의 상태를 가져옵니다. |
| set |
기능의 상태 설정 |
| set |
특정 scope 기능의 상태를 설정합니다. |
생성자 세부 정보
FeatureManagementRestClient(IVssRestClientOptions)
메서드 세부 정보
getFeature(string)
ID로 특정 기능 가져오기
function getFeature(featureId: string): Promise<ContributedFeature>매개 변수
- featureId
-
string
기능의 기여 ID
반환
Promise<ContributedFeature>
getFeatures(string)
정의된 모든 기능 목록 가져오기
function getFeatures(targetContributionId?: string): Promise<ContributedFeature[]>매개 변수
- targetContributionId
-
string
선택적 대상 기여. null/empty인 경우 모든 기능을 반환합니다. 지정된 경우 지정된 기여를 대상으로 하는 기능이 포함됩니다.
반환
Promise<ContributedFeature[]>
getFeatureState(string, string)
지정된 사용자/모든 사용자 scope 대해 지정된 기능의 상태를 가져옵니다.
function getFeatureState(featureId: string, userScope: string): Promise<ContributedFeatureState>매개 변수
- featureId
-
string
기능의 기여 ID
- userScope
-
string
값을 가져올 User-Scope. 현재 사용자의 경우 "me"이거나 모든 사용자의 경우 "호스트"여야 합니다.
반환
Promise<ContributedFeatureState>
getFeatureStateForScope(string, string, string, string)
지정된 명명된 scope 지정된 기능의 상태를 가져옵니다.
function getFeatureStateForScope(featureId: string, userScope: string, scopeName: string, scopeValue: string): Promise<ContributedFeatureState>매개 변수
- featureId
-
string
기능의 기여 ID
- userScope
-
string
값을 가져올 User-Scope. 현재 사용자의 경우 "me"이거나 모든 사용자의 경우 "호스트"여야 합니다.
- scopeName
-
string
에 대한 기능 설정을 가져올 범위(예: "프로젝트" 또는 "팀")
- scopeValue
-
string
scope 값(예: 프로젝트 또는 팀 ID)
반환
Promise<ContributedFeatureState>
queryFeatureStates(ContributedFeatureStateQuery)
기능 ID 목록에 대한 유효 상태 가져오기
function queryFeatureStates(query: ContributedFeatureStateQuery): Promise<ContributedFeatureStateQuery>매개 변수
현재 scope 값과 함께 쿼리할 기능
반환
Promise<ContributedFeatureStateQuery>
queryFeatureStatesForDefaultScope(ContributedFeatureStateQuery, string)
기본 scope 대해 지정된 기능의 상태를 가져옵니다.
function queryFeatureStatesForDefaultScope(query: ContributedFeatureStateQuery, userScope: string): Promise<ContributedFeatureStateQuery>매개 변수
쿼리할 기능을 설명하는 쿼리입니다.
- userScope
-
string
반환
Promise<ContributedFeatureStateQuery>
queryFeatureStatesForNamedScope(ContributedFeatureStateQuery, string, string, string)
특정 명명된 scope 대해 지정된 기능의 상태를 가져옵니다.
function queryFeatureStatesForNamedScope(query: ContributedFeatureStateQuery, userScope: string, scopeName: string, scopeValue: string): Promise<ContributedFeatureStateQuery>매개 변수
쿼리할 기능을 설명하는 쿼리입니다.
- userScope
-
string
- scopeName
-
string
- scopeValue
-
string
반환
Promise<ContributedFeatureStateQuery>
setFeatureState(ContributedFeatureState, string, string, string, string)
기능의 상태 설정
function setFeatureState(feature: ContributedFeatureState, featureId: string, userScope: string, reason?: string, reasonCode?: string): Promise<ContributedFeatureState>매개 변수
- feature
- ContributedFeatureState
게시된 기능 상태 개체입니다. 유효 값을 지정해야 합니다.
- featureId
-
string
기능의 기여 ID
- userScope
-
string
값을 설정할 User-Scope. 현재 사용자의 경우 "me"이거나 모든 사용자의 경우 "호스트"여야 합니다.
- reason
-
string
상태를 변경하는 이유
- reasonCode
-
string
간단한 이유 코드
반환
Promise<ContributedFeatureState>
setFeatureStateForScope(ContributedFeatureState, string, string, string, string, string, string)
특정 scope 기능의 상태를 설정합니다.
function setFeatureStateForScope(feature: ContributedFeatureState, featureId: string, userScope: string, scopeName: string, scopeValue: string, reason?: string, reasonCode?: string): Promise<ContributedFeatureState>매개 변수
- feature
- ContributedFeatureState
게시된 기능 상태 개체입니다. 유효 값을 지정해야 합니다.
- featureId
-
string
기능의 기여 ID
- userScope
-
string
값을 설정할 User-Scope. 현재 사용자의 경우 "me"이거나 모든 사용자의 경우 "호스트"여야 합니다.
- scopeName
-
string
에 대한 기능 설정을 가져올 범위(예: "프로젝트" 또는 "팀")
- scopeValue
-
string
scope 값(예: 프로젝트 또는 팀 ID)
- reason
-
string
상태를 변경하는 이유
- reasonCode
-
string
간단한 이유 코드
반환
Promise<ContributedFeatureState>