FeatureManagementRestClient class
Classe di base da usare (derivata da) per effettuare richieste alle API REST vss
- Extends
Metodi
| get |
Ottenere una funzione specifica in base al suo id |
| get |
Ottieni un elenco di tutte le funzionalità definite |
| get |
Ottenere lo stato della funzionalità specificata per l'ambito utente/tutti gli utenti specificato |
| get |
Ottenere lo stato della funzionalità specificata per l'ambito denominato specificato |
| query |
Ottenere lo stato effettivo per un elenco di ID funzionalità |
| query |
Ottenere gli stati delle funzionalità specificate per l'ambito predefinito |
| query |
Ottenere gli stati delle funzionalità specificate per l'ambito denominato specifico |
| set |
Impostare lo stato di una funzionalità |
| set |
Impostare lo stato di una funzionalità in un ambito specifico |
Dettagli costruttore
FeatureManagementRestClient(IVssRestClientOptions)
new FeatureManagementRestClient(options: IVssRestClientOptions)Parametri
- options
- IVssRestClientOptions
Dettagli metodo
getFeature(string)
Ottenere una funzione specifica in base al suo id
function getFeature(featureId: string): Promise<ContributedFeature>Parametri
- featureId
-
string
L'ID del contributo della funzionalità
Restituisce
Promise<ContributedFeature>
getFeatures(string)
Ottieni un elenco di tutte le funzionalità definite
function getFeatures(targetContributionId?: string): Promise<ContributedFeature[]>Parametri
- targetContributionId
-
string
Contributo target facoltativo. Se null/vuoto, restituisce tutte le funzionalità. Se specificato, includere le funzionalità destinate al contributo specificato.
Restituisce
Promise<ContributedFeature[]>
getFeatureState(string, string)
Ottenere lo stato della funzionalità specificata per l'ambito utente/tutti gli utenti specificato
function getFeatureState(featureId: string, userScope: string): Promise<ContributedFeatureState>Parametri
- featureId
-
string
ID contributo della funzionalità
- userScope
-
string
User-Scope a cui ottenere il valore. Dovrebbe essere "me" per l'utente corrente o "host" per tutti gli utenti.
Restituisce
Promise<ContributedFeatureState>
getFeatureStateForScope(string, string, string, string)
Ottenere lo stato della funzionalità specificata per l'ambito denominato specificato
function getFeatureStateForScope(featureId: string, userScope: string, scopeName: string, scopeValue: string): Promise<ContributedFeatureState>Parametri
- featureId
-
string
ID contributo della funzionalità
- userScope
-
string
User-Scope a cui ottenere il valore. Dovrebbe essere "me" per l'utente corrente o "host" per tutti gli utenti.
- scopeName
-
string
Ambito in cui ottenere l'impostazione della funzionalità (ad esempio, "progetto" o "team")
- scopeValue
-
string
Valore dell'ambito (ad es. l'ID del progetto o del team)
Restituisce
Promise<ContributedFeatureState>
queryFeatureStates(ContributedFeatureStateQuery)
Ottenere lo stato effettivo per un elenco di ID funzionalità
function queryFeatureStates(query: ContributedFeatureStateQuery): Promise<ContributedFeatureStateQuery>Parametri
Funzionalità per eseguire query insieme ai valori di ambito correnti
Restituisce
Promise<ContributedFeatureStateQuery>
queryFeatureStatesForDefaultScope(ContributedFeatureStateQuery, string)
Ottenere gli stati delle funzionalità specificate per l'ambito predefinito
function queryFeatureStatesForDefaultScope(query: ContributedFeatureStateQuery, userScope: string): Promise<ContributedFeatureStateQuery>Parametri
Query che descrive le funzionalità da interrogare.
- userScope
-
string
Restituisce
Promise<ContributedFeatureStateQuery>
queryFeatureStatesForNamedScope(ContributedFeatureStateQuery, string, string, string)
Ottenere gli stati delle funzionalità specificate per l'ambito denominato specifico
function queryFeatureStatesForNamedScope(query: ContributedFeatureStateQuery, userScope: string, scopeName: string, scopeValue: string): Promise<ContributedFeatureStateQuery>Parametri
Query che descrive le funzionalità da interrogare.
- userScope
-
string
- scopeName
-
string
- scopeValue
-
string
Restituisce
Promise<ContributedFeatureStateQuery>
setFeatureState(ContributedFeatureState, string, string, string, string)
Impostare lo stato di una funzionalità
function setFeatureState(feature: ContributedFeatureState, featureId: string, userScope: string, reason?: string, reasonCode?: string): Promise<ContributedFeatureState>Parametri
- feature
- ContributedFeatureState
Oggetto stato della funzionalità pubblicato. Deve specificare il valore effettivo.
- featureId
-
string
ID contributo della funzionalità
- userScope
-
string
User-Scope in cui impostare il valore. Dovrebbe essere "me" per l'utente corrente o "host" per tutti gli utenti.
- reason
-
string
Motivo del cambiamento dello stato
- reasonCode
-
string
Codice motivo breve
Restituisce
Promise<ContributedFeatureState>
setFeatureStateForScope(ContributedFeatureState, string, string, string, string, string, string)
Impostare lo stato di una funzionalità in un ambito specifico
function setFeatureStateForScope(feature: ContributedFeatureState, featureId: string, userScope: string, scopeName: string, scopeValue: string, reason?: string, reasonCode?: string): Promise<ContributedFeatureState>Parametri
- feature
- ContributedFeatureState
Oggetto stato della funzionalità pubblicato. Deve specificare il valore effettivo.
- featureId
-
string
ID contributo della funzionalità
- userScope
-
string
User-Scope in cui impostare il valore. Dovrebbe essere "me" per l'utente corrente o "host" per tutti gli utenti.
- scopeName
-
string
Ambito in cui ottenere l'impostazione della funzionalità (ad esempio, "progetto" o "team")
- scopeValue
-
string
Valore dell'ambito (ad es. l'ID del progetto o del team)
- reason
-
string
Motivo del cambiamento dello stato
- reasonCode
-
string
Codice motivo breve
Restituisce
Promise<ContributedFeatureState>