FeatureAvailabilityRestClient class

Пакет:

azure-devops-extension-api

Базовый класс, который должен использоваться (производный от) для выполнения запросов к REST API VSS

Extends

RestClientBase

Конструкторы

FeatureAvailabilityRestClient(IVssRestClientOptions)

Методы

getAllFeatureFlags(string)	Получение списка всех флагов функций и их текущего состояния для пользователя
getFeatureFlagByName(string, boolean)	Получение сведений об одном флаге функции и его текущих состояниях
getFeatureFlagByNameAndUserEmail(string, string, boolean)	Получение сведений об одном флаге функции и его текущем состоянии для пользователя
getFeatureFlagByNameAndUserId(string, string, boolean)	Получение сведений об одном флаге функции и его текущем состоянии для пользователя
updateFeatureFlag(FeatureFlagPatch, string, string, boolean, boolean)	Изменение состояния флага отдельного компонента для имени

Сведения о конструкторе

FeatureAvailabilityRestClient(IVssRestClientOptions)

new FeatureAvailabilityRestClient(options: IVssRestClientOptions)

Параметры

options

IVssRestClientOptions

Сведения о методе

getAllFeatureFlags(string)

Получение списка всех флагов функций и их текущего состояния для пользователя

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

Параметры

userEmail

string

Адрес электронной почты пользователя для проверка

Возвращаемое значение

Promise<FeatureFlag[]>

getFeatureFlagByName(string, boolean)

Получение сведений об одном флаге функции и его текущих состояниях

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

Параметры

name

string

Имя извлекаемого компонента

checkFeatureExists

boolean

Проверка наличия функции

Возвращаемое значение

Promise<FeatureFlag>

getFeatureFlagByNameAndUserEmail(string, string, boolean)

Получение сведений об одном флаге функции и его текущем состоянии для пользователя

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

Параметры

name

string

Имя извлекаемого компонента

userEmail

string

Адрес электронной почты пользователя для проверка

checkFeatureExists

boolean

Проверка наличия функции

Возвращаемое значение

Promise<FeatureFlag>

getFeatureFlagByNameAndUserId(string, string, boolean)

Получение сведений об одном флаге функции и его текущем состоянии для пользователя

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

Параметры

name

string

Имя извлекаемого компонента

userId

string

Идентификатор пользователя для проверка

checkFeatureExists

boolean

Проверка наличия функции

Возвращаемое значение

Promise<FeatureFlag>

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

Изменение состояния флага отдельного компонента для имени

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

Параметры

state

FeatureFlagPatch

Состояние, которое должно быть задано

name

string

Имя изменяемой функции

userEmail

string

checkFeatureExists

boolean

Проверяет, существует ли функция, перед настройкой состояния

setAtApplicationLevelAlso

boolean

Возвращаемое значение

Promise<FeatureFlag>