FeatureAvailabilityRestClient class

Balíček:

azure-devops-extension-api

Základní třída, která by se měla použít (odvozená) k provádění požadavků na rozhraní REST služby VSS

Extends

RestClientBase

Konstruktory

FeatureAvailabilityRestClient(IVssRestClientOptions)

Metody

getAllFeatureFlags(string)	Načtení seznamu všech příznaků funkcí a jejich aktuálních stavů pro uživatele
getFeatureFlagByName(string, boolean)	Načtení informací o jednom příznaku funkce a jejích aktuálních stavech
getFeatureFlagByNameAndUserEmail(string, string, boolean)	Načtení informací o jednom příznaku funkce a jeho aktuálních stavech pro uživatele
getFeatureFlagByNameAndUserId(string, string, boolean)	Načtení informací o jednom příznaku funkce a jeho aktuálních stavech pro uživatele
updateFeatureFlag(FeatureFlagPatch, string, string, boolean, boolean)	Změna stavu jednotlivého příznaku funkce pro název

Podrobnosti konstruktoru

FeatureAvailabilityRestClient(IVssRestClientOptions)

new FeatureAvailabilityRestClient(options: IVssRestClientOptions)

Parametry

options

IVssRestClientOptions

Podrobnosti metody

getAllFeatureFlags(string)

Načtení seznamu všech příznaků funkcí a jejich aktuálních stavů pro uživatele

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

Parametry

userEmail

string

E-mail uživatele, který má zkontrolovat

Návraty

Promise<FeatureFlag[]>

getFeatureFlagByName(string, boolean)

Načtení informací o jednom příznaku funkce a jejích aktuálních stavech

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

Parametry

name

string

Název funkce, která se má načíst

checkFeatureExists

boolean

Kontrola, jestli funkce existuje

Návraty

Promise<FeatureFlag>

getFeatureFlagByNameAndUserEmail(string, string, boolean)

Načtení informací o jednom příznaku funkce a jeho aktuálních stavech pro uživatele

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

Parametry

name

string

Název funkce, která se má načíst

userEmail

string

E-mail uživatele, který má zkontrolovat

checkFeatureExists

boolean

Kontrola, jestli funkce existuje

Návraty

Promise<FeatureFlag>

getFeatureFlagByNameAndUserId(string, string, boolean)

Načtení informací o jednom příznaku funkce a jeho aktuálních stavech pro uživatele

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

Parametry

name

string

Název funkce, která se má načíst

userId

string

ID uživatele, který se má zkontrolovat

checkFeatureExists

boolean

Kontrola, jestli funkce existuje

Návraty

Promise<FeatureFlag>

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

Změna stavu jednotlivého příznaku funkce pro název

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

Parametry

state

FeatureFlagPatch

Stav, který by se měl nastavit

name

string

Název funkce, kterou chcete změnit

userEmail

string

checkFeatureExists

boolean

Před nastavením stavu zkontroluje, jestli funkce existuje.

setAtApplicationLevelAlso

boolean

Návraty

Promise<FeatureFlag>