FeatureAvailabilityRestClient class

Paket:

azure-devops-extension-api

Basklass som ska användas (härledd från) för att göra begäranden till VSS REST-API:er

Extends

RestClientBase

Konstruktorer

FeatureAvailabilityRestClient(IVssRestClientOptions)

Metoder

getAllFeatureFlags(string)	Hämta en lista över alla funktionsflaggor och deras aktuella tillstånd för en användare
getFeatureFlagByName(string, boolean)	Hämta information om en enskild funktionsflagga och dess aktuella tillstånd
getFeatureFlagByNameAndUserEmail(string, string, boolean)	Hämta information om en enskild funktionsflagga och dess aktuella tillstånd för en användare
getFeatureFlagByNameAndUserId(string, string, boolean)	Hämta information om en enskild funktionsflagga och dess aktuella tillstånd för en användare
updateFeatureFlag(FeatureFlagPatch, string, string, boolean, boolean)	Ändra tillståndet för en enskild funktionsflagga för ett namn

Konstruktorinformation

FeatureAvailabilityRestClient(IVssRestClientOptions)

new FeatureAvailabilityRestClient(options: IVssRestClientOptions)

Parametrar

options

IVssRestClientOptions

Metodinformation

getAllFeatureFlags(string)

Hämta en lista över alla funktionsflaggor och deras aktuella tillstånd för en användare

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

Parametrar

userEmail

string

E-postadressen till användaren som ska kontrolleras

Returer

Promise<FeatureFlag[]>

getFeatureFlagByName(string, boolean)

Hämta information om en enskild funktionsflagga och dess aktuella tillstånd

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

Parametrar

name

string

Namnet på funktionen som ska hämtas

checkFeatureExists

boolean

Kontrollera om funktionen finns

Returer

Promise<FeatureFlag>

getFeatureFlagByNameAndUserEmail(string, string, boolean)

Hämta information om en enskild funktionsflagga och dess aktuella tillstånd för en användare

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

Parametrar

name

string

Namnet på funktionen som ska hämtas

userEmail

string

E-postadressen till användaren som ska kontrolleras

checkFeatureExists

boolean

Kontrollera om funktionen finns

Returer

Promise<FeatureFlag>

getFeatureFlagByNameAndUserId(string, string, boolean)

Hämta information om en enskild funktionsflagga och dess aktuella tillstånd för en användare

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

Parametrar

name

string

Namnet på funktionen som ska hämtas

userId

string

ID:t för den användare som ska kontrolleras

checkFeatureExists

boolean

Kontrollera om funktionen finns

Returer

Promise<FeatureFlag>

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

Ändra tillståndet för en enskild funktionsflagga för ett namn

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

Parametrar

state

FeatureFlagPatch

Tillstånd som ska ställas in

name

string

Namnet på funktionen som ska ändras

userEmail

string

checkFeatureExists

boolean

Kontrollerar om funktionen finns innan du anger tillståndet

setAtApplicationLevelAlso

boolean

Returer

Promise<FeatureFlag>