REST.Backend.EMSApi.TEMSClientAPI.UpdateGroup
Delphi
procedure UpdateGroup(const AGroupName: string; const AGroupObject: TJSONObject; out AUpdatedAt: TUpdatedAt); overload;
procedure UpdateGroup(const AGroup: TGroup; const AGroupObject: TJSONObject; out AUpdatedAt: TUpdatedAt); overload;
C++
void __fastcall UpdateGroup(const System::UnicodeString AGroupName, System::Json::TJSONObject* const AGroupObject, /* out */ TUpdatedAt &AUpdatedAt)/* overload */;
void __fastcall UpdateGroup(const TGroup &AGroup, System::Json::TJSONObject* const AGroupObject, /* out */ TUpdatedAt &AUpdatedAt)/* overload */;
プロパティ
種類 | 可視性 | ソース | ユニット | 親 |
---|---|---|---|---|
procedure function |
public | REST.Backend.EMSApi.pas REST.Backend.EMSApi.hpp |
REST.Backend.EMSApi | TEMSClientAPI |
説明
指定されたグループに関する既存の情報を、指定された情報に置き換えます。
UpdateGroup が受け取るパラメータは次のとおりです。
- 対象グループ: グループ名の文字列(
AGroupName
)か TGroup インスタンス(AGroup
)のどちらかを引数として渡します。 AGroupObject
: 対象グループの新規データを格納した JSON オブジェクトです。AUpdatedAt
: 要求した変更が EMS サーバーで適用された場合に UpdateGroup でその日付と時刻を格納する TUpdatedAt インスタンスです。
例外
例外 | メッセージ | 説明 |
---|---|---|
グループ名が必要です |
指定されたグループ名が空の文字列になっています。 | |
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.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