REST.Backend.EMSApi.TEMSClientAPI.RetrieveGroup
Delphi
function RetrieveGroup(const AGroupName: string; out AGroup: TGroup;
const AJSON: TJSONArray; AProc: TRetrieveGroupProc): Boolean; overload;
function RetrieveGroup(const AGroupName: string; out AFoundGroup: TGroup;
const AJSON: TJSONArray = nil): Boolean; overload;
function RetrieveGroup(const AGroupName: string; AProc: TRetrieveGroupProc): Boolean; overload;
function RetrieveGroup(const AGroup: TGroup; out AFoundGroup: TGroup;
const AJSON: TJSONArray = nil): Boolean; overload;
function RetrieveGroup(const AGroup: TGroup; AProc: TRetrieveGroupProc): Boolean; overload;
C++
bool __fastcall RetrieveGroup(const System::UnicodeString AGroupName, /* out */ TGroup &AGroup, System::Json::TJSONArray* const AJSON, _di_TRetrieveGroupProc AProc)/* overload */;
bool __fastcall RetrieveGroup(const System::UnicodeString AGroupName, /* out */ TGroup &AFoundGroup, System::Json::TJSONArray* const AJSON = (System::Json::TJSONArray*)(0x0))/* overload */;
bool __fastcall RetrieveGroup(const System::UnicodeString AGroupName, _di_TRetrieveGroupProc AProc)/* overload */;
bool __fastcall RetrieveGroup(const TGroup &AGroup, /* out */ TGroup &AFoundGroup, System::Json::TJSONArray* const AJSON = (System::Json::TJSONArray*)(0x0))/* overload */;
bool __fastcall RetrieveGroup(const TGroup &AGroup, _di_TRetrieveGroupProc AProc)/* overload */;
プロパティ
種類 | 可視性 | ソース | ユニット | 親 |
---|---|---|---|---|
function | public | REST.Backend.EMSApi.pas REST.Backend.EMSApi.hpp |
REST.Backend.EMSApi | TEMSClientAPI |
説明
EMS サーバーにグループの情報を要求し、その情報を正常に受け取った場合は True
を返し、そうでない場合は False
を返します。
対象となるグループを指定するには、グループ名の文字列(AGroupID
)か TGroup インスタンス(AGroup
))のどちらかを引数として渡します。
受け取った情報を処理するために、次のいずれかを引数として渡す必要があります。
- TGroup のインスタンス(
AGroup
またはAFoundGroup
)。RetrieveGroup では、受け取ったグループ データをこの指定オブジェクトに格納します。オプションで、TJSONArray のインスタンスを第 3 引数(
AJSON
)として渡してもかまいません。その場合、RetrieveGroup では、受け取ったグループ データをこのオブジェクトに JSON 形式で格納します。
- TRetrieveGroupProc 型の手続き(
AProc
)。RetrieveGroup では、受け取ったグループ データを TGroup のインスタンス(第 1 引数)として、および、TJSONArray のインスタンス(第 2 引数)として渡して、この手続きを呼び出します。
例外
例外 | メッセージ | 説明 |
---|---|---|
グループ名が必要です |
指定されたグループ名が空の文字列になっています。 | |
MasterSecret が必要です |
Authentication が TAuthentication.MasterSecret で、ConnectionInfo.MasterSecret が空の文字列になっています。 | |
セッション トークンが必要です |
Authentication が TAuthentication.Session で、かつ、ログインが行われなかったか、Login の呼び出し時に渡されたセッション認証トークンが空の文字列になっています。 |
関連項目
- REST.Backend.EMSApi.TEMSClientAPI.CreateGroup
- 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.RetrieveUserGroups
- REST.Backend.EMSApi.TEMSClientAPI.DeleteGroup