FeatureManagementRestClient class
Базовый класс, который должен использоваться (производный) для выполнения запросов к VSS REST API
- Extends
Конструкторы
| Feature |
Методы
| get |
Получить конкретную функцию по ее id |
| get |
Получите список всех определенных функций |
| get |
Получение состояния указанной функции для заданной области пользователя или всех пользователей |
| get |
Получение состояния указанной функции для заданной именованной области |
| query |
Получение эффективного состояния для списка идентификаторов функций |
| query |
Получение состояний указанных функций для области по умолчанию |
| query |
Получение состояний указанных функций для конкретной именованной области |
| set |
Настройка состояния функции |
| set |
Задание состояния функции в определенной области |
Сведения о конструкторе
FeatureManagementRestClient(IVssRestClientOptions)
new FeatureManagementRestClient(options: IVssRestClientOptions)Параметры
- options
- IVssRestClientOptions
Сведения о методе
getFeature(string)
Получить конкретную функцию по ее id
function getFeature(featureId: string): Promise<ContributedFeature>Параметры
- featureId
-
string
Идентификатор вклада функции
Возвращаемое значение
Promise<ContributedFeature>
getFeatures(string)
Получите список всех определенных функций
function getFeatures(targetContributionId?: string): Promise<ContributedFeature[]>Параметры
- targetContributionId
-
string
Необязательный целевой взнос. Если null/empty, возвращаются все объекты. Если указано, включите функции, предназначенные для указанного вклада.
Возвращаемое значение
Promise<ContributedFeature[]>
getFeatureState(string, string)
Получение состояния указанной функции для заданной области пользователя или всех пользователей
function getFeatureState(featureId: string, userScope: string): Promise<ContributedFeatureState>Параметры
- featureId
-
string
Идентификатор вклада функции
- userScope
-
string
User-Scope, при котором получить значение. Должно быть "me" для текущего пользователя или "host" для всех пользователей.
Возвращаемое значение
Promise<ContributedFeatureState>
getFeatureStateForScope(string, string, string, string)
Получение состояния указанной функции для заданной именованной области
function getFeatureStateForScope(featureId: string, userScope: string, scopeName: string, scopeValue: string): Promise<ContributedFeatureState>Параметры
- featureId
-
string
Идентификатор вклада функции
- userScope
-
string
User-Scope, при котором получить значение. Должно быть "me" для текущего пользователя или "host" для всех пользователей.
- scopeName
-
string
Область, в которой можно получить настройку функции (например, "проект" или "команда")
- scopeValue
-
string
Значение области действия (например, идентификатор проекта или команды)
Возвращаемое значение
Promise<ContributedFeatureState>
queryFeatureStates(ContributedFeatureStateQuery)
Получение эффективного состояния для списка идентификаторов функций
function queryFeatureStates(query: ContributedFeatureStateQuery): Promise<ContributedFeatureStateQuery>Параметры
Функции для запроса вместе с текущими значениями области
Возвращаемое значение
Promise<ContributedFeatureStateQuery>
queryFeatureStatesForDefaultScope(ContributedFeatureStateQuery, string)
Получение состояний указанных функций для области по умолчанию
function queryFeatureStatesForDefaultScope(query: ContributedFeatureStateQuery, userScope: string): Promise<ContributedFeatureStateQuery>Параметры
Запрос с описанием запрашиваемых функций.
- userScope
-
string
Возвращаемое значение
Promise<ContributedFeatureStateQuery>
queryFeatureStatesForNamedScope(ContributedFeatureStateQuery, string, string, string)
Получение состояний указанных функций для конкретной именованной области
function queryFeatureStatesForNamedScope(query: ContributedFeatureStateQuery, userScope: string, scopeName: string, scopeValue: string): Promise<ContributedFeatureStateQuery>Параметры
Запрос с описанием запрашиваемых функций.
- userScope
-
string
- scopeName
-
string
- scopeValue
-
string
Возвращаемое значение
Promise<ContributedFeatureStateQuery>
setFeatureState(ContributedFeatureState, string, string, string, string)
Настройка состояния функции
function setFeatureState(feature: ContributedFeatureState, featureId: string, userScope: string, reason?: string, reasonCode?: string): Promise<ContributedFeatureState>Параметры
- feature
- ContributedFeatureState
Опубликованный объект состояния функции. Следует указать эффективное значение.
- featureId
-
string
Идентификатор вклада функции
- userScope
-
string
User-Scope, на котором следует задать значение. Должно быть "me" для текущего пользователя или "host" для всех пользователей.
- reason
-
string
Причина изменения состояния
- reasonCode
-
string
Короткий код причины
Возвращаемое значение
Promise<ContributedFeatureState>
setFeatureStateForScope(ContributedFeatureState, string, string, string, string, string, string)
Задание состояния функции в определенной области
function setFeatureStateForScope(feature: ContributedFeatureState, featureId: string, userScope: string, scopeName: string, scopeValue: string, reason?: string, reasonCode?: string): Promise<ContributedFeatureState>Параметры
- feature
- ContributedFeatureState
Опубликованный объект состояния функции. Следует указать эффективное значение.
- featureId
-
string
Идентификатор вклада функции
- userScope
-
string
User-Scope, на котором следует задать значение. Должно быть "me" для текущего пользователя или "host" для всех пользователей.
- scopeName
-
string
Область, в которой можно получить настройку функции (например, "проект" или "команда")
- scopeValue
-
string
Значение области действия (например, идентификатор проекта или команды)
- reason
-
string
Причина изменения состояния
- reasonCode
-
string
Короткий код причины
Возвращаемое значение
Promise<ContributedFeatureState>