crossbrowdy

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width"> <title>CrossBrowdy API documentation [printable] Namespace: REST</title>  <link type="text/css" rel="stylesheet" href="styles/sunlight.default.css"> <link type="text/css" rel="stylesheet" href="styles/site.yeti.css"> </head> <body style="min-width:800px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"> <div class="navbar navbar-default navbar-fixed-top "> <div class="container"> <div class="navbar-header"> <a class="navbar-brand" href="index.html">CrossBrowdy API documentation [printable]</a> <button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation"> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </button> </div> <div class="navbar-collapse collapse" id="topNavigation"> <ul class="nav navbar-nav"> <li class="dropdown"> <a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a> <ul class="dropdown-menu inline"> <li><a href="CB_Arrays.html">CB_Arrays</a></li><li><a href="CB_AudioDetector.html">CB_AudioDetector</a></li><li><a href="CB_Client.html">CB_Client</a></li><li><a href="CB_Collisions.html">CB_Collisions</a></li><li><a href="CB_Configuration.html">CB_Configuration</a></li><li><a href="CB_Configuration.CrossBase.html">CB_Configuration.CrossBase</a></li><li><a href="CB_Configuration.CrossBrowdy.html">CB_Configuration.CrossBrowdy</a></li><li><a href="CB_Controllers.html">CB_Controllers</a></li><li><a href="CB_Controllers_Proprietary.html">CB_Controllers_Proprietary</a></li><li><a href="CB_Controllers_Proprietary.WII.html">CB_Controllers_Proprietary.WII</a></li><li><a href="CB_Controllers_Proprietary.WII_U.html">CB_Controllers_Proprietary.WII_U</a></li><li><a href="CB_Device.html">CB_Device</a></li><li><a href="CB_Device.AmbientLight.html">CB_Device.AmbientLight</a></li><li><a href="CB_Device.Battery.html">CB_Device.Battery</a></li><li><a href="CB_Device.Location.html">CB_Device.Location</a></li><li><a href="CB_Device.Motion.html">CB_Device.Motion</a></li><li><a href="CB_Device.Orientation.html">CB_Device.Orientation</a></li><li><a href="CB_Device.Proximity.html">CB_Device.Proximity</a></li><li><a href="CB_Device.Vibration.html">CB_Device.Vibration</a></li><li><a href="CB_Elements.html">CB_Elements</a></li><li><a href="CB_Events.html">CB_Events</a></li><li><a href="CB_Keyboard.html">CB_Keyboard</a></li><li><a href="CB_Keyboard.chars.html">CB_Keyboard.chars</a></li><li><a href="CB_Keyboard.extended.html">CB_Keyboard.extended</a></li><li><a href="CB_Keyboard.keys.html">CB_Keyboard.keys</a></li><li><a href="CB_Modules.html">CB_Modules</a></li><li><a href="CB_Mouse.html">CB_Mouse</a></li><li><a href="CB_Mouse.CursorImage.html">CB_Mouse.CursorImage</a></li><li><a href="CB_Net.html">CB_Net</a></li><li><a href="CB_Net.Fetch.html">CB_Net.Fetch</a></li><li><a href="CB_Net.REST.html">CB_Net.REST</a></li><li><a href="CB_Net.Sockets.html">CB_Net.Sockets</a></li><li><a href="CB_Net.Sockets.SockJS.html">CB_Net.Sockets.SockJS</a></li><li><a href="CB_Net.XHR.html">CB_Net.XHR</a></li><li><a href="CB_Pointer.html">CB_Pointer</a></li><li><a href="CB_Screen.html">CB_Screen</a></li><li><a href="CB_Speaker.html">CB_Speaker</a></li><li><a href="CB_Touch.html">CB_Touch</a></li><li><a href="CB_baseSymbols.html">CB_baseSymbols</a></li> </ul> </li> <li class="dropdown"> <a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a> <ul class="dropdown-menu inline"> <li><a href="CB_AudioFile.html">CB_AudioFile</a></li><li><a href="CB_AudioFileCache.html">CB_AudioFileCache</a></li><li><a href="CB_AudioFileSprites.html">CB_AudioFileSprites</a></li><li><a href="CB_AudioFileSpritesPool.html">CB_AudioFileSpritesPool</a></li><li><a href="CB_AudioFile_API.AAPI.html">CB_AudioFile_API.AAPI</a></li><li><a href="CB_AudioFile_API.ACMP.html">CB_AudioFile_API.ACMP</a></li><li><a href="CB_AudioFile_API.SM2.html">CB_AudioFile_API.SM2</a></li><li><a href="CB_AudioFile_API.WAAPI.html">CB_AudioFile_API.WAAPI</a></li><li><a href="CB_Canvas.html">CB_Canvas</a></li><li><a href="CB_GraphicSprites.html">CB_GraphicSprites</a></li><li><a href="CB_GraphicSpritesScene.html">CB_GraphicSpritesScene</a></li> </ul> </li> <li class="dropdown"> <a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a> <ul class="dropdown-menu inline"> <li><a href="global.html#CB_BASE_NAME">CB_BASE_NAME</a></li><li><a href="global.html#CB_CREDITS_DEFAULT">CB_CREDITS_DEFAULT</a></li><li><a href="global.html#CB_NAME">CB_NAME</a></li><li><a href="global.html#CB_OPTIONS">CB_OPTIONS</a></li><li><a href="global.html#CB_VERSION">CB_VERSION</a></li><li><a href="global.html#CB_addCredits">CB_addCredits</a></li><li><a href="global.html#CB_baseToBase">CB_baseToBase</a></li><li><a href="global.html#CB_baseToInt">CB_baseToInt</a></li><li><a href="global.html#CB_br2nl">CB_br2nl</a></li><li><a href="global.html#CB_brToNl">CB_brToNl</a></li><li><a href="global.html#CB_combineArraysOrObjects">CB_combineArraysOrObjects</a></li><li><a href="global.html#CB_combineAutomatically">CB_combineAutomatically</a></li><li><a href="global.html#CB_combineJSON">CB_combineJSON</a></li><li><a href="global.html#CB_combineURIParameters">CB_combineURIParameters</a></li><li><a href="global.html#CB_combineURLParameters">CB_combineURLParameters</a></li><li><a href="global.html#CB_console">CB_console</a></li><li><a href="global.html#CB_copyObject">CB_copyObject</a></li><li><a href="global.html#CB_countDecimalDigits">CB_countDecimalDigits</a></li><li><a href="global.html#CB_countDecimalPart">CB_countDecimalPart</a></li><li><a href="global.html#CB_countDecimals">CB_countDecimals</a></li><li><a href="global.html#CB_countIntegerDigits">CB_countIntegerDigits</a></li><li><a href="global.html#CB_countIntegerPart">CB_countIntegerPart</a></li><li><a href="global.html#CB_credits">CB_credits</a></li><li><a href="global.html#CB_forEach">CB_forEach</a></li><li><a href="global.html#CB_forceString">CB_forceString</a></li><li><a href="global.html#CB_getBase64StringObject">CB_getBase64StringObject</a></li><li><a href="global.html#CB_getCookie">CB_getCookie</a></li><li><a href="global.html#CB_getDatum">CB_getDatum</a></li><li><a href="global.html#CB_getJSONPropertyValue">CB_getJSONPropertyValue</a></li><li><a href="global.html#CB_getLZStringObject">CB_getLZStringObject</a></li><li><a href="global.html#CB_getValueIndex">CB_getValueIndex</a></li><li><a href="global.html#CB_getValuePath">CB_getValuePath</a></li><li><a href="global.html#CB_includeJSFile">CB_includeJSFile</a></li><li><a href="global.html#CB_indexOf">CB_indexOf</a></li><li><a href="global.html#CB_init">CB_init</a></li><li><a href="global.html#CB_intToBase">CB_intToBase</a></li><li><a href="global.html#CB_isArray">CB_isArray</a></li><li><a href="global.html#CB_isEmail">CB_isEmail</a></li><li><a href="global.html#CB_isFileLocal">CB_isFileLocal</a></li><li><a href="global.html#CB_isString">CB_isString</a></li><li><a href="global.html#CB_lastIndexOf">CB_lastIndexOf</a></li><li><a href="global.html#CB_ltrim">CB_ltrim</a></li><li><a href="global.html#CB_nl2br">CB_nl2br</a></li><li><a href="global.html#CB_nlToBr">CB_nlToBr</a></li><li><a href="global.html#CB_numberFormat">CB_numberFormat</a></li><li><a href="global.html#CB_numberOfDecimalDigits">CB_numberOfDecimalDigits</a></li><li><a href="global.html#CB_numberOfDecimals">CB_numberOfDecimals</a></li><li><a href="global.html#CB_numberOfIntegerDigits">CB_numberOfIntegerDigits</a></li><li><a href="global.html#CB_parseJSON">CB_parseJSON</a></li><li><a href="global.html#CB_parseString">CB_parseString</a></li><li><a href="global.html#CB_regularExpressionString">CB_regularExpressionString</a></li><li><a href="global.html#CB_renderString">CB_renderString</a></li><li><a href="global.html#CB_replaceAll">CB_replaceAll</a></li><li><a href="global.html#CB_rtrim">CB_rtrim</a></li><li><a href="global.html#CB_scriptPath">CB_scriptPath</a></li><li><a href="global.html#CB_scriptPathCalculate">CB_scriptPathCalculate</a></li><li><a href="global.html#CB_setCookie">CB_setCookie</a></li><li><a href="global.html#CB_setDatum">CB_setDatum</a></li><li><a href="global.html#CB_sizeOf">CB_sizeOf</a></li><li><a href="global.html#CB_sizeof">CB_sizeof</a></li><li><a href="global.html#CB_stringifyJSON">CB_stringifyJSON</a></li><li><a href="global.html#CB_symmetricCall">CB_symmetricCall</a></li><li><a href="global.html#CB_symmetricCallClear">CB_symmetricCallClear</a></li><li><a href="global.html#CB_this">CB_this</a></li><li><a href="global.html#CB_trim">CB_trim</a></li> </ul> </li> </ul> <div class="col-sm-3 col-md-3"> <form class="navbar-form" role="search"> <div class="input-group"> <input type="text" class="form-control" placeholder="Search" name="q" id="search-input"> <div class="input-group-btn"> <button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button> </div> </div> </form> </div> </div> </div> </div> <div class="container" id="toc-content" style="width:100%;"> <div class="row" style="width:100%;"> <div class="col-md-8" style="width:85%;"> <div id="main"> <h1 class="page-title">Namespace: REST</h1> <section> <header> <h2> <span class="ancestors"><a href="CB_Net.html">CB_Net</a>.</span> REST </h2> </header> <article> <div class="container-overview"> <div class="description"><p>Static class to manage <a href="https://en.wikipedia.org/wiki/Representational_state_transfer">REST</a> services and related. It will return itself if it is tried to be instantiated.</p></div> <dl class="details"> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_net_REST_CB_Net_REST.js.html">CrossBase/net/REST/CB_Net_REST.js</a>, <a href="CrossBase_net_REST_CB_Net_REST.js.html#sunlight-1-line-14">line 14</a> </li> </ul> </dd> <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt> <dd class="tag-todo"> <ul> <li>Think about accepting an onAbort function as option (with also default and permanent).</li> </ul> </dd> </dl> </div> <h3 class="subsection-title">Members</h3> <dl> <hr> <dt class="name" id=".SERVER_URL_DEFAULT"> <h4 id=".SERVER_URL_DEFAULT"><span class="type-signature"><static> </span>SERVER_URL_DEFAULT<span class="type-signature"> :string</span></h4> </dt> <dd> <div class="description"> <p>Defines the URL for the default <a href="https://en.wikipedia.org/wiki/Representational_state_transfer">REST</a> server to use when the "serverURL" parameter is not available. Used by the <a href="CB_Net.XHR.html#.callREST"><code>CB_Net.XHR.callREST</code></a> function as the default "serverURL" parameter.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">string</span> </li> </ul> <dl class="details"> <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt> <dd class="tag-default"> <ul class="dummy"> <li>http://localhost/CrossBrowdy/tests/net/fake_rest_server/index.php</li> </ul> </dd> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_net_REST_CB_Net_REST.js.html">CrossBase/net/REST/CB_Net_REST.js</a>, <a href="CrossBase_net_REST_CB_Net_REST.js.html#sunlight-1-line-25">line 25</a> </li> </ul> </dd> </dl> </dd> <hr> <dt class="name" id=".actions"> <h4 id=".actions"><span class="type-signature"><static> </span>actions<span class="type-signature"> :Object</span></h4> </dt> <dd> <div class="description"> <p>List of <a href="https://en.wikipedia.org/wiki/Representational_state_transfer">REST</a> actions. Each property name is the name of the action and its value is a <a href="CB_Net.REST.html#.actionProcess_ACTIONS"><code>CB_Net.REST.actionProcess_ACTIONS</code></a> object. Used by the <a href="CB_Net.REST.html#.actionProcess"><code>CB_Net.REST.actionProcess</code></a> function.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">Object</span> </li> </ul> <dl class="details"> <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt> <dd class="tag-default"> <ul class="dummy"> <li>{}</li> </ul> </dd> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_net_REST_CB_Net_REST.js.html">CrossBase/net/REST/CB_Net_REST.js</a>, <a href="CrossBase_net_REST_CB_Net_REST.js.html#sunlight-1-line-414">line 414</a> </li> </ul> </dd> </dl> </dd> <hr> <dt class="name" id=".allowedSuccessStatuses_DEFAULT"> <h4 id=".allowedSuccessStatuses_DEFAULT"><span class="type-signature"><static> </span>allowedSuccessStatuses_DEFAULT<span class="type-signature"> :array</span></h4> </dt> <dd> <div class="description"> <p>Default "allowedSuccessStatuses", containing the statuses to considerer a successful <a href="https://en.wikipedia.org/wiki/Representational_state_transfer">REST</a> action (must be a numeric array of integers). Used by the <a href="CB_Net.REST.html#.actionProcess"><code>CB_Net.REST.actionProcess</code></a> function.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">array</span> </li> </ul> <dl class="details"> <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt> <dd class="tag-default"> <ul class="dummy"> <li>[200,201,206]</li> </ul> </dd> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_net_REST_CB_Net_REST.js.html">CrossBase/net/REST/CB_Net_REST.js</a>, <a href="CrossBase_net_REST_CB_Net_REST.js.html#sunlight-1-line-272">line 272</a> </li> </ul> </dd> </dl> </dd> <hr> <dt class="name" id=".allowedSuccessStatuses_PERMANENT"> <h4 id=".allowedSuccessStatuses_PERMANENT"><span class="type-signature"><static> </span>allowedSuccessStatuses_PERMANENT<span class="type-signature"> :array</span></h4> </dt> <dd> <div class="description"> <p>Permanent values for the "allowedSuccessStatuses" parameter, containing the statuses to considerer a successful <a href="https://en.wikipedia.org/wiki/Representational_state_transfer">REST</a> action (must be a numeric array of integers). Used by the <a href="CB_Net.REST.html#.actionProcess"><code>CB_Net.REST.actionProcess</code></a> function. This is permanent for each <a href="https://en.wikipedia.org/wiki/Representational_state_transfer">REST</a> action.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">array</span> </li> </ul> <dl class="details"> <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt> <dd class="tag-default"> <ul class="dummy"> <li>[]</li> </ul> </dd> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_net_REST_CB_Net_REST.js.html">CrossBase/net/REST/CB_Net_REST.js</a>, <a href="CrossBase_net_REST_CB_Net_REST.js.html#sunlight-1-line-263">line 263</a> </li> </ul> </dd> </dl> </dd> <hr> <dt class="name" id=".avoidProxy_DEFAULT"> <h4 id=".avoidProxy_DEFAULT"><span class="type-signature"><static> </span>avoidProxy_DEFAULT<span class="type-signature"> :boolean</span></h4> </dt> <dd> <div class="description"> <p>Default value when the "avoidProxy" parameter is not available. Used by the <a href="CB_Net.REST.html#.actionProcess"><code>CB_Net.REST.actionProcess</code></a> function.<br> <br /><br> NOTE: Edit the "CB_proxy.config.php" file to configure the default proxy (set by default in the value of the <a href="CB_Configuration.CrossBase.html#.CB_Net_XHR_PROXY_URL"><code>CB_Configuration.CrossBase.CB_Net_XHR_PROXY_URL</code></a> property). Apart from configuring it, adding some security measures is highly recommended.<br> Have in mind that, for safety reasons, the default proxy only allows to request the URLs defined in the "$allowedURLs" array in the "CB_proxy.config.php" file. Just edit it to allow other URLs.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">boolean</span> </li> </ul> <dl class="details"> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_net_REST_CB_Net_REST.js.html">CrossBase/net/REST/CB_Net_REST.js</a>, <a href="CrossBase_net_REST_CB_Net_REST.js.html#sunlight-1-line-37">line 37</a> </li> </ul> </dd> </dl> </dd> <hr> <dt class="name" id=".callbackBefore_DEFAULT"> <h4 id=".callbackBefore_DEFAULT"><span class="type-signature"><static> </span>callbackBefore_DEFAULT<span class="type-signature"> :<a href="CB_Net.REST.html#.actionProcess_CALLBACK_BEFORE">CB_Net.REST.actionProcess_CALLBACK_BEFORE</a></span></h4> </dt> <dd> <div class="description"> <p>Default "callbackBefore", containing a callback function before performing each <a href="https://en.wikipedia.org/wiki/Representational_state_transfer">REST</a> action returning a boolean (to decide whether to do it or not). The function assigned by default returns true. Used by the <a href="CB_Net.REST.html#.actionProcess"><code>CB_Net.REST.actionProcess</code></a> function.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="CB_Net.REST.html#.actionProcess_CALLBACK_BEFORE">CB_Net.REST.actionProcess_CALLBACK_BEFORE</a></span> </li> </ul> <dl class="details"> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_net_REST_CB_Net_REST.js.html">CrossBase/net/REST/CB_Net_REST.js</a>, <a href="CrossBase_net_REST_CB_Net_REST.js.html#sunlight-1-line-303">line 303</a> </li> </ul> </dd> </dl> </dd> <hr> <dt class="name" id=".callbackBefore_PERMANENT"> <h4 id=".callbackBefore_PERMANENT"><span class="type-signature"><static> </span>callbackBefore_PERMANENT<span class="type-signature"> :<a href="CB_Net.REST.html#.actionProcess_CALLBACK_BEFORE">CB_Net.REST.actionProcess_CALLBACK_BEFORE</a></span></h4> </dt> <dd> <div class="description"> <p>Permanent callback function before performing each <a href="https://en.wikipedia.org/wiki/Representational_state_transfer">REST</a> action returning a boolean (to decide whether to do it or not). Executed before the default or the set "callbackBefore" function (if any). The function assigned by default returns true. Used by the <a href="CB_Net.REST.html#.actionProcess"><code>CB_Net.REST.actionProcess</code></a> function. This is permanent for each <a href="https://en.wikipedia.org/wiki/Representational_state_transfer">REST</a> action.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="CB_Net.REST.html#.actionProcess_CALLBACK_BEFORE">CB_Net.REST.actionProcess_CALLBACK_BEFORE</a></span> </li> </ul> <dl class="details"> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_net_REST_CB_Net_REST.js.html">CrossBase/net/REST/CB_Net_REST.js</a>, <a href="CrossBase_net_REST_CB_Net_REST.js.html#sunlight-1-line-290">line 290</a> </li> </ul> </dd> </dl> </dd> <hr> <dt class="name" id=".callbackError_DEFAULT"> <h4 id=".callbackError_DEFAULT"><span class="type-signature"><static> </span>callbackError_DEFAULT<span class="type-signature"> :<a href="CB_Net.REST.html#.actionProcess_CALLBACK_ERROR">CB_Net.REST.actionProcess_CALLBACK_ERROR</a></span></h4> </dt> <dd> <div class="description"> <p>Default "callbackError", containing a callback function when an error happens processing the <a href="https://en.wikipedia.org/wiki/Representational_state_transfer">REST</a> action. Used by the <a href="CB_Net.REST.html#.actionProcess"><code>CB_Net.REST.actionProcess</code></a> function.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="CB_Net.REST.html#.actionProcess_CALLBACK_ERROR">CB_Net.REST.actionProcess_CALLBACK_ERROR</a></span> </li> </ul> <dl class="details"> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_net_REST_CB_Net_REST.js.html">CrossBase/net/REST/CB_Net_REST.js</a>, <a href="CrossBase_net_REST_CB_Net_REST.js.html#sunlight-1-line-375">line 375</a> </li> </ul> </dd> </dl> </dd> <hr> <dt class="name" id=".callbackError_PERMANENT"> <h4 id=".callbackError_PERMANENT"><span class="type-signature"><static> </span>callbackError_PERMANENT<span class="type-signature"> :<a href="CB_Net.REST.html#.actionProcess_CALLBACK_ERROR">CB_Net.REST.actionProcess_CALLBACK_ERROR</a></span></h4> </dt> <dd> <div class="description"> <p>Permanent callback function when an error happens processing any <a href="https://en.wikipedia.org/wiki/Representational_state_transfer">REST</a> action. Used by the <a href="CB_Net.REST.html#.actionProcess"><code>CB_Net.REST.actionProcess</code></a> function. Executed before the default or the set "callbackError" function (if any). This is permanent for each <a href="https://en.wikipedia.org/wiki/Representational_state_transfer">REST</a> action.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="CB_Net.REST.html#.actionProcess_CALLBACK_ERROR">CB_Net.REST.actionProcess_CALLBACK_ERROR</a></span> </li> </ul> <dl class="details"> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_net_REST_CB_Net_REST.js.html">CrossBase/net/REST/CB_Net_REST.js</a>, <a href="CrossBase_net_REST_CB_Net_REST.js.html#sunlight-1-line-362">line 362</a> </li> </ul> </dd> </dl> </dd> <hr> <dt class="name" id=".callbackOk_DEFAULT"> <h4 id=".callbackOk_DEFAULT"><span class="type-signature"><static> </span>callbackOk_DEFAULT<span class="type-signature"> :<a href="CB_Net.REST.html#.actionProcess_CALLBACK_OK">CB_Net.REST.actionProcess_CALLBACK_OK</a></span></h4> </dt> <dd> <div class="description"> <p>Default "callbackOk", containing a callback function when the <a href="https://en.wikipedia.org/wiki/Representational_state_transfer">REST</a> action has been successful. Used by the <a href="CB_Net.REST.html#.actionProcess"><code>CB_Net.REST.actionProcess</code></a> function.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="CB_Net.REST.html#.actionProcess_CALLBACK_OK">CB_Net.REST.actionProcess_CALLBACK_OK</a></span> </li> </ul> <dl class="details"> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_net_REST_CB_Net_REST.js.html">CrossBase/net/REST/CB_Net_REST.js</a>, <a href="CrossBase_net_REST_CB_Net_REST.js.html#sunlight-1-line-340">line 340</a> </li> </ul> </dd> </dl> </dd> <hr> <dt class="name" id=".callbackOk_PERMANENT"> <h4 id=".callbackOk_PERMANENT"><span class="type-signature"><static> </span>callbackOk_PERMANENT<span class="type-signature"> :<a href="CB_Net.REST.html#.actionProcess_CALLBACK_OK">CB_Net.REST.actionProcess_CALLBACK_OK</a></span></h4> </dt> <dd> <div class="description"> <p>Permanent callback function when each <a href="https://en.wikipedia.org/wiki/Representational_state_transfer">REST</a> action has been successful. Used by the <a href="CB_Net.REST.html#.actionProcess"><code>CB_Net.REST.actionProcess</code></a> function. Executed before the default or the set "callbackOk" function (if any). This is permanent for each <a href="https://en.wikipedia.org/wiki/Representational_state_transfer">REST</a> action.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="CB_Net.REST.html#.actionProcess_CALLBACK_OK">CB_Net.REST.actionProcess_CALLBACK_OK</a></span> </li> </ul> <dl class="details"> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_net_REST_CB_Net_REST.js.html">CrossBase/net/REST/CB_Net_REST.js</a>, <a href="CrossBase_net_REST_CB_Net_REST.js.html#sunlight-1-line-327">line 327</a> </li> </ul> </dd> </dl> </dd> <hr> <dt class="name" id=".dataURL_DEFAULT"> <h4 id=".dataURL_DEFAULT"><span class="type-signature"><static> </span>dataURL_DEFAULT<span class="type-signature"> :<a href="CB_Net.REST.html#.actionProcess_DATA_URL">CB_Net.REST.actionProcess_DATA_URL</a></span></h4> </dt> <dd> <div class="description"> <p>Default "dataURL" for <a href="https://en.wikipedia.org/wiki/Representational_state_transfer">REST</a> actions (must return a string in URL/GET parameters format). The function assigned by default returns an empty string (""). Used by the <a href="CB_Net.REST.html#.actionProcess"><code>CB_Net.REST.actionProcess</code></a> function. NOTE: remember to use <a href="CB_Net.html#.URLValueEncode"><code>CB_Net.URLValueEncode</code></a> if needed.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="CB_Net.REST.html#.actionProcess_DATA_URL">CB_Net.REST.actionProcess_DATA_URL</a></span> </li> </ul> <dl class="details"> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_net_REST_CB_Net_REST.js.html">CrossBase/net/REST/CB_Net_REST.js</a>, <a href="CrossBase_net_REST_CB_Net_REST.js.html#sunlight-1-line-215">line 215</a> </li> </ul> </dd> </dl> </dd> <hr> <dt class="name" id=".dataURL_PERMANENT"> <h4 id=".dataURL_PERMANENT"><span class="type-signature"><static> </span>dataURL_PERMANENT<span class="type-signature"> :<a href="CB_Net.REST.html#.actionProcess_DATA_URL">CB_Net.REST.actionProcess_DATA_URL</a></span></h4> </dt> <dd> <div class="description"> <p>Permanent function (must return a string in URL/GET parameters format) to execute the same way as the "dataURL" parameter. The function assigned by default returns an empty string (""). Used by the <a href="CB_Net.REST.html#.actionProcess"><code>CB_Net.REST.actionProcess</code></a> function. The returning data will be placed in the beginning of the URL, followed by the rest of the "dataURL" desired (if any). NOTE: remember to use <a href="CB_Net.html#.URLValueEncode"><code>CB_Net.URLValueEncode</code></a> if needed. This is permanent for each <a href="https://en.wikipedia.org/wiki/Representational_state_transfer">REST</a> action.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="CB_Net.REST.html#.actionProcess_DATA_URL">CB_Net.REST.actionProcess_DATA_URL</a></span> </li> </ul> <dl class="details"> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_net_REST_CB_Net_REST.js.html">CrossBase/net/REST/CB_Net_REST.js</a>, <a href="CrossBase_net_REST_CB_Net_REST.js.html#sunlight-1-line-202">line 202</a> </li> </ul> </dd> </dl> </dd> <hr> <dt class="name" id=".data_DEFAULT"> <h4 id=".data_DEFAULT"><span class="type-signature"><static> </span>data_DEFAULT<span class="type-signature"> :<a href="CB_Net.REST.html#.actionProcess_DATA">CB_Net.REST.actionProcess_DATA</a></span></h4> </dt> <dd> <div class="description"> <p>Default "data" for <a href="https://en.wikipedia.org/wiki/Representational_state_transfer">REST</a> actions (must return a string in URL/GET parameters format or a <a href="https://en.wikipedia.org/wiki/JSON">JSON</a> format string). The function assigned by default returns an empty string (""). Used by the <a href="CB_Net.REST.html#.actionProcess"><code>CB_Net.REST.actionProcess</code></a> function. The values returned by all functions that are mean to return the data should always return the same type of data (all strinngs or all objects) since <a href="CB_Net.REST.html#.actionProcess"><code>CB_Net.REST.actionProcess</code></a> will use the <a href="global.html#CB_combineAutomatically"><code>CB_combineAutomatically</code></a> function to combine them. NOTE: remember to use <a href="CB_Net.html#.URLValueEncode"><code>CB_Net.URLValueEncode</code></a> if needed.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="CB_Net.REST.html#.actionProcess_DATA">CB_Net.REST.actionProcess_DATA</a></span> </li> </ul> <dl class="details"> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_net_REST_CB_Net_REST.js.html">CrossBase/net/REST/CB_Net_REST.js</a>, <a href="CrossBase_net_REST_CB_Net_REST.js.html#sunlight-1-line-250">line 250</a> </li> </ul> </dd> </dl> </dd> <hr> <dt class="name" id=".data_PERMANENT"> <h4 id=".data_PERMANENT"><span class="type-signature"><static> </span>data_PERMANENT<span class="type-signature"> :<a href="CB_Net.REST.html#.actionProcess_DATA">CB_Net.REST.actionProcess_DATA</a></span></h4> </dt> <dd> <div class="description"> <p>Permanent function (must return a string in URL/GET parameters format or a <a href="https://en.wikipedia.org/wiki/JSON">JSON</a> format string) to execute the same way as the "data" parameter. The function assigned by default returns an empty string (""). Used by the <a href="CB_Net.REST.html#.actionProcess"><code>CB_Net.REST.actionProcess</code></a> function. The values returned by all functions that are mean to return the data should always return the same type of data (all strinngs or all objects) since <a href="CB_Net.REST.html#.actionProcess"><code>CB_Net.REST.actionProcess</code></a> will use the <a href="global.html#CB_combineAutomatically"><code>CB_combineAutomatically</code></a> function to combine them. This is permanent for each <a href="https://en.wikipedia.org/wiki/Representational_state_transfer">REST</a> action. NOTE: remember to use <a href="CB_Net.html#.URLValueEncode"><code>CB_Net.URLValueEncode</code></a> if needed.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="CB_Net.REST.html#.actionProcess_DATA">CB_Net.REST.actionProcess_DATA</a></span> </li> </ul> <dl class="details"> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_net_REST_CB_Net_REST.js.html">CrossBase/net/REST/CB_Net_REST.js</a>, <a href="CrossBase_net_REST_CB_Net_REST.js.html#sunlight-1-line-237">line 237</a> </li> </ul> </dd> </dl> </dd> <hr> <dt class="name" id=".forceJSON_DEFAULT"> <h4 id=".forceJSON_DEFAULT"><span class="type-signature"><static> </span>forceJSON_DEFAULT<span class="type-signature"> :boolean</span></h4> </dt> <dd> <div class="description"> <p>Tells whether to force <a href="https://en.wikipedia.org/wiki/JSON">JSON</a> response by default or not. Used by the <a href="CB_Net.REST.html#.actionProcess"><code>CB_Net.REST.actionProcess</code></a> function when the REST action does not provided it and it is not null, as the "forceJSON" option.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">boolean</span> </li> </ul> <dl class="details"> <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt> <dd class="tag-default"> <ul class="dummy"> <li>true</li> </ul> </dd> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_net_REST_CB_Net_REST.js.html">CrossBase/net/REST/CB_Net_REST.js</a>, <a href="CrossBase_net_REST_CB_Net_REST.js.html#sunlight-1-line-99">line 99</a> </li> </ul> </dd> </dl> </dd> <hr> <dt class="name" id=".getHeadersOneDimensionValues_DEFAULT"> <h4 id=".getHeadersOneDimensionValues_DEFAULT"><span class="type-signature"><static> </span>getHeadersOneDimensionValues_DEFAULT<span class="type-signature"> :boolean</span></h4> </dt> <dd> <div class="description"> <p>Tells whether to get response <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers">HTTP headers</a> values in one-dimension (just one value per key) by default or not (needs "getHeaders" set to true). Used by the <a href="CB_Net.REST.html#.actionProcess"><code>CB_Net.REST.actionProcess</code></a> function when the REST action does not provided it and it is not null, as the "getHeadersOneDimensionValues" option.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">boolean</span> </li> </ul> <dl class="details"> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_net_REST_CB_Net_REST.js.html">CrossBase/net/REST/CB_Net_REST.js</a>, <a href="CrossBase_net_REST_CB_Net_REST.js.html#sunlight-1-line-126">line 126</a> </li> </ul> </dd> </dl> </dd> <hr> <dt class="name" id=".getHeadersOneDimension_DEFAULT"> <h4 id=".getHeadersOneDimension_DEFAULT"><span class="type-signature"><static> </span>getHeadersOneDimension_DEFAULT<span class="type-signature"> :boolean</span></h4> </dt> <dd> <div class="description"> <p>Tells whether to get response <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers">HTTP headers</a> in one-dimension array by default or not (needs "getHeaders" set to true). Used by the <a href="CB_Net.REST.html#.actionProcess"><code>CB_Net.REST.actionProcess</code></a> function when the REST action does not provided it and it is not null, as the "getHeadersOneDimension" option.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">boolean</span> </li> </ul> <dl class="details"> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_net_REST_CB_Net_REST.js.html">CrossBase/net/REST/CB_Net_REST.js</a>, <a href="CrossBase_net_REST_CB_Net_REST.js.html#sunlight-1-line-117">line 117</a> </li> </ul> </dd> </dl> </dd> <hr> <dt class="name" id=".getHeaders_DEFAULT"> <h4 id=".getHeaders_DEFAULT"><span class="type-signature"><static> </span>getHeaders_DEFAULT<span class="type-signature"> :boolean</span></h4> </dt> <dd> <div class="description"> <p>Tells whether get response <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers">HTTP headers</a> by default or not. Used by the <a href="CB_Net.REST.html#.actionProcess"><code>CB_Net.REST.actionProcess</code></a> function when the REST action does not provided it and it is not null, as the "getHeaders" option.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">boolean</span> </li> </ul> <dl class="details"> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_net_REST_CB_Net_REST.js.html">CrossBase/net/REST/CB_Net_REST.js</a>, <a href="CrossBase_net_REST_CB_Net_REST.js.html#sunlight-1-line-108">line 108</a> </li> </ul> </dd> </dl> </dd> <hr> <dt class="name" id=".headers_DEFAULT"> <h4 id=".headers_DEFAULT"><span class="type-signature"><static> </span>headers_DEFAULT<span class="type-signature"> :<a href="CB_Net.REST.html#.actionProcess_HEADERS">CB_Net.REST.actionProcess_HEADERS</a></span></h4> </dt> <dd> <div class="description"> <p>Default "headers" for <a href="https://en.wikipedia.org/wiki/Representational_state_transfer">REST</a> actions (must be a function returning a <a href="CB_Net.XHR.html#.HEADERS"><code>CB_Net.XHR.HEADERS</code></a> object with the <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers">HTTP headers</a>). The function assigned by default returns { "Content-Type" : "application/x-www-form-urlencoded; charset=UTF-8" }. Used by the <a href="CB_Net.REST.html#.actionProcess"><code>CB_Net.REST.actionProcess</code></a> function.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="CB_Net.REST.html#.actionProcess_HEADERS">CB_Net.REST.actionProcess_HEADERS</a></span> </li> </ul> <dl class="details"> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_net_REST_CB_Net_REST.js.html">CrossBase/net/REST/CB_Net_REST.js</a>, <a href="CrossBase_net_REST_CB_Net_REST.js.html#sunlight-1-line-160">line 160</a> </li> </ul> </dd> </dl> </dd> <hr> <dt class="name" id=".headers_PERMANENT"> <h4 id=".headers_PERMANENT"><span class="type-signature"><static> </span>headers_PERMANENT<span class="type-signature"> :<a href="CB_Net.REST.html#.actionProcess_HEADERS">CB_Net.REST.actionProcess_HEADERS</a></span></h4> </dt> <dd> <div class="description"> <p>Permanent function (must be a function returning a <a href="CB_Net.XHR.html#.HEADERS"><code>CB_Net.XHR.HEADERS</code></a> object with the <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers">HTTP headers</a>) to execute the same way as the "headers" parameter. The function assigned by default returns { "Cache-Control" : "no-cache", "Pragma" : "no-cache" }. Used by the <a href="CB_Net.REST.html#.actionProcess"><code>CB_Net.REST.actionProcess</code></a> function. This is permanent for each <a href="https://en.wikipedia.org/wiki/Representational_state_transfer">REST</a> action.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="CB_Net.REST.html#.actionProcess_HEADERS">CB_Net.REST.actionProcess_HEADERS</a></span> </li> </ul> <dl class="details"> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_net_REST_CB_Net_REST.js.html">CrossBase/net/REST/CB_Net_REST.js</a>, <a href="CrossBase_net_REST_CB_Net_REST.js.html#sunlight-1-line-144">line 144</a> </li> </ul> </dd> </dl> </dd> <hr> <dt class="name" id=".method_DEFAULT"> <h4 id=".method_DEFAULT"><span class="type-signature"><static> </span>method_DEFAULT<span class="type-signature"> :string</span></h4> </dt> <dd> <div class="description"> <p>Default "method" for <a href="https://en.wikipedia.org/wiki/Representational_state_transfer">REST</a> actions. Used by the <a href="CB_Net.REST.html#.actionProcess"><code>CB_Net.REST.actionProcess</code></a> function.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">string</span> </li> </ul> <dl class="details"> <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt> <dd class="tag-default"> <ul class="dummy"> <li>GET</li> </ul> </dd> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_net_REST_CB_Net_REST.js.html">CrossBase/net/REST/CB_Net_REST.js</a>, <a href="CrossBase_net_REST_CB_Net_REST.js.html#sunlight-1-line-46">line 46</a> </li> </ul> </dd> </dl> </dd> <hr> <dt class="name" id=".responseType_DEFAULT"> <h4 id=".responseType_DEFAULT"><span class="type-signature"><static> </span>responseType_DEFAULT<span class="type-signature"> :string</span></h4> </dt> <dd> <div class="description"> <p>Default "responseType" for <a href="https://en.wikipedia.org/wiki/Representational_state_transfer">REST</a> actions when it is not provided and it is not null. Used by the <a href="CB_Net.REST.html#.actionProcess"><code>CB_Net.REST.actionProcess</code></a> function.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">string</span> </li> </ul> <dl class="details"> <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt> <dd class="tag-default"> <ul class="dummy"> <li>text</li> </ul> </dd> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_net_REST_CB_Net_REST.js.html">CrossBase/net/REST/CB_Net_REST.js</a>, <a href="CrossBase_net_REST_CB_Net_REST.js.html#sunlight-1-line-55">line 55</a> </li> </ul> </dd> </dl> </dd> <hr> <dt class="name" id=".routeWildcardData_DEFAULT"> <h4 id=".routeWildcardData_DEFAULT"><span class="type-signature"><static> </span>routeWildcardData_DEFAULT<span class="type-signature"> :<a href="CB_Net.REST.html#.actionProcess_ROUTE_WILDCARD_DATA">CB_Net.REST.actionProcess_ROUTE_WILDCARD_DATA</a></span></h4> </dt> <dd> <div class="description"> <p>Default "routeWildcardData" for <a href="https://en.wikipedia.org/wiki/Representational_state_transfer">REST</a> actions (must be a function returning a <a href="https://en.wikipedia.org/wiki/JSON">JSON</a> object or null if we do not want to modify the route). The function assigned by default returns null. Used by the <a href="CB_Net.REST.html#.actionProcess"><code>CB_Net.REST.actionProcess</code></a> function.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="CB_Net.REST.html#.actionProcess_ROUTE_WILDCARD_DATA">CB_Net.REST.actionProcess_ROUTE_WILDCARD_DATA</a></span> </li> </ul> <dl class="details"> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_net_REST_CB_Net_REST.js.html">CrossBase/net/REST/CB_Net_REST.js</a>, <a href="CrossBase_net_REST_CB_Net_REST.js.html#sunlight-1-line-86">line 86</a> </li> </ul> </dd> </dl> </dd> <hr> <dt class="name" id=".routeWildcardData_PERMANENT"> <h4 id=".routeWildcardData_PERMANENT"><span class="type-signature"><static> </span>routeWildcardData_PERMANENT<span class="type-signature"> :<a href="CB_Net.REST.html#.actionProcess_ROUTE_WILDCARD_DATA">CB_Net.REST.actionProcess_ROUTE_WILDCARD_DATA</a></span></h4> </dt> <dd> <div class="description"> <p>Permanent function (must return a <a href="https://en.wikipedia.org/wiki/JSON">JSON</a> object or null if we do not want to modify it) to execute the same way as the "routeWildcardData" parameter (if other "routeWildcardData" are provided or set, they will be executed before this one). The function assigned by default returns null. Used by the <a href="CB_Net.REST.html#.actionProcess"><code>CB_Net.REST.actionProcess</code></a> function. This is permanent for each <a href="https://en.wikipedia.org/wiki/Representational_state_transfer">REST</a> action.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="CB_Net.REST.html#.actionProcess_ROUTE_WILDCARD_DATA">CB_Net.REST.actionProcess_ROUTE_WILDCARD_DATA</a></span> </li> </ul> <dl class="details"> <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="CrossBase_net_REST_CB_Net_REST.js.html">CrossBase/net/REST/CB_Net_REST.js</a>, <a href="CrossBase_net_REST_CB_Net_REST.js.html#sunlight-1-line-73">line 73</a> </li> </ul> </dd> </dl> </dd> <hr> <dt class="name" id=".transparentHeaders_DEFAULT"> <h4 id=".transparentHeaders_DEFAULT"><span class="type-signature"><static> </span>transparentHeaders_DEFAULT<span class="type-signature"> :boolean</span></h4> </dt> <dd> <div class="description"> <p>Tell