REST.Backend.EMSServices.TEMSGroupsAPI.RemoveUsers

De RAD Studio API Documentation
Aller à : navigation, rechercher

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

Propriétés

Type Visibilité  Source Unité  Parent
function protected
REST.Backend.EMSServices.pas
REST.Backend.EMSServices.hpp
REST.Backend.EMSServices TEMSGroupsAPI


Description

Demande de supprimer les utilisateurs spécifiés du groupe spécifié. Renvoie True si le serveur EMS applique la modification demandée ou False si le serveur EMS renvoie une erreur.

RemoveUsers reçoit les paramètres suivants :

  • AGroupName est le nom du groupe cible.
  • AUsers est un tableau de chaînes avec les identifiants des utilisateurs que vous voulez retirer du groupe cible.
  • AUpdatedObject est une instance de TBackendEntityValue que RemoveUsers remplit avec la date et l'heure auxquelles le serveur EMS a appliqué la modification demandée.

Exceptions

Exception Message Description

EEMSClientAPIError

Nom de groupe requis

Le nom de groupe spécifié est une chaîne vide.

MasterSecret requis

Le type d'authentification a la valeur TAuthentication.MasterSecret et la propriété MasterSecret des informations de connexion du service backend EMS sous-jacent est une chaîne vide.

Token de session requis

Le type d'authentification a la valeur TAuthentication.Session, et vous ne vous êtes pas connecté.

Voir aussi