FeatureManagementRestClient class

الحزمة:

azure-devops-extension-api

الفئة الأساسية التي يجب استخدامها (مشتقة من) لتقديم طلبات إلى VSS REST apis

يمتد

RestClientBase

المنشئون

FeatureManagementRestClient(IVssRestClientOptions)

الأساليب

getFeature(string)	احصل على ميزة معينة من خلال معرفها
getFeatures(string)	احصل على قائمة بجميع الميزات المحددة
getFeatureState(string, string)	الحصول على حالة الميزة المحددة لنطاق المستخدم المحدد/جميع المستخدمين
getFeatureStateForScope(string, string, string, string)	الحصول على حالة الميزة المحددة للنطاق المسمى المحدد
queryFeatureStates(ContributedFeatureStateQuery)	الحصول على الحالة الفعالة لقائمة معرفات الميزات
queryFeatureStatesForDefaultScope(ContributedFeatureStateQuery, string)	الحصول على حالات الميزات المحددة للنطاق الافتراضي
queryFeatureStatesForNamedScope(ContributedFeatureStateQuery, string, string, string)	الحصول على حالات الميزات المحددة للنطاق المسمى المحدد
setFeatureState(ContributedFeatureState, string, string, string, string)	تعيين حالة المعلم
setFeatureStateForScope(ContributedFeatureState, string, string, string, string, string, string)	تعيين حالة المعلم في نطاق معين

تفاصيل المنشئ

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

المساهمة المستهدفة الاختيارية. إذا كانت فارغة/فارغة، فقم بإرجاع جميع الميزات. إذا تم تحديده، فقم بتضمين الميزات التي تستهدف المساهمة المحددة.

المرتجعات

Promise<ContributedFeature[]>

getFeatureState(string, string)

الحصول على حالة الميزة المحددة لنطاق المستخدم المحدد/جميع المستخدمين

function getFeatureState(featureId: string, userScope: string): Promise<ContributedFeatureState>

المعلمات

featureId

string

معرف المساهمة للميزة

userScope

string

User-Scope التي تحصل عليها القيمة. يجب أن يكون "أنا" للمستخدم الحالي أو "مضيف" لجميع المستخدمين.

المرتجعات

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 التي تحصل عليها القيمة. يجب أن يكون "أنا" للمستخدم الحالي أو "مضيف" لجميع المستخدمين.

scopeName

string

النطاق الذي يمكن من خلاله الحصول على إعداد الميزة (على سبيل المثال، "مشروع" أو "فريق")

scopeValue

string

قيمة النطاق (مثل معرف المشروع أو الفريق)

المرتجعات

Promise<ContributedFeatureState>

queryFeatureStates(ContributedFeatureStateQuery)

الحصول على الحالة الفعالة لقائمة معرفات الميزات

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

المعلمات

query

ContributedFeatureStateQuery

ميزات للاستعلام مع قيم النطاق الحالية

المرتجعات

Promise<ContributedFeatureStateQuery>

queryFeatureStatesForDefaultScope(ContributedFeatureStateQuery, string)

الحصول على حالات الميزات المحددة للنطاق الافتراضي

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

المعلمات

query

ContributedFeatureStateQuery

الاستعلام الذي يصف الميزات المطلوب الاستعلام عنها.

userScope

string

المرتجعات

Promise<ContributedFeatureStateQuery>

queryFeatureStatesForNamedScope(ContributedFeatureStateQuery, string, string, string)

الحصول على حالات الميزات المحددة للنطاق المسمى المحدد

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

المعلمات

query

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 لتعيين القيمة. يجب أن يكون "أنا" للمستخدم الحالي أو "مضيف" لجميع المستخدمين.

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 لتعيين القيمة. يجب أن يكون "أنا" للمستخدم الحالي أو "مضيف" لجميع المستخدمين.

scopeName

string

النطاق الذي يمكن من خلاله الحصول على إعداد الميزة (على سبيل المثال، "مشروع" أو "فريق")

scopeValue

string

قيمة النطاق (مثل معرف المشروع أو الفريق)

reason

string

سبب تغيير الحالة

reasonCode

string

رمز السبب القصير

المرتجعات

Promise<ContributedFeatureState>