FeatureAvailabilityRestClient class
Basisklasse, die verwendet werden soll (abgeleitet von), um Anforderungen an VSS-REST-APIs zu stellen
- Extends
Konstruktoren
| Feature |
Methoden
| get |
Abrufen einer Liste aller Featureflags und ihres aktuellen Status für einen Benutzer |
| get |
Abrufen von Informationen zu einem einzelnen Feature-Flag und seinem aktuellen Status |
| get |
Abrufen von Informationen zu einem einzelnen Featureflag und seinem aktuellen Status für einen Benutzer |
| get |
Abrufen von Informationen zu einem einzelnen Featureflag und seinem aktuellen Status für einen Benutzer |
| update |
Ändern des Status eines einzelnen Featureflags für einen Namen |
Details zum Konstruktor
FeatureAvailabilityRestClient(IVssRestClientOptions)
new FeatureAvailabilityRestClient(options: IVssRestClientOptions)
Parameter
- options
- IVssRestClientOptions
Details zur Methode
getAllFeatureFlags(string)
Abrufen einer Liste aller Featureflags und ihres aktuellen Status für einen Benutzer
function getAllFeatureFlags(userEmail?: string): Promise<FeatureFlag[]>
Parameter
- userEmail
-
string
Die E-Mail-Adresse des Benutzers, der überprüft werden soll
Gibt zurück
Promise<FeatureFlag[]>
getFeatureFlagByName(string, boolean)
Abrufen von Informationen zu einem einzelnen Feature-Flag und seinem aktuellen Status
function getFeatureFlagByName(name: string, checkFeatureExists?: boolean): Promise<FeatureFlag>
Parameter
- name
-
string
Der Name des abzurufenden Features
- checkFeatureExists
-
boolean
Prüfen, ob Funktion vorhanden ist
Gibt zurück
Promise<FeatureFlag>
getFeatureFlagByNameAndUserEmail(string, string, boolean)
Abrufen von Informationen zu einem einzelnen Featureflag und seinem aktuellen Status für einen Benutzer
function getFeatureFlagByNameAndUserEmail(name: string, userEmail: string, checkFeatureExists?: boolean): Promise<FeatureFlag>
Parameter
- name
-
string
Der Name des abzurufenden Features
- userEmail
-
string
Die E-Mail-Adresse des Benutzers, der überprüft werden soll
- checkFeatureExists
-
boolean
Prüfen, ob Funktion vorhanden ist
Gibt zurück
Promise<FeatureFlag>
getFeatureFlagByNameAndUserId(string, string, boolean)
Abrufen von Informationen zu einem einzelnen Featureflag und seinem aktuellen Status für einen Benutzer
function getFeatureFlagByNameAndUserId(name: string, userId: string, checkFeatureExists?: boolean): Promise<FeatureFlag>
Parameter
- name
-
string
Der Name des abzurufenden Features
- userId
-
string
Die ID des Benutzers, der überprüft werden soll
- checkFeatureExists
-
boolean
Prüfen, ob Funktion vorhanden ist
Gibt zurück
Promise<FeatureFlag>
updateFeatureFlag(FeatureFlagPatch, string, string, boolean, boolean)
Ändern des Status eines einzelnen Featureflags für einen Namen
function updateFeatureFlag(state: FeatureFlagPatch, name: string, userEmail?: string, checkFeatureExists?: boolean, setAtApplicationLevelAlso?: boolean): Promise<FeatureFlag>
Parameter
- state
- FeatureFlagPatch
Angabe, der festgelegt werden sollte
- name
-
string
Der Name des zu ändernden Features
- userEmail
-
string
- checkFeatureExists
-
boolean
Überprüft, ob das Feature vorhanden ist, bevor der Status festgelegt wird
- setAtApplicationLevelAlso
-
boolean
Gibt zurück
Promise<FeatureFlag>