FeatureManagementRestClient class
應該 (衍生自) 的基類對 VSS REST API 提出要求
- Extends
建構函式
| Feature |
方法
| get |
依識別碼取得特定功能 |
| get |
取得所有已定義功能的清單 |
| get |
取得指定使用者/所有使用者範圍之指定功能的狀態 |
| get |
取得指定具名範圍之指定功能的狀態 |
| query |
取得功能識別碼清單的有效狀態 |
| query |
取得預設範圍指定功能的狀態 |
| query |
取得特定具名範圍之指定功能的狀態 |
| set |
設定功能的狀態 |
| set |
在特定範圍設定功能的狀態 |
建構函式詳細資料
FeatureManagementRestClient(IVssRestClientOptions)
方法詳細資料
getFeature(string)
依識別碼取得特定功能
function getFeature(featureId: string): Promise<ContributedFeature>參數
- featureId
-
string
功能的貢獻識別碼
傳回
Promise<ContributedFeature>
getFeatures(string)
取得所有已定義功能的清單
function getFeatures(targetContributionId?: string): Promise<ContributedFeature[]>參數
- targetContributionId
-
string
選擇性的目標貢獻。 如果為 Null/空白，則傳回所有功能。 如果指定包含以指定貢獻為目標的功能。
傳回
Promise<ContributedFeature[]>
getFeatureState(string, string)
取得指定使用者/所有使用者範圍之指定功能的狀態
function getFeatureState(featureId: string, userScope: string): Promise<ContributedFeatureState>參數
- featureId
-
string
功能的貢獻識別碼
- userScope
-
string
要取得值的User-Scope。 應該是目前使用者的 「me」，或所有使用者的 「host」。
傳回
Promise<ContributedFeatureState>
getFeatureStateForScope(string, string, string, string)
取得指定具名範圍之指定功能的狀態
function getFeatureStateForScope(featureId: string, userScope: string, scopeName: string, scopeValue: string): Promise<ContributedFeatureState>參數
- featureId
-
string
功能的貢獻識別碼
- userScope
-
string
要取得值的User-Scope。 應該是目前使用者的 「me」，或所有使用者的 「host」。
- scopeName
-
string
取得 (功能設定的範圍，例如 「project」 或 「team」)
- scopeValue
-
string
範圍值 (，例如專案或小組識別碼)
傳回
Promise<ContributedFeatureState>
queryFeatureStates(ContributedFeatureStateQuery)
取得功能識別碼清單的有效狀態
function queryFeatureStates(query: ContributedFeatureStateQuery): Promise<ContributedFeatureStateQuery>參數
與目前範圍值一起查詢的功能
傳回
Promise<ContributedFeatureStateQuery>
queryFeatureStatesForDefaultScope(ContributedFeatureStateQuery, string)
取得預設範圍指定功能的狀態
function queryFeatureStatesForDefaultScope(query: ContributedFeatureStateQuery, userScope: string): Promise<ContributedFeatureStateQuery>參數
描述要查詢之功能的查詢。
- userScope
-
string
傳回
Promise<ContributedFeatureStateQuery>
queryFeatureStatesForNamedScope(ContributedFeatureStateQuery, string, string, string)
取得特定具名範圍之指定功能的狀態
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
功能的貢獻識別碼
- userScope
-
string
User-Scope設定值。 應該是目前使用者的 「me」，或所有使用者的 「host」。
- reason
-
string
變更狀態的原因
- reasonCode
-
string
簡短原因代碼
傳回
Promise<ContributedFeatureState>
setFeatureStateForScope(ContributedFeatureState, string, string, string, string, string, string)
在特定範圍設定功能的狀態
function setFeatureStateForScope(feature: ContributedFeatureState, featureId: string, userScope: string, scopeName: string, scopeValue: string, reason?: string, reasonCode?: string): Promise<ContributedFeatureState>參數
- feature
- ContributedFeatureState
張貼的功能狀態物件。 應該指定有效值。
- featureId
-
string
功能的貢獻識別碼
- userScope
-
string
User-Scope設定值。 應該是目前使用者的 「me」，或所有使用者的 「host」。
- scopeName
-
string
取得 (功能設定的範圍，例如 「project」 或 「team」)
- scopeValue
-
string
範圍值 (，例如專案或小組識別碼)
- reason
-
string
變更狀態的原因
- reasonCode
-
string
簡短原因代碼
傳回
Promise<ContributedFeatureState>