REST.Backend.EMSApi.TEMSClientAPI.LoginFromObject

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function LoginFromObject(const AUserName: string;
const AJSONObject: TJSONObject): TLogin;

C++

TLogin __fastcall LoginFromObject(const System::UnicodeString AUserName, System::Json::TJSONObject* const AJSONObject);

Properties

Type Visibility Source Unit Parent
function protected
REST.Backend.EMSApi.pas
REST.Backend.EMSApi.hpp
REST.Backend.EMSApi TEMSClientAPI

Description

Returns an instance of TLogin built from the specified username and login data from the EMS server.

The JSON object must contain login data that the EMS server sends as a response to a login or signup request. See the implementation of LoginUser or SignupUser for example requests.

Exceptions

Exception Message Description

EEMSClientAPIError

Session token expected

The specified JSON object of login or signup data does not contain a key-value pair with the value of TJSONNames.SessionToken as key.

See Also