FeatureManagementRestClient class
Basklass som ska användas (härleds från) för att göra begäranden till VSS REST API:er
- Extends
Konstruktorer
| Feature |
Metoder
| get |
Hämta en specifik funktion med dess ID |
| get |
Hämta en lista över alla definierade funktioner |
| get |
Hämta tillståndet för den angivna funktionen för det angivna omfånget användare/alla användare |
| get |
Hämta tillståndet för den angivna funktionen för det angivna namngivna omfånget |
| query |
Hämta det effektiva tillståndet för en lista över funktions-ID:t |
| query |
Hämta tillstånden för de angivna funktionerna för standardomfånget |
| query |
Hämta tillstånden för de angivna funktionerna för det specifika namngivna omfånget |
| set |
Ange tillståndet för en funktion |
| set |
Ange tillståndet för en funktion i ett specifikt omfång |
Konstruktorinformation
FeatureManagementRestClient(IVssRestClientOptions)
new FeatureManagementRestClient(options: IVssRestClientOptions)Parametrar
- options
- IVssRestClientOptions
Metodinformation
getFeature(string)
Hämta en specifik funktion med dess ID
function getFeature(featureId: string): Promise<ContributedFeature>Parametrar
- featureId
-
string
Funktionens bidrags-ID
Returer
Promise<ContributedFeature>
getFeatures(string)
Hämta en lista över alla definierade funktioner
function getFeatures(targetContributionId?: string): Promise<ContributedFeature[]>Parametrar
- targetContributionId
-
string
Valfritt målbidrag. Om värdet är null/tomt returnerar du alla funktioner. Om detta anges inkluderar de funktioner som är inriktade på det angivna bidraget.
Returer
Promise<ContributedFeature[]>
getFeatureState(string, string)
Hämta tillståndet för den angivna funktionen för det angivna omfånget användare/alla användare
function getFeatureState(featureId: string, userScope: string): Promise<ContributedFeatureState>Parametrar
- featureId
-
string
Funktionens bidrags-ID
- userScope
-
string
User-Scope för att hämta värdet. Ska vara "jag" för den aktuella användaren eller "värden" för alla användare.
Returer
Promise<ContributedFeatureState>
getFeatureStateForScope(string, string, string, string)
Hämta tillståndet för den angivna funktionen för det angivna namngivna omfånget
function getFeatureStateForScope(featureId: string, userScope: string, scopeName: string, scopeValue: string): Promise<ContributedFeatureState>Parametrar
- featureId
-
string
Funktionens bidrags-ID
- userScope
-
string
User-Scope för att hämta värdet. Ska vara "jag" för den aktuella användaren eller "värden" för alla användare.
- scopeName
-
string
Omfång där du vill hämta funktionsinställningen för (t.ex. "projekt" eller "team")
- scopeValue
-
string
Omfångets värde (t.ex. projekt- eller team-ID)
Returer
Promise<ContributedFeatureState>
queryFeatureStates(ContributedFeatureStateQuery)
Hämta det effektiva tillståndet för en lista över funktions-ID:t
function queryFeatureStates(query: ContributedFeatureStateQuery): Promise<ContributedFeatureStateQuery>Parametrar
Funktioner att köra frågor mot tillsammans med aktuella omfångsvärden
Returer
Promise<ContributedFeatureStateQuery>
queryFeatureStatesForDefaultScope(ContributedFeatureStateQuery, string)
Hämta tillstånden för de angivna funktionerna för standardomfånget
function queryFeatureStatesForDefaultScope(query: ContributedFeatureStateQuery, userScope: string): Promise<ContributedFeatureStateQuery>Parametrar
Fråga som beskriver de funktioner som ska frågas.
- userScope
-
string
Returer
Promise<ContributedFeatureStateQuery>
queryFeatureStatesForNamedScope(ContributedFeatureStateQuery, string, string, string)
Hämta tillstånden för de angivna funktionerna för det specifika namngivna omfånget
function queryFeatureStatesForNamedScope(query: ContributedFeatureStateQuery, userScope: string, scopeName: string, scopeValue: string): Promise<ContributedFeatureStateQuery>Parametrar
Fråga som beskriver de funktioner som ska frågas.
- userScope
-
string
- scopeName
-
string
- scopeValue
-
string
Returer
Promise<ContributedFeatureStateQuery>
setFeatureState(ContributedFeatureState, string, string, string, string)
Ange tillståndet för en funktion
function setFeatureState(feature: ContributedFeatureState, featureId: string, userScope: string, reason?: string, reasonCode?: string): Promise<ContributedFeatureState>Parametrar
- feature
- ContributedFeatureState
Objekt för funktionstillstånd har publicerats. Bör ange det effektiva värdet.
- featureId
-
string
Funktionens bidrags-ID
- userScope
-
string
User-Scope där värdet ska anges. Ska vara "jag" för den aktuella användaren eller "värden" för alla användare.
- reason
-
string
Orsak till att ändra tillstånd
- reasonCode
-
string
Kort orsakskod
Returer
Promise<ContributedFeatureState>
setFeatureStateForScope(ContributedFeatureState, string, string, string, string, string, string)
Ange tillståndet för en funktion i ett specifikt omfång
function setFeatureStateForScope(feature: ContributedFeatureState, featureId: string, userScope: string, scopeName: string, scopeValue: string, reason?: string, reasonCode?: string): Promise<ContributedFeatureState>Parametrar
- feature
- ContributedFeatureState
Objekt för funktionstillstånd har publicerats. Bör ange det effektiva värdet.
- featureId
-
string
Funktionens bidrags-ID
- userScope
-
string
User-Scope där värdet ska anges. Ska vara "jag" för den aktuella användaren eller "värden" för alla användare.
- scopeName
-
string
Omfång där du vill hämta funktionsinställningen för (t.ex. "projekt" eller "team")
- scopeValue
-
string
Omfångets värde (t.ex. projekt- eller team-ID)
- reason
-
string
Orsak till att ändra tillstånd
- reasonCode
-
string
Kort orsakskod
Returer
Promise<ContributedFeatureState>