REST.Backend.EMSServices.TEMSPushAPI.PushBroadcast

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

procedure PushBroadcast(const AData: TPushData); overload;
procedure PushBroadcast(const AData: TJSONObject); overload;

C++

void __fastcall PushBroadcast(Rest::Backend::Pushtypes::TPushData* const AData)/* overload */;
void __fastcall PushBroadcast(System::Json::TJSONObject* const AData)/* overload */;

Properties

Type Visibility Source Unit Parent
procedure
function
protected
REST.Backend.EMSServices.pas
REST.Backend.EMSServices.hpp
REST.Backend.EMSServices TEMSPushAPI

Description

Sends the specified EMS push data to the EMS server so that the EMS server redirects the message to all devices.

You may specify the EMS push data either as an instance of TPushData or as an instance of TJSONObject.

Note: If you specify the EMS push data as an instance of TJSONObject, that instance must represent a JSON object data structure. If you cast your instance as TJSONObject when it actually represents a different JSON structure, such as a JSON array or a JSON value, PushBroadcast sends an empty JSON object instead of the specified EMS push data.

You may optionally specify an instance of TPushStatus (AStatus) that PushBroadcast fills with the EMS push notification status information that the EMS server provides.

Exceptions

Exception Message Description

EEMSClientAPIError

MasterSecret required

The type of authentication is TAuthentication.MasterSecret and the MasterSecret property of the connection information of the underlying EMS backend service is an empty string.

Session token required

The type of authentication is TAuthentication.Session you did not log in.

See Also