REST.Backend.EMSApi.TEMSClientAPI.RetrieveInstallation
Delphi
function RetrieveInstallation(const AInstallationID: string; out AFoundInstallation: TInstallation; const AJSON: TJSONArray; AProc: TRetrieveInstallationProc; AReset: Boolean): Boolean; overload;
function RetrieveInstallation(const AInstallationID: string; out AFoundInstallation: TInstallation; const AJSON: TJSONArray = nil): Boolean; overload;
function RetrieveInstallation(const AInstallationID: string; AProc: TRetrieveInstallationProc): Boolean; overload;
function RetrieveInstallation(const AInstallation: TInstallation; out AFoundInstallation: TInstallation; const AJSON: TJSONArray = nil): Boolean; overload;
function RetrieveInstallation(const AInstallation: TInstallation; AProc: TRetrieveInstallationProc): Boolean; overload;
C++
bool __fastcall RetrieveInstallation(const System::UnicodeString AInstallationID, /* out */ TInstallation &AFoundInstallation, System::Json::TJSONArray* const AJSON, _di_TRetrieveInstallationProc AProc, bool AReset)/* overload */;
bool __fastcall RetrieveInstallation(const System::UnicodeString AInstallationID, /* out */ TInstallation &AFoundInstallation, System::Json::TJSONArray* const AJSON = (System::Json::TJSONArray*)(0x0))/* overload */;
bool __fastcall RetrieveInstallation(const System::UnicodeString AInstallationID, _di_TRetrieveInstallationProc AProc)/* overload */;
bool __fastcall RetrieveInstallation(const TInstallation &AInstallation, /* out */ TInstallation &AFoundInstallation, System::Json::TJSONArray* const AJSON = (System::Json::TJSONArray*)(0x0))/* overload */;
bool __fastcall RetrieveInstallation(const TInstallation &AInstallation, _di_TRetrieveInstallationProc AProc)/* overload */;
プロパティ
| 種類 | 可視性 | ソース | ユニット | 親 |
|---|---|---|---|---|
| function | public | REST.Backend.EMSApi.pas REST.Backend.EMSApi.hpp |
REST.Backend.EMSApi | TEMSClientAPI |
説明
EMS サーバーにインストールの情報を要求し、その情報を正常に受け取った場合は True を返し、そうでない場合は False を返します。
対象となるインストールを指定するには、インストール ID の文字列（AInstallationID）か TInstallation インスタンス（AInstallation）のどちらかを引数として渡します。
受け取った情報を処理するには、次のいずれかを引数として渡す必要があります。
- TInstallation のインスタンス（
AInstallationまたはAFoundInstallation）。RetrieveInstallation では、受け取ったインストール データをこの指定オブジェクトに格納します。任意で、TJSONArray のインスタンスを第 3 引数（
AJSON）として指定してもかまいません。その場合、RetrieveInstallation では、受け取ったインストール データをこのオブジェクトに JSON 形式で格納します。
- TRetrieveInstallationProc 型の手続き（
AProc）。RetrieveInstallation では、受け取ったインストール データを TInstallation のインスタンス（第 1 引数）として、および、TJSONArray のインスタンス（第 2 引数）として渡して、この手続きを呼び出します。
例外
| 例外 | メッセージ | 説明 |
|---|---|---|
|
インストール ID が必要です |
指定されたインストール ID が空の文字列になっています。 | |
|
MasterSecret が必要です |
Authentication が TAuthentication.MasterSecret で、ConnectionInfo.MasterSecret が空の文字列になっています。 | |
|
セッション トークンが必要です |
Authentication が TAuthentication.Session で、まだログインしていないか、Login に渡したセッション認証トークンが空の文字列になっています。 |
関連項目
- REST.Backend.EMSApi.TEMSClientAPI.CreateAndroidInstallationObject
- REST.Backend.EMSApi.TEMSClientAPI.CreateIOSInstallationObject
- REST.Backend.EMSApi.TEMSClientAPI.UploadInstallation
- REST.Backend.EMSApi.TEMSClientAPI.UpdateInstallation
- REST.Backend.EMSApi.TEMSClientAPI.DeleteInstallation
- REST.Backend.EMSApi.TEMSClientAPI.QueryInstallations
- REST.Backend.EMSApi.TEMSClientAPI.RetrieveInstallationsChannelNames
- REST.Backend.EMSApi.TEMSClientAPI.RetrieveInstallationsFields
- REST.Backend.EMSApi.TEMSClientAPI.PushBroadcast
- REST.Backend.EMSApi.TEMSClientAPI.PushToTarget
- REST.Backend.EMSApi.TEMSClientAPI.PushToChannels
- REST.Backend.EMSApi.TEMSClientAPI.PushWhere