REST.Backend.EMSApi.TEMSClientAPI.RegisterModule
Delphi
procedure RegisterModule(const AName, AProtocol, AProtocolProps: string; const ADetails: TJSONObject; const AResources: TJSONArray; out AModule: TModule); overload;
procedure RegisterModule(const AModuleName, AProtocol, AProtocolProps: string; const ADetails: TJSONObject; const Resources: TResourceList; out AModule: TModule); overload;
C++
void __fastcall RegisterModule(const System::UnicodeString AName, const System::UnicodeString AProtocol, const System::UnicodeString AProtocolProps, System::Json::TJSONObject* const ADetails, System::Json::TJSONArray* const AResources, /* out */ TModule &AModule)/* overload */;
void __fastcall RegisterModule(const System::UnicodeString AModuleName, const System::UnicodeString AProtocol, const System::UnicodeString AProtocolProps, System::Json::TJSONObject* const ADetails, const System::DynamicArray<System::Generics::Collections::TPair__2<System::UnicodeString,System::Json::TJSONObject*> > Resources, /* out */ TModule &AModule)/* overload */;
Propriétés
Type | Visibilité | Source | Unité | Parent |
---|---|---|---|---|
procedure function |
public | REST.Backend.EMSApi.pas REST.Backend.EMSApi.hpp |
REST.Backend.EMSApi | TEMSClientAPI |
Description
Ajoute au serveur EMS un module ayant les nom, protocole, propriétés de protocole, détails et ressources spécifiés.
RegisterModule reçoit les paramètres suivants :
AName
ouAModuleName
est le nom du module.AProtocol
est le protocole du module.AProtocolProps
sont les propriétés de protocole du module.ADetails
est un objet JSON facultatif qui contient des données supplémentaires pour le nouveau module.AResources
ouResources
est un tableau JSON ou une instance de TResourceList contenant les ressources que doit inclure RegisterModule dansADetails
avant qu'il envoie les nouvelles informations au serveur EMS.AModule
est une instance de TModule qui représente le nouveau module.
Exceptions
Exception | Message | Description |
---|---|---|
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
- REST.Backend.EMSApi.TEMSClientAPI.RetrieveModule
- REST.Backend.EMSApi.TEMSClientAPI.RetrieveModulesFields
- REST.Backend.EMSApi.TEMSClientAPI.UpdateModule
- REST.Backend.EMSApi.TEMSClientAPI.QueryModuleName
- REST.Backend.EMSApi.TEMSClientAPI.QueryModules
- REST.Backend.EMSApi.TEMSClientAPI.UnregisterModule