REST.Backend.EMSApi.TEMSClientAPI.UpdateGroup

提供: RAD Studio API Documentation
移動先: 案内検索

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 インスタンスです。

例外

例外 メッセージ 説明

EEMSClientAPIError

グループ名が必要です

指定されたグループ名が空の文字列になっています。

MasterSecret が必要です

AuthenticationTAuthentication.MasterSecret で、ConnectionInfo.MasterSecret が空の文字列になっています。

セッション トークンが必要です

AuthenticationTAuthentication.Session で、かつ、ログインが行われなかったか、Login の呼び出し時に渡されたセッション認証トークンが空の文字列になっています。

関連項目