API:REST.Backend.EMSServices.TEMSUsersAPI.UpdateUser
Delphi
procedure UpdateUser(const AObject: TBackendEntityValue;
const AUserData: TJSONObject; out AUpdatedObject: TBackendEntityValue);
C++
HIDESBASE void __fastcall UpdateUser(const Rest::Backend::Metatypes::TBackendEntityValue &AObject, System::Json::TJSONObject* const AUserData, /* out */ Rest::Backend::Metatypes::TBackendEntityValue &AUpdatedObject);
プロパティ
種類 | 可視性 | ソース | ユニット | 親 |
---|---|---|---|---|
procedure function |
protected | REST.Backend.EMSServices.pas REST.Backend.EMSServices.hpp |
REST.Backend.EMSServices | TEMSUsersAPI |
説明
指定されたユーザーに関する既存の情報を、指定された情報に置き換えます。
REST.Backend.EMSServices.TEMSUsersAPI.UpdateUser は REST.Backend.EMSServices.TEMSLoginAPI.UpdateUser を継承しています。以下の内容はすべて REST.Backend.EMSServices.TEMSLoginAPI.UpdateUser を参照しています。
指定されたユーザーに関する既存の情報を、指定された情報に置き換えます。
UpdateUser が受け取るパラメータは次のとおりです。
AUser
: 対象ユーザーを示す TBackendEntityValue インスタンスです。AUserObject
: 対象ユーザーの新規データを格納した JSON オブジェクトです。AUpdatedAt
: 要求した変更が EMS サーバーで適用された場合に UpdateUser でその日付と時刻を格納する TBackendEntityValue インスタンスです。
例外
例外 | メッセージ | 説明 |
---|---|---|
MasterSecret が必要です |
認証の種類が TAuthentication.MasterSecret で、基になる EMS バックエンド サービスの接続情報の MasterSecret プロパティが空の文字列になっています。 | |
セッション トークンが必要です |
認証の種類が TAuthentication.Session で、かつ、ログインが行われませんでした。 |