REST.Backend.EMSApi.TEMSClientAPI.RetrieveGroup

• Aller au parent : 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 */;

Propriétés

Type	Visibilité	Source	Unité	Parent
function	public	REST.Backend.EMSApi.pas REST.Backend.EMSApi.hpp	REST.Backend.EMSApi	TEMSClientAPI

Description

Demande les informations d'un groupe à partir du serveur EMS et renvoie True s'il reçoit les informations ou False dans le cas contraire.

Pour spécifier le groupe cible, fournissez une chaîne du nom du groupe (AObjectname) ou une instance de TGroup (AGroup).

Pour gérer les informations reçues, vous devez fournir l'un des éléments suivants :

• Une instance de TGroup (AGroup ou AFoundGroup). RetrieveGroup remplit l'objet spécifié avec les données de groupe reçues.

  Vous pouvez facultativement fournir un troisième argument, une instance de TJSONArray (AJSON) pour que RetrieveGroup remplisse cet objet avec les données de groupe reçues au format JSON.

• Une procédure de type TRetrieveGroupProc (AProc). RetrieveGroup appelle votre procédure et fournit les données de groupe reçues à la fois en tant qu'instance de TGroup (premier argument) et qu'instance de TJSONArray (second argument).

Exceptions

Exception	Message	Description
EEMSClientAPIError	Nom de groupe requis	Le nom du groupe spécifié est une chaîne vide.
	MasterSecret requis	Authentication a la valeur TAuthentication.MasterSecret, et ConnectionInfo.MasterSecret est une chaîne vide.
	Token de session requis	Authentication a la valeur TAuthentication.Session, et vous ne vous êtes pas connecté ou le token d'authentification de session fourni lors de la connexion est une chaîne vide.

Voir aussi

• 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