FeatureAvailabilityRestClient class
应使用的基类 (派生自) 以向 VSS REST API 发出请求
- Extends
构造函数
Feature |
方法
get |
检索用户的所有功能标志及其当前状态的列表 |
get |
检索有关单个功能标志及其当前状态的信息 |
get |
检索有关用户的单个功能标志及其当前状态的信息 |
get |
检索有关用户的单个功能标志及其当前状态的信息 |
update |
更改名称的单个功能标志的状态 |
构造函数详细信息
FeatureAvailabilityRestClient(IVssRestClientOptions)
方法详细信息
getAllFeatureFlags(string)
检索用户的所有功能标志及其当前状态的列表
function getAllFeatureFlags(userEmail?: string): Promise<FeatureFlag[]>
参数
- userEmail
-
string
用户要检查的电子邮件
返回
Promise<FeatureFlag[]>
getFeatureFlagByName(string, boolean)
检索有关单个功能标志及其当前状态的信息
function getFeatureFlagByName(name: string, checkFeatureExists?: boolean): Promise<FeatureFlag>
参数
- name
-
string
要检索的功能的名称
- checkFeatureExists
-
boolean
检查功能是否存在
返回
Promise<FeatureFlag>
getFeatureFlagByNameAndUserEmail(string, string, boolean)
检索有关用户的单个功能标志及其当前状态的信息
function getFeatureFlagByNameAndUserEmail(name: string, userEmail: string, checkFeatureExists?: boolean): Promise<FeatureFlag>
参数
- name
-
string
要检索的功能的名称
- userEmail
-
string
用户要检查的电子邮件
- checkFeatureExists
-
boolean
检查功能是否存在
返回
Promise<FeatureFlag>
getFeatureFlagByNameAndUserId(string, string, boolean)
检索有关用户的单个功能标志及其当前状态的信息
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>