REST.Backend.EMSApi.TEMSClientAPI.SignupUser

De RAD Studio API Documentation
Aller à : navigation, rechercher

Delphi

procedure SignupUser(const AUserName, APassword: string;
const AUserFields: TJSONObject; out ALogin: TLogin);

C++

void __fastcall SignupUser(const System::UnicodeString AUserName, const System::UnicodeString APassword, System::Json::TJSONObject* const AUserFields, /* out */ TLogin &ALogin);

Propriétés

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


Description

Recense un compte utilisateur sur le serveur EMS avec le nom d'utilisateur et le mot de passe spécifiés, et se connecte au serveur EMS pour obtenir des données d'authentification que vous pourrez utiliser dans des requêtes ultérieures.

SignupUser reçoit les paramètres suivants :

  • AUserName est le nom d'utilisateur à recenser.
  • APassword est le mot de passe à recenser pour ce nom d'utilisateur.
  • AUserFields est un objet JSON facultatif contenant des paires clé-valeur à envoyer au serveur EMS avec le nom d'utilisateur et le mot de passe spécifiés. Si vous ne voulez pas fournir de données supplémentaires pour l'utilisateur, utilisez une valeur nil comme paramètre.
  • ALogin est une instance de TLogin que SignupUser remplit avec les données d'authentification que le serveur EMS envoie.

Exceptions

Exception Message Description

EEMSClientAPIError

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 d'inscription qui contient une paire clé-valeur avec 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