FeatureAvailabilityRestClient class

パッケージ:

azure-devops-extension-api

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

Extends

RestClientBase

コンストラクター

FeatureAvailabilityRestClient(IVssRestClientOptions)

メソッド

getAllFeatureFlags(string)	ユーザーのすべての機能フラグとその現在の状態の一覧を取得する
getFeatureFlagByName(string, boolean)	1 つの機能フラグとその現在の状態に関する情報を取得する
getFeatureFlagByNameAndUserEmail(string, string, boolean)	ユーザーの 1 つの機能フラグとその現在の状態に関する情報を取得する
getFeatureFlagByNameAndUserId(string, string, boolean)	ユーザーの 1 つの機能フラグとその現在の状態に関する情報を取得する
updateFeatureFlag(FeatureFlagPatch, string, string, boolean, boolean)	名前の個々の機能フラグの状態を変更する

コンストラクターの詳細

FeatureAvailabilityRestClient(IVssRestClientOptions)

new FeatureAvailabilityRestClient(options: IVssRestClientOptions)

パラメーター

options

IVssRestClientOptions

メソッドの詳細

getAllFeatureFlags(string)

ユーザーのすべての機能フラグとその現在の状態の一覧を取得する

function getAllFeatureFlags(userEmail?: string): Promise<FeatureFlag[]>

パラメーター

userEmail

string

チェックするユーザーの電子メール

戻り値

Promise<FeatureFlag[]>

getFeatureFlagByName(string, boolean)

1 つの機能フラグとその現在の状態に関する情報を取得する

function getFeatureFlagByName(name: string, checkFeatureExists?: boolean): Promise<FeatureFlag>

パラメーター

name

string

取得する機能の名前

checkFeatureExists

boolean

機能が存在するかどうかを確認する

戻り値

Promise<FeatureFlag>

getFeatureFlagByNameAndUserEmail(string, string, boolean)

ユーザーの 1 つの機能フラグとその現在の状態に関する情報を取得する

function getFeatureFlagByNameAndUserEmail(name: string, userEmail: string, checkFeatureExists?: boolean): Promise<FeatureFlag>

パラメーター

name

string

取得する機能の名前

userEmail

string

チェックするユーザーの電子メール

checkFeatureExists

boolean

機能が存在するかどうかを確認する

戻り値

Promise<FeatureFlag>

getFeatureFlagByNameAndUserId(string, string, boolean)

ユーザーの 1 つの機能フラグとその現在の状態に関する情報を取得する

function getFeatureFlagByNameAndUserId(name: string, userId: string, checkFeatureExists?: boolean): Promise<FeatureFlag>

パラメーター

name

string

取得する機能の名前

userId

string

チェックするユーザーの ID

checkFeatureExists

boolean

機能が存在するかどうかを確認する

戻り値

Promise<FeatureFlag>

updateFeatureFlag(FeatureFlagPatch, string, string, boolean, boolean)

名前の個々の機能フラグの状態を変更する

function updateFeatureFlag(state: FeatureFlagPatch, name: string, userEmail?: string, checkFeatureExists?: boolean, setAtApplicationLevelAlso?: boolean): Promise<FeatureFlag>

パラメーター

state

FeatureFlagPatch

設定する必要がある状態

name

string

変更する機能の名前

userEmail

string

checkFeatureExists

boolean

状態を設定する前に、機能が存在するかどうかを確認します

setAtApplicationLevelAlso

boolean

戻り値

Promise<FeatureFlag>