REST.Backend.EMSApi.TEMSClientAPI.CreateGroup
Delphi
procedure CreateGroup(const AGroupName: string;
const AGroupFields: TJSONObject; out AGroup: TGroup);
C++
void __fastcall CreateGroup(const System::UnicodeString AGroupName, System::Json::TJSONObject* const AGroupFields, /* out */ TGroup &AGroup);
プロパティ
| 種類 | 可視性 | ソース | ユニット | 親 |
|---|---|---|---|---|
procedure function |
public | REST.Backend.EMSApi.pas REST.Backend.EMSApi.hpp |
REST.Backend.EMSApi | TEMSClientAPI |
説明
指定された名前とデータを持つグループを EMS サーバーに追加します。
CreateGroup が受け取るパラメータは次のとおりです。
AGroupName： 新規グループの名前です。AGroupFields： 新規グループの追加データを格納した任意指定の JSON オブジェクトです。AGroup： 新規グループを表す TGroup インスタンスです。
例外
| 例外 | メッセージ | 説明 |
|---|---|---|
|
MasterSecret が必要です |
Authentication が TAuthentication.MasterSecret で、ConnectionInfo.MasterSecret が空の文字列になっています。 | |
|
セッション トークンが必要です |
Authentication が TAuthentication.Session で、かつ、ログインが行われなかったか、Login の呼び出し時に渡されたセッション認証トークンが空の文字列になっています。 |
関連項目
- 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.QueryGroups
- REST.Backend.EMSApi.TEMSClientAPI.RetrieveUserGroups
- REST.Backend.EMSApi.TEMSClientAPI.DeleteGroup