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 */;
Inhaltsverzeichnis
Eigenschaften
Typ | Sichtbarkeit | Quelle | Unit | Übergeordnet |
---|---|---|---|---|
procedure function |
public | REST.Backend.EMSApi.pas REST.Backend.EMSApi.hpp |
REST.Backend.EMSApi | TEMSClientAPI |
Beschreibung
Ersetzt die vorhandenen Informationen über die angegebene Gruppe durch die angegebenen Informationen.
UpdateGroup übernimmt die folgenden Parameter:
- Die Zielgruppe entweder als String mit dem Gruppennamen (
AGroupName
) oder als TGroup-Instanz (AGroup
). AGroupObject
ist ein JSON-Objekt, das die neuen Daten für die Zielgruppe enthält.AUpdatedAt
ist eine Instanz von TUpdatedAt, die UpdateGroup mit dem Datum und der Uhrzeit, zu der der EMS-Server die angeforderte Änderung ausgeführt hat.
Exceptions
Exception | Meldung | Beschreibung |
---|---|---|
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.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