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>