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 */;
Properties
| Type | Visibility | Source | Unit | Parent |
|---|---|---|---|---|
| function | public | REST.Backend.EMSApi.pas REST.Backend.EMSApi.hpp |
REST.Backend.EMSApi | TEMSClientAPI |
Description
Requests the deletion of the specified group from the EMS server and returns True on success or False otherwise.
You may specify the target group as an instance of TGroup, or provide a string with the name of the target group.
Exceptions
| Exception | Message | Description |
|---|---|---|
|
Group name required |
The specified group name is an empty string. | |
|
MasterSecret required |
Authentication is TAuthentication.MasterSecret and ConnectionInfo.MasterSecret is an empty string. | |
|
Session token required |
Authentication is TAuthentication.Session and you did not log in or the session authentication token that you provided to Login is an empty string. |
See Also
- 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