REST.Backend.EMSApi.TEMSClientAPI.QueryUsers

De RAD Studio API Documentation
Aller à : navigation, rechercher

Delphi

procedure QueryUsers(const AQuery: array of string;
const AJSONArray: TJSONArray); overload;
procedure QueryUsers(const AQuery: array of string;
const AJSONArray: TJSONArray; out AUsers: TArray<TUser>); overload;

C++

void __fastcall QueryUsers(const System::UnicodeString *AQuery, const int AQuery_High, System::Json::TJSONArray* const AJSONArray)/* overload */;
void __fastcall QueryUsers(const System::UnicodeString *AQuery, const int AQuery_High, System::Json::TJSONArray* const AJSONArray, /* out */ System::DynamicArray<TUser> &AUsers)/* overload */;

Propriétés

Type Visibilité  Source Unité  Parent
procedure
function
public
REST.Backend.EMSApi.pas
REST.Backend.EMSApi.hpp
REST.Backend.EMSApi TEMSClientAPI


Description

Demande au serveur EMS une liste d'utilisateurs.

QueryUsers reçoit les paramètres suivants :

  • AQuery est un tableau de chaînes où chaque chaîne doit contenir une paire clé-valeur séparée par un signe égal, comme "mon_paramètre=ma_valeur". QueryUsers ajoute ces paires clé-valeur à la requête en tant que paramètres.
  • QueryUsers remplit AJSONArray avec les résultats provenant du serveur EMS.

Vous pouvez facultativement fournir un tableau d'instances de TUser (AUsers) pour que QueryUsers remplisse le tableau avec les utilisateurs renvoyés par le serveur EMS.

Exceptions

Exception Message Description

EEMSClientAPIError

Objet JSON attendu

Vous avez transmis à QueryUsers un tableau d'instances de TUser (AUsers), mais QueryUsers ne peut pas remplir ce tableau car la structure des données JSON reçues du serveur EMS est inattendue.

La structure attendue des données JSON reçues est un tableau JSON d'objets JSON. Chacun de ces objets représente un utilisateur.

La véritable structure des données JSON reçues est un tableau JSON contenant un ou plusieurs éléments qui ne sont pas des objets JSON.

MasterSecret requis

Authentication a la valeur TAuthentication.MasterSecret, et ConnectionInfo.MasterSecret est une chaîne vide.

Token de session requis

Authentication a la valeur TAuthentication.Session, et vous ne vous êtes pas connecté ou le token d'authentification de session fourni lors de la connexion est une chaîne vide.

Voir aussi