REST.Backend.EMSApi.TEMSClientAPI.RemoveUsersFromGroup

De RAD Studio API Documentation
Aller à : navigation, rechercher

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

Propriétés

Type Visibilité  Source Unité  Parent
function public
REST.Backend.EMSApi.pas
REST.Backend.EMSApi.hpp
REST.Backend.EMSApi TEMSClientAPI


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.

RemoveUsersFromGroup 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.
  • AUpdatedAt est une instance de TUpdatedAt que RemoveUsersFromGroup 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 du groupe spécifié est une chaîne vide.

MasterSecret requis

Authentication a la valeur TAuthentication.MasterSecret, et ConnectionInfo.MasterSecret est une chaîne vide.

Token de session requis

Authentication a la valeur TAuthentication.Session, et vous ne vous êtes pas connecté ou le token d'authentification de session fourni lors de la connexion est une chaîne vide.

Voir aussi