REST.Backend.EMSApi.TEMSClientAPI.RegisterModule

• Übergeordnet: TEMSClientAPI

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 */;

Eigenschaften

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

Beschreibung

Fügt dem EMS-Server ein Modul mit dem angegebenen Namen, Protokoll, Protokolleigenschaften, Details und Ressourcen hinzu.

RegisterModule übernimmt die folgenden Parameter:

• AName oder AModuleName ist der Name des Moduls.
• AProtocol ist das Protokoll des Moduls.
• AProtocolProps sind die Protokolleigenschaften des Moduls.
• ADetails ist ein optionales JSON-Objekt, das weitere Daten für das neue Modul enthält.
• AResources oder Resources ist ein JSON-Array oder eine Instanz von TResourceList mit Ressourcen, die RegisterModule vor dem Senden der neuen Informationen an den EMS-Server in ADetails einbeziehen muss.
• AModule ist eine Instanz von TModule, die das neue Modul repräsentiert.

Exceptions

Exception	Meldung	Beschreibung
EEMSClientAPIError	MasterSecret erforderlich	Authentication ist TAuthentication.MasterSecret und ConnectionInfo.MasterSecret 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.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

• REST.Backend.EMSApi.TEMSClientAPI.AddUser
• REST.Backend.EMSApi.TEMSClientAPI.CreateGroup
• REST.Backend.EMSApi.TEMSClientAPI.UploadInstallation

• REST.Backend.EMSApi.TEMSClientAPI.AddResource