REST.Backend.EMSApi.TEMSClientAPI.RetrieveUser

De RAD Studio API Documentation
Aller à : navigation, rechercher

Delphi 

function RetrieveUser(const AObjectID: string; out AUser: TUser;
const AJSON: TJSONArray; AProc: TRetrieveUserProc): Boolean; overload;
function RetrieveUser(const AUser: TUser; AProc: TRetrieveUserProc): Boolean; overload;
function RetrieveUser(const AUser: TUser; out AFoundUser: TUser;
const AJSON: TJSONArray = nil): Boolean; overload;
function RetrieveUser(const AObjectID: string; out AUser: TUser;
const AJSON: TJSONArray = nil): Boolean; overload;
function RetrieveUser(const AObjectID: string; AProc: TRetrieveUserProc): Boolean; overload;

C++ 

bool __fastcall RetrieveUser(const System::UnicodeString AObjectID, /* out */ TUser &AUser, System::Json::TJSONArray* const AJSON, _di_TRetrieveUserProc AProc)/* overload */;
bool __fastcall RetrieveUser(const TUser &AUser, _di_TRetrieveUserProc AProc)/* overload */;
bool __fastcall RetrieveUser(const TUser &AUser, /* out */ TUser &AFoundUser, System::Json::TJSONArray* const AJSON = (System::Json::TJSONArray*)(0x0))/* overload */;
bool __fastcall RetrieveUser(const System::UnicodeString AObjectID, /* out */ TUser &AUser, System::Json::TJSONArray* const AJSON = (System::Json::TJSONArray*)(0x0))/* overload */;
bool __fastcall RetrieveUser(const System::UnicodeString AObjectID, _di_TRetrieveUserProc AProc)/* overload */;

Propriétés

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


Description

Demande les informations d'un utilisateur à partir du serveur EMS et renvoie True s'il reçoit les informations ou False dans le cas contraire.

Pour spécifier l'utilisateur cible, fournissez une chaîne avec l'identifiant de l'utilisateur (AObjectID) ou une instance de TUser (AUser).

Pour gérer les informations reçues, vous devez fournir l'un des éléments suivants :

  • Une instance de TUser (AUser ou AFoundUser). RetrieveUser remplit l'objet spécifié avec les données d'utilisateur reçues.

    Vous pouvez facultativement fournir un troisième argument, une instance de TJSONArray (AJSON) pour que RetrieveUser remplisse cet objet avec les données d'utilisateur reçues au format JSON.

  • Une procédure de type TRetrieveUserProc (AProc). RetrieveUser appelle votre procédure et fournit les données d'utilisateur reçues à la fois en tant qu'instance de TUser (premier argument) et qu'instance de TJSONArray (second argument).

Exceptions

Exception Message Description

EEMSClientAPIError

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.

ID utilisateur requis

L'ID utilisateur spécifié est une chaîne vide.

Voir aussi

Récupérée de « https://docwiki.embarcadero.com/Libraries/Alexandria/f/index.php?title=REST.Backend.EMSApi.TEMSClientAPI.RetrieveUser&oldid=679478 »