REST.Backend.EMSApi.TEMSClientAPI.LoginUser
Delphi
procedure LoginUser(const AUserName, APassword: string; out ALogin: TLogin;
const AJSON: TJSONArray; AProc: TLoginProc); overload;
procedure LoginUser(const AUserName, APassword: string;
AProc: TLoginProc); overload;
procedure LoginUser(const AUserName, APassword: string; out ALogin: TLogin;
const AJSON: TJSONArray = nil); overload;
C++
void __fastcall LoginUser(const System::UnicodeString AUserName, const System::UnicodeString APassword, /* out */ TLogin &ALogin, System::Json::TJSONArray* const AJSON, _di_TLoginProc AProc)/* overload */;
void __fastcall LoginUser(const System::UnicodeString AUserName, const System::UnicodeString APassword, _di_TLoginProc AProc)/* overload */;
void __fastcall LoginUser(const System::UnicodeString AUserName, const System::UnicodeString APassword, /* out */ TLogin &ALogin, System::Json::TJSONArray* const AJSON = (System::Json::TJSONArray*)(0x0))/* 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
Se connecte au serveur EMS et obtient les données d'authentification que TEMSClientAPI utilise dans ses requêtes ultérieures.
LoginUser reçoit les paramètres suivants :
AUserName
est le nom d'utilisateur de l'utilisateur qui se connecte.APassword
est le mot de passe de l'utilisateur qui se connecte.ALogin
est une instance de TLogin que LoginUser remplit avec les données d'authentification envoyées par le serveur EMS.AJSON
est un tableau JSON facultatif dans lequel LoginUser ajoute l'objet JSON de la réponse du serveur EMS.AProc
est une procédure facultative du type TLoginProc. LoginUser appelle cette procédure avec les paramètres suivants : l'objet des données de connexion (ALogin
) et l'objet JSON renvoyé par le serveur EMS.
Exceptions
Exception | Message | Description |
---|---|---|
MasterSecret requis |
Authentication a la valeur TAuthentication.MasterSecret, et ConnectionInfo.MasterSecret est une chaîne vide. | |
Token de session attendu |
La réponse du serveur EMS ne contient pas de token de session. La réponse du serveur EMS doit être un objet JSON de données de connexion, contenant une paire clé-valeur ayant la valeur de TJSONNames.SessionToken comme clé. | |
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
- REST.Backend.EMSApi.TEMSClientAPI.AddUser
- REST.Backend.EMSApi.TEMSClientAPI.RetrieveUser
- 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.LogoutUser
- REST.Backend.EMSApi.TEMSClientAPI.DeleteUser