REST.Backend.EMSApi.TEMSClientAPI.RetrieveUser

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

Delphi 

function RetrieveUser(const AObjectID: string; out AUser: TUser;
const AJSON: TJSONArray; AProc: TRetrieveUserProc): Boolean; overload;
function RetrieveUser(const AUser: TUser; AProc: TRetrieveUserProc): Boolean; overload;
function RetrieveUser(const AUser: TUser; out AFoundUser: TUser;
const AJSON: TJSONArray = nil): Boolean; overload;
function RetrieveUser(const AObjectID: string; out AUser: TUser;
const AJSON: TJSONArray = nil): Boolean; overload;
function RetrieveUser(const AObjectID: string; AProc: TRetrieveUserProc): Boolean; overload;

C++ 

bool __fastcall RetrieveUser(const System::UnicodeString AObjectID, /* out */ TUser &AUser, System::Json::TJSONArray* const AJSON, _di_TRetrieveUserProc AProc)/* overload */;
bool __fastcall RetrieveUser(const TUser &AUser, _di_TRetrieveUserProc AProc)/* overload */;
bool __fastcall RetrieveUser(const TUser &AUser, /* out */ TUser &AFoundUser, System::Json::TJSONArray* const AJSON = (System::Json::TJSONArray*)(0x0))/* overload */;
bool __fastcall RetrieveUser(const System::UnicodeString AObjectID, /* out */ TUser &AUser, System::Json::TJSONArray* const AJSON = (System::Json::TJSONArray*)(0x0))/* overload */;
bool __fastcall RetrieveUser(const System::UnicodeString AObjectID, _di_TRetrieveUserProc AProc)/* overload */;

プロパティ

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


説明

EMS サーバーにユーザーの情報を要求し、その情報を正常に受け取った場合は True を返し、そうでない場合は False を返します。

対象となるユーザーを指定するには、ユーザー ID の文字列（AUserID）か TUser インスタンス（AUser）のどちらかを引数として渡します。

受け取った情報を処理するために、次のいずれかを引数として渡す必要があります。

  • TUser のインスタンス（AUser または AFoundUser）。RetrieveUser では、受け取ったユーザー データをこの指定オブジェクトに格納します。

    オプションで、TJSONArray のインスタンスを第 3 引数（AJSON）として渡してもかまいません。その場合、RetrieveUser では、受け取ったユーザー データをこのオブジェクトに JSON 形式で格納します。

  • TRetrieveUserProc 型の手続き（AProc）。RetrieveUser では、受け取ったユーザー データを TUser のインスタンス（第 1 引数）として、および、TJSONArray のインスタンス（第 2 引数）として渡して、この手続きを呼び出します。

例外

例外 メッセージ 説明

EEMSClientAPIError

MasterSecret が必要です

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

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

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

ユーザー ID が必要です

指定されたユーザー ID が空の文字列になっています。

関連項目

「https://docwiki.embarcadero.com/Libraries/Alexandria/j/index.php?title=REST.Backend.EMSApi.TEMSClientAPI.RetrieveUser&oldid=683549」から取得