REST.Backend.EMSApi.TEMSClientAPI.DeleteUser

Aus RAD Studio API Documentation
Wechseln zu: Navigation, Suche

Delphi

function DeleteUser(const AObjectID: string): Boolean; overload;
function DeleteUser(const AUser: TUser): Boolean; overload;

C++

bool __fastcall DeleteUser(const System::UnicodeString AObjectID)/* overload */;
bool __fastcall DeleteUser(const TUser &AUser)/* overload */;

Eigenschaften

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


Beschreibung

Fordert das Löschen des angegebenen Benutzers vom EMS-Server an und gibt bei Erfolg True zurück; ansonsten wird False zurückgegeben.

Sie können den Zielbenutzer als Instanz von TUser festlegen oder einen String mit dem Namen des Zielbenutzers angeben.

Exceptions

Exception Meldung Beschreibung

EEMSClientAPIError

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.

Benutzer-ID erforderlich

Die angegebene Benutzer-ID ist ein leerer String.

Siehe auch