REST.Backend.EMSApi.TEMSClientAPI.UpdateGroup
Delphi
procedure UpdateGroup(const AGroupName: string; const AGroupObject: TJSONObject; out AUpdatedAt: TUpdatedAt); overload;
procedure UpdateGroup(const AGroup: TGroup; const AGroupObject: TJSONObject; out AUpdatedAt: TUpdatedAt); overload;
C++
void __fastcall UpdateGroup(const System::UnicodeString AGroupName, System::Json::TJSONObject* const AGroupObject, /* out */ TUpdatedAt &AUpdatedAt)/* overload */;
void __fastcall UpdateGroup(const TGroup &AGroup, System::Json::TJSONObject* const AGroupObject, /* out */ TUpdatedAt &AUpdatedAt)/* overload */;
Propriétés
Type | Visibilité | Source | Unité | Parent |
---|---|---|---|---|
procedure function |
public | REST.Backend.EMSApi.pas REST.Backend.EMSApi.hpp |
REST.Backend.EMSApi | TEMSClientAPI |
Description
Remplace les informations existantes sur le groupe spécifié par les informations spécifiées.
UpdateGroup reçoit les paramètres suivants :
- Le groupe cible, sous forme de chaîne avec le nom du groupe (
AGroupName
) ou d'une instance de TGroup (AGroup
). AGroupObject
est un objet JSON qui contient les nouvelles données du groupe cible.AUpdatedAt
est une instance de TUpdatedAt que UpdateGroup remplit avec la date et l'heure auxquelles le serveur EMS a appliqué la modification demandée.
Exceptions
Exception | Message | Description |
---|---|---|
Nom de groupe requis |
Le nom de 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.RetrieveGroup
- REST.Backend.EMSApi.TEMSClientAPI.RetrieveGroupsFields
- 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