Aracılığıyla paylaş


FeatureManagementRestClient class

VSS REST API'lerine istekte bulunmak için kullanılması gereken (türetilen) temel sınıf

Extends

Oluşturucular

FeatureManagementRestClient(IVssRestClientOptions)

Yöntemler

getFeature(string)

Belirli bir özelliği kimliğine göre alma

getFeatures(string)

Tüm tanımlı özelliklerin listesini alma

getFeatureState(string, string)

Belirtilen kullanıcı/tüm kullanıcılar kapsamı için belirtilen özelliğin durumunu alma

getFeatureStateForScope(string, string, string, string)

Belirtilen adlandırılmış kapsam için belirtilen özelliğin durumunu alma

queryFeatureStates(ContributedFeatureStateQuery)

Özellik kimlikleri listesi için geçerli durumu alma

queryFeatureStatesForDefaultScope(ContributedFeatureStateQuery, string)

Varsayılan kapsam için belirtilen özelliklerin durumlarını alma

queryFeatureStatesForNamedScope(ContributedFeatureStateQuery, string, string, string)

Belirli adlandırılmış kapsam için belirtilen özelliklerin durumlarını alma

setFeatureState(ContributedFeatureState, string, string, string, string)

Özelliğin durumunu ayarlama

setFeatureStateForScope(ContributedFeatureState, string, string, string, string, string, string)

Bir özelliğin durumunu belirli bir kapsamda ayarlama

Oluşturucu Ayrıntıları

FeatureManagementRestClient(IVssRestClientOptions)

new FeatureManagementRestClient(options: IVssRestClientOptions)

Parametreler

Yöntem Ayrıntıları

getFeature(string)

Belirli bir özelliği kimliğine göre alma

function getFeature(featureId: string): Promise<ContributedFeature>

Parametreler

featureId

string

Özelliğin katkı kimliği

Döndürülenler

getFeatures(string)

Tüm tanımlı özelliklerin listesini alma

function getFeatures(targetContributionId?: string): Promise<ContributedFeature[]>

Parametreler

targetContributionId

string

İsteğe bağlı hedef katkı. Null/boşsa, tüm özellikleri döndür. Belirtilirse, belirtilen katkıyı hedefleyen özellikleri içerir.

Döndürülenler

Promise<ContributedFeature[]>

getFeatureState(string, string)

Belirtilen 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ğerin alındığı User-Scope. Geçerli kullanıcı için "ben" veya tüm kullanıcılar için "konak" olmalıdır.

Döndürülenler

getFeatureStateForScope(string, string, string, string)

Belirtilen adlandırılmış kapsam için belirtilen özelliğin durumunu alma

function getFeatureStateForScope(featureId: string, userScope: string, scopeName: string, scopeValue: string): Promise<ContributedFeatureState>

Parametreler

featureId

string

Özelliğin katkı kimliği

userScope

string

Değerin alındığı User-Scope. Geçerli kullanıcı için "ben" veya tüm kullanıcılar için "konak" olmalıdır.

scopeName

string

için özellik ayarının alındığı kapsam (örn. "proje" veya "ekip")

scopeValue

string

Kapsamın değeri (örneğin, proje veya ekip kimliği)

Döndürülenler

queryFeatureStates(ContributedFeatureStateQuery)

Özellik kimlikleri listesi için geçerli durumu alma

function queryFeatureStates(query: ContributedFeatureStateQuery): Promise<ContributedFeatureStateQuery>

Parametreler

query
ContributedFeatureStateQuery

Geçerli kapsam değerleriyle birlikte sorguya yönelik özellikler

Döndürülenler

queryFeatureStatesForDefaultScope(ContributedFeatureStateQuery, string)

Varsayılan kapsam için belirtilen özelliklerin durumlarını alma

function queryFeatureStatesForDefaultScope(query: ContributedFeatureStateQuery, userScope: string): Promise<ContributedFeatureStateQuery>

Parametreler

query
ContributedFeatureStateQuery

Sorgu için özellikleri açıklayan sorgu.

userScope

string

Döndürülenler

queryFeatureStatesForNamedScope(ContributedFeatureStateQuery, string, string, string)

Belirli adlandırılmış kapsam için belirtilen özelliklerin durumlarını alma

function queryFeatureStatesForNamedScope(query: ContributedFeatureStateQuery, userScope: string, scopeName: string, scopeValue: string): Promise<ContributedFeatureStateQuery>

Parametreler

query
ContributedFeatureStateQuery

Sorgu için özellikleri açıklayan sorgu.

userScope

string

scopeName

string

scopeValue

string

Döndürülenler

setFeatureState(ContributedFeatureState, string, string, string, string)

Özelliğin durumunu ayarlama

function setFeatureState(feature: ContributedFeatureState, featureId: string, userScope: string, reason?: string, reasonCode?: string): Promise<ContributedFeatureState>

Parametreler

feature
ContributedFeatureState

Postalanan özellik durumu nesnesi. Geçerli 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 "konak" olmalıdır.

reason

string

Durumu değiştirme nedeni

reasonCode

string

Kısa neden kodu

Döndürülenler

setFeatureStateForScope(ContributedFeatureState, string, string, string, string, string, string)

Bir özelliğin durumunu belirli bir kapsamda ayarlama

function setFeatureStateForScope(feature: ContributedFeatureState, featureId: string, userScope: string, scopeName: string, scopeValue: string, reason?: string, reasonCode?: string): Promise<ContributedFeatureState>

Parametreler

feature
ContributedFeatureState

Postalanan özellik durumu nesnesi. Geçerli 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 "konak" olmalıdır.

scopeName

string

için özellik ayarının alındığı kapsam (örn. "proje" veya "ekip")

scopeValue

string

Kapsamın değeri (örneğin, proje veya ekip kimliği)

reason

string

Durumu değiştirme nedeni

reasonCode

string

Kısa neden kodu

Döndürülenler