REST.Backend.EMSApi.TEMSClientAPI.RetrieveInstallation

• Übergeordnet: TEMSClientAPI

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 */;

Eigenschaften

Typ	Sichtbarkeit	Quelle	Unit	Übergeordnet
function	public	REST.Backend.EMSApi.pas REST.Backend.EMSApi.hpp	REST.Backend.EMSApi	TEMSClientAPI

Beschreibung

Fordert die Informationen einer Installation vom EMS-Server an und gibt True zurück, wenn die Informationen erfolgreich empfangen wurden; ansonsten wird False zurückgegeben.

Um die Zielinstallation festzulegen, geben Sie entweder einen String mit der Installations-ID (AObjectID) oder eine TInstallation-Instanz (AInstallation) an.

Stellen Sie für die weitere Behandlung der empfangenen Informationen entweder die folgende Instanz oder die folgende Prozedur bereit:

• Eine Instanz von TInstallation (AInstallation oder AFoundInstallation). RetrieveInstallation füllt das angegebene Objekt mit den empfangenen Installationsdaten.

  Sie können optional ein drittes Argument, eine TJSONArray-Instanz (AJSON), angeben, damit RetrieveInstallation dieses Objekt mit den empfangenen Installationsdaten im JSON-Format füllt.

• Eine Prozedur mit dem Typ TRetrieveInstallationProc (AProc). RetrieveInstallation ruft Ihre Prozedur auf und stellt die erhaltenen Installationsdaten sowohl als Instanz von TInstallation (erstes Argument) als auch als Instanz von TJSONArray (zweites Argument) bereit.

Exceptions

Exception	Meldung	Beschreibung
EEMSClientAPIError	Installations-ID erforderlich	Die angegebene Installations-ID ist ein leerer String.
	MasterSecret erforderlich	Authentication ist TAuthentication.MasterSecret und ConnectionInfo.MasterSecret ist ein leerer String.
	Sitzungs-Token erforderlich	Authentication ist TAuthentication.Session, und Sie haben sich nicht angemeldet oder das bei der Anmeldung (Login) angegebene Sitzungsauthentifizierungs-Token ist ein leerer String.

Siehe auch

• 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

• REST.Backend.EMSApi.TEMSClientAPI.RetrieveUser
• REST.Backend.EMSApi.TEMSClientAPI.RetrieveGroup
• REST.Backend.EMSApi.TEMSClientAPI.RetrieveModule
• REST.Backend.EMSApi.TEMSClientAPI.RetrieveModuleResource