REST.Backend.EMSApi.TEMSClientAPI.QueryModuleResources

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

Delphi

procedure QueryModuleResources(const AModuleID: string; const AQuery: array of string; const AJSONArray: TJSONArray); overload;
procedure QueryModuleResources(const AModuleID: string; const AQuery: array of string; const AJSONArray: TJSONArray;  out AResources: TArray<TModuleResource>); overload;

C++

void __fastcall QueryModuleResources(const System::UnicodeString AModuleID, const System::UnicodeString *AQuery, const int AQuery_High, System::Json::TJSONArray* const AJSONArray)/* overload */;
void __fastcall QueryModuleResources(const System::UnicodeString AModuleID, const System::UnicodeString *AQuery, const int AQuery_High, System::Json::TJSONArray* const AJSONArray, /* out */ System::DynamicArray<TModuleResource> &AResources)/* overload */;

プロパティ

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


説明

EMS サーバーにモジュール リソースのリストを問い合わせます。

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

  • AQuery: 等号で区切られたキーと値のペアの文字列(たとえば、"my_parameter=my_value" など)を要素とする文字列配列です。QueryModuleResources では、これらのキー/値ペアをパラメータとして要求に追加します。
  • AJSONArrayQueryModuleResources で EMS サーバーから取得された結果の格納先です。

オプションで、TModuleResource インスタンスの配列AModuleResources)を引数として渡すこともできます。その場合、QueryModuleResources では、EMS サーバーから返されたモジュール リソースをその配列に格納します。

例外

例外 メッセージ 説明

EEMSClientAPIError

JSON オブジェクトが必要です

QueryModuleResourcesTModuleResource インスタンスの配列AModuleResources)が渡されましたが、QueryModuleResources では、EMS サーバーから受け取った JSON データの構造が予期しないものであるため、その配列にデータを格納できません。

受け取る JSON データの構造としては、JSON オブジェクトJSON 配列が想定されています。それらのオブジェクトのそれぞれが 1 人のユーザーを表します。

受け取る JSON データの実際の構造は、JSON オブジェクトでない項目が 1 つ以上含まれている JSON 配列です。

MasterSecret が必要です

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

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

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

関連項目