REST.Backend.EMSApi.TEMSClientAPI.UpdateModule
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 */;
プロパティ
種類 | 可視性 | ソース | ユニット | 親 |
---|---|---|---|---|
procedure function |
public | REST.Backend.EMSApi.pas REST.Backend.EMSApi.hpp |
REST.Backend.EMSApi | TEMSClientAPI |
説明
指定されたモジュールに関する既存の情報を、指定された情報に置き換えます。
UpdateModule が受け取るパラメータは次のとおりです。
AModuleID
: 対象モジュールの ID の文字列です。AJSONObject
: 対象モジュールの新規データを格納した JSON オブジェクトです。AResources
: UpdateModule で EMS サーバーに新しい情報を送信する前にAJSONObject
に組み込む必要があるリソースの JSON 配列です。AUpdatedAt
: 要求した変更が EMS サーバーで適用された場合に UpdateModule でその日付と時刻を格納する TUpdatedAt インスタンスです。
あるいは、AModuleID
パラメータの後に次の追加パラメータを指定して、UpdateModule で EMS サーバーに新しい情報を送信する前に AJSONObject
に組み込む必要があるデータを指定してもかまいません。
AModuleName
: モジュールの名前です。AProtocol
: モジュールのプロトコルです。AProtocolProps
: モジュールのプロトコル プロパティです。
例外
例外 | メッセージ | 説明 |
---|---|---|
MasterSecret が必要です |
Authentication が TAuthentication.MasterSecret で、ConnectionInfo.MasterSecret が空の文字列になっています。 | |
モジュール ID が必要です |
指定されたモジュール ID が空の文字列になっています。 | |
セッション トークンが必要です |
Authentication が TAuthentication.Session で、かつ、ログインが行われなかったか、Login の呼び出し時に渡されたセッション認証トークンが空の文字列になっています。 |
関連項目
- 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