Namespace SS.net
Network requesting resources
Defined in: SS.net.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
| Field Attributes | Field Name and Description |
|---|---|
| <static> |
SS.net.dls
Array of SS.net.requestor data loaders which are active or waiting to be reused.
|
| Method Attributes | Method Name and Description |
|---|---|
| <static> |
SS.net.active()
Active Requests.
|
| <static> |
SS.net.getRequest(y)
Get an XMLHTTPRequest object.
|
| <static> |
SS.net.load(url, param, onload, onerror, ontimeout, timeout, nocache, loadId, loadImageId, title, type)
Requests are URI source using the XMLHTTPRequest object.
|
Field Detail
<static>
SS.net.dls
Array of SS.net.requestor data loaders which are active or waiting to be reused.
Method Detail
<static>
{Array}
SS.net.active()
Active Requests. Returns an array of active SS.net.requestor objects, or null.
An active SS.net.requestor is identified as any XMLHTTPRequest object where the
readyState != 4 (complete).
- Returns:
- {Array} Array of SS.net.requestor objects, or null.
<static>
{XMLHTTPRequest}
SS.net.getRequest(y)
Get an XMLHTTPRequest object. Where possible, request objects that have
fully completed are reused.
- Parameters:
- {String} y
- (Optional) Type of Microsoft ActiveX Object Request to use. Default = null.
- Returns:
- {XMLHTTPRequest} XML Http Request Object for loading web resources asynchronously / synchronously in JavaScript.
<static>
SS.net.load(url, param, onload, onerror, ontimeout, timeout, nocache, loadId, loadImageId, title, type)
Requests are URI source using the XMLHTTPRequest object.
This function can also be called specifing the URL parameter as an
object. e.g. SS.events.load({url:"myurl.htm",onload:function(){alert("hello world");});
- Parameters:
- {String} url
- Location of the document to load.
- {Object} param
- Parameters to send to the url using POST method, else leave blank. e.g. {param1:"1",param2:"2" ...}.
- {Function} onload
- Function to call after the document has loaded successfully
- {Function} onerror
- Function to call if there was an error processing the request for the document
- {Function} ontimeout
- Function to call if the request timed out
- {Integer} timeout
- Number of seconds the request must be completed in before raising a timeout error
- {Boolean} nocache
- Request the document using a random query parameter to prevent caching
- {String} loadId
- Id assigned to the request object used for fetching the data
- {String} loadImageId
- Id of an element, typically an image, which is made visible / hidden during the fetching of data
- {String} title
- Data Loader Title Description. Optional use to hold a free text description of what the data loader is doing.
- {String} type
- (Optional) Define a particular Microsoft XML ActiveX Object to use instead of the prefinded defaults. Default = null.
- Returns:
- null