Compartir a través de


FeatureAvailabilityRestClient class

Clase base que se debe usar (derivada de) para realizar solicitudes a las API REST de VSS

Extends

Constructores

FeatureAvailabilityRestClient(IVssRestClientOptions)

Métodos

getAllFeatureFlags(string)

Recuperar una lista de todas las marcas de características y sus estados actuales para un usuario

getFeatureFlagByName(string, boolean)

Recuperar información sobre una sola marca de característica y sus estados actuales

getFeatureFlagByNameAndUserEmail(string, string, boolean)

Recuperar información sobre una sola marca de característica y sus estados actuales para un usuario

getFeatureFlagByNameAndUserId(string, string, boolean)

Recuperar información sobre una sola marca de característica y sus estados actuales para un usuario

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

Cambiar el estado de una marca de característica individual para un nombre

Detalles del constructor

FeatureAvailabilityRestClient(IVssRestClientOptions)

new FeatureAvailabilityRestClient(options: IVssRestClientOptions)

Parámetros

Detalles del método

getAllFeatureFlags(string)

Recuperar una lista de todas las marcas de características y sus estados actuales para un usuario

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

Parámetros

userEmail

string

Correo electrónico del usuario que se va a comprobar

Devoluciones

Promise<FeatureFlag[]>

getFeatureFlagByName(string, boolean)

Recuperar información sobre una sola marca de característica y sus estados actuales

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

Parámetros

name

string

Nombre de la característica que se va a recuperar

checkFeatureExists

boolean

Comprobación de si existe una característica

Devoluciones

Promise<FeatureFlag>

getFeatureFlagByNameAndUserEmail(string, string, boolean)

Recuperar información sobre una sola marca de característica y sus estados actuales para un usuario

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

Parámetros

name

string

Nombre de la característica que se va a recuperar

userEmail

string

Correo electrónico del usuario que se va a comprobar

checkFeatureExists

boolean

Comprobación de si existe una característica

Devoluciones

Promise<FeatureFlag>

getFeatureFlagByNameAndUserId(string, string, boolean)

Recuperar información sobre una sola marca de característica y sus estados actuales para un usuario

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

Parámetros

name

string

Nombre de la característica que se va a recuperar

userId

string

Identificador del usuario que se va a comprobar

checkFeatureExists

boolean

Comprobación de si existe una característica

Devoluciones

Promise<FeatureFlag>

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

Cambiar el estado de una marca de característica individual para un nombre

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

Parámetros

state
FeatureFlagPatch

Estado que se debe establecer

name

string

Nombre de la característica que se va a cambiar

userEmail

string

checkFeatureExists

boolean

Comprueba si la característica existe antes de establecer el estado.

setAtApplicationLevelAlso

boolean

Devoluciones

Promise<FeatureFlag>