REST.Backend.EMSApi.TEMSClientAPI.UpdateModule

• Übergeordnet: 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 */;

Eigenschaften

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

Beschreibung

Ersetzt die vorhandenen Informationen über das angegebene Modul durch die angegebenen Informationen.

UpdateModule übernimmt die folgenden Parameter:

• AModuleID ist ein String mit der ID des Zielmoduls.
• AJSONObject ist ein JSON-Objekt, das die neuen Daten für das Zielmodul enthält.
• AResources ist ein JSON-Array mit Ressourcen, die UpdateModule vor dem Senden der neuen Informationen an den EMS-Server in AJSONObject einbeziehen muss.
• AUpdatedAt ist eine Instanz von TUpdatedAt, die UpdateModule mit dem Datum und der Uhrzeit, zu der der EMS-Server die angeforderte Änderung ausgeführt hat.

Alternativ können Sie die folgenden weiteren Parameter nach dem Parameter AModuleID angeben, um Daten festzulegen, die UpdateModule vor dem Senden der neuen Informationen an den EMS-Server in AJSONObject einbeziehen muss:

• AModuleName ist der Name des Moduls.
• AProtocol ist das Protokoll des Moduls.
• AProtocolProps sind die Protokolleigenschaften des Moduls.

Exceptions

Exception	Meldung	Beschreibung
EEMSClientAPIError	MasterSecret erforderlich	Authentication ist TAuthentication.MasterSecret und ConnectionInfo.MasterSecret ist ein leerer String.
	Modul-ID erforderlich	Die angegebene Modul-ID 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.

Siehe auch

• 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