- Source:
- Author:
-
- Copyright:
- License:
Networking mixin for ish.js
Methods
[mixin]
ish.io.net(oOptionsopt) → {object|object|object|object|object|object|object}
- Source:
Provides an interface that retries up to the passed definition before returning an unsuccessful result.
From Mixin: ish.io.net-compat.js must be included for ishJS to access this functionality.
Parameters:
| Name |
Type |
Attributes |
Description |
oOptions |
object
|
<optional>
|
Value representing the desired options:
Properties
| Name |
Type |
Attributes |
Default |
Description |
retry |
integer
|
function
|
<optional>
|
500
|
Value representing the number of milliseconds (1/1000ths of a second) or function called per attempt that returns the number of milliseconds between each call; iWaitMilliseconds = oOptions.retry(iAttemptCount). |
wait |
integer
|
function
|
<optional>
|
500
|
Value representing the number of milliseconds (1/1000ths of a second) or function called per attempt that returns the number of milliseconds between each call; iWaitMilliseconds = oOptions.wait(iAttemptCount) (DEPRECATED). |
maxAttempts |
integer
|
<optional>
|
5
|
Value representing the maximum number of attempts before returning an unsuccessful result. |
|
Returns:
| Name |
Type |
Description |
interface |
object
|
Value representing the following properties:
Properties
| Name |
Type |
Description |
get |
object
|
{@link: ish.io.net.get}. |
put |
object
|
{@link: ish.io.net.put}. |
post |
object
|
{@link: ish.io.net.post}. |
delete |
object
|
{@link: ish.io.net.delete}. |
head |
object
|
{@link: ish.io.net.head}. |
crud |
object
|
{@link: ish.io.net.crud}. |
|
[mixin]
ish.io.net(oOptionsopt) → {object|object|object|object|object|object|object}
- Source:
Provides an interface that retries up to the passed definition before returning an unsuccessful result.
From Mixin: ish.io.net.js must be included for ishJS to access this functionality.
Parameters:
| Name |
Type |
Attributes |
Description |
oOptions |
object
|
<optional>
|
Value representing the desired options:
Properties
| Name |
Type |
Attributes |
Default |
Description |
retry |
integer
|
function
|
<optional>
|
500
|
Value representing the number of milliseconds (1/1000ths of a second) or function called per attempt that returns the number of milliseconds between each call; iWaitMilliseconds = oOptions.retry(iAttemptCount). |
wait |
integer
|
function
|
<optional>
|
500
|
Value representing the number of milliseconds (1/1000ths of a second) or function called per attempt that returns the number of milliseconds between each call; iWaitMilliseconds = oOptions.wait(iAttemptCount) (DEPRECATED). |
maxAttempts |
integer
|
<optional>
|
5
|
Value representing the maximum number of attempts before returning an unsuccessful result. |
|
Returns:
| Name |
Type |
Description |
interface |
object
|
Value representing the following properties:
Properties
| Name |
Type |
Description |
get |
object
|
{@link: ish.io.net.get}. |
put |
object
|
{@link: ish.io.net.put}. |
post |
object
|
{@link: ish.io.net.post}. |
delete |
object
|
{@link: ish.io.net.delete}. |
head |
object
|
{@link: ish.io.net.head}. |
crud |
object
|
{@link: ish.io.net.crud}. |
|
[mixin]
ish.io.net.cache(oImportCache) → {object}
- Source:
Provides access to the request cache.
From Mixin: ish.io.net-compat.js must be included for ishJS to access this functionality.
Parameters:
| Name |
Type |
Description |
oImportCache |
object
|
Value representing the cached entries to import into the current cache as verb.url.data. |
Returns:
| Type |
Description |
|
object
|
Value representing the request cache. |
[mixin]
ish.io.net.cache(oImportCache) → {object}
- Source:
Provides access to the request cache.
From Mixin: ish.io.net.js must be included for ishJS to access this functionality.
Parameters:
| Name |
Type |
Description |
oImportCache |
object
|
Value representing the cached entries to import into the current cache as verb.url.data. |
Returns:
| Type |
Description |
|
object
|
Value representing the request cache. |
[mixin]
ish.io.net.crud.create(sURL, oBodyopt, vCallbackopt)
- Source:
Calls the passed URL to create a new entity (via PUT).
From Mixin: ish.io.net-compat.js must be included for ishJS to access this functionality.
Parameters:
| Name |
Type |
Attributes |
Description |
sURL |
string
|
|
Value representing the URL to interrogate. |
oBody |
object
|
<optional>
|
Value representing the body of the request. |
vCallback |
fnIshIoNetCallback
|
object
|
<optional>
|
Value representing the function to be called when the request returns or the desired options:
Properties
| Name |
Type |
Attributes |
Default |
Description |
fn |
fnIshIoNetCallback
|
<optional>
|
|
Value representing the function to be called when the request returns; vCallback.fn(bSuccess, oResponse, vArg, $xhr). |
arg |
variant
|
<optional>
|
|
Value representing the argument that will be passed to the callback function. |
headers |
object
|
<optional>
|
|
Value representing the HTTP headers of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader|Mozilla.org}). |
mimeType |
string
|
<optional>
|
|
Value representing the MIME Type of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/overrideMimeType|Mozilla.org}). |
contentType |
string
|
<optional>
|
|
Value representing the Content Type HTTP Header of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader|Mozilla.org}).When vCallback.contentType is set, its value will override any value set in vCallback.headers['content-type']. |
responseType |
string
|
<optional>
|
'text'
|
Value representing the type of data contained in the response (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/responseType|Mozilla.org}). |
cache |
boolean
|
<optional>
|
false
|
Value representing if the response is to be cached. |
useCache |
boolean
|
<optional>
|
false
|
Value representing if the response is to be sourced from the cache if it's available.When !vCallback.useCache, the HTTP Header Cache-Control is set to no-cache, max-age=0. |
|
[mixin]
ish.io.net.crud.create(sURL, oBodyopt, vCallbackopt)
- Source:
Calls the passed URL to create a new entity (via PUT).
From Mixin: ish.io.net.js must be included for ishJS to access this functionality.
Parameters:
| Name |
Type |
Attributes |
Description |
sURL |
string
|
|
Value representing the URL to interrogate. |
oBody |
object
|
<optional>
|
Value representing the body of the request. |
vCallback |
fnIshIoNetCallback
|
object
|
<optional>
|
Value representing the function to be called when the request returns or the desired options:
Properties
| Name |
Type |
Attributes |
Default |
Description |
fn |
fnIshIoNetCallback
|
<optional>
|
|
Value representing the function to be called when the request returns; vCallback.fn(bSuccess, oResponse, vArg, $xhr). |
arg |
variant
|
<optional>
|
|
Value representing the argument that will be passed to the callback function. |
headers |
object
|
<optional>
|
|
Value representing the HTTP headers of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader|Mozilla.org}). |
mimeType |
string
|
<optional>
|
|
Value representing the MIME Type of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/overrideMimeType|Mozilla.org}). |
contentType |
string
|
<optional>
|
|
Value representing the Content Type HTTP Header of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader|Mozilla.org}).When vCallback.contentType is set, its value will override any value set in vCallback.headers['content-type']. |
responseType |
string
|
<optional>
|
'text'
|
Value representing the type of data contained in the response (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/responseType|Mozilla.org}). |
cache |
boolean
|
<optional>
|
false
|
Value representing if the response is to be cached. |
useCache |
boolean
|
<optional>
|
false
|
Value representing if the response is to be sourced from the cache if it's available.When !vCallback.useCache, the HTTP Header Cache-Control is set to no-cache, max-age=0. |
|
[mixin]
ish.io.net.crud.delete(sURL, vCallbackopt)
- Source:
Calls the passed URL to remove an entity (via DELETE).
From Mixin: ish.io.net-compat.js must be included for ishJS to access this functionality.
Parameters:
| Name |
Type |
Attributes |
Description |
sURL |
string
|
|
Value representing the URL to interrogate. |
vCallback |
fnIshIoNetCallback
|
object
|
<optional>
|
Value representing the function to be called when the request returns or the desired options:
Properties
| Name |
Type |
Attributes |
Default |
Description |
fn |
fnIshIoNetCallback
|
<optional>
|
|
Value representing the function to be called when the request returns; vCallback.fn(bSuccess, oResponse, vArg, $xhr). |
arg |
variant
|
<optional>
|
|
Value representing the argument that will be passed to the callback function. |
headers |
object
|
<optional>
|
|
Value representing the HTTP headers of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader|Mozilla.org}). |
mimeType |
string
|
<optional>
|
|
Value representing the MIME Type of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/overrideMimeType|Mozilla.org}). |
contentType |
string
|
<optional>
|
|
Value representing the Content Type HTTP Header of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader|Mozilla.org}).When vCallback.contentType is set, its value will override any value set in vCallback.headers['content-type']. |
responseType |
string
|
<optional>
|
'text'
|
Value representing the type of data contained in the response (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/responseType|Mozilla.org}). |
cache |
boolean
|
<optional>
|
false
|
Value representing if the response is to be cached. |
useCache |
boolean
|
<optional>
|
false
|
Value representing if the response is to be sourced from the cache if it's available.When !vCallback.useCache, the HTTP Header Cache-Control is set to no-cache, max-age=0. |
|
[mixin]
ish.io.net.crud.delete(sURL, vCallbackopt)
- Source:
Calls the passed URL to remove an entity (via DELETE).
From Mixin: ish.io.net.js must be included for ishJS to access this functionality.
Parameters:
| Name |
Type |
Attributes |
Description |
sURL |
string
|
|
Value representing the URL to interrogate. |
vCallback |
fnIshIoNetCallback
|
object
|
<optional>
|
Value representing the function to be called when the request returns or the desired options:
Properties
| Name |
Type |
Attributes |
Default |
Description |
fn |
fnIshIoNetCallback
|
<optional>
|
|
Value representing the function to be called when the request returns; vCallback.fn(bSuccess, oResponse, vArg, $xhr). |
arg |
variant
|
<optional>
|
|
Value representing the argument that will be passed to the callback function. |
headers |
object
|
<optional>
|
|
Value representing the HTTP headers of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader|Mozilla.org}). |
mimeType |
string
|
<optional>
|
|
Value representing the MIME Type of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/overrideMimeType|Mozilla.org}). |
contentType |
string
|
<optional>
|
|
Value representing the Content Type HTTP Header of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader|Mozilla.org}).When vCallback.contentType is set, its value will override any value set in vCallback.headers['content-type']. |
responseType |
string
|
<optional>
|
'text'
|
Value representing the type of data contained in the response (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/responseType|Mozilla.org}). |
cache |
boolean
|
<optional>
|
false
|
Value representing if the response is to be cached. |
useCache |
boolean
|
<optional>
|
false
|
Value representing if the response is to be sourced from the cache if it's available.When !vCallback.useCache, the HTTP Header Cache-Control is set to no-cache, max-age=0. |
|
[mixin]
ish.io.net.crud.read(sURL, vCallbackopt)
- Source:
Calls the passed URL to read an entity (via GET).
From Mixin: ish.io.net-compat.js must be included for ishJS to access this functionality.
Parameters:
| Name |
Type |
Attributes |
Description |
sURL |
string
|
|
Value representing the URL to interrogate. |
vCallback |
fnIshIoNetCallback
|
object
|
<optional>
|
Value representing the function to be called when the request returns or the desired options:
Properties
| Name |
Type |
Attributes |
Default |
Description |
fn |
fnIshIoNetCallback
|
<optional>
|
|
Value representing the function to be called when the request returns; vCallback.fn(bSuccess, oResponse, vArg, $xhr). |
arg |
variant
|
<optional>
|
|
Value representing the argument that will be passed to the callback function. |
headers |
object
|
<optional>
|
|
Value representing the HTTP headers of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader|Mozilla.org}). |
mimeType |
string
|
<optional>
|
|
Value representing the MIME Type of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/overrideMimeType|Mozilla.org}). |
contentType |
string
|
<optional>
|
|
Value representing the Content Type HTTP Header of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader|Mozilla.org}).When vCallback.contentType is set, its value will override any value set in vCallback.headers['content-type']. |
responseType |
string
|
<optional>
|
'text'
|
Value representing the type of data contained in the response (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/responseType|Mozilla.org}). |
cache |
boolean
|
<optional>
|
false
|
Value representing if the response is to be cached. |
useCache |
boolean
|
<optional>
|
false
|
Value representing if the response is to be sourced from the cache if it's available.When !vCallback.useCache, the HTTP Header Cache-Control is set to no-cache, max-age=0. |
|
[mixin]
ish.io.net.crud.read(sURL, vCallbackopt)
- Source:
Calls the passed URL to read an entity (via GET).
From Mixin: ish.io.net.js must be included for ishJS to access this functionality.
Parameters:
| Name |
Type |
Attributes |
Description |
sURL |
string
|
|
Value representing the URL to interrogate. |
vCallback |
fnIshIoNetCallback
|
object
|
<optional>
|
Value representing the function to be called when the request returns or the desired options:
Properties
| Name |
Type |
Attributes |
Default |
Description |
fn |
fnIshIoNetCallback
|
<optional>
|
|
Value representing the function to be called when the request returns; vCallback.fn(bSuccess, oResponse, vArg, $xhr). |
arg |
variant
|
<optional>
|
|
Value representing the argument that will be passed to the callback function. |
headers |
object
|
<optional>
|
|
Value representing the HTTP headers of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader|Mozilla.org}). |
mimeType |
string
|
<optional>
|
|
Value representing the MIME Type of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/overrideMimeType|Mozilla.org}). |
contentType |
string
|
<optional>
|
|
Value representing the Content Type HTTP Header of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader|Mozilla.org}).When vCallback.contentType is set, its value will override any value set in vCallback.headers['content-type']. |
responseType |
string
|
<optional>
|
'text'
|
Value representing the type of data contained in the response (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/responseType|Mozilla.org}). |
cache |
boolean
|
<optional>
|
false
|
Value representing if the response is to be cached. |
useCache |
boolean
|
<optional>
|
false
|
Value representing if the response is to be sourced from the cache if it's available.When !vCallback.useCache, the HTTP Header Cache-Control is set to no-cache, max-age=0. |
|
[mixin]
ish.io.net.crud.update(sURL, oBodyopt, vCallbackopt)
- Source:
Calls the passed URL to update an entity (via POST).
From Mixin: ish.io.net-compat.js must be included for ishJS to access this functionality.
Parameters:
| Name |
Type |
Attributes |
Description |
sURL |
string
|
|
Value representing the URL to interrogate. |
oBody |
object
|
<optional>
|
Value representing the body of the request. |
vCallback |
fnIshIoNetCallback
|
object
|
<optional>
|
Value representing the function to be called when the request returns or the desired options:
Properties
| Name |
Type |
Attributes |
Default |
Description |
fn |
fnIshIoNetCallback
|
<optional>
|
|
Value representing the function to be called when the request returns; vCallback.fn(bSuccess, oResponse, vArg, $xhr). |
arg |
variant
|
<optional>
|
|
Value representing the argument that will be passed to the callback function. |
headers |
object
|
<optional>
|
|
Value representing the HTTP headers of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader|Mozilla.org}). |
mimeType |
string
|
<optional>
|
|
Value representing the MIME Type of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/overrideMimeType|Mozilla.org}). |
contentType |
string
|
<optional>
|
|
Value representing the Content Type HTTP Header of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader|Mozilla.org}).When vCallback.contentType is set, its value will override any value set in vCallback.headers['content-type']. |
responseType |
string
|
<optional>
|
'text'
|
Value representing the type of data contained in the response (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/responseType|Mozilla.org}). |
cache |
boolean
|
<optional>
|
false
|
Value representing if the response is to be cached. |
useCache |
boolean
|
<optional>
|
false
|
Value representing if the response is to be sourced from the cache if it's available.When !vCallback.useCache, the HTTP Header Cache-Control is set to no-cache, max-age=0. |
|
[mixin]
ish.io.net.crud.update(sURL, oBodyopt, vCallbackopt)
- Source:
Calls the passed URL to update an entity (via POST).
From Mixin: ish.io.net.js must be included for ishJS to access this functionality.
Parameters:
| Name |
Type |
Attributes |
Description |
sURL |
string
|
|
Value representing the URL to interrogate. |
oBody |
object
|
<optional>
|
Value representing the body of the request. |
vCallback |
fnIshIoNetCallback
|
object
|
<optional>
|
Value representing the function to be called when the request returns or the desired options:
Properties
| Name |
Type |
Attributes |
Default |
Description |
fn |
fnIshIoNetCallback
|
<optional>
|
|
Value representing the function to be called when the request returns; vCallback.fn(bSuccess, oResponse, vArg, $xhr). |
arg |
variant
|
<optional>
|
|
Value representing the argument that will be passed to the callback function. |
headers |
object
|
<optional>
|
|
Value representing the HTTP headers of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader|Mozilla.org}). |
mimeType |
string
|
<optional>
|
|
Value representing the MIME Type of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/overrideMimeType|Mozilla.org}). |
contentType |
string
|
<optional>
|
|
Value representing the Content Type HTTP Header of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader|Mozilla.org}).When vCallback.contentType is set, its value will override any value set in vCallback.headers['content-type']. |
responseType |
string
|
<optional>
|
'text'
|
Value representing the type of data contained in the response (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/responseType|Mozilla.org}). |
cache |
boolean
|
<optional>
|
false
|
Value representing if the response is to be cached. |
useCache |
boolean
|
<optional>
|
false
|
Value representing if the response is to be sourced from the cache if it's available.When !vCallback.useCache, the HTTP Header Cache-Control is set to no-cache, max-age=0. |
|
[mixin]
ish.io.net.delete(sURL, vCallbackopt)
- Source:
Calls the passed URL via the DELETE HTTP Verb.
From Mixin: ish.io.net-compat.js must be included for ishJS to access this functionality.
Parameters:
| Name |
Type |
Attributes |
Description |
sURL |
string
|
|
Value representing the URL to interrogate. |
vCallback |
function
|
object
|
<optional>
|
Value representing the function to be called when the request returns or the desired options:
Properties
| Name |
Type |
Attributes |
Default |
Description |
fn |
function
|
<optional>
|
|
Value representing the function to be called when the request returns; vCallback.fn(bSuccess, oResponse, vArg, $xhr). |
arg |
variant
|
<optional>
|
|
Value representing the argument that will be passed to the callback function. |
headers |
object
|
<optional>
|
|
Value representing the HTTP headers of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader|Mozilla.org}). |
mimeType |
string
|
<optional>
|
|
Value representing the MIME Type of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/overrideMimeType|Mozilla.org}). |
contentType |
string
|
<optional>
|
|
Value representing the Content Type HTTP Header of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader|Mozilla.org}).When vCallback.contentType is set, its value will override any value set in vCallback.headers['content-type']. |
responseType |
string
|
<optional>
|
'text'
|
Value representing the type of data contained in the response (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/responseType|Mozilla.org}). |
cache |
boolean
|
<optional>
|
false
|
Value representing if the response is to be cached. |
useCache |
boolean
|
<optional>
|
false
|
Value representing if the response is to be sourced from the cache if it's available.When !vCallback.useCache, the HTTP Header Cache-Control is set to no-cache, max-age=0. |
|
[mixin]
ish.io.net.delete(sURL, vCallbackopt)
- Source:
Calls the passed URL via the DELETE HTTP Verb.
From Mixin: ish.io.net.js must be included for ishJS to access this functionality.
Parameters:
| Name |
Type |
Attributes |
Description |
sURL |
string
|
|
Value representing the URL to interrogate. |
vCallback |
function
|
object
|
<optional>
|
Value representing the function to be called when the request returns or the desired options:
Properties
| Name |
Type |
Attributes |
Default |
Description |
fn |
function
|
<optional>
|
|
Value representing the function to be called when the request returns; vCallback.fn(bSuccess, oResponse, vArg, $xhr). |
arg |
variant
|
<optional>
|
|
Value representing the argument that will be passed to the callback function. |
headers |
object
|
<optional>
|
|
Value representing the HTTP headers of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader|Mozilla.org}). |
mimeType |
string
|
<optional>
|
|
Value representing the MIME Type of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/overrideMimeType|Mozilla.org}). |
contentType |
string
|
<optional>
|
|
Value representing the Content Type HTTP Header of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader|Mozilla.org}).When vCallback.contentType is set, its value will override any value set in vCallback.headers['content-type']. |
responseType |
string
|
<optional>
|
'text'
|
Value representing the type of data contained in the response (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/responseType|Mozilla.org}). |
cache |
boolean
|
<optional>
|
false
|
Value representing if the response is to be cached. |
useCache |
boolean
|
<optional>
|
false
|
Value representing if the response is to be sourced from the cache if it's available.When !vCallback.useCache, the HTTP Header Cache-Control is set to no-cache, max-age=0. |
|
[mixin]
ish.io.net.get(sURL, vCallbackopt)
- Source:
Calls the passed URL via the GET HTTP Verb.
From Mixin: ish.io.net-compat.js must be included for ishJS to access this functionality.
Parameters:
| Name |
Type |
Attributes |
Description |
sURL |
string
|
|
Value representing the URL to interrogate. |
vCallback |
fnIshIoNetCallback
|
object
|
<optional>
|
Value representing the function to be called when the request returns or the desired options:
Properties
| Name |
Type |
Attributes |
Default |
Description |
fn |
fnIshIoNetCallback
|
<optional>
|
|
Value representing the function to be called when the request returns; vCallback.fn(bSuccess, oResponse, vArg, $xhr). |
arg |
variant
|
<optional>
|
|
Value representing the argument that will be passed to the callback function. |
headers |
object
|
<optional>
|
|
Value representing the HTTP headers of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader|Mozilla.org}). |
mimeType |
string
|
<optional>
|
|
Value representing the MIME Type of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/overrideMimeType|Mozilla.org}). |
contentType |
string
|
<optional>
|
|
Value representing the Content Type HTTP Header of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader|Mozilla.org}).When vCallback.contentType is set, its value will override any value set in vCallback.headers['content-type']. |
responseType |
string
|
<optional>
|
'text'
|
Value representing the type of data contained in the response (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/responseType|Mozilla.org}). |
cache |
boolean
|
<optional>
|
false
|
Value representing if the response is to be cached. |
useCache |
boolean
|
<optional>
|
false
|
Value representing if the response is to be sourced from the cache if it's available.When !vCallback.useCache, the HTTP Header Cache-Control is set to no-cache, max-age=0. |
|
[mixin]
ish.io.net.get(sURL, vCallbackopt)
- Source:
Calls the passed URL via the GET HTTP Verb.
From Mixin: ish.io.net.js must be included for ishJS to access this functionality.
Parameters:
| Name |
Type |
Attributes |
Description |
sURL |
string
|
|
Value representing the URL to interrogate. |
vCallback |
fnIshIoNetCallback
|
object
|
<optional>
|
Value representing the function to be called when the request returns or the desired options:
Properties
| Name |
Type |
Attributes |
Default |
Description |
fn |
fnIshIoNetCallback
|
<optional>
|
|
Value representing the function to be called when the request returns; vCallback.fn(bSuccess, oResponse, vArg, $xhr). |
arg |
variant
|
<optional>
|
|
Value representing the argument that will be passed to the callback function. |
headers |
object
|
<optional>
|
|
Value representing the HTTP headers of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader|Mozilla.org}). |
mimeType |
string
|
<optional>
|
|
Value representing the MIME Type of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/overrideMimeType|Mozilla.org}). |
contentType |
string
|
<optional>
|
|
Value representing the Content Type HTTP Header of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader|Mozilla.org}).When vCallback.contentType is set, its value will override any value set in vCallback.headers['content-type']. |
responseType |
string
|
<optional>
|
'text'
|
Value representing the type of data contained in the response (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/responseType|Mozilla.org}). |
cache |
boolean
|
<optional>
|
false
|
Value representing if the response is to be cached. |
useCache |
boolean
|
<optional>
|
false
|
Value representing if the response is to be sourced from the cache if it's available.When !vCallback.useCache, the HTTP Header Cache-Control is set to no-cache, max-age=0. |
|
[mixin]
ish.io.net.head(sURL, vCallbackopt)
- Source:
Calls the passed URL via the HEAD HTTP Verb.
From Mixin: ish.io.net-compat.js must be included for ishJS to access this functionality.
Parameters:
| Name |
Type |
Attributes |
Description |
sURL |
string
|
|
Value representing the URL to interrogate. |
vCallback |
fnIshIoNetCallback
|
object
|
<optional>
|
Value representing the function to be called when the request returns or the desired options:
Properties
| Name |
Type |
Attributes |
Default |
Description |
fn |
fnIshIoNetCallback
|
<optional>
|
|
Value representing the function to be called when the request returns; vCallback.fn(bSuccess, oResponse, vArg, $xhr). |
arg |
variant
|
<optional>
|
|
Value representing the argument that will be passed to the callback function. |
headers |
object
|
<optional>
|
|
Value representing the HTTP headers of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader|Mozilla.org}). |
mimeType |
string
|
<optional>
|
|
Value representing the MIME Type of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/overrideMimeType|Mozilla.org}). |
contentType |
string
|
<optional>
|
|
Value representing the Content Type HTTP Header of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader|Mozilla.org}).When vCallback.contentType is set, its value will override any value set in vCallback.headers['content-type']. |
responseType |
string
|
<optional>
|
'text'
|
Value representing the type of data contained in the response (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/responseType|Mozilla.org}). |
cache |
boolean
|
<optional>
|
false
|
Value representing if the response is to be cached. |
useCache |
boolean
|
<optional>
|
false
|
Value representing if the response is to be sourced from the cache if it's available.When !vCallback.useCache, the HTTP Header Cache-Control is set to no-cache, max-age=0. |
|
[mixin]
ish.io.net.head(sURL, vCallbackopt)
- Source:
Calls the passed URL via the HEAD HTTP Verb.
From Mixin: ish.io.net.js must be included for ishJS to access this functionality.
Parameters:
| Name |
Type |
Attributes |
Description |
sURL |
string
|
|
Value representing the URL to interrogate. |
vCallback |
fnIshIoNetCallback
|
object
|
<optional>
|
Value representing the function to be called when the request returns or the desired options:
Properties
| Name |
Type |
Attributes |
Default |
Description |
fn |
fnIshIoNetCallback
|
<optional>
|
|
Value representing the function to be called when the request returns; vCallback.fn(bSuccess, oResponse, vArg, $xhr). |
arg |
variant
|
<optional>
|
|
Value representing the argument that will be passed to the callback function. |
headers |
object
|
<optional>
|
|
Value representing the HTTP headers of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader|Mozilla.org}). |
mimeType |
string
|
<optional>
|
|
Value representing the MIME Type of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/overrideMimeType|Mozilla.org}). |
contentType |
string
|
<optional>
|
|
Value representing the Content Type HTTP Header of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader|Mozilla.org}).When vCallback.contentType is set, its value will override any value set in vCallback.headers['content-type']. |
responseType |
string
|
<optional>
|
'text'
|
Value representing the type of data contained in the response (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/responseType|Mozilla.org}). |
cache |
boolean
|
<optional>
|
false
|
Value representing if the response is to be cached. |
useCache |
boolean
|
<optional>
|
false
|
Value representing if the response is to be sourced from the cache if it's available.When !vCallback.useCache, the HTTP Header Cache-Control is set to no-cache, max-age=0. |
|
[mixin]
ish.io.net.ip.is(x) → {integer}
- Source:
Determines if the passed value represents an IP.
From Mixin: ish.io.net-compat.js must be included for ishJS to access this functionality.
Parameters:
| Name |
Type |
Description |
x |
variant
|
Value to interrogate. |
Returns:
| Type |
Description |
|
integer
|
Value representing the type of IP; 4 representing an IPv4, 6 representing an IPv6 and 0 (falsey) representing a non-IP. |
[mixin]
ish.io.net.ip.is(x) → {integer}
- Source:
Determines if the passed value represents an IP.
From Mixin: ish.io.net.js must be included for ishJS to access this functionality.
Parameters:
| Name |
Type |
Description |
x |
variant
|
Value to interrogate. |
Returns:
| Type |
Description |
|
integer
|
Value representing the type of IP; 4 representing an IPv4, 6 representing an IPv6 and 0 (falsey) representing a non-IP. |
[mixin]
ish.io.net.ip.is.v4(x) → {boolean}
- Source:
Determines if the passed value represents an IPv4.
From Mixin: ish.io.net-compat.js must be included for ishJS to access this functionality.
Parameters:
| Name |
Type |
Description |
x |
variant
|
Value to interrogate. |
Returns:
| Type |
Description |
|
boolean
|
Value representing if the passed value represents an IPv4. |
[mixin]
ish.io.net.ip.is.v4(x) → {boolean}
- Source:
Determines if the passed value represents an IPv4.
From Mixin: ish.io.net.js must be included for ishJS to access this functionality.
Parameters:
| Name |
Type |
Description |
x |
variant
|
Value to interrogate. |
Returns:
| Type |
Description |
|
boolean
|
Value representing if the passed value represents an IPv4. |
[mixin]
ish.io.net.ip.is.v6(x) → {boolean}
- Source:
Determines if the passed value represents an IPv6.
From Mixin: ish.io.net-compat.js must be included for ishJS to access this functionality.
Parameters:
| Name |
Type |
Description |
x |
variant
|
Value to interrogate. |
Returns:
| Type |
Description |
|
boolean
|
Value representing if the passed value represents an IPv6. |
[mixin]
ish.io.net.ip.is.v6(x) → {boolean}
- Source:
Determines if the passed value represents an IPv6.
From Mixin: ish.io.net.js must be included for ishJS to access this functionality.
Parameters:
| Name |
Type |
Description |
x |
variant
|
Value to interrogate. |
Returns:
| Type |
Description |
|
boolean
|
Value representing if the passed value represents an IPv6. |
- Source:
Converts an object of key/value pairs into a FormData representation for use with multipart form bodies.
From Mixin: ish.io.net.js must be included for ishJS to access this functionality.
Parameters:
| Name |
Type |
Description |
oKeyValuePairs |
object
|
Value representing the key/value pairs to be sent in the request body. |
Returns:
| Type |
Description |
|
object
|
Value representing the key/value pairs in a FormData object. |
[mixin]
ish.io.net.ping(sURL, vCallbackopt)
- Source:
Calls the passed URL simulating a ping via the HEAD HTTP Verb.
From Mixin: ish.io.net-compat.js must be included for ishJS to access this functionality.
Parameters:
| Name |
Type |
Attributes |
Description |
sURL |
string
|
|
Value representing the URL to interrogate. |
vCallback |
fnIshIoNetCallback
|
object
|
<optional>
|
Value representing the function to be called when the request returns or the desired options:
Properties
| Name |
Type |
Attributes |
Default |
Description |
fn |
fnIshIoNetCallback
|
<optional>
|
|
Value representing the function to be called when the request returns; vCallback.fn(bSuccess, oResponse, vArg, $xhr). |
arg |
variant
|
<optional>
|
|
Value representing the argument that will be passed to the callback function. |
headers |
object
|
<optional>
|
|
Value representing the HTTP headers of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader|Mozilla.org}). |
mimeType |
string
|
<optional>
|
|
Value representing the MIME Type of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/overrideMimeType|Mozilla.org}). |
contentType |
string
|
<optional>
|
|
Value representing the Content Type HTTP Header of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader|Mozilla.org}).When vCallback.contentType is set, its value will override any value set in vCallback.headers['content-type']. |
responseType |
string
|
<optional>
|
'text'
|
Value representing the type of data contained in the response (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/responseType|Mozilla.org}). |
cache |
boolean
|
<optional>
|
false
|
Value representing if the response is to be cached. |
useCache |
boolean
|
<optional>
|
false
|
Value representing if the response is to be sourced from the cache if it's available.When !vCallback.useCache, the HTTP Header Cache-Control is set to no-cache, max-age=0. |
|
[mixin]
ish.io.net.ping(sURL, vCallbackopt)
- Source:
Calls the passed URL simulating a ping via the HEAD HTTP Verb.
From Mixin: ish.io.net.js must be included for ishJS to access this functionality.
Parameters:
| Name |
Type |
Attributes |
Description |
sURL |
string
|
|
Value representing the URL to interrogate. |
vCallback |
fnIshIoNetCallback
|
object
|
<optional>
|
Value representing the function to be called when the request returns or the desired options:
Properties
| Name |
Type |
Attributes |
Default |
Description |
fn |
fnIshIoNetCallback
|
<optional>
|
|
Value representing the function to be called when the request returns; vCallback.fn(bSuccess, oResponse, vArg, $xhr). |
arg |
variant
|
<optional>
|
|
Value representing the argument that will be passed to the callback function. |
headers |
object
|
<optional>
|
|
Value representing the HTTP headers of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader|Mozilla.org}). |
mimeType |
string
|
<optional>
|
|
Value representing the MIME Type of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/overrideMimeType|Mozilla.org}). |
contentType |
string
|
<optional>
|
|
Value representing the Content Type HTTP Header of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader|Mozilla.org}).When vCallback.contentType is set, its value will override any value set in vCallback.headers['content-type']. |
responseType |
string
|
<optional>
|
'text'
|
Value representing the type of data contained in the response (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/responseType|Mozilla.org}). |
cache |
boolean
|
<optional>
|
false
|
Value representing if the response is to be cached. |
useCache |
boolean
|
<optional>
|
false
|
Value representing if the response is to be sourced from the cache if it's available.When !vCallback.useCache, the HTTP Header Cache-Control is set to no-cache, max-age=0. |
|
[mixin]
ish.io.net.post(sURL, oBodyopt, vCallbackopt)
- Source:
Calls the passed URL via the POST HTTP Verb.
From Mixin: ish.io.net-compat.js must be included for ishJS to access this functionality.
Parameters:
| Name |
Type |
Attributes |
Description |
sURL |
string
|
|
Value representing the URL to interrogate. |
oBody |
object
|
<optional>
|
Value representing the body of the request. |
vCallback |
fnIshIoNetCallback
|
object
|
<optional>
|
Value representing the function to be called when the request returns or the desired options:
Properties
| Name |
Type |
Attributes |
Default |
Description |
fn |
fnIshIoNetCallback
|
<optional>
|
|
Value representing the function to be called when the request returns; vCallback.fn(bSuccess, oResponse, vArg, $xhr). |
arg |
variant
|
<optional>
|
|
Value representing the argument that will be passed to the callback function. |
headers |
object
|
<optional>
|
|
Value representing the HTTP headers of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader|Mozilla.org}). |
mimeType |
string
|
<optional>
|
|
Value representing the MIME Type of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/overrideMimeType|Mozilla.org}). |
contentType |
string
|
<optional>
|
|
Value representing the Content Type HTTP Header of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader|Mozilla.org}).When vCallback.contentType is set, its value will override any value set in vCallback.headers['content-type']. |
responseType |
string
|
<optional>
|
'text'
|
Value representing the type of data contained in the response (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/responseType|Mozilla.org}). |
cache |
boolean
|
<optional>
|
false
|
Value representing if the response is to be cached. |
useCache |
boolean
|
<optional>
|
false
|
Value representing if the response is to be sourced from the cache if it's available.When !vCallback.useCache, the HTTP Header Cache-Control is set to no-cache, max-age=0. |
|
[mixin]
ish.io.net.post(sURL, oBodyopt, vCallbackopt)
- Source:
Calls the passed URL via the POST HTTP Verb.
From Mixin: ish.io.net.js must be included for ishJS to access this functionality.
Parameters:
| Name |
Type |
Attributes |
Description |
sURL |
string
|
|
Value representing the URL to interrogate. |
oBody |
object
|
<optional>
|
Value representing the body of the request. |
vCallback |
fnIshIoNetCallback
|
object
|
<optional>
|
Value representing the function to be called when the request returns or the desired options:
Properties
| Name |
Type |
Attributes |
Default |
Description |
fn |
fnIshIoNetCallback
|
<optional>
|
|
Value representing the function to be called when the request returns; vCallback.fn(bSuccess, oResponse, vArg, $xhr). |
arg |
variant
|
<optional>
|
|
Value representing the argument that will be passed to the callback function. |
headers |
object
|
<optional>
|
|
Value representing the HTTP headers of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader|Mozilla.org}). |
mimeType |
string
|
<optional>
|
|
Value representing the MIME Type of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/overrideMimeType|Mozilla.org}). |
contentType |
string
|
<optional>
|
|
Value representing the Content Type HTTP Header of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader|Mozilla.org}).When vCallback.contentType is set, its value will override any value set in vCallback.headers['content-type']. |
responseType |
string
|
<optional>
|
'text'
|
Value representing the type of data contained in the response (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/responseType|Mozilla.org}). |
cache |
boolean
|
<optional>
|
false
|
Value representing if the response is to be cached. |
useCache |
boolean
|
<optional>
|
false
|
Value representing if the response is to be sourced from the cache if it's available.When !vCallback.useCache, the HTTP Header Cache-Control is set to no-cache, max-age=0. |
|
[mixin]
ish.io.net.put(sURL, oBodyopt, vCallbackopt)
- Source:
Calls the passed URL via the PUT HTTP Verb.
From Mixin: ish.io.net-compat.js must be included for ishJS to access this functionality.
Parameters:
| Name |
Type |
Attributes |
Description |
sURL |
string
|
|
Value representing the URL to interrogate. |
oBody |
object
|
<optional>
|
Value representing the body of the request. |
vCallback |
fnIshIoNetCallback
|
object
|
<optional>
|
Value representing the function to be called when the request returns or the desired options:
Properties
| Name |
Type |
Attributes |
Default |
Description |
fn |
fnIshIoNetCallback
|
<optional>
|
|
Value representing the function to be called when the request returns; vCallback.fn(bSuccess, oResponse, vArg, $xhr). |
arg |
variant
|
<optional>
|
|
Value representing the argument that will be passed to the callback function. |
headers |
object
|
<optional>
|
|
Value representing the HTTP headers of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader|Mozilla.org}). |
mimeType |
string
|
<optional>
|
|
Value representing the MIME Type of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/overrideMimeType|Mozilla.org}). |
contentType |
string
|
<optional>
|
|
Value representing the Content Type HTTP Header of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader|Mozilla.org}).When vCallback.contentType is set, its value will override any value set in vCallback.headers['content-type']. |
responseType |
string
|
<optional>
|
'text'
|
Value representing the type of data contained in the response (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/responseType|Mozilla.org}). |
cache |
boolean
|
<optional>
|
false
|
Value representing if the response is to be cached. |
useCache |
boolean
|
<optional>
|
false
|
Value representing if the response is to be sourced from the cache if it's available.When !vCallback.useCache, the HTTP Header Cache-Control is set to no-cache, max-age=0. |
|
[mixin]
ish.io.net.put(sURL, oBodyopt, vCallbackopt)
- Source:
Calls the passed URL via the PUT HTTP Verb.
From Mixin: ish.io.net.js must be included for ishJS to access this functionality.
Parameters:
| Name |
Type |
Attributes |
Description |
sURL |
string
|
|
Value representing the URL to interrogate. |
oBody |
object
|
<optional>
|
Value representing the body of the request. |
vCallback |
fnIshIoNetCallback
|
object
|
<optional>
|
Value representing the function to be called when the request returns or the desired options:
Properties
| Name |
Type |
Attributes |
Default |
Description |
fn |
fnIshIoNetCallback
|
<optional>
|
|
Value representing the function to be called when the request returns; vCallback.fn(bSuccess, oResponse, vArg, $xhr). |
arg |
variant
|
<optional>
|
|
Value representing the argument that will be passed to the callback function. |
headers |
object
|
<optional>
|
|
Value representing the HTTP headers of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader|Mozilla.org}). |
mimeType |
string
|
<optional>
|
|
Value representing the MIME Type of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/overrideMimeType|Mozilla.org}). |
contentType |
string
|
<optional>
|
|
Value representing the Content Type HTTP Header of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader|Mozilla.org}).When vCallback.contentType is set, its value will override any value set in vCallback.headers['content-type']. |
responseType |
string
|
<optional>
|
'text'
|
Value representing the type of data contained in the response (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/responseType|Mozilla.org}). |
cache |
boolean
|
<optional>
|
false
|
Value representing if the response is to be cached. |
useCache |
boolean
|
<optional>
|
false
|
Value representing if the response is to be sourced from the cache if it's available.When !vCallback.useCache, the HTTP Header Cache-Control is set to no-cache, max-age=0. |
|
[mixin]
ish.io.net.status() → {object|object|object|object|object|object}
- Source:
Enumeration of HTTP Status Codes.
From Mixin: ish.io.net-compat.js must be included for ishJS to access this functionality.
Returns:
| Name |
Type |
Description |
status |
object
|
Value representing the following properties:
Properties
| Name |
Type |
Description |
info |
object
|
Value representing 1xx HTTP status codes. |
success |
object
|
Value representing 2xx HTTP status codes. |
redirection |
object
|
Value representing 3xx HTTP status codes. |
clientError |
object
|
Value representing 4xx HTTP status codes. |
serverError |
object
|
Value representing 5xx HTTP status codes. |
|
[mixin]
ish.io.net.status() → {object|object|object|object|object|object}
- Source:
Enumeration of HTTP Status Codes.
From Mixin: ish.io.net.js must be included for ishJS to access this functionality.
Returns:
| Name |
Type |
Description |
status |
object
|
Value representing the following properties:
Properties
| Name |
Type |
Description |
info |
object
|
Value representing 1xx HTTP status codes. |
success |
object
|
Value representing 2xx HTTP status codes. |
redirection |
object
|
Value representing 3xx HTTP status codes. |
clientError |
object
|
Value representing 4xx HTTP status codes. |
serverError |
object
|
Value representing 5xx HTTP status codes. |
|
[mixin]
ish.io.net.xhr(sVerb, bAsync, sUrl, vCallbackopt, fnRetryopt, oBodyopt) → {object|function|function|object}
- Source:
XMLHttpRequest (XHR) management function.
From Mixin: ish.io.net-compat.js must be included for ishJS to access this functionality.
Parameters:
| Name |
Type |
Attributes |
Description |
sVerb |
string
|
|
Value representing the HTTP Verb. |
bAsync |
boolean
|
|
Value representing if the HTTP request is to be asynchronous. |
sUrl |
string
|
|
Value representing the URL to interrogate. |
vCallback |
fnIshIoNetCallback
|
object
|
<optional>
|
Value representing the function to be called when the request returns or the desired options:
Properties
| Name |
Type |
Attributes |
Default |
Description |
fn |
fnIshIoNetCallback
|
<optional>
|
|
Value representing the function to be called when the request returns; vCallback.fn(bSuccess, oResponse, vArg, $xhr). |
arg |
variant
|
<optional>
|
|
Value representing the argument that will be passed to the callback function. |
headers |
object
|
<optional>
|
|
Value representing the HTTP headers of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader|Mozilla.org}). |
mimeType |
string
|
<optional>
|
|
Value representing the MIME Type of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/overrideMimeType|Mozilla.org}). |
contentType |
string
|
<optional>
|
|
Value representing the Content Type HTTP Header of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader|Mozilla.org}).When vCallback.contentType is set, its value will override any value set in vCallback.headers['content-type']. |
responseType |
string
|
<optional>
|
'text'
|
Value representing the type of data contained in the response (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/responseType|Mozilla.org}). |
cache |
boolean
|
<optional>
|
false
|
Value representing if the response is to be cached. |
useCache |
boolean
|
<optional>
|
false
|
Value representing if the response is to be sourced from the cache if it's available.When !vCallback.useCache, the HTTP Header Cache-Control is set to no-cache, max-age=0. |
|
fnRetry |
function
|
<optional>
|
Value representing the function to be called when the request is to be retried. |
oBody |
object
|
<optional>
|
Value representing the body of the request. |
Returns:
| Name |
Type |
Description |
interface |
object
|
Value representing the following properties:
Properties
| Name |
Type |
Description |
send |
function
|
Sends the request; send(vBody, fnHook):
vBody | | variant | object | | Value representing the body of the call. |
fnHook | | function | | Value representing the function to be called before the request is sent via the underlying XMLHttpRequest management object; fnHook($xhr). |
|
abort |
function
|
Aborts the request; abort(). |
xhr |
object
|
Value representing the underlying XMLHttpRequest management object. |
|
[mixin]
ish.io.net.xhr(sVerb, bAsync, sUrl, vCallbackopt, fnRetryopt, oBodyopt) → {object|function|function|object}
- Source:
XMLHttpRequest (XHR) management function.
From Mixin: ish.io.net-xhr.js must be included for ishJS to access this functionality.
Parameters:
| Name |
Type |
Attributes |
Description |
sVerb |
string
|
|
Value representing the HTTP Verb. |
bAsync |
boolean
|
|
Value representing if the HTTP request is to be asynchronous. |
sUrl |
string
|
|
Value representing the URL to interrogate. |
vCallback |
fnIshIoNetCallback
|
object
|
<optional>
|
Value representing the function to be called when the request returns or the desired options:
Properties
| Name |
Type |
Attributes |
Default |
Description |
fn |
fnIshIoNetCallback
|
<optional>
|
|
Value representing the function to be called when the request returns; vCallback.fn(bSuccess, oResponse, vArg, $xhr). |
arg |
variant
|
<optional>
|
|
Value representing the argument that will be passed to the callback function. |
headers |
object
|
<optional>
|
|
Value representing the HTTP headers of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader|Mozilla.org}). |
mimeType |
string
|
<optional>
|
|
Value representing the MIME Type of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/overrideMimeType|Mozilla.org}). |
contentType |
string
|
<optional>
|
|
Value representing the Content Type HTTP Header of the request (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader|Mozilla.org}).When vCallback.contentType is set, its value will override any value set in vCallback.headers['content-type']. |
responseType |
string
|
<optional>
|
'text'
|
Value representing the type of data contained in the response (see: {@link: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/responseType|Mozilla.org}). |
cache |
boolean
|
<optional>
|
false
|
Value representing if the response is to be cached. |
useCache |
boolean
|
<optional>
|
false
|
Value representing if the response is to be sourced from the cache if it's available.When !vCallback.useCache, the HTTP Header Cache-Control is set to no-cache, max-age=0. |
|
fnRetry |
function
|
<optional>
|
Value representing the function to be called when the request is to be retried. |
oBody |
object
|
<optional>
|
Value representing the body of the request. |
Returns:
| Name |
Type |
Description |
interface |
object
|
Value representing the following properties:
Properties
| Name |
Type |
Description |
send |
function
|
Sends the request; send(vBody, fnHook):
vBody | | variant | object | | Value representing the body of the call. |
fnHook | | function | | Value representing the function to be called before the request is sent via the underlying XMLHttpRequest management object; fnHook($xhr). |
|
abort |
function
|
Aborts the request; abort(). |
xhr |
object
|
Value representing the underlying XMLHttpRequest management object. |
|
