REST.Backend.EMSApi.TEMSClientAPI.UpdateUser
Delphi
procedure UpdateUser(const AObjectID: string; const AUserObject: TJSONObject; out AUpdatedAt: TUpdatedAt); overload;
procedure UpdateUser(const AUser: TUser; const AUserObject: TJSONObject; out AUpdatedAt: TUpdatedAt); overload;
C++
void __fastcall UpdateUser(const System::UnicodeString AObjectID, System::Json::TJSONObject* const AUserObject, /* out */ TUpdatedAt &AUpdatedAt)/* overload */;
void __fastcall UpdateUser(const TUser &AUser, System::Json::TJSONObject* const AUserObject, /* out */ TUpdatedAt &AUpdatedAt)/* overload */;
プロパティ
| 種類 | 可視性 | ソース | ユニット | 親 |
|---|---|---|---|---|
procedure function |
public | REST.Backend.EMSApi.pas REST.Backend.EMSApi.hpp |
REST.Backend.EMSApi | TEMSClientAPI |
説明
指定されたユーザーに関する既存の情報を、指定された情報に置き換えます。
UpdateUser が受け取るパラメータは次のとおりです。
- 対象ユーザー： ユーザー ID の文字列（
AUserID）か TUser インスタンス（AUser）のどちらかを引数として渡します。 AUserObject： 対象ユーザーの新規データを格納した JSON オブジェクトです。AUpdatedAt： 要求した変更が EMS サーバーで適用された場合に UpdateUser でその日付と時刻を格納する TUpdatedAt インスタンスです。
例外
| 例外 | メッセージ | 説明 |
|---|---|---|
|
MasterSecret が必要です |
Authentication が TAuthentication.MasterSecret で、ConnectionInfo.MasterSecret が空の文字列になっています。 | |
|
セッション トークンが必要です |
Authentication が TAuthentication.Session で、かつ、ログインが行われなかったか、Login の呼び出し時に渡されたセッション認証トークンが空の文字列になっています。 |
関連項目
- REST.Backend.EMSApi.TEMSClientAPI.AddUser
- REST.Backend.EMSApi.TEMSClientAPI.RetrieveUser
- REST.Backend.EMSApi.TEMSClientAPI.RetrieveCurrentUser
- REST.Backend.EMSApi.TEMSClientAPI.QueryUserName
- REST.Backend.EMSApi.TEMSClientAPI.RetrieveUsersNames
- REST.Backend.EMSApi.TEMSClientAPI.RetrieveUsersFields
- REST.Backend.EMSApi.TEMSClientAPI.QueryUsers
- REST.Backend.EMSApi.TEMSClientAPI.SignupUser
- REST.Backend.EMSApi.TEMSClientAPI.LoginUser
- REST.Backend.EMSApi.TEMSClientAPI.LogoutUser
- REST.Backend.EMSApi.TEMSClientAPI.DeleteUser
- REST.Backend.EMSApi.TEMSClientAPI.AddUsersToGroup
- REST.Backend.EMSApi.TEMSClientAPI.RemoveUsersFromGroup