REST.Backend.EMSServices.TEMSGroupsAPI.RemoveUsers
Delphi
function RemoveUsers(const AGroupName: string; const AUsers: TArray<string>; out AUpdatedObject: TBackendEntityValue): Boolean;
C++
bool __fastcall RemoveUsers(const System::UnicodeString AGroupName, const System::DynamicArray<System::UnicodeString> AUsers, /* out */ Rest::Backend::Metatypes::TBackendEntityValue &AUpdatedObject);
Properties
Type | Visibility | Source | Unit | Parent |
---|---|---|---|---|
function | protected | REST.Backend.EMSServices.pas REST.Backend.EMSServices.hpp |
REST.Backend.EMSServices | TEMSGroupsAPI |
Description
Requests to remove the specified users from the specified group. Returns True
if the EMS server applies the requested change or False
if the EMS server returns an error.
RemoveUsers receives the following parameters:
AGroupName
is the name of the target group.AUsers
is an array of strings with the IDs of the users that you want to remove from the target group.AUpdatedObject
is an instance of TBackendEntityValue that RemoveUsers fills with the date and time when the EMS Server applied the requested change.
Exceptions
Exception | Message | Description |
---|---|---|
Group name required |
The specified group name is an empty string. | |
MasterSecret required |
The type of authentication is TAuthentication.MasterSecret and the MasterSecret property of the connection information of the underlying EMS backend service is an empty string. | |
Session token required |
The type of authentication is TAuthentication.Session you did not log in. |