REST.Backend.EMSServices.TEMSUsersAPI.QueryUsers
Delphi
procedure QueryUsers(const AQuery: array of string;
const AJSONArray: TJSONArray); overload;
procedure QueryUsers(const AQuery: array of string;
const AJSONArray: TJSONArray;
out AMetaArray: TArray<TBackendEntityValue>); overload;
C++
void __fastcall QueryUsers(const System::UnicodeString *AQuery, const int AQuery_High, System::Json::TJSONArray* const AJSONArray)/* overload */;
void __fastcall QueryUsers(const System::UnicodeString *AQuery, const int AQuery_High, System::Json::TJSONArray* const AJSONArray, /* out */ System::DynamicArray<Rest::Backend::Metatypes::TBackendEntityValue> &AMetaArray)/* overload */;
プロパティ
種類 | 可視性 | ソース | ユニット | 親 |
---|---|---|---|---|
procedure function |
protected | REST.Backend.EMSServices.pas REST.Backend.EMSServices.hpp |
REST.Backend.EMSServices | TEMSUsersAPI |
説明
EMS サーバーにユーザーのリストを問い合わせます。
QueryUsers が受け取るパラメータは次のとおりです。
AQuery
: 等号で区切られたキーと値のペアの文字列(たとえば、"my_parameter=my_value" など)を要素とする文字列配列です。QueryUsers では、これらのキー/値ペアをパラメータとして要求に追加します。AJSONArray
: QueryUsers で EMS サーバーから取得された結果の格納先です。
オプションで、TBackendEntityValue インスタンスの配列(AMetaArray
)を引数として渡すこともできます。その場合、QueryUsers では、EMS サーバーから返されたユーザーをその配列に格納します。
例外
例外 | メッセージ | 説明 |
---|---|---|
JSON オブジェクトが必要です |
QueryUsers に TBackendEntityValue インスタンスの配列( 受け取る JSON データの構造としては、JSON オブジェクトの JSON 配列が想定されています。 受け取る JSON データの実際の構造は、JSON オブジェクトでない項目が 1 つ以上含まれている JSON 配列です。 | |
MasterSecret が必要です |
認証の種類が TAuthentication.MasterSecret で、基になる EMS バックエンド サービスの接続情報の MasterSecret プロパティが空の文字列になっています。 | |
セッション トークンが必要です |
認証の種類が TAuthentication.Session で、かつ、ログインが行われませんでした。 |