Partager via


FeatureManagementRestClient class

Classe de base qui doit être utilisée (dérivée de) pour effectuer des requêtes à des api REST VSS

Extends

Constructeurs

FeatureManagementRestClient(IVssRestClientOptions)

Méthodes

getFeature(string)

Obtenir une fonctionnalité spécifique par son ID

getFeatures(string)

Obtenir la liste de toutes les fonctionnalités définies

getFeatureState(string, string)

Obtenir l’état de la fonctionnalité spécifiée pour l’étendue utilisateur/tous les utilisateurs donné

getFeatureStateForScope(string, string, string, string)

Obtenir l’état de la fonctionnalité spécifiée pour l’étendue nommée donnée

queryFeatureStates(ContributedFeatureStateQuery)

Obtenir l’état effectif d’une liste d’ID de fonctionnalité

queryFeatureStatesForDefaultScope(ContributedFeatureStateQuery, string)

Obtenir les états des fonctionnalités spécifiées pour l’étendue par défaut

queryFeatureStatesForNamedScope(ContributedFeatureStateQuery, string, string, string)

Obtenir les états des fonctionnalités spécifiées pour l’étendue nommée spécifique

setFeatureState(ContributedFeatureState, string, string, string, string)

Définir l’état d’une fonctionnalité

setFeatureStateForScope(ContributedFeatureState, string, string, string, string, string, string)

Définir l’état d’une fonctionnalité dans une étendue spécifique

Détails du constructeur

FeatureManagementRestClient(IVssRestClientOptions)

new FeatureManagementRestClient(options: IVssRestClientOptions)

Paramètres

Détails de la méthode

getFeature(string)

Obtenir une fonctionnalité spécifique par son ID

function getFeature(featureId: string): Promise<ContributedFeature>

Paramètres

featureId

string

ID de contribution de la fonctionnalité

Retours

getFeatures(string)

Obtenir la liste de toutes les fonctionnalités définies

function getFeatures(targetContributionId?: string): Promise<ContributedFeature[]>

Paramètres

targetContributionId

string

Contribution cible facultative. Si la valeur est null/vide, retourne toutes les fonctionnalités. Si spécifié, incluez les fonctionnalités qui ciblent la contribution spécifiée.

Retours

Promise<ContributedFeature[]>

getFeatureState(string, string)

Obtenir l’état de la fonctionnalité spécifiée pour l’étendue utilisateur/tous les utilisateurs donné

function getFeatureState(featureId: string, userScope: string): Promise<ContributedFeatureState>

Paramètres

featureId

string

ID de contribution de la fonctionnalité

userScope

string

User-Scope à laquelle obtenir la valeur. Doit être « moi » pour l’utilisateur actuel ou « hôte » pour tous les utilisateurs.

Retours

getFeatureStateForScope(string, string, string, string)

Obtenir l’état de la fonctionnalité spécifiée pour l’étendue nommée donnée

function getFeatureStateForScope(featureId: string, userScope: string, scopeName: string, scopeValue: string): Promise<ContributedFeatureState>

Paramètres

featureId

string

ID de contribution de la fonctionnalité

userScope

string

User-Scope à laquelle obtenir la valeur. Doit être « moi » pour l’utilisateur actuel ou « hôte » pour tous les utilisateurs.

scopeName

string

Étendue à laquelle obtenir le paramètre de fonctionnalité pour (par exemple, « projet » ou « équipe »)

scopeValue

string

Valeur de l’étendue (par exemple, l’ID de projet ou d’équipe)

Retours

queryFeatureStates(ContributedFeatureStateQuery)

Obtenir l’état effectif d’une liste d’ID de fonctionnalité

function queryFeatureStates(query: ContributedFeatureStateQuery): Promise<ContributedFeatureStateQuery>

Paramètres

query
ContributedFeatureStateQuery

Fonctionnalités à interroger avec les valeurs d’étendue actuelles

Retours

queryFeatureStatesForDefaultScope(ContributedFeatureStateQuery, string)

Obtenir les états des fonctionnalités spécifiées pour l’étendue par défaut

function queryFeatureStatesForDefaultScope(query: ContributedFeatureStateQuery, userScope: string): Promise<ContributedFeatureStateQuery>

Paramètres

query
ContributedFeatureStateQuery

Requête décrivant les fonctionnalités à interroger.

userScope

string

Retours

queryFeatureStatesForNamedScope(ContributedFeatureStateQuery, string, string, string)

Obtenir les états des fonctionnalités spécifiées pour l’étendue nommée spécifique

function queryFeatureStatesForNamedScope(query: ContributedFeatureStateQuery, userScope: string, scopeName: string, scopeValue: string): Promise<ContributedFeatureStateQuery>

Paramètres

query
ContributedFeatureStateQuery

Requête décrivant les fonctionnalités à interroger.

userScope

string

scopeName

string

scopeValue

string

Retours

setFeatureState(ContributedFeatureState, string, string, string, string)

Définir l’état d’une fonctionnalité

function setFeatureState(feature: ContributedFeatureState, featureId: string, userScope: string, reason?: string, reasonCode?: string): Promise<ContributedFeatureState>

Paramètres

feature
ContributedFeatureState

Objet d’état de fonctionnalité publié. Doit spécifier la valeur effective.

featureId

string

ID de contribution de la fonctionnalité

userScope

string

User-Scope auquel définir la valeur. Doit être « moi » pour l’utilisateur actuel ou « hôte » pour tous les utilisateurs.

reason

string

Raison de la modification de l’état

reasonCode

string

Code de raison court

Retours

setFeatureStateForScope(ContributedFeatureState, string, string, string, string, string, string)

Définir l’état d’une fonctionnalité dans une étendue spécifique

function setFeatureStateForScope(feature: ContributedFeatureState, featureId: string, userScope: string, scopeName: string, scopeValue: string, reason?: string, reasonCode?: string): Promise<ContributedFeatureState>

Paramètres

feature
ContributedFeatureState

Objet d’état de fonctionnalité publié. Doit spécifier la valeur effective.

featureId

string

ID de contribution de la fonctionnalité

userScope

string

User-Scope auquel définir la valeur. Doit être « moi » pour l’utilisateur actuel ou « hôte » pour tous les utilisateurs.

scopeName

string

Étendue à laquelle obtenir le paramètre de fonctionnalité pour (par exemple, « projet » ou « équipe »)

scopeValue

string

Valeur de l’étendue (par exemple, l’ID de projet ou d’équipe)

reason

string

Raison de la modification de l’état

reasonCode

string

Code de raison court

Retours