Class PTHTTPRequest

Object
   |
   +--PTHTTPRequest

Direct Known Subclasses:

PTHTTPPOSTRequest, PTHTTPGETRequest

class PTHTTPRequest

Abstract superclass for PTHTTPGETRequest and PTHTTPPOSTRequest. Invoking a PTHTTPRequest will cause a background HTTP request to be sent to the server without reloading the contents of the browser. PTHTTPRequests can be set to automatically refresh the inner HTML of an element on the page, or to have the HTTP response that they generate be handled by a JavaScript function. Note that this class should not be used or instantiated directly.
Defined in PTHTTPRequest.js

Field Detail

_requestForm

<private> Object _requestForm

callback

<private> Object callback

The function to call when the response comes back (string or function ref). This function will be passed a PTHTTPResponse object as an argument. Note that you should set either a callback or a targetElement, not both.

concurrencyMode

<private> String concurrencyMode

Specifies how to handle concurrent requests. Possible values are:
PTHTTPTransport.CCMODE_QUEUE - concurrent requests are queued(default)
PTHTTPTransport.CCMODE_ASYNC - concurrent requests are set asynchronously
PTHTTPTransport.CCMODE_SYNC - requests are set synchronously

formDataSet

<private> Object formDataSet

properties

<private> Hash properties

Associative array of key/value pairs available for arbitrary use. (Optional)

requestHeaders

<private> Hash requestHeaders

Associative array of http client request headers to set on the request. (Optional)

responsePostProcHandler

Function responsePostProcHandler

A reference to a function that will be called (and passed a PTHTTPResponse object) after either the callback is invoked or the targetElement's innerHTML is set. This field can also be set using the String name of a function. (Optional)

responsePreProcHandler

Function responsePreProcHandler

A reference to a function that will be called (and passed a PTHTTPResponse object) before either the callback is invoked or the targetElement's innerHTML is set. If this method returns false, further processing is halted. This field can also be set using the String name of a function. (Optional)

targetElement

<private> Element targetElement

The element whose innerHTML property will be set to the response text. Note that you should set either a callback or a targetElement, not both.

type

<private> String type

The request type.

url

<private> String url

The request URL.

CONTENT_TYPE_HEADER

<static> <final> String CONTENT_TYPE_HEADER

Request Header containing content type

See Also:

Constant Field Values

REQUEST_TYPE_CLIENT_SIDE

<static> <final> Object REQUEST_TYPE_CLIENT_SIDE

Enumerated Request type for client side requests

See Also:

Constant Field Values

REQUEST_TYPE_HEADER

<static> <final> String REQUEST_TYPE_HEADER

Request Header containing the type of request being generated

See Also:

Constant Field Values

REQUEST_TYPE_PORTLET_REFRESH

<static> <final> Object REQUEST_TYPE_PORTLET_REFRESH

Enumerated Request type for portlet refresh requests

See Also:

Constant Field Values

VERSION

<static> <final> Object VERSION

See Also:

Constant Field Values

PTHTTPRequest

PTHTTPRequest()

Abstract superclass for PTHTTPGETRequest and PTHTTPPOSTRequest. Note that this class should not be used or instantiated directly.

_setFormURLEncodedDataFromForm

 <private> Object _setFormURLEncodedDataFromForm(formRef)

Generates URL encoded form data from a form

Parameters:
formRef - a reference to the form (form element ref, form id, or form name)

_setFormURLEncodedDataFromNVPairs

 <private> Object _setFormURLEncodedDataFromNVPairs(nvPairs)

Generates URL encoded form data from an associative array of name/value pairs

invoke

Object invoke(loadMessageCommand)

Invoke the HTTP request, sending the request to a server and executing any actions required by the response.

Parameters:
loadMessageCommand - A JavaScript string to be evaluated when a response is being loaded as content

setFormContent

 <private> void setFormContent(formContent)

Sets the form content for the request.

Parameters:
formContent - a element of Object representing a form

setRequestHeader

void setRequestHeader(header, value)

Sets a client http request header for the request.

Parameters:
header - the request header name
value - the request header value

setResponseHandler

void setResponseHandler(responseHandler)

Sets the appropriate response handler for the request

Parameters:
responseHandler - This can be either a callback function to call and pass back results of the request (string or Function) or it can be a target HTML element, whose innerHTML property will be set from the response text

_resolveFormReference

<static>  <private> Object _resolveFormReference(formRef)

Finds a valid form element object from a form reference