REST.Backend.EMSApi.TEMSClientAPI.AddUsersToGroup

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

Delphi 

procedure AddUsersToGroup(const AGroupName: string;  const AUsers: TArray<string>; out AUpdatedAt: TUpdatedAt);

C++ 

void __fastcall AddUsersToGroup(const System::UnicodeString AGroupName, const System::DynamicArray<System::UnicodeString> AUsers, /* out */ TUpdatedAt &AUpdatedAt);

プロパティ

種類 可視性 ソース ユニット 親
procedure
function
 public
REST.Backend.EMSApi.pas
REST.Backend.EMSApi.hpp
 REST.Backend.EMSApi TEMSClientAPI


説明

指定のユーザーを指定のグループに追加するように要求します。要求した変更が EMS サーバーで適用された場合は True を返し、EMS サーバーからエラーが返された場合は False を返します。

AddUsersToGroup が受け取るパラメータは次のとおりです。

  • AGroupName： 対象となるグループの名前です。
  • AUsers： 対象となるグループに追加するユーザーの ID 文字列の配列です。
  • AUpdatedAt： 要求した変更が EMS サーバーで適用された場合に AddUsersToGroup でその日付と時刻を格納する TUpdatedAt インスタンスです。

例外

例外 メッセージ 説明

EEMSClientAPIError

グループ名が必要です

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

グループが見つかりません: <指定されたグループ名>

EMS サーバーには、指定されたグループ名のグループがありません。

MasterSecret が必要です

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

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

Authentication が TAuthentication.Session で、かつ、ログインしなかったか、Login に渡したセッション認証トークンが空の文字列になっています。

関連項目

「http://docwiki.embarcadero.com/Libraries/Sydney/j/index.php?title=REST.Backend.EMSApi.TEMSClientAPI.AddUsersToGroup&oldid=683469」から取得