REST.Backend.EMSApi.TEMSClientAPI.AddUsersToGroup

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

procedure AddUsersToGroup(const AGroupName: string;  const AUsers: TArray<string>; out AUpdatedAt: TUpdatedAt);

C++

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

Properties

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

Description

Requests to add the specified users to the specified group. Returns True if the EMS server applies the requested change or False if the EMS server returns an error.

AddUsersToGroup 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 add to the target group.
  • AUpdatedAt is an instance of TUpdatedAt that AddUsersToGroup 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.

Group not found: <specified group name>

The EMS server does not contain any group with the specified group name.

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