FeatureAvailabilityRestClient class

Пакет:

azure-devops-extension-api

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

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>