REST.Backend.EMSServices.TEMSLoginAPI.LoginUser
Delphi
procedure LoginUser(const AUserName, APassword: string; AProc: TFindObjectProc); overload;
procedure LoginUser(const AUserName, APassword: string; out AUser: TBackendEntityValue; const AJSON: TJSONArray); overload;
C++
void __fastcall LoginUser(const System::UnicodeString AUserName, const System::UnicodeString APassword, Rest::Backend::Servicetypes::_di_TFindObjectProc AProc)/* overload */;
void __fastcall LoginUser(const System::UnicodeString AUserName, const System::UnicodeString APassword, /* out */ Rest::Backend::Metatypes::TBackendEntityValue &AUser, System::Json::TJSONArray* const AJSON)/* overload */;
プロパティ
| 種類 | 可視性 | ソース | ユニット | 親 |
|---|---|---|---|---|
procedure function |
protected | REST.Backend.EMSServices.pas REST.Backend.EMSServices.hpp |
REST.Backend.EMSServices | TEMSLoginAPI |
説明
EMS サーバーにログインし、今後の要求で使用できる認証データを取得します。
ログインするユーザーのユーザー名（AUserName）とそのユーザーのパスワード（APassword）を指定する必要があります。
受け取った情報を処理するために、次のいずれかを引数として渡す必要があります。
- TBackendEntityValue のインスタンス（
AUser）と JSON 配列（AJSON）。LoginUser では、受け取ったデータをAUserに格納し、受け取った JSON オブジェクトをAJSONに追加します。 - TFindObjectProc 型の手続き（
AProc）。LoginUser では、受け取った認証データを JSON オブジェクトとして引数に渡して、この手続きを呼び出します。
例外
| 例外 | メッセージ | 説明 |
|---|---|---|
|
MasterSecret が必要です |
認証の種類が TAuthentication.MasterSecret で、基になる EMS バックエンド サービスの接続情報の MasterSecret プロパティが空の文字列になっています。 | |
|
セッション トークンが必要です |
EMS サーバーからの応答にセッション トークンが含まれていません。 EMS サーバーからの応答は、TJSONNames.SessionToken の値をキーとするキー/値ペアが格納されたログイン データの JSON オブジェクトでなければなりません。 | |
|
セッション トークンが必要です |
認証の種類が TAuthentication.Session で、かつ、ログインが行われませんでした。 |