REST.Backend.EMSApi.TEMSClientAPI.PushToChannels

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

procedure PushToChannels(const AData: TJSONObject; const AChannels: array of string); overload;
procedure PushToChannels(const AData: TJSONObject; const AChannels: array of string; out AStatus: TPushStatus); overload;

C++

void __fastcall PushToChannels(System::Json::TJSONObject* const AData, const System::UnicodeString *AChannels, const int AChannels_High)/* overload */;
void __fastcall PushToChannels(System::Json::TJSONObject* const AData, const System::UnicodeString *AChannels, const int AChannels_High, /* out */ TPushStatus &AStatus)/* overload */;

Properties

Type Visibility Source Unit Parent
procedure
function
public
REST.Backend.EMSApi.pas
REST.Backend.EMSApi.hpp
REST.Backend.EMSApi TEMSClientAPI

Description

Sends the specified EMS push message payload to the EMS server so that the EMS server redirects the message to the specified channels.

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

Exceptions

Exception Message Description

EEMSClientAPIError

Channel names expected

The specified list of channel names is empty.

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