XMLBrokr.TXMLBroker.OnRequestUpdate

From RAD Studio VCL Reference
Jump to: navigation, search

Contents

Delphi Information

From XMLBrokr.pas

	property OnRequestUpdate: TRequestUpdateEvent read FRequestUpdate write FRequestUpdate;


Unit: XMLBrokr

Type: event

Visibility: published

Member Of: TXMLBroker

C++ Information

From XMLBrokr.hpp

	__property TRequestUpdateEvent OnRequestUpdate;


Unit: XMLBrokr

Type: property

Visibility: public

Member Of: TXMLBroker

Description

Occurs immediately before the XML broker applies updates to the application server.


Write an OnRequestUpdate event handler to provide an alternate mechanism for applying updates to the application server. For example, the OnRequestUpdate event handler might call GetDelta to extract the delta packet from the request message and then preprocess the XML string before applying the updates with a call to ApplyXMLUpdates.

OnRequestUpdate occurs immediately after the BeforeDispatch event or when the application calls the XML broker's RequestUpdate method.

The Sender parameter is the object that received the update request (the XML broker or a Web action item).

Request is the request message that contains the updates to be applied. The XML delta packet can be extracted from this request object using the GetDelta method.

Response is the emerging response message that will be sent back to the Web browser that generated the update request. The event handler can set properties on this response object to partially or completely specify the message will be returned to the Web browser.

Handled indicates whether the event handler applied the updates. If Handled is true on exit from the event handler, the XML broker does not apply the updates, does not receive an OnGetResponse or OnGetErrorResponse event, and does not call on the ReconcileProducer to generate a response message. (It does still receive an AfterDispatch event). If Handled is false on exit from the event handler, the XML broker proceeds to apply the updates contained in the request message and receives all the associated events.

Note:  If the event handler applies the updates, it must also generate the response message.

See Also

Personal tools
Translations
Newest Version