Class FeatureManagementApi

Hierarchy (View Summary)

ClientApiBase
- FeatureManagementApi

Implements

IFeatureManagementApi

Index

Constructors

constructor

new FeatureManagementApi(
    baseUrl: string,
    handlers: IRequestHandler[],
    options?: IRequestOptions,
): FeatureManagementApi
Parameters
- baseUrl: string
- handlers: IRequestHandler[]
- Optionaloptions: IRequestOptions
Returns FeatureManagementApi
Overrides ClientApiBase.constructor
- Defined in repos/azure-devops-node-api/api/FeatureManagementApi.ts:32

Properties

baseUrl

baseUrl: string

http

http: HttpClient

rest

rest: RestClient

userAgent

userAgent: string

vsoClient

vsoClient: VsoClient

Methods

createAcceptHeader

createAcceptHeader(type: string, apiVersion?: string): string
Parameters
- type: string
- OptionalapiVersion: string
Returns string
Implementation of IFeatureManagementApi.createAcceptHeader
Inherited from ClientApiBase.createAcceptHeader
- Defined in repos/azure-devops-node-api/api/ClientApiBases.ts:30

createRequestOptions

createRequestOptions(type: string, apiVersion?: string): IRequestOptions
Parameters
- type: string
- OptionalapiVersion: string
Returns IRequestOptions
Implementation of IFeatureManagementApi.createRequestOptions
Inherited from ClientApiBase.createRequestOptions
- Defined in repos/azure-devops-node-api/api/ClientApiBases.ts:34

formatResponse

formatResponse(data: any, responseTypeMetadata: any, isCollection: boolean): any
Parameters
- data: any
- responseTypeMetadata: any
- isCollection: boolean
Returns any
Implementation of IFeatureManagementApi.formatResponse
Inherited from ClientApiBase.formatResponse
- Defined in repos/azure-devops-node-api/api/ClientApiBases.ts:40

getFeature

getFeature(featureId: string): Promise<ContributedFeature>
Get a specific feature by its id
Parameters
- featureId: string
  The contribution id of the feature
Returns Promise<ContributedFeature>
Implementation of IFeatureManagementApi.getFeature
- Defined in repos/azure-devops-node-api/api/FeatureManagementApi.ts:41

getFeatures

getFeatures(targetContributionId?: string): Promise<ContributedFeature[]>
Get a list of all defined features
Parameters
- OptionaltargetContributionId: string
  Optional target contribution. If null/empty, return all features. If specified include the features that target the specified contribution.
Returns Promise<ContributedFeature[]>
Implementation of IFeatureManagementApi.getFeatures
- Defined in repos/azure-devops-node-api/api/FeatureManagementApi.ts:82

getFeatureState

getFeatureState(
featureId: string,
userScope: string,
): Promise<ContributedFeatureState>
Get the state of the specified feature for the given user/all-users scope
Parameters
- featureId: string
  Contribution id of the feature
- userScope: string
  User-Scope at which to get the value. Should be "me" for the current user or "host" for all users.
Returns Promise<ContributedFeatureState>
Implementation of IFeatureManagementApi.getFeatureState
- Defined in repos/azure-devops-node-api/api/FeatureManagementApi.ts:128

getFeatureStateForScope

getFeatureStateForScope(
    featureId: string,
    userScope: string,
    scopeName: string,
    scopeValue: string,
): Promise<ContributedFeatureState>
Get the state of the specified feature for the given named scope
Parameters
- featureId: string
  Contribution id of the feature
- userScope: string
  User-Scope at which to get the value. Should be "me" for the current user or "host" for all users.
- scopeName: string
  Scope at which to get the feature setting for (e.g. "project" or "team")
- scopeValue: string
  Value of the scope (e.g. the project or team id)
Returns Promise<ContributedFeatureState>
Implementation of IFeatureManagementApi.getFeatureStateForScope
- Defined in repos/azure-devops-node-api/api/FeatureManagementApi.ts:230

queryFeatureStates

queryFeatureStates(
query: ContributedFeatureStateQuery,
): Promise<ContributedFeatureStateQuery>
Get the effective state for a list of feature ids
Parameters
- query: ContributedFeatureStateQuery
  Features to query along with current scope values
