FeatureAvailabilityRestClient class

Pakiet:

azure-devops-extension-api

Klasa podstawowa, która powinna być używana (pochodna) do tworzenia żądań do interfejsów API REST usługi VSS

Extends

RestClientBase

Konstruktory

FeatureAvailabilityRestClient(IVssRestClientOptions)

Metody

getAllFeatureFlags(string)	Pobieranie listy wszystkich flag funkcji i ich bieżących stanów dla użytkownika
getFeatureFlagByName(string, boolean)	Pobieranie informacji o jednej flagi funkcji i jej bieżących stanach
getFeatureFlagByNameAndUserEmail(string, string, boolean)	Pobieranie informacji na temat pojedynczej flagi funkcji i jej bieżących stanów dla użytkownika
getFeatureFlagByNameAndUserId(string, string, boolean)	Pobieranie informacji na temat pojedynczej flagi funkcji i jej bieżących stanów dla użytkownika
updateFeatureFlag(FeatureFlagPatch, string, string, boolean, boolean)	Zmienianie stanu pojedynczej flagi funkcji dla nazwy

Szczegóły konstruktora

FeatureAvailabilityRestClient(IVssRestClientOptions)

new FeatureAvailabilityRestClient(options: IVssRestClientOptions)

Parametry

options

IVssRestClientOptions

Szczegóły metody

getAllFeatureFlags(string)

Pobieranie listy wszystkich flag funkcji i ich bieżących stanów dla użytkownika

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

Parametry

userEmail

string

Adres e-mail użytkownika do sprawdzenia

Zwraca

Promise<FeatureFlag[]>

getFeatureFlagByName(string, boolean)

Pobieranie informacji o jednej flagi funkcji i jej bieżących stanach

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

Parametry

name

string

Nazwa funkcji do pobrania

checkFeatureExists

boolean

Sprawdzanie, czy funkcja istnieje

Zwraca

Promise<FeatureFlag>

getFeatureFlagByNameAndUserEmail(string, string, boolean)

Pobieranie informacji na temat pojedynczej flagi funkcji i jej bieżących stanów dla użytkownika

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

Parametry

name

string

Nazwa funkcji do pobrania

userEmail

string

Adres e-mail użytkownika do sprawdzenia

checkFeatureExists

boolean

Sprawdzanie, czy funkcja istnieje

Zwraca

Promise<FeatureFlag>

getFeatureFlagByNameAndUserId(string, string, boolean)

Pobieranie informacji na temat pojedynczej flagi funkcji i jej bieżących stanów dla użytkownika

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

Parametry

name

string

Nazwa funkcji do pobrania

userId

string

Identyfikator użytkownika do sprawdzenia

checkFeatureExists

boolean

Sprawdzanie, czy funkcja istnieje

Zwraca

Promise<FeatureFlag>

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

Zmienianie stanu pojedynczej flagi funkcji dla nazwy

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

Parametry

state

FeatureFlagPatch

Stan, który należy ustawić

name

string

Nazwa funkcji do zmiany

userEmail

string

checkFeatureExists

boolean

Sprawdza, czy funkcja istnieje przed ustawieniem stanu

setAtApplicationLevelAlso

boolean

Zwraca

Promise<FeatureFlag>