FeatureAvailabilityRestClient class
Classe de base qui doit être utilisée (dérivée de) pour effectuer des requêtes à des API REST VSS
- Extends
Constructeurs
| Feature |
Méthodes
| get |
Récupérer une liste de tous les indicateurs de fonctionnalité et de leurs états actuels pour un utilisateur |
| get |
Récupérer des informations sur un indicateur de fonctionnalité unique et ses états actuels |
| get |
Récupérer des informations sur un indicateur de fonctionnalité unique et ses états actuels pour un utilisateur |
| get |
Récupérer des informations sur un indicateur de fonctionnalité unique et ses états actuels pour un utilisateur |
| update |
Modifier l’état d’un indicateur de fonction individuel pour un nom |
Détails du constructeur
FeatureAvailabilityRestClient(IVssRestClientOptions)
new FeatureAvailabilityRestClient(options: IVssRestClientOptions)
Paramètres
- options
- IVssRestClientOptions
Détails de la méthode
getAllFeatureFlags(string)
Récupérer une liste de tous les indicateurs de fonctionnalité et de leurs états actuels pour un utilisateur
function getAllFeatureFlags(userEmail?: string): Promise<FeatureFlag[]>
Paramètres
- userEmail
-
string
L’email de l’utilisateur à vérifier
Retours
Promise<FeatureFlag[]>
getFeatureFlagByName(string, boolean)
Récupérer des informations sur un indicateur de fonctionnalité unique et ses états actuels
function getFeatureFlagByName(name: string, checkFeatureExists?: boolean): Promise<FeatureFlag>
Paramètres
- name
-
string
Le nom de l’entité à récupérer
- checkFeatureExists
-
boolean
Vérifier si la fonctionnalité existe
Retours
Promise<FeatureFlag>
getFeatureFlagByNameAndUserEmail(string, string, boolean)
Récupérer des informations sur un indicateur de fonctionnalité unique et ses états actuels pour un utilisateur
function getFeatureFlagByNameAndUserEmail(name: string, userEmail: string, checkFeatureExists?: boolean): Promise<FeatureFlag>
Paramètres
- name
-
string
Le nom de l’entité à récupérer
- userEmail
-
string
L’email de l’utilisateur à vérifier
- checkFeatureExists
-
boolean
Vérifier si la fonctionnalité existe
Retours
Promise<FeatureFlag>
getFeatureFlagByNameAndUserId(string, string, boolean)
Récupérer des informations sur un indicateur de fonctionnalité unique et ses états actuels pour un utilisateur
function getFeatureFlagByNameAndUserId(name: string, userId: string, checkFeatureExists?: boolean): Promise<FeatureFlag>
Paramètres
- name
-
string
Le nom de l’entité à récupérer
- userId
-
string
L’identifiant de l’utilisateur à vérifier
- checkFeatureExists
-
boolean
Vérifier si la fonctionnalité existe
Retours
Promise<FeatureFlag>
updateFeatureFlag(FeatureFlagPatch, string, string, boolean, boolean)
Modifier l’état d’un indicateur de fonction individuel pour un nom
function updateFeatureFlag(state: FeatureFlagPatch, name: string, userEmail?: string, checkFeatureExists?: boolean, setAtApplicationLevelAlso?: boolean): Promise<FeatureFlag>
Paramètres
- state
- FeatureFlagPatch
État qui devrait être défini
- name
-
string
Le nom de la fonctionnalité à modifier
- userEmail
-
string
- checkFeatureExists
-
boolean
Vérifie si la fonctionnalité existe avant de définir l’état
- setAtApplicationLevelAlso
-
boolean
Retours
Promise<FeatureFlag>