FeatureManagementRestClient class
Clase base que se debe usar (derivada de) para realizar solicitudes a las API REST de VSS
- Extends
Constructores
| Feature |
Métodos
| get |
Obtención de una característica específica por su identificador |
| get |
Obtener una lista de todas las características definidas |
| get |
Obtiene el estado de la característica especificada para el ámbito de usuario o todos los usuarios especificados. |
| get |
Obtiene el estado de la característica especificada para el ámbito con nombre especificado. |
| query |
Obtención del estado efectivo de una lista de identificadores de características |
| query |
Obtiene los estados de las características especificadas para el ámbito predeterminado. |
| query |
Obtiene los estados de las características especificadas para el ámbito con nombre específico. |
| set |
Establecer el estado de una característica |
| set |
Establecer el estado de una característica en un ámbito específico |
Detalles del constructor
FeatureManagementRestClient(IVssRestClientOptions)
new FeatureManagementRestClient(options: IVssRestClientOptions)Parámetros
- options
- IVssRestClientOptions
Detalles del método
getFeature(string)
Obtención de una característica específica por su identificador
function getFeature(featureId: string): Promise<ContributedFeature>Parámetros
- featureId
-
string
Identificador de contribución de la característica
Devoluciones
Promise<ContributedFeature>
getFeatures(string)
Obtener una lista de todas las características definidas
function getFeatures(targetContributionId?: string): Promise<ContributedFeature[]>Parámetros
- targetContributionId
-
string
Contribución de destino opcional. Si es null/vacío, devuelva todas las características. Si se especifica, incluya las características destinadas a la contribución especificada.
Devoluciones
Promise<ContributedFeature[]>
getFeatureState(string, string)
Obtiene el estado de la característica especificada para el ámbito de usuario o todos los usuarios especificados.
function getFeatureState(featureId: string, userScope: string): Promise<ContributedFeatureState>Parámetros
- featureId
-
string
Identificador de contribución de la característica
- userScope
-
string
User-Scope en el que se va a obtener el valor. Debe ser "me" para el usuario actual o "host" para todos los usuarios.
Devoluciones
Promise<ContributedFeatureState>
getFeatureStateForScope(string, string, string, string)
Obtiene el estado de la característica especificada para el ámbito con nombre especificado.
function getFeatureStateForScope(featureId: string, userScope: string, scopeName: string, scopeValue: string): Promise<ContributedFeatureState>Parámetros
- featureId
-
string
Identificador de contribución de la característica
- userScope
-
string
User-Scope en el que se va a obtener el valor. Debe ser "me" para el usuario actual o "host" para todos los usuarios.
- scopeName
-
string
Ámbito en el que se va a obtener la configuración de la característica (por ejemplo, "proyecto" o "equipo")
- scopeValue
-
string
Valor del ámbito (por ejemplo, el proyecto o el identificador de equipo)
Devoluciones
Promise<ContributedFeatureState>
queryFeatureStates(ContributedFeatureStateQuery)
Obtención del estado efectivo de una lista de identificadores de características
function queryFeatureStates(query: ContributedFeatureStateQuery): Promise<ContributedFeatureStateQuery>Parámetros
Características que se van a consultar junto con los valores de ámbito actuales
Devoluciones
Promise<ContributedFeatureStateQuery>
queryFeatureStatesForDefaultScope(ContributedFeatureStateQuery, string)
Obtiene los estados de las características especificadas para el ámbito predeterminado.
function queryFeatureStatesForDefaultScope(query: ContributedFeatureStateQuery, userScope: string): Promise<ContributedFeatureStateQuery>Parámetros
Consulta que describe las características que se van a consultar.
- userScope
-
string
Devoluciones
Promise<ContributedFeatureStateQuery>
queryFeatureStatesForNamedScope(ContributedFeatureStateQuery, string, string, string)
Obtiene los estados de las características especificadas para el ámbito con nombre específico.
function queryFeatureStatesForNamedScope(query: ContributedFeatureStateQuery, userScope: string, scopeName: string, scopeValue: string): Promise<ContributedFeatureStateQuery>Parámetros
Consulta que describe las características que se van a consultar.
- userScope
-
string
- scopeName
-
string
- scopeValue
-
string
Devoluciones
Promise<ContributedFeatureStateQuery>
setFeatureState(ContributedFeatureState, string, string, string, string)
Establecer el estado de una característica
function setFeatureState(feature: ContributedFeatureState, featureId: string, userScope: string, reason?: string, reasonCode?: string): Promise<ContributedFeatureState>Parámetros
- feature
- ContributedFeatureState
Objeto de estado de característica publicado. Debe especificar el valor efectivo.
- featureId
-
string
Identificador de contribución de la característica
- userScope
-
string
User-Scope en el que se va a establecer el valor. Debe ser "me" para el usuario actual o "host" para todos los usuarios.
- reason
-
string
Motivo para cambiar el estado
- reasonCode
-
string
Código de motivo corto
Devoluciones
Promise<ContributedFeatureState>
setFeatureStateForScope(ContributedFeatureState, string, string, string, string, string, string)
Establecer el estado de una característica en un ámbito específico
function setFeatureStateForScope(feature: ContributedFeatureState, featureId: string, userScope: string, scopeName: string, scopeValue: string, reason?: string, reasonCode?: string): Promise<ContributedFeatureState>Parámetros
- feature
- ContributedFeatureState
Objeto de estado de característica publicado. Debe especificar el valor efectivo.
- featureId
-
string
Identificador de contribución de la característica
- userScope
-
string
User-Scope en el que se va a establecer el valor. Debe ser "me" para el usuario actual o "host" para todos los usuarios.
- scopeName
-
string
Ámbito en el que se va a obtener la configuración de la característica (por ejemplo, "proyecto" o "equipo")
- scopeValue
-
string
Valor del ámbito (por ejemplo, el proyecto o el identificador de equipo)
- reason
-
string
Motivo para cambiar el estado
- reasonCode
-
string
Código de motivo corto
Devoluciones
Promise<ContributedFeatureState>