REST.Backend.EMSApi.TEMSClientAPI.RemoveUsersFromGroup

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

Delphi 

function RemoveUsersFromGroup(const AGroupName: string;  const AUsers: TArray<string>; out AUpdatedAt: TUpdatedAt): Boolean;

C++ 

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

プロパティ

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


説明

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

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

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

例外

例外 メッセージ 説明

EEMSClientAPIError

グループ名が必要です

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

MasterSecret が必要です

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

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

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

関連項目

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