REST.Backend.EMSServices.TEMSGroupsAPI.RemoveUsers

Aus RAD Studio API Documentation
Wechseln zu: Navigation, Suche

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

Eigenschaften

Typ Sichtbarkeit Quelle Unit Übergeordnet
function protected
REST.Backend.EMSServices.pas
REST.Backend.EMSServices.hpp
REST.Backend.EMSServices TEMSGroupsAPI


Beschreibung

Fordert das Entfernen des angegebenen Benutzers aus 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.

RemoveUsers übernimmt die folgenden Parameter:

  • AGroupName ist der Name der Zielgruppe.
  • AUsers ist ein String-Array mit den IDs der Benutzer, die Sie aus der Zielgruppe entfernen möchten.
  • AUpdatedObject ist eine Instanz von TBackendEntityValue, die RemoveUsers 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.

MasterSecret erforderlich

Der Authentifizierungstyp ist TAuthentication.MasterSecret, und die Eigenschaft MasterSecret der Verbindungsinformationen des zugrunde liegenden EMS-Backend-Dienstes ist ein leerer String.

Sitzungs-Token erforderlich

Der Authentifizierungstyp ist TAuthentication.Session, und Sie haben sich nicht angemeldet.

Siehe auch