REST.Backend.EMSApi.TEMSClientAPI.DeleteGroup
Delphi
function DeleteGroup(const AGroupName: string): Boolean; overload;
function DeleteGroup(const AGroup: TGroup): Boolean; overload;
C++
bool __fastcall DeleteGroup(const System::UnicodeString AGroupName)/* overload */;
bool __fastcall DeleteGroup(const TGroup &AGroup)/* overload */;
Inhaltsverzeichnis
Eigenschaften
Typ | Sichtbarkeit | Quelle | Unit | Übergeordnet |
---|---|---|---|---|
function | public | REST.Backend.EMSApi.pas REST.Backend.EMSApi.hpp |
REST.Backend.EMSApi | TEMSClientAPI |
Beschreibung
Fordert das Löschen der angegebenen Gruppe vom EMS-Server an und gibt bei Erfolg True
zurück; ansonsten wird False
zurückgegeben.
Sie können die Zielgruppe als Instanz von TGroup festlegen oder einen String mit dem Namen der Zielgruppe angeben.
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.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