FeatureManagementRestClient class
Basisklasse, die verwendet werden soll (abgeleitet von), um Anforderungen an VSS-REST-APIs zu stellen
- Extends
Konstruktoren
| Feature |
Methoden
| get |
Abrufen einer bestimmten Funktion anhand ihrer ID |
| get |
Abrufen einer Liste aller definierten Funktionen |
| get |
Abrufen des Status des angegebenen Features für den angegebenen Benutzer-/All-Users-Bereich |
| get |
Abrufen des Status des angegebenen Features für den angegebenen benannten Bereich |
| query |
Abrufen des effektiven Zustands für eine Liste von Feature-IDs |
| query |
Abrufen der Zustände der angegebenen Features für den Standardbereich |
| query |
Abrufen der Zustände der angegebenen Features für den spezifischen benannten Bereich |
| set |
Festlegen des Status eines Features |
| set |
Festlegen des Status eines Features auf einen bestimmten Bereich |
Details zum Konstruktor
FeatureManagementRestClient(IVssRestClientOptions)
new FeatureManagementRestClient(options: IVssRestClientOptions)Parameter
- options
- IVssRestClientOptions
Details zur Methode
getFeature(string)
Abrufen einer bestimmten Funktion anhand ihrer ID
function getFeature(featureId: string): Promise<ContributedFeature>Parameter
- featureId
-
string
Die Beitrags-ID der Funktion
Gibt zurück
Promise<ContributedFeature>
getFeatures(string)
Abrufen einer Liste aller definierten Funktionen
function getFeatures(targetContributionId?: string): Promise<ContributedFeature[]>Parameter
- targetContributionId
-
string
Optionaler Zielbeitrag. Falls null/empty, werden alle Features zurückgegeben. Wenn angegeben, schließen Sie die Funktionen ein, die auf den angegebenen Beitrag abzielen.
Gibt zurück
Promise<ContributedFeature[]>
getFeatureState(string, string)
Abrufen des Status des angegebenen Features für den angegebenen Benutzer-/All-Users-Bereich
function getFeatureState(featureId: string, userScope: string): Promise<ContributedFeatureState>Parameter
- featureId
-
string
Beitrags-ID der Funktion
- userScope
-
string
User-Scope, bei dem der Wert abgerufen werden soll. Sollte "me" für den aktuellen Benutzer oder "host" für alle Benutzer sein.
Gibt zurück
Promise<ContributedFeatureState>
getFeatureStateForScope(string, string, string, string)
Abrufen des Status des angegebenen Features für den angegebenen benannten Bereich
function getFeatureStateForScope(featureId: string, userScope: string, scopeName: string, scopeValue: string): Promise<ContributedFeatureState>Parameter
- featureId
-
string
Beitrags-ID der Funktion
- userScope
-
string
User-Scope, bei dem der Wert abgerufen werden soll. Sollte "me" für den aktuellen Benutzer oder "host" für alle Benutzer sein.
- scopeName
-
string
Bereich, für den die Funktionseinstellung abgerufen werden soll (z. B. "Projekt" oder "Team")
- scopeValue
-
string
Wert des Umfangs (z. B. die Projekt- oder Team-ID)
Gibt zurück
Promise<ContributedFeatureState>
queryFeatureStates(ContributedFeatureStateQuery)
Abrufen des effektiven Zustands für eine Liste von Feature-IDs
function queryFeatureStates(query: ContributedFeatureStateQuery): Promise<ContributedFeatureStateQuery>Parameter
Funktionen, die zusammen mit den aktuellen Bereichswerten abgefragt werden sollen
Gibt zurück
Promise<ContributedFeatureStateQuery>
queryFeatureStatesForDefaultScope(ContributedFeatureStateQuery, string)
Abrufen der Zustände der angegebenen Features für den Standardbereich
function queryFeatureStatesForDefaultScope(query: ContributedFeatureStateQuery, userScope: string): Promise<ContributedFeatureStateQuery>Parameter
Abfrage, die die abzufragenden Features beschreibt.
- userScope
-
string
Gibt zurück
Promise<ContributedFeatureStateQuery>
queryFeatureStatesForNamedScope(ContributedFeatureStateQuery, string, string, string)
Abrufen der Zustände der angegebenen Features für den spezifischen benannten Bereich
function queryFeatureStatesForNamedScope(query: ContributedFeatureStateQuery, userScope: string, scopeName: string, scopeValue: string): Promise<ContributedFeatureStateQuery>Parameter
Abfrage, die die abzufragenden Features beschreibt.
- userScope
-
string
- scopeName
-
string
- scopeValue
-
string
Gibt zurück
Promise<ContributedFeatureStateQuery>
setFeatureState(ContributedFeatureState, string, string, string, string)
Festlegen des Status eines Features
function setFeatureState(feature: ContributedFeatureState, featureId: string, userScope: string, reason?: string, reasonCode?: string): Promise<ContributedFeatureState>Parameter
- feature
- ContributedFeatureState
Bereitgestelltes Feature-Statusobjekt. Sollte den effektiven Wert angeben.
- featureId
-
string
Beitrags-ID der Funktion
- userScope
-
string
User-Scope, bei dem der Wert festgelegt werden soll. Sollte "me" für den aktuellen Benutzer oder "host" für alle Benutzer sein.
- reason
-
string
Grund für die Änderung des Zustands
- reasonCode
-
string
Kurzer Ursachencode
Gibt zurück
Promise<ContributedFeatureState>
setFeatureStateForScope(ContributedFeatureState, string, string, string, string, string, string)
Festlegen des Status eines Features auf einen bestimmten Bereich
function setFeatureStateForScope(feature: ContributedFeatureState, featureId: string, userScope: string, scopeName: string, scopeValue: string, reason?: string, reasonCode?: string): Promise<ContributedFeatureState>Parameter
- feature
- ContributedFeatureState
Bereitgestelltes Feature-Statusobjekt. Sollte den effektiven Wert angeben.
- featureId
-
string
Beitrags-ID der Funktion
- userScope
-
string
User-Scope, bei dem der Wert festgelegt werden soll. Sollte "me" für den aktuellen Benutzer oder "host" für alle Benutzer sein.
- scopeName
-
string
Bereich, für den die Funktionseinstellung abgerufen werden soll (z. B. "Projekt" oder "Team")
- scopeValue
-
string
Wert des Umfangs (z. B. die Projekt- oder Team-ID)
- reason
-
string
Grund für die Änderung des Zustands
- reasonCode
-
string
Kurzer Ursachencode
Gibt zurück
Promise<ContributedFeatureState>