REST.Backend.EMSApi.TEMSClientAPI.RetrieveGroup

• Übergeordnet: TEMSClientAPI

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 */;

Eigenschaften

Typ	Sichtbarkeit	Quelle	Unit	Übergeordnet
function	public	REST.Backend.EMSApi.pas REST.Backend.EMSApi.hpp	REST.Backend.EMSApi	TEMSClientAPI

Beschreibung

Fordert die Informationen einer Gruppe vom EMS-Server an und gibt True zurück, wenn die Informationen erfolgreich empfangen wurden; ansonsten wird False zurückgegeben.

Um die Zielgruppe festzulegen, geben Sie entweder einen String mit dem Gruppennamen (AObjectname) oder eine TGroup-Instanz (AGroup) an.

Stellen Sie für die weitere Behandlung der empfangenen Informationen entweder die folgende Instanz oder die folgende Prozedur bereit:

• Eine Instanz von TGroup (AGroup oder AFoundGroup). RetrieveGroup füllt das angegebene Objekt mit den empfangenen Gruppendaten.

  Sie können optional ein drittes Argument, eine TJSONArray-Instanz (AJSON), angeben, damit RetrieveGroup dieses Objekt mit den empfangenen Gruppendaten im JSON-Format füllt.

• Eine Prozedur mit dem Typ TRetrieveGroupProc (AProc). RetrieveGroup ruft Ihre Prozedur auf und stellt die erhaltenen Gruppendaten sowohl als Instanz von TGroup (erstes Argument) als auch als Instanz von TJSONArray (zweites Argument) bereit.

Exceptions

Exception	Meldung	Beschreibung
EEMSClientAPIError	Gruppenname erforderlich	Der angegebene Gruppenname ist ein leerer String.
	MasterSecret erforderlich	Authentication ist TAuthentication.MasterSecret und ConnectionInfo.MasterSecret ist ein leerer String.
	Sitzungs-Token erforderlich	Authentication ist TAuthentication.Session, und Sie haben sich nicht angemeldet oder das bei der Anmeldung (Login) angegebene Sitzungsauthentifizierungs-Token ist ein leerer String.

Siehe auch

• 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

• REST.Backend.EMSApi.TEMSClientAPI.RetrieveUser
• REST.Backend.EMSApi.TEMSClientAPI.RetrieveCurrentUser
• REST.Backend.EMSApi.TEMSClientAPI.RetrieveModule
• REST.Backend.EMSApi.TEMSClientAPI.RetrieveModuleResource
• REST.Backend.EMSApi.TEMSClientAPI.RetrieveInstallation

• REST.Backend.EMSServices.TEMSGroupsAPI.FindGroup