FeatureManagementRestClient class
Klasa bazowa, która powinna być używana (pochodna) do tworzenia żądań do interfejsów API REST usługi VSS
- Extends
Konstruktory
| Feature |
Metody
| get |
Pobieranie określonej funkcji według jej identyfikatora |
| get |
Pobieranie listy wszystkich zdefiniowanych funkcji |
| get |
Pobieranie stanu określonej funkcji dla danego zakresu użytkownika/wszystkich użytkowników |
| get |
Pobieranie stanu określonej funkcji dla danego nazwanego zakresu |
| query |
Pobieranie stanu skutecznego dla listy identyfikatorów funkcji |
| query |
Pobieranie stanów określonych funkcji dla zakresu domyślnego |
| query |
Pobieranie stanów określonych funkcji dla określonego nazwanego zakresu |
| set |
Ustawianie stanu funkcji |
| set |
Ustawianie stanu funkcji w określonym zakresie |
Szczegóły konstruktora
FeatureManagementRestClient(IVssRestClientOptions)
new FeatureManagementRestClient(options: IVssRestClientOptions)Parametry
- options
- IVssRestClientOptions
Szczegóły metody
getFeature(string)
Pobieranie określonej funkcji według jej identyfikatora
function getFeature(featureId: string): Promise<ContributedFeature>Parametry
- featureId
-
string
Identyfikator udziału funkcji
Zwraca
Promise<ContributedFeature>
getFeatures(string)
Pobieranie listy wszystkich zdefiniowanych funkcji
function getFeatures(targetContributionId?: string): Promise<ContributedFeature[]>Parametry
- targetContributionId
-
string
Opcjonalny udział docelowy. Jeśli wartość null/jest pusta, zwróć wszystkie funkcje. Jeśli określono, obejmują funkcje, które są przeznaczone dla określonego udziału.
Zwraca
Promise<ContributedFeature[]>
getFeatureState(string, string)
Pobieranie stanu określonej funkcji dla danego zakresu użytkownika/wszystkich użytkowników
function getFeatureState(featureId: string, userScope: string): Promise<ContributedFeatureState>Parametry
- featureId
-
string
Identyfikator udziału funkcji
- userScope
-
string
User-Scope, w którym ma być pobierana wartość. Powinna być "mną" dla bieżącego użytkownika lub "hosta" dla wszystkich użytkowników.
Zwraca
Promise<ContributedFeatureState>
getFeatureStateForScope(string, string, string, string)
Pobieranie stanu określonej funkcji dla danego nazwanego zakresu
function getFeatureStateForScope(featureId: string, userScope: string, scopeName: string, scopeValue: string): Promise<ContributedFeatureState>Parametry
- featureId
-
string
Identyfikator udziału funkcji
- userScope
-
string
User-Scope, w którym ma być pobierana wartość. Powinna być "mną" dla bieżącego użytkownika lub "hosta" dla wszystkich użytkowników.
- scopeName
-
string
Zakres, dla którego ma być dostępne ustawienie funkcji (np. "projekt" lub "zespół")
- scopeValue
-
string
Wartość zakresu (np. identyfikator projektu lub zespołu)
Zwraca
Promise<ContributedFeatureState>
queryFeatureStates(ContributedFeatureStateQuery)
Pobieranie stanu skutecznego dla listy identyfikatorów funkcji
function queryFeatureStates(query: ContributedFeatureStateQuery): Promise<ContributedFeatureStateQuery>Parametry
Funkcje do wykonywania zapytań wraz z bieżącymi wartościami zakresu
Zwraca
Promise<ContributedFeatureStateQuery>
queryFeatureStatesForDefaultScope(ContributedFeatureStateQuery, string)
Pobieranie stanów określonych funkcji dla zakresu domyślnego
function queryFeatureStatesForDefaultScope(query: ContributedFeatureStateQuery, userScope: string): Promise<ContributedFeatureStateQuery>Parametry
Zapytanie opisujące funkcje do wykonywania zapytań.
- userScope
-
string
Zwraca
Promise<ContributedFeatureStateQuery>
queryFeatureStatesForNamedScope(ContributedFeatureStateQuery, string, string, string)
Pobieranie stanów określonych funkcji dla określonego nazwanego zakresu
function queryFeatureStatesForNamedScope(query: ContributedFeatureStateQuery, userScope: string, scopeName: string, scopeValue: string): Promise<ContributedFeatureStateQuery>Parametry
Zapytanie opisujące funkcje do wykonywania zapytań.
- userScope
-
string
- scopeName
-
string
- scopeValue
-
string
Zwraca
Promise<ContributedFeatureStateQuery>
setFeatureState(ContributedFeatureState, string, string, string, string)
Ustawianie stanu funkcji
function setFeatureState(feature: ContributedFeatureState, featureId: string, userScope: string, reason?: string, reasonCode?: string): Promise<ContributedFeatureState>Parametry
- feature
- ContributedFeatureState
Opublikowano obiekt stanu funkcji. Należy określić obowiązującą wartość.
- featureId
-
string
Identyfikator udziału funkcji
- userScope
-
string
User-Scope, w którym należy ustawić wartość. Powinna być "mną" dla bieżącego użytkownika lub "hosta" dla wszystkich użytkowników.
- reason
-
string
Przyczyna zmiany stanu
- reasonCode
-
string
Krótki kod przyczyny
Zwraca
Promise<ContributedFeatureState>
setFeatureStateForScope(ContributedFeatureState, string, string, string, string, string, string)
Ustawianie stanu funkcji w określonym zakresie
function setFeatureStateForScope(feature: ContributedFeatureState, featureId: string, userScope: string, scopeName: string, scopeValue: string, reason?: string, reasonCode?: string): Promise<ContributedFeatureState>Parametry
- feature
- ContributedFeatureState
Opublikowano obiekt stanu funkcji. Należy określić obowiązującą wartość.
- featureId
-
string
Identyfikator udziału funkcji
- userScope
-
string
User-Scope, w którym należy ustawić wartość. Powinna być "mną" dla bieżącego użytkownika lub "hosta" dla wszystkich użytkowników.
- scopeName
-
string
Zakres, dla którego ma być dostępne ustawienie funkcji (np. "projekt" lub "zespół")
- scopeValue
-
string
Wartość zakresu (np. identyfikator projektu lub zespołu)
- reason
-
string
Przyczyna zmiany stanu
- reasonCode
-
string
Krótki kod przyczyny
Zwraca
Promise<ContributedFeatureState>