REST.Backend.EMSApi.TEMSClientAPI.RemoveUsersFromGroup

• Up to Parent: TEMSClientAPI

Delphi

function RemoveUsersFromGroup(const AGroupName: string;
const AUsers: TArray<string>; out AUpdatedAt: TUpdatedAt): Boolean;

C++

bool __fastcall RemoveUsersFromGroup(const System::UnicodeString AGroupName, const System::DynamicArray<System::UnicodeString> AUsers, /* out */ TUpdatedAt &AUpdatedAt);

Properties

Type	Visibility	Source	Unit	Parent
function	public	REST.Backend.EMSApi.pas REST.Backend.EMSApi.hpp	REST.Backend.EMSApi	TEMSClientAPI

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.

RemoveUsersFromGroup 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.
• AUpdatedAt is an instance of TUpdatedAt that RemoveUsersFromGroup fills with the date and time when the EMS Server applied the requested change.

Exceptions

Exception	Message	Description
EEMSClientAPIError	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.EMSServices.TEMSGroupsAPI.RemoveUsers

• REST.Backend.EMSApi.TEMSClientAPI.AddUsersToGroup

• REST.Backend.EMSApi.TEMSClientAPI.RetrieveGroup
• REST.Backend.EMSApi.TEMSClientAPI.RetrieveGroupsFields
• REST.Backend.EMSApi.TEMSClientAPI.UpdateGroup
• REST.Backend.EMSApi.TEMSClientAPI.RetrieveGroupsNames
• REST.Backend.EMSApi.TEMSClientAPI.QueryGroups
• REST.Backend.EMSApi.TEMSClientAPI.RetrieveUserGroups
• REST.Backend.EMSApi.TEMSClientAPI.DeleteGroup

• REST.Backend.EMSApi.TEMSClientAPI.RetrieveUser
• REST.Backend.EMSApi.TEMSClientAPI.RetrieveCurrentUser
• REST.Backend.EMSApi.TEMSClientAPI.UpdateUser
• REST.Backend.EMSApi.TEMSClientAPI.QueryUserName
• REST.Backend.EMSApi.TEMSClientAPI.RetrieveUsersNames
• REST.Backend.EMSApi.TEMSClientAPI.RetrieveUsersFields
• REST.Backend.EMSApi.TEMSClientAPI.QueryUsers
• REST.Backend.EMSApi.TEMSClientAPI.SignupUser
• REST.Backend.EMSApi.TEMSClientAPI.LoginUser
• REST.Backend.EMSApi.TEMSClientAPI.LogoutUser
• REST.Backend.EMSApi.TEMSClientAPI.DeleteUser