FeatureManagementRestClient class
Classe base que deve ser utilizada (derivada de) para fazer pedidos às apis REST do VSS
- Extends
Construtores
| Feature |
Métodos
| get |
Obter uma funcionalidade específica pelo respetivo ID |
| get |
Obter uma lista de todas as funcionalidades definidas |
| get |
Obter o estado da funcionalidade especificada para o âmbito de utilizador/todos os utilizadores especificado |
| get |
Obter o estado da funcionalidade especificada para o âmbito com nome especificado |
| query |
Obter o estado efetivo de uma lista de IDs de funcionalidades |
| query |
Obter os estados das funcionalidades especificadas para o âmbito predefinido |
| query |
Obter os estados das funcionalidades especificadas para o âmbito com nome específico |
| set |
Definir o estado de uma funcionalidade |
| set |
Definir o estado de uma funcionalidade num âmbito específico |
Detalhes do Construtor
FeatureManagementRestClient(IVssRestClientOptions)
new FeatureManagementRestClient(options: IVssRestClientOptions)Parâmetros
- options
- IVssRestClientOptions
Detalhes de Método
getFeature(string)
Obter uma funcionalidade específica pelo respetivo ID
function getFeature(featureId: string): Promise<ContributedFeature>Parâmetros
- featureId
-
string
O ID de contribuição da funcionalidade
Devoluções
Promise<ContributedFeature>
getFeatures(string)
Obter uma lista de todas as funcionalidades definidas
function getFeatures(targetContributionId?: string): Promise<ContributedFeature[]>Parâmetros
- targetContributionId
-
string
Contribuição de destino opcional. Se for nulo/vazio, devolva todas as funcionalidades. Se especificado, inclua as funcionalidades que visam a contribuição especificada.
Devoluções
Promise<ContributedFeature[]>
getFeatureState(string, string)
Obter o estado da funcionalidade especificada para o âmbito de utilizador/todos os utilizadores especificado
function getFeatureState(featureId: string, userScope: string): Promise<ContributedFeatureState>Parâmetros
- featureId
-
string
ID de contribuição da funcionalidade
- userScope
-
string
User-Scope para obter o valor. Deve ser "eu" para o utilizador atual ou "anfitrião" para todos os utilizadores.
Devoluções
Promise<ContributedFeatureState>
getFeatureStateForScope(string, string, string, string)
Obter o estado da funcionalidade especificada para o âmbito com nome especificado
function getFeatureStateForScope(featureId: string, userScope: string, scopeName: string, scopeValue: string): Promise<ContributedFeatureState>Parâmetros
- featureId
-
string
ID de contribuição da funcionalidade
- userScope
-
string
User-Scope para obter o valor. Deve ser "eu" para o utilizador atual ou "anfitrião" para todos os utilizadores.
- scopeName
-
string
Âmbito para obter a definição de funcionalidade para (por exemplo, "projeto" ou "equipa")
- scopeValue
-
string
Valor do âmbito (por exemplo, o projeto ou o ID da equipa)
Devoluções
Promise<ContributedFeatureState>
queryFeatureStates(ContributedFeatureStateQuery)
Obter o estado efetivo de uma lista de IDs de funcionalidades
function queryFeatureStates(query: ContributedFeatureStateQuery): Promise<ContributedFeatureStateQuery>Parâmetros
Funcionalidades a consultar juntamente com os valores de âmbito atuais
Devoluções
Promise<ContributedFeatureStateQuery>
queryFeatureStatesForDefaultScope(ContributedFeatureStateQuery, string)
Obter os estados das funcionalidades especificadas para o âmbito predefinido
function queryFeatureStatesForDefaultScope(query: ContributedFeatureStateQuery, userScope: string): Promise<ContributedFeatureStateQuery>Parâmetros
Consulta que descreve as funcionalidades a consultar.
- userScope
-
string
Devoluções
Promise<ContributedFeatureStateQuery>
queryFeatureStatesForNamedScope(ContributedFeatureStateQuery, string, string, string)
Obter os estados das funcionalidades especificadas para o âmbito com nome específico
function queryFeatureStatesForNamedScope(query: ContributedFeatureStateQuery, userScope: string, scopeName: string, scopeValue: string): Promise<ContributedFeatureStateQuery>Parâmetros
Consulta que descreve as funcionalidades a consultar.
- userScope
-
string
- scopeName
-
string
- scopeValue
-
string
Devoluções
Promise<ContributedFeatureStateQuery>
setFeatureState(ContributedFeatureState, string, string, string, string)
Definir o estado de uma funcionalidade
function setFeatureState(feature: ContributedFeatureState, featureId: string, userScope: string, reason?: string, reasonCode?: string): Promise<ContributedFeatureState>Parâmetros
- feature
- ContributedFeatureState
Objeto de estado da funcionalidade publicado. Deve especificar o valor efetivo.
- featureId
-
string
ID de contribuição da funcionalidade
- userScope
-
string
User-Scope para definir o valor. Deve ser "eu" para o utilizador atual ou "anfitrião" para todos os utilizadores.
- reason
-
string
Motivo para alterar o estado
- reasonCode
-
string
Código de razão abreviado
Devoluções
Promise<ContributedFeatureState>
setFeatureStateForScope(ContributedFeatureState, string, string, string, string, string, string)
Definir o estado de uma funcionalidade num â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 da funcionalidade publicado. Deve especificar o valor efetivo.
- featureId
-
string
ID de contribuição da funcionalidade
- userScope
-
string
User-Scope para definir o valor. Deve ser "eu" para o utilizador atual ou "anfitrião" para todos os utilizadores.
- scopeName
-
string
Âmbito para obter a definição de funcionalidade para (por exemplo, "projeto" ou "equipa")
- scopeValue
-
string
Valor do âmbito (por exemplo, o projeto ou o ID da equipa)
- reason
-
string
Motivo para alterar o estado
- reasonCode
-
string
Código de razão abreviado
Devoluções
Promise<ContributedFeatureState>
Comentários
Brevemente: Ao longo de 2024, vamos descontinuar progressivamente o GitHub Issues como mecanismo de feedback para conteúdos e substituí-lo por um novo sistema de feedback. Para obter mais informações, veja: https://aka.ms/ContentUserFeedback.
Submeter e ver comentários