Preparing search index...
The search index is not available
azure-devops-node-api
azure-devops-node-api
FeatureManagementApi
IFeatureManagementApi
Interface IFeatureManagementApi
interface
IFeatureManagementApi
{
baseUrl
:
string
;
http
:
HttpClient
;
rest
:
RestClient
;
userAgent
:
string
;
vsoClient
:
VsoClient
;
createAcceptHeader
(
type
:
string
,
apiVersion
?:
string
)
:
string
;
createRequestOptions
(
type
:
string
,
apiVersion
?:
string
)
:
IRequestOptions
;
formatResponse
(
data
:
any
,
responseTypeMetadata
:
any
,
isCollection
:
boolean
,
)
:
any
;
getFeature
(
featureId
:
string
)
:
Promise
<
ContributedFeature
>
;
getFeatures
(
targetContributionId
?:
string
)
:
Promise
<
ContributedFeature
[]
>
;
getFeatureState
(
featureId
:
string
,
userScope
:
string
,
)
:
Promise
<
ContributedFeatureState
>
;
getFeatureStateForScope
(
featureId
:
string
,
userScope
:
string
,
scopeName
:
string
,
scopeValue
:
string
,
)
:
Promise
<
ContributedFeatureState
>
;
queryFeatureStates
(
query
:
ContributedFeatureStateQuery
,
)
:
Promise
<
ContributedFeatureStateQuery
>
;
queryFeatureStatesForDefaultScope
(
query
:
ContributedFeatureStateQuery
,
userScope
:
string
,
)
:
Promise
<
ContributedFeatureStateQuery
>
;
queryFeatureStatesForNamedScope
(
query
:
ContributedFeatureStateQuery
,
userScope
:
string
,
scopeName
:
string
,
scopeValue
:
string
,
)
:
Promise
<
ContributedFeatureStateQuery
>
;
setFeatureState
(
feature
:
ContributedFeatureState
,
featureId
:
string
,
userScope
:
string
,
reason
?:
string
,
reasonCode
?:
string
,
)
:
Promise
<
ContributedFeatureState
>
;
setFeatureStateForScope
(
feature
:
ContributedFeatureState
,
featureId
:
string
,
userScope
:
string
,
scopeName
:
string
,
scopeValue
:
string
,
reason
?:
string
,
reasonCode
?:
string
,
)
:
Promise
<
ContributedFeatureState
>
;
}
Hierarchy (
View Summary
)
ClientApiBase
IFeatureManagementApi
Implemented by
FeatureManagementApi
Index
Properties
base
Url
http
rest
user
Agent
vso
Client
Methods
create
Accept
Header
create
Request
Options
format
Response
get
Feature
get
Features
get
Feature
State
get
Feature
State
For
Scope
query
Feature
States
query
Feature
States
For
Default
Scope
query
Feature
States
For
Named
Scope
set
Feature
State
set
Feature
State
For
Scope
Properties
base
Url
baseUrl
:
string
http
http
:
HttpClient
rest
rest
:
RestClient
user
Agent
userAgent
:
string
vso
Client
vsoClient
:
VsoClient
Methods
create
Accept
Header
createAcceptHeader
(
type
:
string
,
apiVersion
?:
string
)
:
string
Parameters
type
:
string
Optional
apiVersion
:
string
Returns
string
create
Request
Options
createRequestOptions
(
type
:
string
,
apiVersion
?:
string
)
:
IRequestOptions
Parameters
type
:
string
Optional
apiVersion
:
string
Returns
IRequestOptions
format
Response
formatResponse
(
data
:
any
,
responseTypeMetadata
:
any
,
isCollection
:
boolean
)
:
any
Parameters
data
:
any
responseTypeMetadata
:
any
isCollection
:
boolean
Returns
any
get
Feature
getFeature
(
featureId
:
string
)
:
Promise
<
ContributedFeature
>
Parameters
featureId
:
string
Returns
Promise
<
ContributedFeature
>
get
Features
getFeatures
(
targetContributionId
?:
string
)
:
Promise
<
ContributedFeature
[]
>
Parameters
Optional
targetContributionId
:
string
Returns
Promise
<
ContributedFeature
[]
>
get
Feature
State
getFeatureState
(
featureId
:
string
,
userScope
:
string
,
)
:
Promise
<
ContributedFeatureState
>
Parameters
featureId
:
string
userScope
:
string
Returns
Promise
<
ContributedFeatureState
>
get
Feature
State
For
Scope
getFeatureStateForScope
(
featureId
:
string
,
userScope
:
string
,
scopeName
:
string
,
scopeValue
:
string
,
)
:
Promise
<
ContributedFeatureState
>
Parameters
featureId
:
string
userScope
:
string
scopeName
:
string
scopeValue
:
string
Returns
Promise
<
ContributedFeatureState
>
query
Feature
States
queryFeatureStates
(
query
:
ContributedFeatureStateQuery
,
)
:
Promise
<
ContributedFeatureStateQuery
>
Parameters
query
:
ContributedFeatureStateQuery
Returns
Promise
<
ContributedFeatureStateQuery
>
query
Feature
States
For
Default
Scope
queryFeatureStatesForDefaultScope
(
query
:
ContributedFeatureStateQuery
,
userScope
:
string
,
)
:
Promise
<
ContributedFeatureStateQuery
>
Parameters
query
:
ContributedFeatureStateQuery
userScope
:
string
Returns
Promise
<
ContributedFeatureStateQuery
>
query
Feature
States
For
Named
Scope
queryFeatureStatesForNamedScope
(
query
:
ContributedFeatureStateQuery
,
userScope
:
string
,
scopeName
:
string
,
scopeValue
:
string
,
)
:
Promise
<
ContributedFeatureStateQuery
>
Parameters
query
:
ContributedFeatureStateQuery
userScope
:
string
scopeName
:
string
scopeValue
:
string
Returns
Promise
<
ContributedFeatureStateQuery
>
set
Feature
State
setFeatureState
(
feature
:
ContributedFeatureState
,
featureId
:
string
,
userScope
:
string
,
reason
?:
string
,
reasonCode
?:
string
,
)
:
Promise
<
ContributedFeatureState
>
Parameters
feature
:
ContributedFeatureState
featureId
:
string
userScope
:
string
Optional
reason
:
string
Optional
reasonCode
:
string
Returns
Promise
<
ContributedFeatureState
>
set
Feature
State
For
Scope
setFeatureStateForScope
(
feature
:
ContributedFeatureState
,
featureId
:
string
,
userScope
:
string
,
scopeName
:
string
,
scopeValue
:
string
,
reason
?:
string
,
reasonCode
?:
string
,
)
:
Promise
<
ContributedFeatureState
>
Parameters
feature
:
ContributedFeatureState
featureId
:
string
userScope
:
string
scopeName
:
string
scopeValue
:
string
Optional
reason
:
string
Optional
reasonCode
:
string
Returns
Promise
<
ContributedFeatureState
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
base
Url
http
rest
user
Agent
vso
Client
Methods
create
Accept
Header
create
Request
Options
format
Response
get
Feature
get
Features
get
Feature
State
get
Feature
State
For
Scope
query
Feature
States
query
Feature
States
For
Default
Scope
query
Feature
States
For
Named
Scope
set
Feature
State
set
Feature
State
For
Scope
azure-devops-node-api
Loading...