FeatureAvailabilityRestClient class
應該使用 (衍生自) 的基類，向 VSS REST API 提出要求
- Extends
建構函式
| Feature |
方法
| get |
擷取使用者的所有功能旗標及其目前狀態的清單 |
| get |
擷取單一功能旗標及其目前狀態的相關資訊 |
| get |
擷取單一功能旗標及其使用者目前狀態的相關資訊 |
| get |
擷取單一功能旗標及其使用者目前狀態的相關資訊 |
| update |
變更名稱的個別功能旗標狀態 |
建構函式詳細資料
FeatureAvailabilityRestClient(IVssRestClientOptions)
方法詳細資料
getAllFeatureFlags(string)
擷取使用者的所有功能旗標及其目前狀態的清單
function getAllFeatureFlags(userEmail?: string): Promise<FeatureFlag[]>參數
- userEmail
-
string
要檢查的使用者電子郵件
傳回
Promise<FeatureFlag[]>
getFeatureFlagByName(string, boolean)
擷取單一功能旗標及其目前狀態的相關資訊
function getFeatureFlagByName(name: string, checkFeatureExists?: boolean): Promise<FeatureFlag>參數
- name
-
string
要擷取的功能名稱
- checkFeatureExists
-
boolean
檢查功能是否存在
傳回
Promise<FeatureFlag>
getFeatureFlagByNameAndUserEmail(string, string, boolean)
擷取單一功能旗標及其使用者目前狀態的相關資訊
function getFeatureFlagByNameAndUserEmail(name: string, userEmail: string, checkFeatureExists?: boolean): Promise<FeatureFlag>參數
- name
-
string
要擷取的功能名稱
- userEmail
-
string
要檢查的使用者電子郵件
- checkFeatureExists
-
boolean
檢查功能是否存在
傳回
Promise<FeatureFlag>
getFeatureFlagByNameAndUserId(string, string, boolean)
擷取單一功能旗標及其使用者目前狀態的相關資訊
function getFeatureFlagByNameAndUserId(name: string, userId: string, checkFeatureExists?: boolean): Promise<FeatureFlag>參數
- name
-
string
要擷取的功能名稱
- userId
-
string
要檢查的使用者識別碼
- checkFeatureExists
-
boolean
檢查功能是否存在
傳回
Promise<FeatureFlag>
updateFeatureFlag(FeatureFlagPatch, string, string, boolean, boolean)
變更名稱的個別功能旗標狀態
function updateFeatureFlag(state: FeatureFlagPatch, name: string, userEmail?: string, checkFeatureExists?: boolean, setAtApplicationLevelAlso?: boolean): Promise<FeatureFlag>參數
- state
- FeatureFlagPatch
應設定的狀態
- name
-
string
要變更的功能名稱
- userEmail
-
string
- checkFeatureExists
-
boolean
在設定狀態之前檢查功能是否存在
- setAtApplicationLevelAlso
-
boolean
傳回
Promise<FeatureFlag>