FeatureManagementRestClient class
Alaposztály, amelyet a VSS REST API-k kéréseinek igényléséhez (származtatásából) kell használni
- Extends
Konstruktorok
| Feature |
Metódusok
| get |
Adott funkció lekérése az azonosító alapján |
| get |
Az összes definiált funkció listájának lekérése |
| get |
A megadott funkció állapotának lekérése az adott felhasználó/minden felhasználó hatóköréhez |
| get |
A megadott funkció állapotának lekérése az adott elnevezett hatókörhöz |
| query |
A funkcióazonosítók listájának érvényes állapotának lekérése |
| query |
Az alapértelmezett hatókör megadott funkcióinak állapotának lekérése |
| query |
A megadott funkciók állapotának lekérése az adott elnevezett hatókörhöz |
| set |
Funkció állapotának beállítása |
| set |
Egy funkció állapotának beállítása egy adott hatókörben |
Konstruktor adatai
FeatureManagementRestClient(IVssRestClientOptions)
new FeatureManagementRestClient(options: IVssRestClientOptions)Paraméterek
- options
- IVssRestClientOptions
Metódus adatai
getFeature(string)
Adott funkció lekérése az azonosító alapján
function getFeature(featureId: string): Promise<ContributedFeature>Paraméterek
- featureId
-
string
A funkció hozzájárulási azonosítója
Válaszok
Promise<ContributedFeature>
getFeatures(string)
Az összes definiált funkció listájának lekérése
function getFeatures(targetContributionId?: string): Promise<ContributedFeature[]>Paraméterek
- targetContributionId
-
string
Választható cél hozzájárulás. Ha null/üres, adja vissza az összes funkciót. Ha meg van adva, tartalmazza azokat a funkciókat, amelyek a megadott hozzájárulást célják.
Válaszok
Promise<ContributedFeature[]>
getFeatureState(string, string)
A megadott funkció állapotának lekérése az adott felhasználó/minden felhasználó hatóköréhez
function getFeatureState(featureId: string, userScope: string): Promise<ContributedFeatureState>Paraméterek
- featureId
-
string
A funkció hozzájárulási azonosítója
- userScope
-
string
User-Scope az érték lekéréséhez. Az aktuális felhasználó esetében "én" vagy "gazdagép" kell, hogy legyen az összes felhasználó számára.
Válaszok
Promise<ContributedFeatureState>
getFeatureStateForScope(string, string, string, string)
A megadott funkció állapotának lekérése az adott elnevezett hatókörhöz
function getFeatureStateForScope(featureId: string, userScope: string, scopeName: string, scopeValue: string): Promise<ContributedFeatureState>Paraméterek
- featureId
-
string
A funkció hozzájárulási azonosítója
- userScope
-
string
User-Scope az érték lekéréséhez. Az aktuális felhasználó esetében "én" vagy "gazdagép" kell, hogy legyen az összes felhasználó számára.
- scopeName
-
string
Hatókör, amellyel lekérheti a funkcióbeállítást (pl. "projekt" vagy "csapat")
- scopeValue
-
string
A hatókör értéke (például a projekt vagy a csapat azonosítója)
Válaszok
Promise<ContributedFeatureState>
queryFeatureStates(ContributedFeatureStateQuery)
A funkcióazonosítók listájának érvényes állapotának lekérése
function queryFeatureStates(query: ContributedFeatureStateQuery): Promise<ContributedFeatureStateQuery>Paraméterek
A lekérdezési funkciók és az aktuális hatókörértékek
Válaszok
Promise<ContributedFeatureStateQuery>
queryFeatureStatesForDefaultScope(ContributedFeatureStateQuery, string)
Az alapértelmezett hatókör megadott funkcióinak állapotának lekérése
function queryFeatureStatesForDefaultScope(query: ContributedFeatureStateQuery, userScope: string): Promise<ContributedFeatureStateQuery>Paraméterek
A lekérdezés funkcióit leíró lekérdezés.
- userScope
-
string
Válaszok
Promise<ContributedFeatureStateQuery>
queryFeatureStatesForNamedScope(ContributedFeatureStateQuery, string, string, string)
A megadott funkciók állapotának lekérése az adott elnevezett hatókörhöz
function queryFeatureStatesForNamedScope(query: ContributedFeatureStateQuery, userScope: string, scopeName: string, scopeValue: string): Promise<ContributedFeatureStateQuery>Paraméterek
A lekérdezés funkcióit leíró lekérdezés.
- userScope
-
string
- scopeName
-
string
- scopeValue
-
string
Válaszok
Promise<ContributedFeatureStateQuery>
setFeatureState(ContributedFeatureState, string, string, string, string)
Funkció állapotának beállítása
function setFeatureState(feature: ContributedFeatureState, featureId: string, userScope: string, reason?: string, reasonCode?: string): Promise<ContributedFeatureState>Paraméterek
- feature
- ContributedFeatureState
Közzétett funkcióállapot-objektum. Meg kell adnia a tényleges értéket.
- featureId
-
string
A funkció hozzájárulási azonosítója
- userScope
-
string
User-Scope az érték beállításához. Az aktuális felhasználó esetében "én" vagy "gazdagép" kell, hogy legyen az összes felhasználó számára.
- reason
-
string
Az állapot módosításának oka
- reasonCode
-
string
Rövid okkód
Válaszok
Promise<ContributedFeatureState>
setFeatureStateForScope(ContributedFeatureState, string, string, string, string, string, string)
Egy funkció állapotának beállítása egy adott hatókörben
function setFeatureStateForScope(feature: ContributedFeatureState, featureId: string, userScope: string, scopeName: string, scopeValue: string, reason?: string, reasonCode?: string): Promise<ContributedFeatureState>Paraméterek
- feature
- ContributedFeatureState
Közzétett funkcióállapot-objektum. Meg kell adnia a tényleges értéket.
- featureId
-
string
A funkció hozzájárulási azonosítója
- userScope
-
string
User-Scope az érték beállításához. Az aktuális felhasználó esetében "én" vagy "gazdagép" kell, hogy legyen az összes felhasználó számára.
- scopeName
-
string
Hatókör, amellyel lekérheti a funkcióbeállítást (pl. "projekt" vagy "csapat")
- scopeValue
-
string
A hatókör értéke (például a projekt vagy a csapat azonosítója)
- reason
-
string
Az állapot módosításának oka
- reasonCode
-
string
Rövid okkód
Válaszok
Promise<ContributedFeatureState>