FeatureAvailabilityRestClient class

Pacote:

azure-devops-extension-api

Classe base que deve ser utilizada (derivada de) para fazer pedidos às apis REST do VSS

Extends

RestClientBase

Construtores

FeatureAvailabilityRestClient(IVssRestClientOptions)

Métodos

getAllFeatureFlags(string)	Obter uma listagem de todos os sinalizadores de funcionalidades e os respetivos estados atuais para um utilizador
getFeatureFlagByName(string, boolean)	Obter informações sobre um único sinalizador de funcionalidade e os respetivos estados atuais
getFeatureFlagByNameAndUserEmail(string, string, boolean)	Obter informações sobre um único sinalizador de funcionalidade e os respetivos estados atuais para um utilizador
getFeatureFlagByNameAndUserId(string, string, boolean)	Obter informações sobre um único sinalizador de funcionalidade e os respetivos estados atuais para um utilizador
updateFeatureFlag(FeatureFlagPatch, string, string, boolean, boolean)	Alterar o estado de um sinalizador de funcionalidade individual para um nome

Detalhes do Construtor

FeatureAvailabilityRestClient(IVssRestClientOptions)

new FeatureAvailabilityRestClient(options: IVssRestClientOptions)

Parâmetros

options

IVssRestClientOptions

Detalhes de Método

getAllFeatureFlags(string)

Obter uma listagem de todos os sinalizadores de funcionalidades e os respetivos estados atuais para um utilizador

function getAllFeatureFlags(userEmail?: string): Promise<FeatureFlag[]>

Parâmetros

userEmail

string

O e-mail do utilizador a verificar

Devoluções

Promise<FeatureFlag[]>

getFeatureFlagByName(string, boolean)

Obter informações sobre um único sinalizador de funcionalidade e os respetivos estados atuais

function getFeatureFlagByName(name: string, checkFeatureExists?: boolean): Promise<FeatureFlag>

Parâmetros

name

string

O nome da funcionalidade a obter

checkFeatureExists

boolean

Verificar se a funcionalidade existe

Devoluções

Promise<FeatureFlag>

getFeatureFlagByNameAndUserEmail(string, string, boolean)

Obter informações sobre um único sinalizador de funcionalidade e os respetivos estados atuais para um utilizador

function getFeatureFlagByNameAndUserEmail(name: string, userEmail: string, checkFeatureExists?: boolean): Promise<FeatureFlag>

Parâmetros

name

string

O nome da funcionalidade a obter

userEmail

string

O e-mail do utilizador a verificar

checkFeatureExists

boolean

Verificar se a funcionalidade existe

Devoluções

Promise<FeatureFlag>

getFeatureFlagByNameAndUserId(string, string, boolean)

Obter informações sobre um único sinalizador de funcionalidade e os respetivos estados atuais para um utilizador

function getFeatureFlagByNameAndUserId(name: string, userId: string, checkFeatureExists?: boolean): Promise<FeatureFlag>

Parâmetros

name

string

O nome da funcionalidade a obter

userId

string

O ID do utilizador a verificar

checkFeatureExists

boolean

Verificar se a funcionalidade existe

Devoluções

Promise<FeatureFlag>

updateFeatureFlag(FeatureFlagPatch, string, string, boolean, boolean)

Alterar o estado de um sinalizador de funcionalidade individual para um nome

function updateFeatureFlag(state: FeatureFlagPatch, name: string, userEmail?: string, checkFeatureExists?: boolean, setAtApplicationLevelAlso?: boolean): Promise<FeatureFlag>

Parâmetros

state

FeatureFlagPatch

Estado que deve ser definido

name

string

O nome da funcionalidade a alterar

userEmail

string

checkFeatureExists

boolean

Verifica se a funcionalidade existe antes de definir o estado

setAtApplicationLevelAlso

boolean

Devoluções

Promise<FeatureFlag>