FeatureManagementRestClient class
Basisklasse die moet worden gebruikt (afgeleid van) om aanvragen te doen voor VSS REST API's
- Extends
Constructors
| Feature |
Methoden
| get |
Een specifieke functie ophalen op basis van de id |
| get |
Een lijst met alle gedefinieerde functies ophalen |
| get |
De status van de opgegeven functie ophalen voor het opgegeven bereik van de gebruiker/alle gebruikers |
| get |
De status ophalen van de opgegeven functie voor het opgegeven benoemde bereik |
| query |
De effectieve status ophalen voor een lijst met functie-id's |
| query |
De statussen van de opgegeven functies voor het standaardbereik ophalen |
| query |
De statussen ophalen van de opgegeven functies voor het specifieke benoemde bereik |
| set |
De status van een functie instellen |
| set |
De status van een functie instellen op een specifiek bereik |
Constructordetails
FeatureManagementRestClient(IVssRestClientOptions)
new FeatureManagementRestClient(options: IVssRestClientOptions)Parameters
- options
- IVssRestClientOptions
Methodedetails
getFeature(string)
Een specifieke functie ophalen 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)
Een lijst met alle gedefinieerde functies ophalen
function getFeatures(targetContributionId?: string): Promise<ContributedFeature[]>Parameters
- targetContributionId
-
string
Optionele doelbijdrage. Als het null/leeg is, retourneert u alle functies. Indien opgegeven omvatten de functies die gericht zijn op de opgegeven bijdrage.
Retouren
Promise<ContributedFeature[]>
getFeatureState(string, string)
De status van de opgegeven functie ophalen voor het opgegeven bereik van de gebruiker/alle gebruikers
function getFeatureState(featureId: string, userScope: string): Promise<ContributedFeatureState>Parameters
- featureId
-
string
Bijdrage-id van de functie
- userScope
-
string
User-Scope waarop u de waarde wilt ophalen. Moet 'ik' zijn voor de huidige gebruiker of 'host' voor alle gebruikers.
Retouren
Promise<ContributedFeatureState>
getFeatureStateForScope(string, string, string, string)
De status ophalen van de opgegeven functie voor het opgegeven 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 u de waarde wilt ophalen. Moet 'ik' zijn voor de huidige gebruiker of 'host' voor alle gebruikers.
- scopeName
-
string
Bereik waarvoor de functie-instelling moet worden opgehaald (bijvoorbeeld 'project' of 'team')
- scopeValue
-
string
Waarde van het bereik (bijvoorbeeld de project- of team-id)
Retouren
Promise<ContributedFeatureState>
queryFeatureStates(ContributedFeatureStateQuery)
De effectieve status ophalen voor een lijst met functie-id's
function queryFeatureStates(query: ContributedFeatureStateQuery): Promise<ContributedFeatureStateQuery>Parameters
Functies die samen met huidige bereikwaarden moeten worden opgevraagd
Retouren
Promise<ContributedFeatureStateQuery>
queryFeatureStatesForDefaultScope(ContributedFeatureStateQuery, string)
De statussen van de opgegeven functies voor het standaardbereik ophalen
function queryFeatureStatesForDefaultScope(query: ContributedFeatureStateQuery, userScope: string): Promise<ContributedFeatureStateQuery>Parameters
Query met een beschrijving van de functies waarop een query moet worden uitgevoerd.
- userScope
-
string
Retouren
Promise<ContributedFeatureStateQuery>
queryFeatureStatesForNamedScope(ContributedFeatureStateQuery, string, string, string)
De statussen ophalen van de opgegeven functies voor het specifieke benoemde bereik
function queryFeatureStatesForNamedScope(query: ContributedFeatureStateQuery, userScope: string, scopeName: string, scopeValue: string): Promise<ContributedFeatureStateQuery>Parameters
Query met een beschrijving van de functies waarop een query moet worden uitgevoerd.
- userScope
-
string
- scopeName
-
string
- scopeValue
-
string
Retouren
Promise<ContributedFeatureStateQuery>
setFeatureState(ContributedFeatureState, string, string, string, string)
De status van een functie instellen
function setFeatureState(feature: ContributedFeatureState, featureId: string, userScope: string, reason?: string, reasonCode?: string): Promise<ContributedFeatureState>Parameters
- feature
- ContributedFeatureState
Statusobject geposte functie. Moet de effectieve waarde opgeven.
- featureId
-
string
Bijdrage-id van de functie
- userScope
-
string
User-Scope waarop u de waarde wilt instellen. Moet 'ik' zijn voor de huidige gebruiker of 'host' voor alle gebruikers.
- reason
-
string
Reden voor het wijzigen van de status
- reasonCode
-
string
Korte redencode
Retouren
Promise<ContributedFeatureState>
setFeatureStateForScope(ContributedFeatureState, string, string, string, string, string, string)
De status van een functie instellen 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
Statusobject geposte functie. Moet de effectieve waarde opgeven.
- featureId
-
string
Bijdrage-id van de functie
- userScope
-
string
User-Scope waarop u de waarde wilt instellen. Moet 'ik' zijn voor de huidige gebruiker of 'host' voor alle gebruikers.
- scopeName
-
string
Bereik waarvoor de functie-instelling moet worden opgehaald (bijvoorbeeld 'project' of 'team')
- scopeValue
-
string
Waarde van het bereik (bijvoorbeeld de project- of team-id)
- reason
-
string
Reden voor het wijzigen van de status
- reasonCode
-
string
Korte redencode
Retouren
Promise<ContributedFeatureState>