REST.Backend.EMSApi.TEMSClientAPI.AddUsersToGroup

Aus RAD Studio API Documentation
Wechseln zu: Navigation, Suche

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);

Eigenschaften

Typ Sichtbarkeit Quelle Unit Übergeordnet
procedure
function
public
REST.Backend.EMSApi.pas
REST.Backend.EMSApi.hpp
REST.Backend.EMSApi TEMSClientAPI


Beschreibung

Fordert das Hinzufügen des angegebenen Benutzers zu der angegebenen Gruppe an. Gibt True zurück, wenn der EMS-Server die angeforderte Änderung übernimmt, oder False, wenn der EMS-Server einen Fehler zurückgibt.

AddUsersToGroup übernimmt die folgenden Parameter:

  • AGroupName ist der Name der Zielgruppe.
  • AUsers ist ein String-Array mit den IDs der Benutzer, die Sie der Zielgruppe hinzufügen möchten.
  • AUpdatedAt ist eine Instanz von TUpdatedAt, die AddUsersToGroup mit dem Datum und der Uhrzeit, zu der der EMS-Server die angeforderte Änderung ausgeführt hat.

Exceptions

Exception Meldung Beschreibung

EEMSClientAPIError

Gruppenname erforderlich

Der angegebene Gruppenname ist ein leerer String.

Gruppe nicht gefunden: <angegebener Gruppenname>

Der EMS-Server enthält keine Gruppe mit dem angegebenen Gruppennamen.

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