REST.Backend.EMSApi.TEMSClientAPI.RemoveUsersFromGroup

Aus RAD Studio API Documentation
Wechseln zu: Navigation, Suche

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

Eigenschaften

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


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.

RemoveUsersFromGroup ü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.
  • AUpdatedAt ist eine Instanz von TUpdatedAt, die RemoveUsersFromGroup 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

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

Abgerufen von „https://docwiki.embarcadero.com/Libraries/Rio/d/index.php?title=REST.Backend.EMSApi.TEMSClientAPI.RemoveUsersFromGroup&oldid=718718“