REST.Backend.EMSApi.TEMSClientAPI.QueryUsers
Delphi
procedure QueryUsers(const AQuery: array of string;
const AJSONArray: TJSONArray); overload;
procedure QueryUsers(const AQuery: array of string;
const AJSONArray: TJSONArray; out AUsers: TArray<TUser>); 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<TUser> &AUsers)/* overload */;
プロパティ
種類 | 可視性 | ソース | ユニット | 親 |
---|---|---|---|---|
procedure function |
public | REST.Backend.EMSApi.pas REST.Backend.EMSApi.hpp |
REST.Backend.EMSApi | TEMSClientAPI |
説明
EMS サーバーにユーザーのリストを問い合わせます。
QueryUsers が受け取るパラメータは次のとおりです。
AQuery
: 等号で区切られたキーと値のペアの文字列(たとえば、"my_parameter=my_value" など)を要素とする文字列配列です。QueryUsers では、これらのキー/値ペアをパラメータとして要求に追加します。AJSONArray
: QueryUsers で EMS サーバーから取得された結果の格納先です。
オプションで、TUser インスタンスの配列(AUsers
)を引数として渡すこともできます。その場合、QueryUsers では、EMS サーバーから返されたユーザーをその配列に格納します。
例外
例外 | メッセージ | 説明 |
---|---|---|
JSON オブジェクトが必要です |
QueryUsers に TUser インスタンスの配列( 受け取る JSON データの構造としては、JSON オブジェクトの JSON 配列が想定されています。それらのオブジェクトのそれぞれが 1 人のユーザーを表します。 受け取る JSON データの実際の構造は、JSON オブジェクトでない項目が 1 つ以上含まれている JSON 配列です。 | |
MasterSecret が必要です |
Authentication が TAuthentication.MasterSecret で、ConnectionInfo.MasterSecret が空の文字列になっています。 | |
セッション トークンが必要です |
Authentication が TAuthentication.Session で、かつ、ログインが行われなかったか、Login の呼び出し時に渡されたセッション認証トークンが空の文字列になっています。 |
関連項目
- REST.Backend.EMSApi.TEMSClientAPI.AddUser
- REST.Backend.EMSApi.TEMSClientAPI.RetrieveUser
- REST.Backend.EMSApi.TEMSClientAPI.RetrieveCurrentUser
- REST.Backend.EMSApi.TEMSClientAPI.UpdateUser
- REST.Backend.EMSApi.TEMSClientAPI.QueryUserName
- REST.Backend.EMSApi.TEMSClientAPI.RetrieveUsersNames
- REST.Backend.EMSApi.TEMSClientAPI.RetrieveUsersFields
- REST.Backend.EMSApi.TEMSClientAPI.SignupUser
- REST.Backend.EMSApi.TEMSClientAPI.LoginUser
- REST.Backend.EMSApi.TEMSClientAPI.LogoutUser
- REST.Backend.EMSApi.TEMSClientAPI.DeleteUser