REST.Backend.EMSApi.TEMSClientAPI.AppHandshake

• Up to Parent: TEMSClientAPI

Delphi

procedure AppHandshake(const AJSONArray: TJSONArray); overload;
procedure AppHandshake(const AProc: TAppHandshakeProc); overload;

C++

void __fastcall AppHandshake(System::Json::TJSONArray* const AJSONArray)/* overload */;
void __fastcall AppHandshake(const _di_TAppHandshakeProc AProc)/* overload */;

Properties

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

Description

Requests the version information of 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:

• A JSON array (AJSONArray), so that AppHandshake appends the received JSON object to that JSON array.
• A procedure of type TAppHandshakeProc (AProc). AppHandshake calls your procedure and provides the received version information as a JSON object.

Exceptions

Exception	Message	Description
EEMSClientAPIError	MasterSecret required	Authentication is TAuthentication.MasterSecret and ConnectionInfo.MasterSecret is an empty string.
	Session token required	Authentication is TAuthentication.Session and you did not log in or the session authentication token that you provided to Login is an empty string.

See Also

• REST.Backend.EMSProvider.TCustomEMSConnectionInfo.AppHandshake