FeatureAvailabilityRestClient class

Pacote:

azure-devops-extension-api

Classe base que deve ser usada (derivada de) para fazer solicitações para apis REST do VSS

Extends

RestClientBase

Construtores

FeatureAvailabilityRestClient(IVssRestClientOptions)

Métodos

getAllFeatureFlags(string)	Recuperar uma listagem de todos os sinalizadores de recursos e seus estados atuais para um usuário
getFeatureFlagByName(string, boolean)	Recuperar informações sobre um único sinalizador de recurso e seus estados atuais
getFeatureFlagByNameAndUserEmail(string, string, boolean)	Recuperar informações sobre um único sinalizador de recurso e seus estados atuais para um usuário
getFeatureFlagByNameAndUserId(string, string, boolean)	Recuperar informações sobre um único sinalizador de recurso e seus estados atuais para um usuário
updateFeatureFlag(FeatureFlagPatch, string, string, boolean, boolean)	Alterar o estado de um sinalizador de recurso individual para um nome

Detalhes do construtor

FeatureAvailabilityRestClient(IVssRestClientOptions)

new FeatureAvailabilityRestClient(options: IVssRestClientOptions)

Parâmetros

options

IVssRestClientOptions

Detalhes do método

getAllFeatureFlags(string)

Recuperar uma listagem de todos os sinalizadores de recursos e seus estados atuais para um usuário

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

Parâmetros

userEmail

string

O email do usuário para marcar

Retornos

Promise<FeatureFlag[]>

getFeatureFlagByName(string, boolean)

Recuperar informações sobre um único sinalizador de recurso e seus estados atuais

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

Parâmetros

name

string

O nome do recurso a ser recuperado

checkFeatureExists

boolean

Verificar se o recurso existe

Retornos

Promise<FeatureFlag>

getFeatureFlagByNameAndUserEmail(string, string, boolean)

Recuperar informações sobre um único sinalizador de recurso e seus estados atuais para um usuário

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

Parâmetros

name

string

O nome do recurso a ser recuperado

userEmail

string

O email do usuário para marcar

checkFeatureExists

boolean

Verificar se o recurso existe

Retornos

Promise<FeatureFlag>

getFeatureFlagByNameAndUserId(string, string, boolean)

Recuperar informações sobre um único sinalizador de recurso e seus estados atuais para um usuário

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

Parâmetros

name

string

O nome do recurso a ser recuperado

userId

string

A ID do usuário a ser marcar

checkFeatureExists

boolean

Verificar se o recurso existe

Retornos

Promise<FeatureFlag>

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

Alterar o estado de um sinalizador de recurso 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 do recurso a ser alterado

userEmail

string

checkFeatureExists

boolean

Verifica se o recurso existe antes de definir o estado

setAtApplicationLevelAlso

boolean

Retornos

Promise<FeatureFlag>