Datasnap.DSServer.TDSServer.NotifyCallback

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function NotifyCallback(const ChannelName: string;
const ClientId: string;
const CallbackId: string;
const Msg: TJSONValue; out Response: TJSONValue;
Timeout: Cardinal = INFINITE;
const ArgType: Integer = TDBXCallback.ArgJson): Boolean; overload; deprecated 'ChannelName is no longer required';
function NotifyCallback(const ClientId: string;
const CallbackId: string;
const Msg: TJSONValue; out Response: TJSONValue;
Timeout: Cardinal = INFINITE;
const ArgType: Integer = TDBXCallback.ArgJson): Boolean; overload;

C++

bool __fastcall NotifyCallback _DEPRECATED_ATTRIBUTE1("ChannelName is no longer required") (const System::UnicodeString ChannelName, const System::UnicodeString ClientId, const System::UnicodeString CallbackId, System::Json::TJSONValue* const Msg, /* out */ System::Json::TJSONValue* &Response, unsigned Timeout = (unsigned)(0xffffffff), const int ArgType = 0x1)/* overload */;
bool __fastcall NotifyCallback(const System::UnicodeString ClientId, const System::UnicodeString CallbackId, System::Json::TJSONValue* const Msg, /* out */ System::Json::TJSONValue* &Response, unsigned Timeout = (unsigned)(0xffffffff), const int ArgType = 0x1)/* overload */;

Properties

Type Visibility Source Unit Parent
function public
Datasnap.DSServer.pas
Datasnap.DSServer.hpp
Datasnap.DSServer TDSServer

Description

Performs synchronous message delivery to a callback.

The NotifyCallback method performs synchronous message delivery to a callback located in a client channel. NotifyCallback returns True if the delivery was successful, False otherwise. Call NotifyCallback with the ChannelName, ClientId, CallbackId, Msg, Response, Timeout, and ArgType parameters.

ChannelName represents the name of the channel callback.

ClientId represents the identifier of the client channel callback.

CallbackId is a string representing the identifier of the callback.

Msg is a TJSONValue containing the message to be broadcasted.

Response is a TJSONValue containing the response from the channel callback.

Timeout represents the time-out interval in milliseconds. By default it is set to INFINITE.

ArgType represents a JSON argument.

See Also