REST.Backend.EMSServices.TEMSLoginAPI.SignupUser
Delphi
procedure SignupUser(const AUserName, APassword: string;
const AUserData: TJSONObject; out ACreatedObject: TBackendEntityValue);
C++
void __fastcall SignupUser(const System::UnicodeString AUserName, const System::UnicodeString APassword, System::Json::TJSONObject* const AUserData, /* out */ Rest::Backend::Metatypes::TBackendEntityValue &ACreatedObject);
プロパティ
| 種類 | 可視性 | ソース | ユニット | 親 |
|---|---|---|---|---|
procedure function |
protected | REST.Backend.EMSServices.pas REST.Backend.EMSServices.hpp |
REST.Backend.EMSServices | TEMSLoginAPI |
説明
指定されたユーザー名とパスワードで EMS サーバーにユーザー アカウントを登録し、EMS サーバーにログインして、それ以降の要求で使用できる認証データを取得します。
SignupUser が受け取るパラメータは次のとおりです。
AUserName： 登録するユーザー名です。APassword： そのユーザー名用に登録するパスワードです。- {
AUserData（任意指定）： 指定されたユーザー名およびパスワードと共に EMS サーバーに送信するユーザー データのキー/値ペアを格納した JSON オブジェクトです。付加的なユーザー データを渡さない場合は、このパラメータに nil 値を使用します。 ACreatedObject： EMS サーバーから送信される認証データの格納先として SignupUser メソッドで使用される TBackendEntityValue インスタンスです。
例外
| 例外 | メッセージ | 説明 |
|---|---|---|
|
MasterSecret が必要です |
認証の種類が TAuthentication.MasterSecret で、基になる EMS バックエンド サービスの接続情報の MasterSecret プロパティが空の文字列になっています。 | |
|
セッション トークンが必要です |
EMS サーバーからの応答にセッション トークンが含まれていません。 EMS サーバーからの応答は、TJSONNames.SessionToken の値をキーとするキー/値ペアが格納されたユーザー登録データの JSON オブジェクトでなければなりません。 | |
|
セッション トークンが必要です |
認証の種類が TAuthentication.Session で、かつ、ログインが行われませんでした。 |