FeatureManagementRestClient class
VSS REST API への要求を行うために使用する (派生する) 基本クラス
- Extends
メソッド
| get |
特定の機能を ID で取得する |
| get |
定義されているすべての機能のリストを取得する |
| get |
指定されたユーザー/すべてのユーザー スコープで指定された機能の状態を取得する |
| get |
指定された名前付きスコープの指定された機能の状態を取得する |
| query |
機能 ID の一覧の有効な状態を取得する |
| query |
既定のスコープで指定された機能の状態を取得する |
| query |
特定の名前付きスコープの指定された機能の状態を取得する |
| set |
フィーチャの状態を設定する |
| set |
特定のスコープで機能の状態を設定する |
コンストラクターの詳細
FeatureManagementRestClient(IVssRestClientOptions)
new FeatureManagementRestClient(options: IVssRestClientOptions)パラメーター
- options
- 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/空の場合、すべての特徴を返します。 指定する場合は、指定した寄与を対象とする特徴を含めます。
戻り値
Promise<ContributedFeature[]>
getFeatureState(string, string)
指定されたユーザー/すべてのユーザー スコープで指定された機能の状態を取得する
function getFeatureState(featureId: string, userScope: string): Promise<ContributedFeatureState>パラメーター
- featureId
-
string
機能のコントリビューション ID
- 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
機能のコントリビューション ID
- userScope
-
string
値を取得する User-Scope。 現在のユーザーは "me"、すべてのユーザーは "host" にする必要があります。
- scopeName
-
string
機能設定を取得する範囲 (例: "project" または "team")
- scopeValue
-
string
スコープの値 (プロジェクトやチーム ID など)
戻り値
Promise<ContributedFeatureState>
queryFeatureStates(ContributedFeatureStateQuery)
機能 ID の一覧の有効な状態を取得する
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
機能のコントリビューション ID
- 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
機能のコントリビューション ID
- userScope
-
string
値を設定する User-Scope。 現在のユーザーは "me"、すべてのユーザーは "host" にする必要があります。
- scopeName
-
string
機能設定を取得する範囲 (例: "project" または "team")
- scopeValue
-
string
スコープの値 (プロジェクトやチーム ID など)
- reason
-
string
状態変更の理由
- reasonCode
-
string
短い理由コード
戻り値
Promise<ContributedFeatureState>