REST.Backend.EMSApi.TEMSClientAPI.RegisterModule

提供: RAD Studio API Documentation
移動先: 案内、 検索

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

プロパティ

種類 可視性 ソース ユニット 親
procedure
function
 public
REST.Backend.EMSApi.pas
REST.Backend.EMSApi.hpp
 REST.Backend.EMSApi TEMSClientAPI


説明

指定された名前、プロトコル、プロトコル プロパティ、詳細、リソースのモジュールを EMS サーバーに追加します。

RegisterModule が受け取るパラメータは次のとおりです。

  • AName または AModuleName： モジュールの名前です。
  • AProtocol： モジュールのプロトコルです。
  • AProtocolProps： モジュールのプロトコル プロパティです。
  • ADetails（任意指定）： 新規モジュールの追加データを格納した JSON オブジェクトです。
  • AResources または Resources： RegisterModule で EMS サーバーに新しい情報を送信する前に ADetails に含めておく必要があるリソースを格納した JSON 配列または TResourceList インスタンスです。
  • AModule： 新規モジュールを表す TModule インスタンスです。

例外

例外 メッセージ 説明

EEMSClientAPIError

MasterSecret が必要です

Authentication が TAuthentication.MasterSecret で、ConnectionInfo.MasterSecret が空の文字列になっています。

セッション トークンが必要です

Authentication が TAuthentication.Session で、かつ、ログインが行われなかったか、Login の呼び出し時に渡されたセッション認証トークンが空の文字列になっています。

関連項目

「https://docwiki.embarcadero.com/Libraries/Alexandria/j/index.php?title=REST.Backend.EMSApi.TEMSClientAPI.RegisterModule&oldid=683519」から取得