REST.Backend.EMSApi.TEMSClientAPI.RetrieveUserGroups
Delphi
function RetrieveUserGroups(const AUserID: string): TArray<string>;
C++
System::DynamicArray<System::UnicodeString> __fastcall RetrieveUserGroups(const System::UnicodeString AUserID);
プロパティ
種類 | 可視性 | ソース | ユニット | 親 |
---|---|---|---|---|
function | public | REST.Backend.EMSApi.pas REST.Backend.EMSApi.hpp |
REST.Backend.EMSApi | TEMSClientAPI |
説明
指定された ID のユーザーが所属しているグループの ID の配列を返します。
例外
例外 | メッセージ | 説明 |
---|---|---|
JSON 配列が必要です |
RetrieveUserGroups では、EMS サーバーから JSON 配列が得られると想定しています。しかし、EMS サーバーからは、それ以外のものが送信されました。 | |
MasterSecret が必要です |
Authentication が TAuthentication.MasterSecret で、ConnectionInfo.MasterSecret が空の文字列になっています。 | |
セッション トークンが必要です |
Authentication が TAuthentication.Session で、かつ、ログインが行われなかったか、Login の呼び出し時に渡されたセッション認証トークンが空の文字列になっています。 | |
ユーザー ID が必要です |
指定されたユーザー ID が空の文字列になっています。 |
関連項目
- REST.Backend.EMSApi.TEMSClientAPI.CreateGroup
- REST.Backend.EMSApi.TEMSClientAPI.RetrieveGroup
- REST.Backend.EMSApi.TEMSClientAPI.RetrieveGroupsFields
- REST.Backend.EMSApi.TEMSClientAPI.UpdateGroup
- REST.Backend.EMSApi.TEMSClientAPI.AddUsersToGroup
- REST.Backend.EMSApi.TEMSClientAPI.RemoveUsersFromGroup
- REST.Backend.EMSApi.TEMSClientAPI.RetrieveGroupsNames
- REST.Backend.EMSApi.TEMSClientAPI.QueryGroups
- REST.Backend.EMSApi.TEMSClientAPI.DeleteGroup