OpenEdge Development: Mobile Applications - Product ...

onOpenRequest property
onOpenRequest property
Returns a developer-specified callback function that the Session object executes to
modify a request object before sending the request object to the server. Such a function
might serve, for example, to add a header to the request.
It is not normally necessary to use this property, because OpenEdge Mobile properly
handles preparation of the request object for normal circumstances.
Data type: function
Access: Writable
Applies to: progress.data.Session class
By default, the value of the onOpenRequest property is null, meaning that the request
object is sent without modification. If the value is set to a function, the function takes a
single parameter.
Syntax
mysession.onOpenRequest = myFunction( params )
params
An object that has the following properties:
• xhr — An object reference to the XMLHttpRequest object (XHR) to be used to
send the request. The current request object can be modified by the function.
When the callback is called, XMLHttpRequest.open( ) will already have been
called on the XHR , but the callback can call open( ) again, overriding the effects
of the first open( ). When the callback function is used for a login( ),
addCatalog( ), or logout( ) call, although it should not be necessary and is not
recommended, it is possible to replace the XHR entirely by creating a new object
and assigning it as the value of the xhr property.
• verb — The HTTP operation (GET, PUT, etc.) to be performed by the request.
• uri — The URI to which the request is addressed.
• session — A reference to the Session object that invoked the callback.
• formPreTest — A Boolean specifying whether the current login( ) request is a
preliminary request, used in cases of Form authentication, to determine whether
the user is already logged in (true) or an actual login request (false).
• async — A Boolean specifying whether the request is asynchronous (true) or
synchronous (false).
Note: If the callback function is used for a login( ), addCatalog( ), or
logout( ) call, and if it calls XMLHttpRequest.open( ), the request must
be sent synchronously.
OpenEdge ® Development: Mobile Applications 235