REST.Backend.EMSApi.TEMSClientAPI.RetrieveCurrentUser

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

Delphi 

function RetrieveCurrentUser(AProc: TRetrieveUserProc): Boolean; overload;
function RetrieveCurrentUser(out AUser: TUser;
const AJSON: TJSONArray = nil): Boolean; overload;

C++ 

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

プロパティ

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


説明

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

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

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

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

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

例外

例外 メッセージ 説明

EEMSClientAPIError

MasterSecret が必要です

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

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

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

関連項目

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