FeatureManagementRestClient class
Classe base que deve ser usada (derivada de) para fazer solicitações para apis REST do VSS
- Extends
Construtores
| Feature |
Métodos
| get |
Obter um recurso específico por sua ID |
| get |
Obter uma lista de todos os recursos definidos |
| get |
Obter o estado do recurso especificado para o escopo determinado de usuário/todos os usuários |
| get |
Obter o estado do recurso especificado para o escopo nomeado fornecido |
| query |
Obter o estado efetivo para uma lista de IDs de recurso |
| query |
Obter os estados dos recursos especificados para o escopo padrão |
| query |
Obter os estados dos recursos especificados para o escopo nomeado específico |
| set |
Definir o estado de um recurso |
| set |
Definir o estado de um recurso em um escopo específico |
Detalhes do construtor
FeatureManagementRestClient(IVssRestClientOptions)
new FeatureManagementRestClient(options: IVssRestClientOptions)Parâmetros
- options
- IVssRestClientOptions
Detalhes do método
getFeature(string)
Obter um recurso específico por sua ID
function getFeature(featureId: string): Promise<ContributedFeature>Parâmetros
- featureId
-
string
A ID de contribuição do recurso
Retornos
Promise<ContributedFeature>
getFeatures(string)
Obter uma lista de todos os recursos definidos
function getFeatures(targetContributionId?: string): Promise<ContributedFeature[]>Parâmetros
- targetContributionId
-
string
Contribuição de destino opcional. Se for nulo/vazio, retorne todos os recursos. Se especificado, inclua os recursos destinados à contribuição especificada.
Retornos
Promise<ContributedFeature[]>
getFeatureState(string, string)
Obter o estado do recurso especificado para o escopo determinado de usuário/todos os usuários
function getFeatureState(featureId: string, userScope: string): Promise<ContributedFeatureState>Parâmetros
- featureId
-
string
ID de contribuição do recurso
- userScope
-
string
User-Scope no qual obter o valor. Deve ser "eu" para o usuário atual ou "host" para todos os usuários.
Retornos
Promise<ContributedFeatureState>
getFeatureStateForScope(string, string, string, string)
Obter o estado do recurso especificado para o escopo nomeado fornecido
function getFeatureStateForScope(featureId: string, userScope: string, scopeName: string, scopeValue: string): Promise<ContributedFeatureState>Parâmetros
- featureId
-
string
ID de contribuição do recurso
- userScope
-
string
User-Scope no qual obter o valor. Deve ser "eu" para o usuário atual ou "host" para todos os usuários.
- scopeName
-
string
Escopo para o qual obter a configuração de recurso (por exemplo, "project" ou "team")
- scopeValue
-
string
Valor do escopo (por exemplo, o projeto ou a ID da equipe)
Retornos
Promise<ContributedFeatureState>
queryFeatureStates(ContributedFeatureStateQuery)
Obter o estado efetivo para uma lista de IDs de recurso
function queryFeatureStates(query: ContributedFeatureStateQuery): Promise<ContributedFeatureStateQuery>Parâmetros
Recursos a serem consultados junto com os valores de escopo atuais
Retornos
Promise<ContributedFeatureStateQuery>
queryFeatureStatesForDefaultScope(ContributedFeatureStateQuery, string)
Obter os estados dos recursos especificados para o escopo padrão
function queryFeatureStatesForDefaultScope(query: ContributedFeatureStateQuery, userScope: string): Promise<ContributedFeatureStateQuery>Parâmetros
Consulta que descreve os recursos a serem consultados.
- userScope
-
string
Retornos
Promise<ContributedFeatureStateQuery>
queryFeatureStatesForNamedScope(ContributedFeatureStateQuery, string, string, string)
Obter os estados dos recursos especificados para o escopo nomeado específico
function queryFeatureStatesForNamedScope(query: ContributedFeatureStateQuery, userScope: string, scopeName: string, scopeValue: string): Promise<ContributedFeatureStateQuery>Parâmetros
Consulta que descreve os recursos a serem consultados.
- userScope
-
string
- scopeName
-
string
- scopeValue
-
string
Retornos
Promise<ContributedFeatureStateQuery>
setFeatureState(ContributedFeatureState, string, string, string, string)
Definir o estado de um recurso
function setFeatureState(feature: ContributedFeatureState, featureId: string, userScope: string, reason?: string, reasonCode?: string): Promise<ContributedFeatureState>Parâmetros
- feature
- ContributedFeatureState
Objeto de estado do recurso postado. Deve especificar o valor efetivo.
- featureId
-
string
ID de contribuição do recurso
- userScope
-
string
User-Scope no qual definir o valor. Deve ser "eu" para o usuário atual ou "host" para todos os usuários.
- reason
-
string
Motivo para alterar o estado
- reasonCode
-
string
Código de motivo curto
Retornos
Promise<ContributedFeatureState>
setFeatureStateForScope(ContributedFeatureState, string, string, string, string, string, string)
Definir o estado de um recurso em um escopo 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 do recurso postado. Deve especificar o valor efetivo.
- featureId
-
string
ID de contribuição do recurso
- userScope
-
string
User-Scope no qual definir o valor. Deve ser "eu" para o usuário atual ou "host" para todos os usuários.
- scopeName
-
string
Escopo para o qual obter a configuração de recurso (por exemplo, "project" ou "team")
- scopeValue
-
string
Valor do escopo (por exemplo, o projeto ou a ID da equipe)
- reason
-
string
Motivo para alterar o estado
- reasonCode
-
string
Código de motivo curto
Retornos
Promise<ContributedFeatureState>