FeatureManagementRestClient class
Базовый класс, который должен использоваться (производный от) для выполнения запросов к REST API VSS
- Extends
Конструкторы
| Feature |
Методы
| get |
Получение определенной функции по идентификатору |
| get |
Получение списка всех определенных функций |
| get |
Получение состояния указанной функции для заданного пользователя или всех пользователей область |
| get |
Получение состояния указанного компонента для заданного именованного область |
| query |
Получение действующего состояния для списка идентификаторов компонентов |
| query |
Получение состояний указанных компонентов для область по умолчанию |
| query |
Получение состояний указанных признаков для конкретного именованного область |
| set |
Настройка состояния компонента |
| set |
Установка состояния компонента в определенном область |
Сведения о конструкторе
FeatureManagementRestClient(IVssRestClientOptions)
new FeatureManagementRestClient(options: IVssRestClientOptions)Параметры
- options
- IVssRestClientOptions
Сведения о методе
getFeature(string)
Получение определенной функции по идентификатору
function getFeature(featureId: string): Promise<ContributedFeature>Параметры
- featureId
-
string
Идентификатор вклада функции
Возвращаемое значение
Promise<ContributedFeature>
getFeatures(string)
Получение списка всех определенных функций
function getFeatures(targetContributionId?: string): Promise<ContributedFeature[]>Параметры
- targetContributionId
-
string
Необязательный целевой вклад. Если значение равно null или пусто, возвращаются все функции. Если указано, включите функции, предназначенные для указанного вклада.
Возвращаемое значение
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>