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 */;
Properties
Type | Visibility | Source | Unit | Parent |
---|---|---|---|---|
function | public | REST.Backend.EMSApi.pas REST.Backend.EMSApi.hpp |
REST.Backend.EMSApi | TEMSClientAPI |
Description
Requests the information of an installation from the EMS server and returns True
if it receives the information successfully or False
otherwise.
To specify the target installation, provide either a string with the installation ID (AObjectID
) or an instance of TInstallation (AInstallation
).
To handle the received information, you must provide either of the following:
- An instance of TInstallation (
AInstallation
orAFoundInstallation
). RetrieveInstallation fills the specified object with the received installation data.You may optionally provide a third argument, an instance of TJSONArray (
AJSON
), so that RetrieveInstallation fills that object with the received installation data in JSON format. - A procedure of type TRetrieveInstallationProc (
AProc
). RetrieveInstallation calls your procedure and provides the received installation data both as an instance of TInstallation (first argument) and as an instance of TJSONArray (second argument).
Exceptions
Exception | Message | Description |
---|---|---|
Installation ID required |
The specified installation ID is an empty string. | |
MasterSecret required |
Authentication is TAuthentication.MasterSecret and ConnectionInfo.MasterSecret is an empty string. | |
Session token required |
Authentication is TAuthentication.Session and you did not log in or the session authentication token that you provided to Login is an empty string. |
See Also
- 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