Datasnap.DSClientRest.TDSRestClientChannel.Notify

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function Notify(const AClientId, ACallbackId: string; AMessage: TJSONValue): Boolean;

C++

bool __fastcall Notify(const System::UnicodeString AClientId, const System::UnicodeString ACallbackId, System::Json::TJSONValue* AMessage);

Properties

Type Visibility Source Unit Parent
function public
Datasnap.DSClientRest.pas
Datasnap.DSClientRest.hpp
Datasnap.DSClientRest TDSRestClientChannel


Description

Sends a notification message to a single callback of a specific client channel.

The Notify method sends a notification message to a single callback of a specific client channel. Notify returns True if the notification was successful, False otherwise.

Note: If you try to notify a callback of this client channel, no trip to the server will be made to perform this.

Notify takes in three parameters, AClientId, ACallbackId, and AMessage.

AClientId is the unique identifier of the client channel where the callback is. ACallbackId is the unique identifier of the callback to notify. AMessage is the message to notify the callback with.

See Also