REST.Backend.EMSApi.TEMSClientAPI.AppHandshake
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 */;
プロパティ
| 種類 | 可視性 | ソース | ユニット | 親 | 
|---|---|---|---|---|
| procedure function | public | REST.Backend.EMSApi.pas REST.Backend.EMSApi.hpp | REST.Backend.EMSApi | TEMSClientAPI | 
説明
EMS サーバーにバージョン情報を要求し、その情報を正常に受け取った場合は True を返し、そうでない場合は False を返します。
受け取った情報を処理するために、次のいずれかを引数として渡す必要があります。
- JSON 配列(AJSONArray)。AppHandshake では、受け取った JSON オブジェクトをこの JSON 配列に追加します。
- TAppHandshakeProc 型の手続き(AProc)。AppHandshake では、受け取ったバージョン情報を JSON オブジェクトとして引数に渡して、この手続きを呼び出します。
例外
| 例外 | メッセージ | 説明 | 
|---|---|---|
| MasterSecret が必要です | Authentication が TAuthentication.MasterSecret で、ConnectionInfo.MasterSecret が空の文字列になっています。 | |
| セッション トークンが必要です | Authentication が TAuthentication.Session で、かつ、ログインが行われなかったか、Login の呼び出し時に渡されたセッション認証トークンが空の文字列になっています。 |