FeatureManagementRestClient class

Balíček:

azure-devops-extension-api

Základní třída, která by se měla použít (odvozená) k provádění požadavků na rozhraní REST API služby VSS

Extends

RestClientBase

Konstruktory

FeatureManagementRestClient(IVssRestClientOptions)

Metody

getFeature(string)	Získání konkrétní funkce podle ID
getFeatures(string)	Získání seznamu všech definovaných funkcí
getFeatureState(string, string)	Získání stavu zadané funkce pro daný rozsah uživatele nebo všech uživatelů
getFeatureStateForScope(string, string, string, string)	Získání stavu zadané funkce pro daný pojmenovaný obor
queryFeatureStates(ContributedFeatureStateQuery)	Získání efektivního stavu pro seznam ID funkcí
queryFeatureStatesForDefaultScope(ContributedFeatureStateQuery, string)	Získání stavů zadaných funkcí pro výchozí obor
queryFeatureStatesForNamedScope(ContributedFeatureStateQuery, string, string, string)	Získání stavů zadaných funkcí pro konkrétní pojmenovaný obor
setFeatureState(ContributedFeatureState, string, string, string, string)	Nastavení stavu funkce
setFeatureStateForScope(ContributedFeatureState, string, string, string, string, string, string)	Nastavení stavu funkce v určitém oboru

Podrobnosti konstruktoru

FeatureManagementRestClient(IVssRestClientOptions)

new FeatureManagementRestClient(options: IVssRestClientOptions)

Parametry

options

IVssRestClientOptions

Podrobnosti metody

getFeature(string)

Získání konkrétní funkce podle ID

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

Parametry

featureId

string

ID příspěvku funkce

Návraty

Promise<ContributedFeature>

getFeatures(string)

Získání seznamu všech definovaných funkcí

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

Parametry

targetContributionId

string

Volitelný cílový příspěvek. Pokud je hodnota null/prázdná, vraťte všechny funkce. Pokud zadáte, uveďte funkce, které cílí na zadaný příspěvek.

Návraty

Promise<ContributedFeature[]>

getFeatureState(string, string)

Získání stavu zadané funkce pro daný rozsah uživatele nebo všech uživatelů

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

Parametry

featureId

string

ID příspěvku funkce

userScope

string

User-Scope, při kterém chcete získat hodnotu. Měl by být "já" pro aktuálního uživatele nebo "hostitele" pro všechny uživatele.

Návraty

Promise<ContributedFeatureState>

getFeatureStateForScope(string, string, string, string)

Získání stavu zadané funkce pro daný pojmenovaný obor

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

Parametry

featureId

string

ID příspěvku funkce

userScope

string

User-Scope, při kterém chcete získat hodnotu. Měl by být "já" pro aktuálního uživatele nebo "hostitele" pro všechny uživatele.

scopeName

string

Rozsah, ve kterém se má získat nastavení funkce (např. "projekt" nebo "tým")

scopeValue

string

Hodnota oboru (např. ID projektu nebo týmu)

Návraty

Promise<ContributedFeatureState>

queryFeatureStates(ContributedFeatureStateQuery)

Získání efektivního stavu pro seznam ID funkcí

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

Parametry

query

ContributedFeatureStateQuery

Funkce pro dotazování spolu s aktuálními hodnotami oboru

Návraty

Promise<ContributedFeatureStateQuery>

queryFeatureStatesForDefaultScope(ContributedFeatureStateQuery, string)

Získání stavů zadaných funkcí pro výchozí obor

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

Parametry

query

ContributedFeatureStateQuery

Dotaz popisující funkce, které se mají dotazovat.

userScope

string

Návraty

Promise<ContributedFeatureStateQuery>

queryFeatureStatesForNamedScope(ContributedFeatureStateQuery, string, string, string)

Získání stavů zadaných funkcí pro konkrétní pojmenovaný obor

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

Parametry

query

ContributedFeatureStateQuery

Dotaz popisující funkce, které se mají dotazovat.

userScope

string

scopeName

string

scopeValue

string

Návraty

Promise<ContributedFeatureStateQuery>

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

Nastavení stavu funkce

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

Parametry

feature

ContributedFeatureState

Publikováno stav objektu funkce. Měla by být zadána platná hodnota.

featureId

string

ID příspěvku funkce

userScope

string

User-Scope, na které chcete hodnotu nastavit. Měl by být "já" pro aktuálního uživatele nebo "hostitele" pro všechny uživatele.

reason

string

Důvod změny stavu

reasonCode

string

Krátký kód důvodu

Návraty

Promise<ContributedFeatureState>

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

Nastavení stavu funkce v určitém oboru

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

Parametry

feature

ContributedFeatureState

Publikováno stav objektu funkce. Měla by být zadána platná hodnota.

featureId

string

ID příspěvku funkce

userScope

string

User-Scope, na které chcete hodnotu nastavit. Měl by být "já" pro aktuálního uživatele nebo "hostitele" pro všechny uživatele.

scopeName

string

Rozsah, ve kterém se má získat nastavení funkce (např. "projekt" nebo "tým")

scopeValue

string

Hodnota oboru (např. ID projektu nebo týmu)

reason

string

Důvod změny stavu

reasonCode

string

Krátký kód důvodu

Návraty

Promise<ContributedFeatureState>