REST.Backend.EMSApi.TEMSClientAPI.RetrieveUser

• Übergeordnet: TEMSClientAPI

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 */;

Eigenschaften

Typ	Sichtbarkeit	Quelle	Unit	Übergeordnet
function	public	REST.Backend.EMSApi.pas REST.Backend.EMSApi.hpp	REST.Backend.EMSApi	TEMSClientAPI

Beschreibung

Fordert die Informationen eines Benutzers vom EMS-Server an und gibt True zurück, wenn die Informationen erfolgreich empfangen wurden; ansonsten wird False zurückgegeben.

Um den Zielbenutzer festzulegen, geben Sie entweder einen String mit der Benutzer-ID (AObjectID) oder eine TUser-Instanz (AUser) an.

Stellen Sie für die weitere Behandlung der empfangenen Informationen entweder die folgende Instanz oder die folgende Prozedur bereit:

• Eine Instanz von TUser (AUser oder AFoundUser). RetrieveUser füllt das angegebene Objekt mit den empfangenen Benutzerdaten.

  Sie können optional ein drittes Argument, eine TJSONArray-Instanz (AJSON), angeben, damit RetrieveUser dieses Objekt mit den empfangenen Benutzerdaten im JSON-Format füllt.

• Eine Prozedur mit dem Typ TRetrieveUserProc (AProc). RetrieveUser ruft Ihre Prozedur auf und stellt die erhaltenen Benutzerdaten sowohl als Instanz von TUser (erstes Argument) als auch als Instanz von TJSONArray (zweites Argument) bereit.

Exceptions

Exception	Meldung	Beschreibung
EEMSClientAPIError	MasterSecret erforderlich	Authentication ist TAuthentication.MasterSecret und ConnectionInfo.MasterSecret ist ein leerer String.
	Sitzungs-Token erforderlich	Authentication ist TAuthentication.Session, und Sie haben sich nicht angemeldet oder das bei der Anmeldung (Login) angegebene Sitzungsauthentifizierungs-Token ist ein leerer String.
	Benutzer-ID erforderlich	Die angegebene Benutzer-ID ist ein leerer String.

Siehe auch

• REST.Backend.EMSApi.TEMSClientAPI.AddUser
• REST.Backend.EMSApi.TEMSClientAPI.RetrieveCurrentUser
• REST.Backend.EMSApi.TEMSClientAPI.UpdateUser
• REST.Backend.EMSApi.TEMSClientAPI.QueryUserName
• REST.Backend.EMSApi.TEMSClientAPI.RetrieveUsersNames
• REST.Backend.EMSApi.TEMSClientAPI.RetrieveUsersFields
• REST.Backend.EMSApi.TEMSClientAPI.QueryUsers
• REST.Backend.EMSApi.TEMSClientAPI.SignupUser
• REST.Backend.EMSApi.TEMSClientAPI.LoginUser
• REST.Backend.EMSApi.TEMSClientAPI.LogoutUser
• REST.Backend.EMSApi.TEMSClientAPI.DeleteUser

• REST.Backend.EMSApi.TEMSClientAPI.AddUsersToGroup
• REST.Backend.EMSApi.TEMSClientAPI.RemoveUsersFromGroup

• REST.Backend.EMSApi.TEMSClientAPI.RetrieveGroup
• REST.Backend.EMSApi.TEMSClientAPI.RetrieveModule
• REST.Backend.EMSApi.TEMSClientAPI.RetrieveModuleResource
• REST.Backend.EMSApi.TEMSClientAPI.RetrieveInstallation

• REST.Backend.EMSServices.TEMSUsersAPI.FindUser