REST.Backend.EMSApi.TEMSClientAPI.DeleteUser
Delphi
function DeleteUser(const AObjectID: string): Boolean; overload;
function DeleteUser(const AUser: TUser): Boolean; overload;
C++
bool __fastcall DeleteUser(const System::UnicodeString AObjectID)/* overload */;
bool __fastcall DeleteUser(const TUser &AUser)/* overload */;
プロパティ
種類 | 可視性 | ソース | ユニット | 親 |
---|---|---|---|---|
function | public | REST.Backend.EMSApi.pas REST.Backend.EMSApi.hpp |
REST.Backend.EMSApi | TEMSClientAPI |
説明
指定されたユーザーの削除を EMS サーバーに要求し、成功した場合は True
を返し、そうでない場合は False
を返します。
対象ユーザーを TUser のインスタンスとして指定することもできますし、対象ユーザーの ID の文字列を引数として渡してもかまいません。
例外
例外 | メッセージ | 説明 |
---|---|---|
MasterSecret が必要です |
Authentication が TAuthentication.MasterSecret で、ConnectionInfo.MasterSecret が空の文字列になっています。 | |
セッション トークンが必要です |
Authentication が TAuthentication.Session で、かつ、ログインが行われなかったか、Login の呼び出し時に渡されたセッション認証トークンが空の文字列になっています。 | |
ユーザー ID が必要です |
指定されたユーザー ID が空の文字列になっています。 |
関連項目
- REST.Backend.EMSApi.TEMSClientAPI.AddUser
- REST.Backend.EMSApi.TEMSClientAPI.RetrieveUser
- REST.Backend.EMSApi.TEMSClientAPI.RetrieveCurrentUser
- REST.Backend.EMSApi.TEMSClientAPI.UpdateUser
- 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.AddUsersToGroup
- REST.Backend.EMSApi.TEMSClientAPI.RemoveUsersFromGroup