FeatureManagementRestClient class
Basisklasse die moet worden gebruikt (afgeleid van) om verzoeken in te dienen bij VSS REST-api's
- Uitbreiding
Constructors
| Feature |
Methoden
| get |
Haal een specifieke functie op basis van de ID |
| get |
Krijg een lijst met alle gedefinieerde functies |
| get |
Haal de status op van de opgegeven functie voor het gegeven bereik voor gebruiker/alle gebruikers |
| get |
Haal de status op van de opgegeven functie voor het gegeven benoemde bereik |
| query |
Haal de effectieve status op voor een lijst met functie-id's |
| query |
Haal de statussen op van de opgegeven functies voor het standaardbereik |
| query |
Haal de statussen op van de opgegeven functies voor het specifieke benoemde bereik |
| set |
De status van een element instellen |
| set |
Stel de status van een functie in op een specifiek bereik |
Constructordetails
FeatureManagementRestClient(IVssRestClientOptions)
new FeatureManagementRestClient(options: IVssRestClientOptions)Parameters
- options
- IVssRestClientOptions
Methodedetails
getFeature(string)
Haal een specifieke functie op basis van de ID
function getFeature(featureId: string): Promise<ContributedFeature>Parameters
- featureId
-
string
De bijdrage-id van de functie
Retouren
Promise<ContributedFeature>
getFeatures(string)
Krijg een lijst met alle gedefinieerde functies
function getFeatures(targetContributionId?: string): Promise<ContributedFeature[]>Parameters
- targetContributionId
-
string
Optionele doelbijdrage. Als null/empty, retourneer dan alle functies. Indien opgegeven, neemt u de functies op die gericht zijn op de opgegeven bijdrage.
Retouren
Promise<ContributedFeature[]>
getFeatureState(string, string)
Haal de status op van de opgegeven functie voor het gegeven bereik voor gebruiker/alle gebruikers
function getFeatureState(featureId: string, userScope: string): Promise<ContributedFeatureState>Parameters
- featureId
-
string
Bijdrage-ID van de functie
- userScope
-
string
User-Scope waarop de waarde te krijgen. Moet "ik" zijn voor de huidige gebruiker of "host" voor alle gebruikers.
Retouren
Promise<ContributedFeatureState>
getFeatureStateForScope(string, string, string, string)
Haal de status op van de opgegeven functie voor het gegeven benoemde bereik
function getFeatureStateForScope(featureId: string, userScope: string, scopeName: string, scopeValue: string): Promise<ContributedFeatureState>Parameters
- featureId
-
string
Bijdrage-ID van de functie
- userScope
-
string
User-Scope waarop de waarde te krijgen. Moet "ik" zijn voor de huidige gebruiker of "host" voor alle gebruikers.
- scopeName
-
string
Bereik waarop de functie-instelling voor moet worden opgehaald (bijv. "project" of "team")
- scopeValue
-
string
Waarde van de scope (bijv. de project- of team-ID)
Retouren
Promise<ContributedFeatureState>
queryFeatureStates(ContributedFeatureStateQuery)
Haal de effectieve status op voor een lijst met functie-id's
function queryFeatureStates(query: ContributedFeatureStateQuery): Promise<ContributedFeatureStateQuery>Parameters
Functies om op te vragen samen met de huidige bereikwaarden
Retouren
Promise<ContributedFeatureStateQuery>
queryFeatureStatesForDefaultScope(ContributedFeatureStateQuery, string)
Haal de statussen op van de opgegeven functies voor het standaardbereik
function queryFeatureStatesForDefaultScope(query: ContributedFeatureStateQuery, userScope: string): Promise<ContributedFeatureStateQuery>Parameters
Query die de functies beschrijft die moeten worden opgevraagd.
- userScope
-
string
Retouren
Promise<ContributedFeatureStateQuery>
queryFeatureStatesForNamedScope(ContributedFeatureStateQuery, string, string, string)
Haal de statussen op van de opgegeven functies voor het specifieke benoemde bereik
function queryFeatureStatesForNamedScope(query: ContributedFeatureStateQuery, userScope: string, scopeName: string, scopeValue: string): Promise<ContributedFeatureStateQuery>Parameters
Query die de functies beschrijft die moeten worden opgevraagd.
- userScope
-
string
- scopeName
-
string
- scopeValue
-
string
Retouren
Promise<ContributedFeatureStateQuery>
setFeatureState(ContributedFeatureState, string, string, string, string)
De status van een element instellen
function setFeatureState(feature: ContributedFeatureState, featureId: string, userScope: string, reason?: string, reasonCode?: string): Promise<ContributedFeatureState>Parameters
- feature
- ContributedFeatureState
Geplaatst object met functiestatus. Moet de effectieve waarde specificeren.
- featureId
-
string
Bijdrage-ID van de functie
- userScope
-
string
User-Scope waarop de waarde moet worden ingesteld. Moet "ik" zijn voor de huidige gebruiker of "host" voor alle gebruikers.
- reason
-
string
Reden voor het wijzigen van de staat
- reasonCode
-
string
Korte redencode
Retouren
Promise<ContributedFeatureState>
setFeatureStateForScope(ContributedFeatureState, string, string, string, string, string, string)
Stel de status van een functie in op een specifiek bereik
function setFeatureStateForScope(feature: ContributedFeatureState, featureId: string, userScope: string, scopeName: string, scopeValue: string, reason?: string, reasonCode?: string): Promise<ContributedFeatureState>Parameters
- feature
- ContributedFeatureState
Geplaatst object met functiestatus. Moet de effectieve waarde specificeren.
- featureId
-
string
Bijdrage-ID van de functie
- userScope
-
string
User-Scope waarop de waarde moet worden ingesteld. Moet "ik" zijn voor de huidige gebruiker of "host" voor alle gebruikers.
- scopeName
-
string
Bereik waarop de functie-instelling voor moet worden opgehaald (bijv. "project" of "team")
- scopeValue
-
string
Waarde van de scope (bijv. de project- of team-ID)
- reason
-
string
Reden voor het wijzigen van de staat
- reasonCode
-
string
Korte redencode
Retouren
Promise<ContributedFeatureState>