REST.Backend.EMSProvider.TCustomEMSConnectionInfo.AppHandshake

提供:RAD Studio API Documentation

Delphi

procedure AppHandshake(const ACallback: TEMSClientAPI.TAppHandshakeProc);

C++

void __fastcall AppHandshake(const Rest::Backend::Emsapi::TEMSClientAPI::_di_TAppHandshakeProc ACallback);

プロパティ

種類 可視性 ソース ユニット 親
procedure
function
public
REST.Backend.EMSProvider.pas
REST.Backend.EMSProvider.hpp
REST.Backend.EMSProvider TCustomEMSConnectionInfo


説明

EMS サーバーにバージョン情報を要求し、その情報を正常に受け取った場合は True を返し、そうでない場合は False を返します。

受け取った情報を処理するには、TAppHandshakeProc 型の手続きを引数(ACallback)として渡す必要があります。AppHandshake では、受け取ったバージョン情報を JSON オブジェクトとして引数に渡して、この手続きを呼び出します。

例外

例外 メッセージ 説明

EEMSClientAPIError

MasterSecret が必要です

Authentication が TAuthentication.MasterSecret で、ConnectionInfo.MasterSecret が空の文字列になっています。

セッション トークンが必要です

Authentication が TAuthentication.Session で、かつ、ログインが行われなかったか、Login の呼び出し時に渡されたセッション認証トークンが空の文字列になっています。

EEMSProviderError

URLHost に値を設定する必要があります

RAD サーバー エンジン(EMS サーバー)に接続するための URLHost を空にすることはできません。

URLProtocol に値を設定する必要があります

RAD サーバー エンジン(EMS サーバー)に接続するための URLProtocol を空にすることはできません。