REST.Backend.EMSApi.TEMSClientAPI.UpdateModule

• Aller au parent : TEMSClientAPI

Delphi

procedure UpdateModule(const AModuleID, AModuleName, AProtocol, AProtocolProps: string; const AJSONObject: TJSONObject; const AResources: TJSONArray; out AUpdatedAt: TUpdatedAt); overload;
procedure UpdateModule(const AModuleID: string; const AJSONObject: TJSONObject; const AResources: TJSONArray; out AUpdatedAt: TUpdatedAt); overload;

C++

void __fastcall UpdateModule(const System::UnicodeString AModuleID, const System::UnicodeString AModuleName, const System::UnicodeString AProtocol, const System::UnicodeString AProtocolProps, System::Json::TJSONObject* const AJSONObject, System::Json::TJSONArray* const AResources, /* out */ TUpdatedAt &AUpdatedAt)/* overload */;
void __fastcall UpdateModule(const System::UnicodeString AModuleID, System::Json::TJSONObject* const AJSONObject, System::Json::TJSONArray* const AResources, /* out */ TUpdatedAt &AUpdatedAt)/* 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

Remplace les informations existantes sur le module spécifié par les informations spécifiées.

UpdateModule reçoit les paramètres suivants :

• AModuleID est une chaîne avec l'identifiant du module cible.
• AJSONObject est un objet JSON qui contient les nouvelles données du module cible.
• AResources est un tableau JSON de ressources que UpdateModule doit inclure dans AJSONObject avant d'envoyer les nouvelles informations au serveur EMS.
• AUpdatedAt est une instance de TUpdatedAt que UpdateModule remplit avec la date et l'heure auxquelles le serveur EMS a appliqué la modification demandée.

Vous pouvez aussi spécifier les paramètres supplémentaires suivants après le paramètre AModuleID pour spécifier les données que UpdateModule doit inclure dans AJSONObject avant d'envoyer les nouvelles informations au serveur EMS :

• AModuleName est le nom du module.
• AProtocol est le protocole du module.
• AProtocolProps sont les propriétés du protocole du module.

Exceptions

Exception	Message	Description
EEMSClientAPIError	MasterSecret requis	Authentication a la valeur TAuthentication.MasterSecret, et ConnectionInfo.MasterSecret est une chaîne vide.
	ID de module requis	L'ID de module spécifié 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.RegisterModule
• REST.Backend.EMSApi.TEMSClientAPI.RetrieveModule
• REST.Backend.EMSApi.TEMSClientAPI.RetrieveModulesFields
• REST.Backend.EMSApi.TEMSClientAPI.QueryModuleName
• REST.Backend.EMSApi.TEMSClientAPI.QueryModules
• REST.Backend.EMSApi.TEMSClientAPI.UnregisterModule

• REST.Backend.EMSApi.TEMSClientAPI.UpdateUser
• REST.Backend.EMSApi.TEMSClientAPI.UpdateGroup
• REST.Backend.EMSApi.TEMSClientAPI.UpdateModuleResource
• REST.Backend.EMSApi.TEMSClientAPI.UpdateInstallation

• REST.Backend.EMSApi.TEMSClientAPI.PutResource