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