Returns Promise<ContributedFeatureStateQuery>
Implementation of IFeatureManagementApi.queryFeatureStates
- Defined in repos/azure-devops-node-api/api/FeatureManagementApi.ts:339

queryFeatureStatesForDefaultScope

queryFeatureStatesForDefaultScope(
query: ContributedFeatureStateQuery,
userScope: string,
): Promise<ContributedFeatureStateQuery>
Get the states of the specified features for the default scope
Parameters
- query: ContributedFeatureStateQuery
  Query describing the features to query.
- userScope: string
Returns Promise<ContributedFeatureStateQuery>
Implementation of IFeatureManagementApi.queryFeatureStatesForDefaultScope
- Defined in repos/azure-devops-node-api/api/FeatureManagementApi.ts:380

queryFeatureStatesForNamedScope

queryFeatureStatesForNamedScope(
    query: ContributedFeatureStateQuery,
    userScope: string,
    scopeName: string,
    scopeValue: string,
): Promise<ContributedFeatureStateQuery>
Get the states of the specified features for the specific named scope
Parameters
- query: ContributedFeatureStateQuery
  Query describing the features to query.
- userScope: string
- scopeName: string
- scopeValue: string
Returns Promise<ContributedFeatureStateQuery>
Implementation of IFeatureManagementApi.queryFeatureStatesForNamedScope
- Defined in repos/azure-devops-node-api/api/FeatureManagementApi.ts:425

setFeatureState

setFeatureState(
    feature: ContributedFeatureState,
    featureId: string,
    userScope: string,
    reason?: string,
    reasonCode?: string,
): Promise<ContributedFeatureState>
Set the state of a feature
Parameters
- feature: ContributedFeatureState
  Posted feature state object. Should specify the effective value.
- featureId: string
  Contribution id of the feature
- userScope: string
  User-Scope at which to set the value. Should be "me" for the current user or "host" for all users.
- Optionalreason: string
  Reason for changing the state
- OptionalreasonCode: string
  Short reason code
Returns Promise<ContributedFeatureState>
Implementation of IFeatureManagementApi.setFeatureState
- Defined in repos/azure-devops-node-api/api/FeatureManagementApi.ts:175

setFeatureStateForScope

setFeatureStateForScope(
    feature: ContributedFeatureState,
    featureId: string,
    userScope: string,
    scopeName: string,
    scopeValue: string,
    reason?: string,
    reasonCode?: string,
): Promise<ContributedFeatureState>
Set the state of a feature at a specific scope
Parameters
- feature: ContributedFeatureState
  Posted feature state object. Should specify the effective value.
- featureId: string
  Contribution id of the feature
- userScope: string
  User-Scope at which to set the value. Should be "me" for the current user or "host" for all users.
- scopeName: string
  Scope at which to get the feature setting for (e.g. "project" or "team")
- scopeValue: string
  Value of the scope (e.g. the project or team id)
- Optionalreason: string
  Reason for changing the state
- OptionalreasonCode: string
  Short reason code
Returns Promise<ContributedFeatureState>
Implementation of IFeatureManagementApi.setFeatureStateForScope
- Defined in repos/azure-devops-node-api/api/FeatureManagementApi.ts:283

Class FeatureManagementApi

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FeatureManagementApi

Properties

baseUrl

http

rest

userAgent

vsoClient

Methods

createAcceptHeader

Parameters

Returns string

createRequestOptions

Parameters

Returns IRequestOptions

formatResponse

Parameters

Returns any

getFeature

Parameters

Returns Promise<ContributedFeature>

getFeatures

Parameters

Returns Promise<ContributedFeature[]>

getFeatureState

Parameters

Returns Promise<ContributedFeatureState>

getFeatureStateForScope

Parameters

Returns Promise<ContributedFeatureState>

queryFeatureStates

Parameters

Returns Promise<ContributedFeatureStateQuery>

queryFeatureStatesForDefaultScope

Parameters

Returns Promise<ContributedFeatureStateQuery>

queryFeatureStatesForNamedScope

Parameters

Returns Promise<ContributedFeatureStateQuery>

setFeatureState

Parameters

Returns Promise<ContributedFeatureState>

setFeatureStateForScope

Parameters

Returns Promise<ContributedFeatureState>

Settings

On This Page