REST.Backend.EMSServices.TEMSUsersAPI.FindUser
Delphi
function FindUser(const AObject: TBackendEntityValue; AProc: TFindObjectProc): Boolean; overload;
function FindUser(const AObject: TBackendEntityValue; out AUser: TBackendEntityValue; const AJSON: TJSONArray)
C++
bool __fastcall FindUser(const Rest::Backend::Metatypes::TBackendEntityValue &AObject, Rest::Backend::Servicetypes::_di_TFindObjectProc AProc)/* overload */;
bool __fastcall FindUser(const Rest::Backend::Metatypes::TBackendEntityValue &AObject, /* out */ Rest::Backend::Metatypes::TBackendEntityValue &AUser, System::Json::TJSONArray* const AJSON)/* overload */;
Properties
Type | Visibility | Source | Unit | Parent |
---|---|---|---|---|
function | protected | REST.Backend.EMSServices.pas REST.Backend.EMSServices.hpp |
REST.Backend.EMSServices | TEMSUsersAPI |
Description
Requests the information of the specified user from the EMS server and returns True
if it receives the information successfully or False
otherwise.
To handle the received information, you must provide either of the following:
- An instance of TBackendEntityValue (
AUser
) and an instance of TJSONArray (AJSON
). FindUser fills both objects with the received user data. - A procedure of type TFindObjectProc (
AProc
). FindUser calls your procedure and provides the received user data both as an instance of TBackendEntityValue (first argument) and as an instance of TJSONObject (second argument).
Exceptions
Exception | Message | Description |
---|---|---|
MasterSecret required |
The type of authentication is TAuthentication.MasterSecret and the MasterSecret property of the connection information of the underlying EMS backend service is an empty string. | |
Session token required |
The type of authentication is TAuthentication.Session you did not log in. | |
User ID required |
|