FeatureManagementRestClient class
Basisklasse, die verwendet (von abgeleitet) werden soll, um Anforderungen an VSS-REST-APIs zu senden
- Extends
Konstruktoren
| Feature |
Methoden
| get |
Abrufen eines bestimmten Features anhand seiner ID |
| get |
Abrufen einer Liste aller definierten Features |
| get |
Abrufen des Status des angegebenen Features für den angegebenen Benutzer-/Alle-Benutzer-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 des Status der angegebenen Features für den Standardbereich |
| query |
Abrufen der Zustände der angegebenen Features für den bestimmten benannten Bereich |
| set |
Festlegen des Status eines Features |
| set |
Festlegen des Status eines Features in einem bestimmten Bereich |
Details zum Konstruktor
FeatureManagementRestClient(IVssRestClientOptions)
new FeatureManagementRestClient(options: IVssRestClientOptions)Parameter
- options
- IVssRestClientOptions
Details zur Methode
getFeature(string)
Abrufen eines bestimmten Features anhand seiner ID
function getFeature(featureId: string): Promise<ContributedFeature>Parameter
- featureId
-
string
Die Beitrags-ID des Features
Gibt zurück
Promise<ContributedFeature>
getFeatures(string)
Abrufen einer Liste aller definierten Features
function getFeatures(targetContributionId?: string): Promise<ContributedFeature[]>Parameter
- targetContributionId
-
string
Optionaler Zielbeitrag. Wenn null/leer, werden alle Features zurückgegeben. Wenn angegeben, schließen Sie die Features 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-/Alle-Benutzer-Bereich
function getFeatureState(featureId: string, userScope: string): Promise<ContributedFeatureState>Parameter
- featureId
-
string
Beitrags-ID des Features
- userScope
-
string
User-Scope, an dem der Wert abgerufen werden soll. Sollte "ich" 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 des Features
- userScope
-
string
User-Scope, an dem der Wert abgerufen werden soll. Sollte "ich" für den aktuellen Benutzer oder "Host" für alle Benutzer sein.
- scopeName
-
string
Bereich, an dem die Featureeinstellung für abgerufen werden soll (z. B. "Projekt" oder "Team")
- scopeValue
-
string
Wert des Bereichs (z. B. 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
Abzufragende Features zusammen mit aktuellen Bereichswerten
Gibt zurück
Promise<ContributedFeatureStateQuery>
queryFeatureStatesForDefaultScope(ContributedFeatureStateQuery, string)
Abrufen des Status 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 bestimmten 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 Featurestatusobjekt. Sollte den effektiven Wert angeben.
- featureId
-
string
Beitrags-ID des Features
- userScope
-
string
User-Scope, an der der Wert festgelegt werden soll. Sollte "ich" für den aktuellen Benutzer oder "Host" für alle Benutzer sein.
- reason
-
string
Grund für die Änderung des Zustands
- reasonCode
-
string
Kurzer Grundcode
Gibt zurück
Promise<ContributedFeatureState>
setFeatureStateForScope(ContributedFeatureState, string, string, string, string, string, string)
Festlegen des Status eines Features in einem bestimmten Bereich
function setFeatureStateForScope(feature: ContributedFeatureState, featureId: string, userScope: string, scopeName: string, scopeValue: string, reason?: string, reasonCode?: string): Promise<ContributedFeatureState>Parameter
- feature
- ContributedFeatureState
Bereitgestelltes Featurestatusobjekt. Sollte den effektiven Wert angeben.
- featureId
-
string
Beitrags-ID des Features
- userScope
-
string
User-Scope, an der der Wert festgelegt werden soll. Sollte "ich" für den aktuellen Benutzer oder "Host" für alle Benutzer sein.
- scopeName
-
string
Bereich, an dem die Featureeinstellung für abgerufen werden soll (z. B. "Projekt" oder "Team")
- scopeValue
-
string
Wert des Bereichs (z. B. Projekt- oder Team-ID)
- reason
-
string
Grund für die Änderung des Zustands
- reasonCode
-
string
Kurzer Grundcode
Gibt zurück
Promise<ContributedFeatureState>