FeatureManagementRestClient class

パッケージ:

azure-devops-extension-api

VSS REST API への要求を行うために使用する (から派生する) 基本クラス

Extends

RestClientBase

コンストラクター

FeatureManagementRestClient(IVssRestClientOptions)

メソッド

getFeature(string)	ID で特定の機能を取得する
getFeatures(string)	定義されているすべての機能の一覧を取得する
getFeatureState(string, string)	指定されたユーザー/すべてのユーザー スコープの指定された機能の状態を取得する
getFeatureStateForScope(string, string, string, string)	指定された名前付きスコープの指定された機能の状態を取得する
queryFeatureStates(ContributedFeatureStateQuery)	機能 ID の一覧の有効な状態を取得する
queryFeatureStatesForDefaultScope(ContributedFeatureStateQuery, string)	既定のスコープの指定された機能の状態を取得する
queryFeatureStatesForNamedScope(ContributedFeatureStateQuery, string, string, string)	特定の名前付きスコープの指定された機能の状態を取得する
setFeatureState(ContributedFeatureState, string, string, string, string)	機能の状態を設定する
setFeatureStateForScope(ContributedFeatureState, string, string, string, string, string, string)	特定のスコープで機能の状態を設定する

コンストラクターの詳細

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>

パラメーター

query

ContributedFeatureStateQuery

現在のスコープ値と共にクエリを実行する機能

戻り値

Promise<ContributedFeatureStateQuery>

queryFeatureStatesForDefaultScope(ContributedFeatureStateQuery, string)

既定のスコープの指定された機能の状態を取得する

function queryFeatureStatesForDefaultScope(query: ContributedFeatureStateQuery, userScope: string): Promise<ContributedFeatureStateQuery>

パラメーター

query

ContributedFeatureStateQuery

クエリを実行する機能を記述するクエリ。

userScope

string

戻り値

Promise<ContributedFeatureStateQuery>

queryFeatureStatesForNamedScope(ContributedFeatureStateQuery, string, string, string)

特定の名前付きスコープの指定された機能の状態を取得する

function queryFeatureStatesForNamedScope(query: ContributedFeatureStateQuery, userScope: string, scopeName: string, scopeValue: string): Promise<ContributedFeatureStateQuery>

パラメーター

query

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>