FeatureManagementRestClient class
VSS REST api'lerine istekte bulunmak için kullanılması gereken (türetilen) temel sınıf
- Extends
Oluşturucular
| Feature |
Yöntemler
| get |
Kimliğine göre belirli bir özelliği alın |
| get |
Tanımlanmış tüm özelliklerin bir listesini alın |
| get |
Belirli bir kullanıcı/tüm kullanıcılar kapsamı için belirtilen özelliğin durumunu alma |
| get |
Verilen adlandırılmış kapsam için belirtilen özelliğin durumunu alın |
| query |
Özellik kimliklerinin bir listesi için geçerli durumu alma |
| query |
Varsayılan kapsam için belirtilen özelliklerin durumlarını alma |
| query |
Belirli bir adlandırılmış kapsam için belirtilen özelliklerin durumlarını alma |
| set |
Bir özelliğin durumunu ayarlama |
| set |
Belirli bir kapsamdaki bir özelliğin durumunu ayarlama |
Oluşturucu Ayrıntıları
FeatureManagementRestClient(IVssRestClientOptions)
new FeatureManagementRestClient(options: IVssRestClientOptions)Parametreler
- options
- IVssRestClientOptions
Yöntem Ayrıntıları
getFeature(string)
Kimliğine göre belirli bir özelliği alın
function getFeature(featureId: string): Promise<ContributedFeature>Parametreler
- featureId
-
string
Özelliğin katkı kimliği
Döndürülenler
Promise<ContributedFeature>
getFeatures(string)
Tanımlanmış tüm özelliklerin bir listesini alın
function getFeatures(targetContributionId?: string): Promise<ContributedFeature[]>Parametreler
- targetContributionId
-
string
İsteğe bağlı hedef katkı. Boş/boş ise, tüm özellikleri döndürün. Belirtilirse, belirtilen katkıyı hedefleyen özellikleri dahil edin.
Döndürülenler
Promise<ContributedFeature[]>
getFeatureState(string, string)
Belirli bir kullanıcı/tüm kullanıcılar kapsamı için belirtilen özelliğin durumunu alma
function getFeatureState(featureId: string, userScope: string): Promise<ContributedFeatureState>Parametreler
- featureId
-
string
Özelliğin katkı kimliği
- userScope
-
string
Değeri elde etmek için User-Scope. Geçerli kullanıcı için "ben" veya tüm kullanıcılar için "ana bilgisayar" olmalıdır.
Döndürülenler
Promise<ContributedFeatureState>
getFeatureStateForScope(string, string, string, string)
Verilen adlandırılmış kapsam için belirtilen özelliğin durumunu alın
function getFeatureStateForScope(featureId: string, userScope: string, scopeName: string, scopeValue: string): Promise<ContributedFeatureState>Parametreler
- featureId
-
string
Özelliğin katkı kimliği
- userScope
-
string
Değeri elde etmek için User-Scope. Geçerli kullanıcı için "ben" veya tüm kullanıcılar için "ana bilgisayar" olmalıdır.
- scopeName
-
string
Özellik ayarının alınacağı kapsam (ör. "proje" veya "ekip")
- scopeValue
-
string
Kapsamın değeri (ör. proje veya ekip kimliği)
Döndürülenler
Promise<ContributedFeatureState>
queryFeatureStates(ContributedFeatureStateQuery)
Özellik kimliklerinin bir listesi için geçerli durumu alma
function queryFeatureStates(query: ContributedFeatureStateQuery): Promise<ContributedFeatureStateQuery>Parametreler
Geçerli kapsam değerleriyle birlikte sorgulanacak özellikler
Döndürülenler
Promise<ContributedFeatureStateQuery>
queryFeatureStatesForDefaultScope(ContributedFeatureStateQuery, string)
Varsayılan kapsam için belirtilen özelliklerin durumlarını alma
function queryFeatureStatesForDefaultScope(query: ContributedFeatureStateQuery, userScope: string): Promise<ContributedFeatureStateQuery>Parametreler
Sorgulanacak özellikleri açıklayan sorgu.
- userScope
-
string
Döndürülenler
Promise<ContributedFeatureStateQuery>
queryFeatureStatesForNamedScope(ContributedFeatureStateQuery, string, string, string)
Belirli bir adlandırılmış kapsam için belirtilen özelliklerin durumlarını alma
function queryFeatureStatesForNamedScope(query: ContributedFeatureStateQuery, userScope: string, scopeName: string, scopeValue: string): Promise<ContributedFeatureStateQuery>Parametreler
Sorgulanacak özellikleri açıklayan sorgu.
- userScope
-
string
- scopeName
-
string
- scopeValue
-
string
Döndürülenler
Promise<ContributedFeatureStateQuery>
setFeatureState(ContributedFeatureState, string, string, string, string)
Bir özelliğin durumunu ayarlama
function setFeatureState(feature: ContributedFeatureState, featureId: string, userScope: string, reason?: string, reasonCode?: string): Promise<ContributedFeatureState>Parametreler
- feature
- ContributedFeatureState
Gönderilen özellik durumu nesnesi. Efektif değeri belirtmelidir.
- featureId
-
string
Özelliğin katkı kimliği
- userScope
-
string
Değerin ayarlanacağı User-Scope. Geçerli kullanıcı için "ben" veya tüm kullanıcılar için "ana bilgisayar" olmalıdır.
- reason
-
string
Durumu değiştirme nedeni
- reasonCode
-
string
Kısa neden kodu
Döndürülenler
Promise<ContributedFeatureState>
setFeatureStateForScope(ContributedFeatureState, string, string, string, string, string, string)
Belirli bir kapsamdaki bir özelliğin durumunu ayarlama
function setFeatureStateForScope(feature: ContributedFeatureState, featureId: string, userScope: string, scopeName: string, scopeValue: string, reason?: string, reasonCode?: string): Promise<ContributedFeatureState>Parametreler
- feature
- ContributedFeatureState
Gönderilen özellik durumu nesnesi. Efektif değeri belirtmelidir.
- featureId
-
string
Özelliğin katkı kimliği
- userScope
-
string
Değerin ayarlanacağı User-Scope. Geçerli kullanıcı için "ben" veya tüm kullanıcılar için "ana bilgisayar" olmalıdır.
- scopeName
-
string
Özellik ayarının alınacağı kapsam (ör. "proje" veya "ekip")
- scopeValue
-
string
Kapsamın değeri (ör. proje veya ekip kimliği)
- reason
-
string
Durumu değiştirme nedeni
- reasonCode
-
string
Kısa neden kodu
Döndürülenler
Promise<ContributedFeatureState>