| 1 | <!DOCTYPE html>
|
| 2 |
|
| 3 | <html lang="en">
|
| 4 | <head>
|
| 5 | <meta charset="utf-8">
|
| 6 | <meta name="viewport" content="width=device-width">
|
| 7 | <title>CrossBrowdy API documentation Namespace: CB_Net</title>
|
| 8 |
|
| 9 | |
| 10 | |
| 11 |
|
| 12 | <link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
|
| 13 |
|
| 14 | <link type="text/css" rel="stylesheet" href="styles/site.cosmo.css">
|
| 15 |
|
| 16 | </head>
|
| 17 |
|
| 18 | <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;">
|
| 19 |
|
| 20 | <div class="navbar navbar-default navbar-fixed-top ">
|
| 21 | <div class="container">
|
| 22 | <div class="navbar-header">
|
| 23 | <a class="navbar-brand" href="index.html">CrossBrowdy API documentation</a>
|
| 24 | <button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
|
| 25 | <span class="icon-bar"></span>
|
| 26 | <span class="icon-bar"></span>
|
| 27 | <span class="icon-bar"></span>
|
| 28 | </button>
|
| 29 | </div>
|
| 30 | <div class="navbar-collapse collapse" id="topNavigation">
|
| 31 | <ul class="nav navbar-nav">
|
| 32 |
|
| 33 | <li class="dropdown">
|
| 34 | <a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a>
|
| 35 | <ul class="dropdown-menu inline">
|
| 36 | <li><a href="CB_Arrays.html">CB_Arrays</a></li><li><a href="CB_AudioDetector.html">CB_AudioDetector</a></li><li><a href="CB_baseSymbols.html">CB_baseSymbols</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>
|
| 37 | </ul>
|
| 38 | </li>
|
| 39 |
|
| 40 | <li class="dropdown">
|
| 41 | <a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
|
| 42 | <ul class="dropdown-menu inline">
|
| 43 | <li><a href="CB_AudioFile.html">CB_AudioFile</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_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_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>
|
| 44 | </ul>
|
| 45 | </li>
|
| 46 |
|
| 47 | <li class="dropdown">
|
| 48 | <a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
|
| 49 | <ul class="dropdown-menu inline">
|
| 50 | <li><a href="global.html#CB_addCredits">CB_addCredits</a></li><li><a href="global.html#CB_BASE_NAME">CB_BASE_NAME</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_CREDITS_DEFAULT">CB_CREDITS_DEFAULT</a></li><li><a href="global.html#CB_forceString">CB_forceString</a></li><li><a href="global.html#CB_forEach">CB_forEach</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_NAME">CB_NAME</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_OPTIONS">CB_OPTIONS</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><li><a href="global.html#CB_VERSION">CB_VERSION</a></li>
|
| 51 | </ul>
|
| 52 | </li>
|
| 53 |
|
| 54 | </ul>
|
| 55 |
|
| 56 | <div class="col-sm-3 col-md-3">
|
| 57 | <form class="navbar-form" role="search">
|
| 58 | <div class="input-group">
|
| 59 | <input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
|
| 60 | <div class="input-group-btn">
|
| 61 | <button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
|
| 62 | </div>
|
| 63 | </div>
|
| 64 | </form>
|
| 65 | </div>
|
| 66 |
|
| 67 | </div>
|
| 68 |
|
| 69 | </div>
|
| 70 | </div>
|
| 71 |
|
| 72 |
|
| 73 | <div class="container" id="toc-content" style="width:100%;">
|
| 74 | <div class="row" style="width:100%;">
|
| 75 |
|
| 76 |
|
| 77 | <div class="col-md-8" style="width:85%;">
|
| 78 |
|
| 79 | <div id="main">
|
| 80 |
|
| 81 |
|
| 82 |
|
| 83 | <h1 class="page-title">Namespace: CB_Net</h1>
|
| 84 |
|
| 85 | <section>
|
| 86 |
|
| 87 | <header>
|
| 88 |
|
| 89 | <h2>
|
| 90 | CB_Net
|
| 91 | </h2>
|
| 92 |
|
| 93 |
|
| 94 | </header>
|
| 95 |
|
| 96 |
|
| 97 | <article>
|
| 98 | <div class="container-overview">
|
| 99 |
|
| 100 |
|
| 101 | <div class="description"><p>Static class to manage things related to the net. It will return itself if it is tried to be instantiated.</p></div>
|
| 102 |
|
| 103 |
|
| 104 |
|
| 105 | <dl class="details">
|
| 106 |
|
| 107 |
|
| 108 |
|
| 109 |
|
| 110 |
|
| 111 |
|
| 112 |
|
| 113 |
|
| 114 |
|
| 115 |
|
| 116 |
|
| 117 |
|
| 118 |
|
| 119 |
|
| 120 |
|
| 121 |
|
| 122 |
|
| 123 |
|
| 124 |
|
| 125 |
|
| 126 |
|
| 127 |
|
| 128 |
|
| 129 |
|
| 130 |
|
| 131 |
|
| 132 |
|
| 133 |
|
| 134 |
|
| 135 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
| 136 | <dd class="tag-source">
|
| 137 | <ul class="dummy">
|
| 138 | <li>
|
| 139 | <a href="CrossBase_net_CB_Net.js.html">CrossBase/net/CB_Net.js</a>,
|
| 140 | <a href="CrossBase_net_CB_Net.js.html#sunlight-1-line-8">line 8</a>
|
| 141 | </li>
|
| 142 | </ul>
|
| 143 | </dd>
|
| 144 |
|
| 145 |
|
| 146 |
|
| 147 |
|
| 148 |
|
| 149 |
|
| 150 |
|
| 151 | </dl>
|
| 152 |
|
| 153 |
|
| 154 |
|
| 155 |
|
| 156 | </div>
|
| 157 |
|
| 158 |
|
| 159 |
|
| 160 |
|
| 161 |
|
| 162 |
|
| 163 |
|
| 164 |
|
| 165 |
|
| 166 |
|
| 167 | <h3 class="subsection-title">Namespaces</h3>
|
| 168 |
|
| 169 | <dl>
|
| 170 | <dt><a href="namespaces.html#CB_Net.Fetch"><a href="CB_Net.Fetch.html">Fetch</a></a></dt>
|
| 171 | <dd></dd>
|
| 172 |
|
| 173 | <dt><a href="namespaces.html#CB_Net.REST"><a href="CB_Net.REST.html">REST</a></a></dt>
|
| 174 | <dd></dd>
|
| 175 |
|
| 176 | <dt><a href="namespaces.html#CB_Net.Sockets"><a href="CB_Net.Sockets.html">Sockets</a></a></dt>
|
| 177 | <dd></dd>
|
| 178 |
|
| 179 | <dt><a href="namespaces.html#CB_Net.XHR"><a href="CB_Net.XHR.html">XHR</a></a></dt>
|
| 180 | <dd></dd>
|
| 181 | </dl>
|
| 182 |
|
| 183 |
|
| 184 |
|
| 185 |
|
| 186 |
|
| 187 | <h3 class="subsection-title">Methods</h3>
|
| 188 |
|
| 189 | <dl>
|
| 190 |
|
| 191 | <hr>
|
| 192 | <dt>
|
| 193 | <h4 class="name" id=".combineURIParameters"><span class="type-signature"><static> </span>combineURIParameters<span class="signature">()</span><span class="type-signature"></span></h4>
|
| 194 |
|
| 195 |
|
| 196 | </dt>
|
| 197 | <dd>
|
| 198 |
|
| 199 |
|
| 200 | <div class="description">
|
| 201 | <p>Alias for <a href="global.html#CB_combineURIParameters"><code>CB_combineURIParameters</code></a>.</p>
|
| 202 | </div>
|
| 203 |
|
| 204 |
|
| 205 |
|
| 206 |
|
| 207 |
|
| 208 |
|
| 209 |
|
| 210 |
|
| 211 |
|
| 212 |
|
| 213 | <dl class="details">
|
| 214 |
|
| 215 |
|
| 216 |
|
| 217 |
|
| 218 |
|
| 219 |
|
| 220 |
|
| 221 |
|
| 222 |
|
| 223 |
|
| 224 |
|
| 225 |
|
| 226 |
|
| 227 |
|
| 228 |
|
| 229 |
|
| 230 |
|
| 231 |
|
| 232 |
|
| 233 |
|
| 234 |
|
| 235 |
|
| 236 |
|
| 237 |
|
| 238 |
|
| 239 |
|
| 240 |
|
| 241 |
|
| 242 |
|
| 243 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
| 244 | <dd class="tag-source">
|
| 245 | <ul class="dummy">
|
| 246 | <li>
|
| 247 | <a href="CrossBase_net_CB_Net.js.html">CrossBase/net/CB_Net.js</a>,
|
| 248 | <a href="CrossBase_net_CB_Net.js.html#sunlight-1-line-322">line 322</a>
|
| 249 | </li>
|
| 250 | </ul>
|
| 251 | </dd>
|
| 252 |
|
| 253 |
|
| 254 |
|
| 255 |
|
| 256 |
|
| 257 | <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
|
| 258 | <dd class="tag-see">
|
| 259 | <ul>
|
| 260 | <li><a href="global.html#CB_combineURIParameters"><code>CB_combineURIParameters</code></a></li>
|
| 261 | </ul>
|
| 262 | </dd>
|
| 263 |
|
| 264 |
|
| 265 |
|
| 266 | </dl>
|
| 267 |
|
| 268 |
|
| 269 |
|
| 270 |
|
| 271 |
|
| 272 |
|
| 273 |
|
| 274 |
|
| 275 |
|
| 276 |
|
| 277 |
|
| 278 |
|
| 279 |
|
| 280 |
|
| 281 |
|
| 282 | </dd>
|
| 283 |
|
| 284 |
|
| 285 |
|
| 286 | <hr>
|
| 287 | <dt>
|
| 288 | <h4 class="name" id=".combineURLParameters"><span class="type-signature"><static> </span>combineURLParameters<span class="signature">()</span><span class="type-signature"></span></h4>
|
| 289 |
|
| 290 |
|
| 291 | </dt>
|
| 292 | <dd>
|
| 293 |
|
| 294 |
|
| 295 | <div class="description">
|
| 296 | <p>Alias for <a href="CB_Net.html#.combineURIParameters"><code>CB_Net.combineURIParameters</code></a>.</p>
|
| 297 | </div>
|
| 298 |
|
| 299 |
|
| 300 |
|
| 301 |
|
| 302 |
|
| 303 |
|
| 304 |
|
| 305 |
|
| 306 |
|
| 307 |
|
| 308 | <dl class="details">
|
| 309 |
|
| 310 |
|
| 311 |
|
| 312 |
|
| 313 |
|
| 314 |
|
| 315 |
|
| 316 |
|
| 317 |
|
| 318 |
|
| 319 |
|
| 320 |
|
| 321 |
|
| 322 |
|
| 323 |
|
| 324 |
|
| 325 |
|
| 326 |
|
| 327 |
|
| 328 |
|
| 329 |
|
| 330 |
|
| 331 |
|
| 332 |
|
| 333 |
|
| 334 |
|
| 335 |
|
| 336 |
|
| 337 |
|
| 338 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
| 339 | <dd class="tag-source">
|
| 340 | <ul class="dummy">
|
| 341 | <li>
|
| 342 | <a href="CrossBase_net_CB_Net.js.html">CrossBase/net/CB_Net.js</a>,
|
| 343 | <a href="CrossBase_net_CB_Net.js.html#sunlight-1-line-317">line 317</a>
|
| 344 | </li>
|
| 345 | </ul>
|
| 346 | </dd>
|
| 347 |
|
| 348 |
|
| 349 |
|
| 350 |
|
| 351 |
|
| 352 | <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
|
| 353 | <dd class="tag-see">
|
| 354 | <ul>
|
| 355 | <li><a href="CB_Net.html#.combineURIParameters"><code>CB_Net.combineURIParameters</code></a></li>
|
| 356 | </ul>
|
| 357 | </dd>
|
| 358 |
|
| 359 |
|
| 360 |
|
| 361 | </dl>
|
| 362 |
|
| 363 |
|
| 364 |
|
| 365 |
|
| 366 |
|
| 367 |
|
| 368 |
|
| 369 |
|
| 370 |
|
| 371 |
|
| 372 |
|
| 373 |
|
| 374 |
|
| 375 |
|
| 376 |
|
| 377 | </dd>
|
| 378 |
|
| 379 |
|
| 380 |
|
| 381 | <hr>
|
| 382 | <dt>
|
| 383 | <h4 class="name" id=".getHashParameters"><span class="type-signature"><static> </span>getHashParameters<span class="signature">( [URI] [, exclude] [, includeOnly] [, includeIfNotExists] [, trim])</span><span class="type-signature"> → {string}</span></h4>
|
| 384 |
|
| 385 |
|
| 386 | </dt>
|
| 387 | <dd>
|
| 388 |
|
| 389 |
|
| 390 | <div class="description">
|
| 391 | <p>Gets all the hash parameters (names and their values) from a given URI or from the current URL.<br> <br /><br> For example, if the URI provided is "http://whatever.com/index.html?parameter1=value1&parameter2=value2#hash_parameter1=hash_value1&hash_parameter2=hash_value2", it will return<br> "hash_parameter1=hash_value1&hash_parameter2=hash_value2" (using the default options).</p>
|
| 392 | </div>
|
| 393 |
|
| 394 |
|
| 395 |
|
| 396 |
|
| 397 |
|
| 398 |
|
| 399 |
|
| 400 |
|
| 401 | <h5>Parameters:</h5>
|
| 402 |
|
| 403 |
|
| 404 | <table class="params table table-striped">
|
| 405 | <thead>
|
| 406 | <tr>
|
| 407 |
|
| 408 | <th style="width:12%; min-width:110px;">Name</th>
|
| 409 |
|
| 410 |
|
| 411 | <th style="width:12%; min-width:110px;">Type</th>
|
| 412 |
|
| 413 |
|
| 414 | <th style="width:12%; min-width:110px;">Argument</th>
|
| 415 |
|
| 416 |
|
| 417 |
|
| 418 | <th style="width:12%; min-width:110px;">Default</th>
|
| 419 |
|
| 420 |
|
| 421 | <th class="last" style="min-width:310px;">Description</th>
|
| 422 | </tr>
|
| 423 | </thead>
|
| 424 |
|
| 425 | <tbody>
|
| 426 |
|
| 427 |
|
| 428 | <tr>
|
| 429 |
|
| 430 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>URI</code></td>
|
| 431 |
|
| 432 |
|
| 433 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 434 |
|
| 435 |
|
| 436 | <span class="param-type">string</span>
|
| 437 |
|
| 438 |
|
| 439 |
|
| 440 |
|
| 441 | </td>
|
| 442 |
|
| 443 |
|
| 444 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 445 |
|
| 446 | <optional><br>
|
| 447 |
|
| 448 |
|
| 449 |
|
| 450 |
|
| 451 |
|
| 452 | </td>
|
| 453 |
|
| 454 |
|
| 455 |
|
| 456 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 457 |
|
| 458 | <a href="https://developer.mozilla.org/en-US/docs/Web/API/Window/location">window.location</a>.href
|
| 459 |
|
| 460 | </td>
|
| 461 |
|
| 462 |
|
| 463 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The URI that we want to work with. If not provided, it will try to use the current URL (by using <a href="https://developer.mozilla.org/en-US/docs/Web/API/Window/location">window.location</a>.href).</p></td>
|
| 464 | </tr>
|
| 465 |
|
| 466 |
|
| 467 |
|
| 468 | <tr>
|
| 469 |
|
| 470 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>exclude</code></td>
|
| 471 |
|
| 472 |
|
| 473 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 474 |
|
| 475 |
|
| 476 | <span class="param-type">array</span>
|
| 477 |
|
| 478 |
|
| 479 |
|
| 480 |
|
| 481 | </td>
|
| 482 |
|
| 483 |
|
| 484 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 485 |
|
| 486 | <optional><br>
|
| 487 |
|
| 488 |
|
| 489 |
|
| 490 |
|
| 491 |
|
| 492 | </td>
|
| 493 |
|
| 494 |
|
| 495 |
|
| 496 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 497 |
|
| 498 | </td>
|
| 499 |
|
| 500 |
|
| 501 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>A numeric array containing the name of the parameters that we want to exclude in the returned string. It will exclude them even if they are contained in the given "includeOnly" parameter (if any).</p></td>
|
| 502 | </tr>
|
| 503 |
|
| 504 |
|
| 505 |
|
| 506 | <tr>
|
| 507 |
|
| 508 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>includeOnly</code></td>
|
| 509 |
|
| 510 |
|
| 511 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 512 |
|
| 513 |
|
| 514 | <span class="param-type">array</span>
|
| 515 |
|
| 516 |
|
| 517 |
|
| 518 |
|
| 519 | </td>
|
| 520 |
|
| 521 |
|
| 522 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 523 |
|
| 524 | <optional><br>
|
| 525 |
|
| 526 |
|
| 527 |
|
| 528 |
|
| 529 |
|
| 530 | </td>
|
| 531 |
|
| 532 |
|
| 533 |
|
| 534 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 535 |
|
| 536 | </td>
|
| 537 |
|
| 538 |
|
| 539 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>A numeric array containing the name of the parameters that we want to include in the returned string. If provided, it will only include these ones to the returned string (unless they are included in the "exclude" parameter).</p></td>
|
| 540 | </tr>
|
| 541 |
|
| 542 |
|
| 543 |
|
| 544 | <tr>
|
| 545 |
|
| 546 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>includeIfNotExists</code></td>
|
| 547 |
|
| 548 |
|
| 549 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 550 |
|
| 551 |
|
| 552 | <span class="param-type">boolean</span>
|
| 553 |
|
| 554 |
|
| 555 |
|
| 556 |
|
| 557 | </td>
|
| 558 |
|
| 559 |
|
| 560 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 561 |
|
| 562 | <optional><br>
|
| 563 |
|
| 564 |
|
| 565 |
|
| 566 |
|
| 567 |
|
| 568 | </td>
|
| 569 |
|
| 570 |
|
| 571 |
|
| 572 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 573 |
|
| 574 | false
|
| 575 |
|
| 576 | </td>
|
| 577 |
|
| 578 |
|
| 579 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If it is set to true and an array is given as the "includeOnly" parameter, it will add the parameters in the "includeOnly" array (with empty values) in the returned string even when they did not exist in the original URI provided.</p></td>
|
| 580 | </tr>
|
| 581 |
|
| 582 |
|
| 583 |
|
| 584 | <tr>
|
| 585 |
|
| 586 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>trim</code></td>
|
| 587 |
|
| 588 |
|
| 589 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 590 |
|
| 591 |
|
| 592 | <span class="param-type">boolean</span>
|
| 593 |
|
| 594 |
|
| 595 |
|
| 596 |
|
| 597 | </td>
|
| 598 |
|
| 599 |
|
| 600 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 601 |
|
| 602 | <optional><br>
|
| 603 |
|
| 604 |
|
| 605 |
|
| 606 |
|
| 607 |
|
| 608 | </td>
|
| 609 |
|
| 610 |
|
| 611 |
|
| 612 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 613 |
|
| 614 | true
|
| 615 |
|
| 616 | </td>
|
| 617 |
|
| 618 |
|
| 619 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>It will use this option when it calls the <a href="CB_Net.html#.getURIParameters"><code>CB_Net.getURIParameters</code></a> function internally.</p></td>
|
| 620 | </tr>
|
| 621 |
|
| 622 |
|
| 623 | </tbody>
|
| 624 | </table>
|
| 625 |
|
| 626 |
|
| 627 |
|
| 628 |
|
| 629 | <dl class="details">
|
| 630 |
|
| 631 |
|
| 632 |
|
| 633 |
|
| 634 |
|
| 635 |
|
| 636 |
|
| 637 |
|
| 638 |
|
| 639 |
|
| 640 |
|
| 641 |
|
| 642 |
|
| 643 |
|
| 644 |
|
| 645 |
|
| 646 |
|
| 647 |
|
| 648 |
|
| 649 |
|
| 650 |
|
| 651 |
|
| 652 |
|
| 653 |
|
| 654 |
|
| 655 |
|
| 656 |
|
| 657 |
|
| 658 |
|
| 659 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
| 660 | <dd class="tag-source">
|
| 661 | <ul class="dummy">
|
| 662 | <li>
|
| 663 | <a href="CrossBase_net_CB_Net.js.html">CrossBase/net/CB_Net.js</a>,
|
| 664 | <a href="CrossBase_net_CB_Net.js.html#sunlight-1-line-216">line 216</a>
|
| 665 | </li>
|
| 666 | </ul>
|
| 667 | </dd>
|
| 668 |
|
| 669 |
|
| 670 |
|
| 671 |
|
| 672 |
|
| 673 |
|
| 674 |
|
| 675 | </dl>
|
| 676 |
|
| 677 |
|
| 678 |
|
| 679 |
|
| 680 |
|
| 681 |
|
| 682 |
|
| 683 |
|
| 684 |
|
| 685 |
|
| 686 |
|
| 687 |
|
| 688 |
|
| 689 | <h5>Returns:</h5>
|
| 690 |
|
| 691 |
|
| 692 | <div class="param-desc">
|
| 693 | <p>An empty string will be returned if no parameters can be found.</p>
|
| 694 | </div>
|
| 695 |
|
| 696 |
|
| 697 |
|
| 698 | <dl>
|
| 699 | <dt>
|
| 700 | Type
|
| 701 | </dt>
|
| 702 | <dd>
|
| 703 |
|
| 704 | <span class="param-type">string</span>
|
| 705 |
|
| 706 |
|
| 707 |
|
| 708 | </dd>
|
| 709 | </dl>
|
| 710 |
|
| 711 |
|
| 712 |
|
| 713 |
|
| 714 |
|
| 715 | </dd>
|
| 716 |
|
| 717 |
|
| 718 |
|
| 719 | <hr>
|
| 720 | <dt>
|
| 721 | <h4 class="name" id=".getHashValue"><span class="type-signature"><static> </span>getHashValue<span class="signature">(index [, trim] [, URI])</span><span class="type-signature"> → {string}</span></h4>
|
| 722 |
|
| 723 |
|
| 724 | </dt>
|
| 725 | <dd>
|
| 726 |
|
| 727 |
|
| 728 | <div class="description">
|
| 729 | <p>Gets the value of a specific hash (string after "#") parameter from the current URL or a desired URI.<br> <br /><br> For example, if the URI provided is "http://whatever.com/index.html?parameter1=value1&parameter2=value2#hash_parameter1=hash_value1&hash_parameter2=hash_value2" and the index given is "hash_parameter1",<br> it will return "hash_value1" (using the default options).</p>
|
| 730 | </div>
|
| 731 |
|
| 732 |
|
| 733 |
|
| 734 |
|
| 735 |
|
| 736 |
|
| 737 |
|
| 738 |
|
| 739 | <h5>Parameters:</h5>
|
| 740 |
|
| 741 |
|
| 742 | <table class="params table table-striped">
|
| 743 | <thead>
|
| 744 | <tr>
|
| 745 |
|
| 746 | <th style="width:12%; min-width:110px;">Name</th>
|
| 747 |
|
| 748 |
|
| 749 | <th style="width:12%; min-width:110px;">Type</th>
|
| 750 |
|
| 751 |
|
| 752 | <th style="width:12%; min-width:110px;">Argument</th>
|
| 753 |
|
| 754 |
|
| 755 |
|
| 756 | <th style="width:12%; min-width:110px;">Default</th>
|
| 757 |
|
| 758 |
|
| 759 | <th class="last" style="min-width:310px;">Description</th>
|
| 760 | </tr>
|
| 761 | </thead>
|
| 762 |
|
| 763 | <tbody>
|
| 764 |
|
| 765 |
|
| 766 | <tr>
|
| 767 |
|
| 768 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>index</code></td>
|
| 769 |
|
| 770 |
|
| 771 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 772 |
|
| 773 |
|
| 774 | <span class="param-type">string</span>
|
| 775 |
|
| 776 |
|
| 777 |
|
| 778 |
|
| 779 | </td>
|
| 780 |
|
| 781 |
|
| 782 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 783 |
|
| 784 |
|
| 785 |
|
| 786 |
|
| 787 |
|
| 788 | </td>
|
| 789 |
|
| 790 |
|
| 791 |
|
| 792 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 793 |
|
| 794 | </td>
|
| 795 |
|
| 796 |
|
| 797 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The name of the parameter whose value we want to get.</p></td>
|
| 798 | </tr>
|
| 799 |
|
| 800 |
|
| 801 |
|
| 802 | <tr>
|
| 803 |
|
| 804 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>trim</code></td>
|
| 805 |
|
| 806 |
|
| 807 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 808 |
|
| 809 |
|
| 810 | <span class="param-type">boolean</span>
|
| 811 |
|
| 812 |
|
| 813 |
|
| 814 |
|
| 815 | </td>
|
| 816 |
|
| 817 |
|
| 818 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 819 |
|
| 820 | <optional><br>
|
| 821 |
|
| 822 |
|
| 823 |
|
| 824 |
|
| 825 |
|
| 826 | </td>
|
| 827 |
|
| 828 |
|
| 829 |
|
| 830 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 831 |
|
| 832 | true
|
| 833 |
|
| 834 | </td>
|
| 835 |
|
| 836 |
|
| 837 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>It will trim the value (using <a href="CB_Net.html#.getParameter"><code>CB_Net.getParameter</code></a> internally) before returning it.</p></td>
|
| 838 | </tr>
|
| 839 |
|
| 840 |
|
| 841 |
|
| 842 | <tr>
|
| 843 |
|
| 844 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>URI</code></td>
|
| 845 |
|
| 846 |
|
| 847 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 848 |
|
| 849 |
|
| 850 | <span class="param-type">string</span>
|
| 851 |
|
| 852 |
|
| 853 |
|
| 854 |
|
| 855 | </td>
|
| 856 |
|
| 857 |
|
| 858 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 859 |
|
| 860 | <optional><br>
|
| 861 |
|
| 862 |
|
| 863 |
|
| 864 |
|
| 865 |
|
| 866 | </td>
|
| 867 |
|
| 868 |
|
| 869 |
|
| 870 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 871 |
|
| 872 | <a href="https://developer.mozilla.org/en-US/docs/Web/API/Window/location">window.location</a>.href
|
| 873 |
|
| 874 | </td>
|
| 875 |
|
| 876 |
|
| 877 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The URI that we want to work with. If not provided, it will try to use the current URL (by using <a href="https://developer.mozilla.org/en-US/docs/Web/API/Window/location">window.location</a>.href).</p></td>
|
| 878 | </tr>
|
| 879 |
|
| 880 |
|
| 881 | </tbody>
|
| 882 | </table>
|
| 883 |
|
| 884 |
|
| 885 |
|
| 886 |
|
| 887 | <dl class="details">
|
| 888 |
|
| 889 |
|
| 890 |
|
| 891 |
|
| 892 |
|
| 893 |
|
| 894 |
|
| 895 |
|
| 896 |
|
| 897 |
|
| 898 |
|
| 899 |
|
| 900 |
|
| 901 |
|
| 902 |
|
| 903 |
|
| 904 |
|
| 905 |
|
| 906 |
|
| 907 |
|
| 908 |
|
| 909 |
|
| 910 |
|
| 911 |
|
| 912 |
|
| 913 |
|
| 914 |
|
| 915 |
|
| 916 |
|
| 917 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
| 918 | <dd class="tag-source">
|
| 919 | <ul class="dummy">
|
| 920 | <li>
|
| 921 | <a href="CrossBase_net_CB_Net.js.html">CrossBase/net/CB_Net.js</a>,
|
| 922 | <a href="CrossBase_net_CB_Net.js.html#sunlight-1-line-311">line 311</a>
|
| 923 | </li>
|
| 924 | </ul>
|
| 925 | </dd>
|
| 926 |
|
| 927 |
|
| 928 |
|
| 929 |
|
| 930 |
|
| 931 |
|
| 932 |
|
| 933 | </dl>
|
| 934 |
|
| 935 |
|
| 936 |
|
| 937 |
|
| 938 |
|
| 939 |
|
| 940 |
|
| 941 |
|
| 942 |
|
| 943 |
|
| 944 |
|
| 945 |
|
| 946 |
|
| 947 | <h5>Returns:</h5>
|
| 948 |
|
| 949 |
|
| 950 | <div class="param-desc">
|
| 951 | <p>An empty string will be returned if the value of the given parameter cannot be found.</p>
|
| 952 | </div>
|
| 953 |
|
| 954 |
|
| 955 |
|
| 956 | <dl>
|
| 957 | <dt>
|
| 958 | Type
|
| 959 | </dt>
|
| 960 | <dd>
|
| 961 |
|
| 962 | <span class="param-type">string</span>
|
| 963 |
|
| 964 |
|
| 965 |
|
| 966 | </dd>
|
| 967 | </dl>
|
| 968 |
|
| 969 |
|
| 970 |
|
| 971 |
|
| 972 |
|
| 973 | </dd>
|
| 974 |
|
| 975 |
|
| 976 |
|
| 977 | <hr>
|
| 978 | <dt>
|
| 979 | <h4 class="name" id=".getParameter"><span class="type-signature"><static> </span>getParameter<span class="signature">(index [, trim] [, URI] [, firstDelimiter] [, lastDelimiter] [, concatenator] [, nameValueSeparator])</span><span class="type-signature"> → {string}</span></h4>
|
| 980 |
|
| 981 |
|
| 982 | </dt>
|
| 983 | <dd>
|
| 984 |
|
| 985 |
|
| 986 | <div class="description">
|
| 987 | <p>Gets the value of a specific URI parameter (query or hash), respecting GET/URL rules by default, from the current URL or a desired one (with the given delimiters).<br> <br /><br> For example, if the URI provided is "http://whatever.com/index.html?parameter1=value1&parameter2=value2#hash_parameter1=hash_value1&hash_parameter2=hash_value2" and the index given is "parameter1", it will return "value1" (using the default options).</p>
|
| 988 | </div>
|
| 989 |
|
| 990 |
|
| 991 |
|
| 992 |
|
| 993 |
|
| 994 |
|
| 995 |
|
| 996 |
|
| 997 | <h5>Parameters:</h5>
|
| 998 |
|
| 999 |
|
| 1000 | <table class="params table table-striped">
|
| 1001 | <thead>
|
| 1002 | <tr>
|
| 1003 |
|
| 1004 | <th style="width:12%; min-width:110px;">Name</th>
|
| 1005 |
|
| 1006 |
|
| 1007 | <th style="width:12%; min-width:110px;">Type</th>
|
| 1008 |
|
| 1009 |
|
| 1010 | <th style="width:12%; min-width:110px;">Argument</th>
|
| 1011 |
|
| 1012 |
|
| 1013 |
|
| 1014 | <th style="width:12%; min-width:110px;">Default</th>
|
| 1015 |
|
| 1016 |
|
| 1017 | <th class="last" style="min-width:310px;">Description</th>
|
| 1018 | </tr>
|
| 1019 | </thead>
|
| 1020 |
|
| 1021 | <tbody>
|
| 1022 |
|
| 1023 |
|
| 1024 | <tr>
|
| 1025 |
|
| 1026 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>index</code></td>
|
| 1027 |
|
| 1028 |
|
| 1029 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1030 |
|
| 1031 |
|
| 1032 | <span class="param-type">string</span>
|
| 1033 |
|
| 1034 |
|
| 1035 |
|
| 1036 |
|
| 1037 | </td>
|
| 1038 |
|
| 1039 |
|
| 1040 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1041 |
|
| 1042 |
|
| 1043 |
|
| 1044 |
|
| 1045 |
|
| 1046 | </td>
|
| 1047 |
|
| 1048 |
|
| 1049 |
|
| 1050 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1051 |
|
| 1052 | </td>
|
| 1053 |
|
| 1054 |
|
| 1055 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The name of the parameter whose value we want to get.</p></td>
|
| 1056 | </tr>
|
| 1057 |
|
| 1058 |
|
| 1059 |
|
| 1060 | <tr>
|
| 1061 |
|
| 1062 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>trim</code></td>
|
| 1063 |
|
| 1064 |
|
| 1065 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1066 |
|
| 1067 |
|
| 1068 | <span class="param-type">boolean</span>
|
| 1069 |
|
| 1070 |
|
| 1071 |
|
| 1072 |
|
| 1073 | </td>
|
| 1074 |
|
| 1075 |
|
| 1076 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1077 |
|
| 1078 | <optional><br>
|
| 1079 |
|
| 1080 |
|
| 1081 |
|
| 1082 |
|
| 1083 |
|
| 1084 | </td>
|
| 1085 |
|
| 1086 |
|
| 1087 |
|
| 1088 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1089 |
|
| 1090 | true
|
| 1091 |
|
| 1092 | </td>
|
| 1093 |
|
| 1094 |
|
| 1095 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>It will trim the value (using <a href="global.html#CB_trim"><code>CB_trim</code></a> internally) before returning it.</p></td>
|
| 1096 | </tr>
|
| 1097 |
|
| 1098 |
|
| 1099 |
|
| 1100 | <tr>
|
| 1101 |
|
| 1102 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>URI</code></td>
|
| 1103 |
|
| 1104 |
|
| 1105 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1106 |
|
| 1107 |
|
| 1108 | <span class="param-type">string</span>
|
| 1109 |
|
| 1110 |
|
| 1111 |
|
| 1112 |
|
| 1113 | </td>
|
| 1114 |
|
| 1115 |
|
| 1116 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1117 |
|
| 1118 | <optional><br>
|
| 1119 |
|
| 1120 |
|
| 1121 |
|
| 1122 |
|
| 1123 |
|
| 1124 | </td>
|
| 1125 |
|
| 1126 |
|
| 1127 |
|
| 1128 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1129 |
|
| 1130 | <a href="https://developer.mozilla.org/en-US/docs/Web/API/Window/location">window.location</a>.href
|
| 1131 |
|
| 1132 | </td>
|
| 1133 |
|
| 1134 |
|
| 1135 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The URI that we want to work with. If not provided, it will try to use the current URL (by using <a href="https://developer.mozilla.org/en-US/docs/Web/API/Window/location">window.location</a>.href).</p></td>
|
| 1136 | </tr>
|
| 1137 |
|
| 1138 |
|
| 1139 |
|
| 1140 | <tr>
|
| 1141 |
|
| 1142 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>firstDelimiter</code></td>
|
| 1143 |
|
| 1144 |
|
| 1145 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1146 |
|
| 1147 |
|
| 1148 | <span class="param-type">string</span>
|
| 1149 |
|
| 1150 |
|
| 1151 |
|
| 1152 |
|
| 1153 | </td>
|
| 1154 |
|
| 1155 |
|
| 1156 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1157 |
|
| 1158 | <optional><br>
|
| 1159 |
|
| 1160 |
|
| 1161 |
|
| 1162 |
|
| 1163 |
|
| 1164 | </td>
|
| 1165 |
|
| 1166 |
|
| 1167 |
|
| 1168 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1169 |
|
| 1170 | '?'
|
| 1171 |
|
| 1172 | </td>
|
| 1173 |
|
| 1174 |
|
| 1175 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The string that indicates where the parameters start. If it is not provided, it will be "?" as default. If not provided and "lastDelimiter" is not provided either, it will be "?" and "lastDelimiter" will be "#".</p></td>
|
| 1176 | </tr>
|
| 1177 |
|
| 1178 |
|
| 1179 |
|
| 1180 | <tr>
|
| 1181 |
|
| 1182 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>lastDelimiter</code></td>
|
| 1183 |
|
| 1184 |
|
| 1185 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1186 |
|
| 1187 |
|
| 1188 | <span class="param-type">string</span>
|
| 1189 |
|
| 1190 |
|
| 1191 |
|
| 1192 |
|
| 1193 | </td>
|
| 1194 |
|
| 1195 |
|
| 1196 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1197 |
|
| 1198 | <optional><br>
|
| 1199 |
|
| 1200 |
|
| 1201 |
|
| 1202 |
|
| 1203 |
|
| 1204 | </td>
|
| 1205 |
|
| 1206 |
|
| 1207 |
|
| 1208 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1209 |
|
| 1210 | undefined|'#'
|
| 1211 |
|
| 1212 | </td>
|
| 1213 |
|
| 1214 |
|
| 1215 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The string that indicates where the parameters end. If not provided and "firstDelimiter" is provided, it will stop at the end of the given URI. If it is not provided and "firstDelimiter" is not provided either, "firstDelimiter" will be "?" and "lastDelimiter" will be "#".</p></td>
|
| 1216 | </tr>
|
| 1217 |
|
| 1218 |
|
| 1219 |
|
| 1220 | <tr>
|
| 1221 |
|
| 1222 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>concatenator</code></td>
|
| 1223 |
|
| 1224 |
|
| 1225 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1226 |
|
| 1227 |
|
| 1228 | <span class="param-type">string</span>
|
| 1229 |
|
| 1230 |
|
| 1231 |
|
| 1232 |
|
| 1233 | </td>
|
| 1234 |
|
| 1235 |
|
| 1236 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1237 |
|
| 1238 | <optional><br>
|
| 1239 |
|
| 1240 |
|
| 1241 |
|
| 1242 |
|
| 1243 |
|
| 1244 | </td>
|
| 1245 |
|
| 1246 |
|
| 1247 |
|
| 1248 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1249 |
|
| 1250 | '&'
|
| 1251 |
|
| 1252 | </td>
|
| 1253 |
|
| 1254 |
|
| 1255 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The string that joints the different parameters.</p></td>
|
| 1256 | </tr>
|
| 1257 |
|
| 1258 |
|
| 1259 |
|
| 1260 | <tr>
|
| 1261 |
|
| 1262 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>nameValueSeparator</code></td>
|
| 1263 |
|
| 1264 |
|
| 1265 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1266 |
|
| 1267 |
|
| 1268 | <span class="param-type">string</span>
|
| 1269 |
|
| 1270 |
|
| 1271 |
|
| 1272 |
|
| 1273 | </td>
|
| 1274 |
|
| 1275 |
|
| 1276 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1277 |
|
| 1278 | <optional><br>
|
| 1279 |
|
| 1280 |
|
| 1281 |
|
| 1282 |
|
| 1283 |
|
| 1284 | </td>
|
| 1285 |
|
| 1286 |
|
| 1287 |
|
| 1288 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1289 |
|
| 1290 | '='
|
| 1291 |
|
| 1292 | </td>
|
| 1293 |
|
| 1294 |
|
| 1295 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The string that is the separator for the parameters and their values.</p></td>
|
| 1296 | </tr>
|
| 1297 |
|
| 1298 |
|
| 1299 | </tbody>
|
| 1300 | </table>
|
| 1301 |
|
| 1302 |
|
| 1303 |
|
| 1304 |
|
| 1305 | <dl class="details">
|
| 1306 |
|
| 1307 |
|
| 1308 |
|
| 1309 |
|
| 1310 |
|
| 1311 |
|
| 1312 |
|
| 1313 |
|
| 1314 |
|
| 1315 |
|
| 1316 |
|
| 1317 |
|
| 1318 |
|
| 1319 |
|
| 1320 |
|
| 1321 |
|
| 1322 |
|
| 1323 |
|
| 1324 |
|
| 1325 |
|
| 1326 |
|
| 1327 |
|
| 1328 |
|
| 1329 |
|
| 1330 |
|
| 1331 |
|
| 1332 |
|
| 1333 |
|
| 1334 |
|
| 1335 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
| 1336 | <dd class="tag-source">
|
| 1337 | <ul class="dummy">
|
| 1338 | <li>
|
| 1339 | <a href="CrossBase_net_CB_Net.js.html">CrossBase/net/CB_Net.js</a>,
|
| 1340 | <a href="CrossBase_net_CB_Net.js.html#sunlight-1-line-236">line 236</a>
|
| 1341 | </li>
|
| 1342 | </ul>
|
| 1343 | </dd>
|
| 1344 |
|
| 1345 |
|
| 1346 |
|
| 1347 |
|
| 1348 |
|
| 1349 |
|
| 1350 |
|
| 1351 | </dl>
|
| 1352 |
|
| 1353 |
|
| 1354 |
|
| 1355 |
|
| 1356 |
|
| 1357 |
|
| 1358 |
|
| 1359 |
|
| 1360 |
|
| 1361 |
|
| 1362 |
|
| 1363 |
|
| 1364 |
|
| 1365 | <h5>Returns:</h5>
|
| 1366 |
|
| 1367 |
|
| 1368 | <div class="param-desc">
|
| 1369 | <p>An empty string will be returned if the value of the given parameter cannot be found.</p>
|
| 1370 | </div>
|
| 1371 |
|
| 1372 |
|
| 1373 |
|
| 1374 | <dl>
|
| 1375 | <dt>
|
| 1376 | Type
|
| 1377 | </dt>
|
| 1378 | <dd>
|
| 1379 |
|
| 1380 | <span class="param-type">string</span>
|
| 1381 |
|
| 1382 |
|
| 1383 |
|
| 1384 | </dd>
|
| 1385 | </dl>
|
| 1386 |
|
| 1387 |
|
| 1388 |
|
| 1389 |
|
| 1390 |
|
| 1391 | </dd>
|
| 1392 |
|
| 1393 |
|
| 1394 |
|
| 1395 | <hr>
|
| 1396 | <dt>
|
| 1397 | <h4 class="name" id=".getURIParameters"><span class="type-signature"><static> </span>getURIParameters<span class="signature">( [URI] [, exclude] [, includeOnly] [, includeIfNotExists] [, trim] [, firstDelimiter] [, lastDelimiter] [, concatenator] [, nameValueSeparator])</span><span class="type-signature"> → {string}</span></h4>
|
| 1398 |
|
| 1399 |
|
| 1400 | </dt>
|
| 1401 | <dd>
|
| 1402 |
|
| 1403 |
|
| 1404 | <div class="description">
|
| 1405 | <p>Gets all the "GET" (query) parameters (names and their values) from a given URI or from the current URL.<br> <br /><br> For example, if the URI provided is "http://whatever.com/index.html?parameter1=value1&parameter2=value2#hash_parameter1=hash_value1&hash_parameter2=hash_value2", it will return "parameter1=value1&parameter2=value2" (using the default options).</p>
|
| 1406 | </div>
|
| 1407 |
|
| 1408 |
|
| 1409 |
|
| 1410 |
|
| 1411 |
|
| 1412 |
|
| 1413 |
|
| 1414 |
|
| 1415 | <h5>Parameters:</h5>
|
| 1416 |
|
| 1417 |
|
| 1418 | <table class="params table table-striped">
|
| 1419 | <thead>
|
| 1420 | <tr>
|
| 1421 |
|
| 1422 | <th style="width:12%; min-width:110px;">Name</th>
|
| 1423 |
|
| 1424 |
|
| 1425 | <th style="width:12%; min-width:110px;">Type</th>
|
| 1426 |
|
| 1427 |
|
| 1428 | <th style="width:12%; min-width:110px;">Argument</th>
|
| 1429 |
|
| 1430 |
|
| 1431 |
|
| 1432 | <th style="width:12%; min-width:110px;">Default</th>
|
| 1433 |
|
| 1434 |
|
| 1435 | <th class="last" style="min-width:310px;">Description</th>
|
| 1436 | </tr>
|
| 1437 | </thead>
|
| 1438 |
|
| 1439 | <tbody>
|
| 1440 |
|
| 1441 |
|
| 1442 | <tr>
|
| 1443 |
|
| 1444 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>URI</code></td>
|
| 1445 |
|
| 1446 |
|
| 1447 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1448 |
|
| 1449 |
|
| 1450 | <span class="param-type">string</span>
|
| 1451 |
|
| 1452 |
|
| 1453 |
|
| 1454 |
|
| 1455 | </td>
|
| 1456 |
|
| 1457 |
|
| 1458 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1459 |
|
| 1460 | <optional><br>
|
| 1461 |
|
| 1462 |
|
| 1463 |
|
| 1464 |
|
| 1465 |
|
| 1466 | </td>
|
| 1467 |
|
| 1468 |
|
| 1469 |
|
| 1470 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1471 |
|
| 1472 | <a href="https://developer.mozilla.org/en-US/docs/Web/API/Window/location">window.location</a>.href
|
| 1473 |
|
| 1474 | </td>
|
| 1475 |
|
| 1476 |
|
| 1477 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The URI that we want to work with. If not provided, it will try to use the current URL (by using <a href="https://developer.mozilla.org/en-US/docs/Web/API/Window/location">window.location</a>.href).</p></td>
|
| 1478 | </tr>
|
| 1479 |
|
| 1480 |
|
| 1481 |
|
| 1482 | <tr>
|
| 1483 |
|
| 1484 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>exclude</code></td>
|
| 1485 |
|
| 1486 |
|
| 1487 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1488 |
|
| 1489 |
|
| 1490 | <span class="param-type">array</span>
|
| 1491 |
|
| 1492 |
|
| 1493 |
|
| 1494 |
|
| 1495 | </td>
|
| 1496 |
|
| 1497 |
|
| 1498 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1499 |
|
| 1500 | <optional><br>
|
| 1501 |
|
| 1502 |
|
| 1503 |
|
| 1504 |
|
| 1505 |
|
| 1506 | </td>
|
| 1507 |
|
| 1508 |
|
| 1509 |
|
| 1510 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1511 |
|
| 1512 | </td>
|
| 1513 |
|
| 1514 |
|
| 1515 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>A numeric array containing the name of the parameters that we want to exclude in the returned string. It will exclude them even if they are contained in the given "includeOnly" parameter (if any).</p></td>
|
| 1516 | </tr>
|
| 1517 |
|
| 1518 |
|
| 1519 |
|
| 1520 | <tr>
|
| 1521 |
|
| 1522 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>includeOnly</code></td>
|
| 1523 |
|
| 1524 |
|
| 1525 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1526 |
|
| 1527 |
|
| 1528 | <span class="param-type">array</span>
|
| 1529 |
|
| 1530 |
|
| 1531 |
|
| 1532 |
|
| 1533 | </td>
|
| 1534 |
|
| 1535 |
|
| 1536 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1537 |
|
| 1538 | <optional><br>
|
| 1539 |
|
| 1540 |
|
| 1541 |
|
| 1542 |
|
| 1543 |
|
| 1544 | </td>
|
| 1545 |
|
| 1546 |
|
| 1547 |
|
| 1548 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1549 |
|
| 1550 | </td>
|
| 1551 |
|
| 1552 |
|
| 1553 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>A numeric array containing the name of the parameters that we want to include in the returned string. If provided, it will only include these ones to the returned string (unless they are included in the "exclude" parameter).</p></td>
|
| 1554 | </tr>
|
| 1555 |
|
| 1556 |
|
| 1557 |
|
| 1558 | <tr>
|
| 1559 |
|
| 1560 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>includeIfNotExists</code></td>
|
| 1561 |
|
| 1562 |
|
| 1563 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1564 |
|
| 1565 |
|
| 1566 | <span class="param-type">boolean</span>
|
| 1567 |
|
| 1568 |
|
| 1569 |
|
| 1570 |
|
| 1571 | </td>
|
| 1572 |
|
| 1573 |
|
| 1574 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1575 |
|
| 1576 | <optional><br>
|
| 1577 |
|
| 1578 |
|
| 1579 |
|
| 1580 |
|
| 1581 |
|
| 1582 | </td>
|
| 1583 |
|
| 1584 |
|
| 1585 |
|
| 1586 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1587 |
|
| 1588 | false
|
| 1589 |
|
| 1590 | </td>
|
| 1591 |
|
| 1592 |
|
| 1593 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>If it is set to true and an array is given as the "includeOnly" parameter, it will add the parameters in the "includeOnly" array (with empty values) in the returned string even when they did not exist in the original URI provided.</p></td>
|
| 1594 | </tr>
|
| 1595 |
|
| 1596 |
|
| 1597 |
|
| 1598 | <tr>
|
| 1599 |
|
| 1600 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>trim</code></td>
|
| 1601 |
|
| 1602 |
|
| 1603 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1604 |
|
| 1605 |
|
| 1606 | <span class="param-type">boolean</span>
|
| 1607 |
|
| 1608 |
|
| 1609 |
|
| 1610 |
|
| 1611 | </td>
|
| 1612 |
|
| 1613 |
|
| 1614 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1615 |
|
| 1616 | <optional><br>
|
| 1617 |
|
| 1618 |
|
| 1619 |
|
| 1620 |
|
| 1621 |
|
| 1622 | </td>
|
| 1623 |
|
| 1624 |
|
| 1625 |
|
| 1626 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1627 |
|
| 1628 | true
|
| 1629 |
|
| 1630 | </td>
|
| 1631 |
|
| 1632 |
|
| 1633 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>Defines whether we want to trim the spaces around the values or not.</p></td>
|
| 1634 | </tr>
|
| 1635 |
|
| 1636 |
|
| 1637 |
|
| 1638 | <tr>
|
| 1639 |
|
| 1640 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>firstDelimiter</code></td>
|
| 1641 |
|
| 1642 |
|
| 1643 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1644 |
|
| 1645 |
|
| 1646 | <span class="param-type">string</span>
|
| 1647 |
|
| 1648 |
|
| 1649 |
|
| 1650 |
|
| 1651 | </td>
|
| 1652 |
|
| 1653 |
|
| 1654 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1655 |
|
| 1656 | <optional><br>
|
| 1657 |
|
| 1658 |
|
| 1659 |
|
| 1660 |
|
| 1661 |
|
| 1662 | </td>
|
| 1663 |
|
| 1664 |
|
| 1665 |
|
| 1666 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1667 |
|
| 1668 | '?'
|
| 1669 |
|
| 1670 | </td>
|
| 1671 |
|
| 1672 |
|
| 1673 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The string that indicates where the parameters start. If it is not provided, it will be "?" as default. If not provided and "lastDelimiter" is not provided either, it will be "?" and "lastDelimiter" will be "#".</p></td>
|
| 1674 | </tr>
|
| 1675 |
|
| 1676 |
|
| 1677 |
|
| 1678 | <tr>
|
| 1679 |
|
| 1680 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>lastDelimiter</code></td>
|
| 1681 |
|
| 1682 |
|
| 1683 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1684 |
|
| 1685 |
|
| 1686 | <span class="param-type">string</span>
|
| 1687 |
|
| 1688 |
|
| 1689 |
|
| 1690 |
|
| 1691 | </td>
|
| 1692 |
|
| 1693 |
|
| 1694 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1695 |
|
| 1696 | <optional><br>
|
| 1697 |
|
| 1698 |
|
| 1699 |
|
| 1700 |
|
| 1701 |
|
| 1702 | </td>
|
| 1703 |
|
| 1704 |
|
| 1705 |
|
| 1706 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1707 |
|
| 1708 | undefined|'#'
|
| 1709 |
|
| 1710 | </td>
|
| 1711 |
|
| 1712 |
|
| 1713 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The string that indicates where the parameters end. If not provided and "firstDelimiter" is provided, it will stop at the end of the given URI. If it is not provided and "firstDelimiter" is not provided either, "firstDelimiter" will be "?" and "lastDelimiter" will be "#".</p></td>
|
| 1714 | </tr>
|
| 1715 |
|
| 1716 |
|
| 1717 |
|
| 1718 | <tr>
|
| 1719 |
|
| 1720 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>concatenator</code></td>
|
| 1721 |
|
| 1722 |
|
| 1723 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1724 |
|
| 1725 |
|
| 1726 | <span class="param-type">string</span>
|
| 1727 |
|
| 1728 |
|
| 1729 |
|
| 1730 |
|
| 1731 | </td>
|
| 1732 |
|
| 1733 |
|
| 1734 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1735 |
|
| 1736 | <optional><br>
|
| 1737 |
|
| 1738 |
|
| 1739 |
|
| 1740 |
|
| 1741 |
|
| 1742 | </td>
|
| 1743 |
|
| 1744 |
|
| 1745 |
|
| 1746 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1747 |
|
| 1748 | '&'
|
| 1749 |
|
| 1750 | </td>
|
| 1751 |
|
| 1752 |
|
| 1753 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The string that joints the different parameters.</p></td>
|
| 1754 | </tr>
|
| 1755 |
|
| 1756 |
|
| 1757 |
|
| 1758 | <tr>
|
| 1759 |
|
| 1760 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>nameValueSeparator</code></td>
|
| 1761 |
|
| 1762 |
|
| 1763 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1764 |
|
| 1765 |
|
| 1766 | <span class="param-type">string</span>
|
| 1767 |
|
| 1768 |
|
| 1769 |
|
| 1770 |
|
| 1771 | </td>
|
| 1772 |
|
| 1773 |
|
| 1774 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1775 |
|
| 1776 | <optional><br>
|
| 1777 |
|
| 1778 |
|
| 1779 |
|
| 1780 |
|
| 1781 |
|
| 1782 | </td>
|
| 1783 |
|
| 1784 |
|
| 1785 |
|
| 1786 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1787 |
|
| 1788 | '='
|
| 1789 |
|
| 1790 | </td>
|
| 1791 |
|
| 1792 |
|
| 1793 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The string that is the separator for the parameters and their values.</p></td>
|
| 1794 | </tr>
|
| 1795 |
|
| 1796 |
|
| 1797 | </tbody>
|
| 1798 | </table>
|
| 1799 |
|
| 1800 |
|
| 1801 |
|
| 1802 |
|
| 1803 | <dl class="details">
|
| 1804 |
|
| 1805 |
|
| 1806 |
|
| 1807 |
|
| 1808 |
|
| 1809 |
|
| 1810 |
|
| 1811 |
|
| 1812 |
|
| 1813 |
|
| 1814 |
|
| 1815 |
|
| 1816 |
|
| 1817 |
|
| 1818 |
|
| 1819 |
|
| 1820 |
|
| 1821 |
|
| 1822 |
|
| 1823 |
|
| 1824 |
|
| 1825 |
|
| 1826 |
|
| 1827 |
|
| 1828 |
|
| 1829 |
|
| 1830 |
|
| 1831 |
|
| 1832 |
|
| 1833 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
| 1834 | <dd class="tag-source">
|
| 1835 | <ul class="dummy">
|
| 1836 | <li>
|
| 1837 | <a href="CrossBase_net_CB_Net.js.html">CrossBase/net/CB_Net.js</a>,
|
| 1838 | <a href="CrossBase_net_CB_Net.js.html#sunlight-1-line-123">line 123</a>
|
| 1839 | </li>
|
| 1840 | </ul>
|
| 1841 | </dd>
|
| 1842 |
|
| 1843 |
|
| 1844 |
|
| 1845 |
|
| 1846 |
|
| 1847 |
|
| 1848 |
|
| 1849 | </dl>
|
| 1850 |
|
| 1851 |
|
| 1852 |
|
| 1853 |
|
| 1854 |
|
| 1855 |
|
| 1856 |
|
| 1857 |
|
| 1858 |
|
| 1859 |
|
| 1860 |
|
| 1861 |
|
| 1862 |
|
| 1863 | <h5>Returns:</h5>
|
| 1864 |
|
| 1865 |
|
| 1866 | <div class="param-desc">
|
| 1867 | <p>An empty string will be returned if no parameters can be found.</p>
|
| 1868 | </div>
|
| 1869 |
|
| 1870 |
|
| 1871 |
|
| 1872 | <dl>
|
| 1873 | <dt>
|
| 1874 | Type
|
| 1875 | </dt>
|
| 1876 | <dd>
|
| 1877 |
|
| 1878 | <span class="param-type">string</span>
|
| 1879 |
|
| 1880 |
|
| 1881 |
|
| 1882 | </dd>
|
| 1883 | </dl>
|
| 1884 |
|
| 1885 |
|
| 1886 |
|
| 1887 |
|
| 1888 |
|
| 1889 | </dd>
|
| 1890 |
|
| 1891 |
|
| 1892 |
|
| 1893 | <hr>
|
| 1894 | <dt>
|
| 1895 | <h4 class="name" id=".getURIValue"><span class="type-signature"><static> </span>getURIValue<span class="signature">(index [, trim] [, URI])</span><span class="type-signature"> → {string}</span></h4>
|
| 1896 |
|
| 1897 |
|
| 1898 | </dt>
|
| 1899 | <dd>
|
| 1900 |
|
| 1901 |
|
| 1902 | <div class="description">
|
| 1903 | <p>Gets the value of a specific URI "GET" parameter (query) from the current URL or a desired URI.<br> <br /><br> For example, if the URI provided is "http://whatever.com/index.html?parameter1=value1&parameter2=value2#hash_parameter1=hash_value1&hash_parameter2=hash_value2" and the index given is "parameter1", it will return "value1" (using the default options).</p>
|
| 1904 | </div>
|
| 1905 |
|
| 1906 |
|
| 1907 |
|
| 1908 |
|
| 1909 |
|
| 1910 |
|
| 1911 |
|
| 1912 |
|
| 1913 | <h5>Parameters:</h5>
|
| 1914 |
|
| 1915 |
|
| 1916 | <table class="params table table-striped">
|
| 1917 | <thead>
|
| 1918 | <tr>
|
| 1919 |
|
| 1920 | <th style="width:12%; min-width:110px;">Name</th>
|
| 1921 |
|
| 1922 |
|
| 1923 | <th style="width:12%; min-width:110px;">Type</th>
|
| 1924 |
|
| 1925 |
|
| 1926 | <th style="width:12%; min-width:110px;">Argument</th>
|
| 1927 |
|
| 1928 |
|
| 1929 |
|
| 1930 | <th style="width:12%; min-width:110px;">Default</th>
|
| 1931 |
|
| 1932 |
|
| 1933 | <th class="last" style="min-width:310px;">Description</th>
|
| 1934 | </tr>
|
| 1935 | </thead>
|
| 1936 |
|
| 1937 | <tbody>
|
| 1938 |
|
| 1939 |
|
| 1940 | <tr>
|
| 1941 |
|
| 1942 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>index</code></td>
|
| 1943 |
|
| 1944 |
|
| 1945 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1946 |
|
| 1947 |
|
| 1948 | <span class="param-type">string</span>
|
| 1949 |
|
| 1950 |
|
| 1951 |
|
| 1952 |
|
| 1953 | </td>
|
| 1954 |
|
| 1955 |
|
| 1956 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1957 |
|
| 1958 |
|
| 1959 |
|
| 1960 |
|
| 1961 |
|
| 1962 | </td>
|
| 1963 |
|
| 1964 |
|
| 1965 |
|
| 1966 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1967 |
|
| 1968 | </td>
|
| 1969 |
|
| 1970 |
|
| 1971 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The name of the parameter whose value we want to get.</p></td>
|
| 1972 | </tr>
|
| 1973 |
|
| 1974 |
|
| 1975 |
|
| 1976 | <tr>
|
| 1977 |
|
| 1978 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>trim</code></td>
|
| 1979 |
|
| 1980 |
|
| 1981 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1982 |
|
| 1983 |
|
| 1984 | <span class="param-type">boolean</span>
|
| 1985 |
|
| 1986 |
|
| 1987 |
|
| 1988 |
|
| 1989 | </td>
|
| 1990 |
|
| 1991 |
|
| 1992 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 1993 |
|
| 1994 | <optional><br>
|
| 1995 |
|
| 1996 |
|
| 1997 |
|
| 1998 |
|
| 1999 |
|
| 2000 | </td>
|
| 2001 |
|
| 2002 |
|
| 2003 |
|
| 2004 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 2005 |
|
| 2006 | true
|
| 2007 |
|
| 2008 | </td>
|
| 2009 |
|
| 2010 |
|
| 2011 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>It will trim the value (using <a href="CB_Net.html#.getParameter"><code>CB_Net.getParameter</code></a> internally) before returning it.</p></td>
|
| 2012 | </tr>
|
| 2013 |
|
| 2014 |
|
| 2015 |
|
| 2016 | <tr>
|
| 2017 |
|
| 2018 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>URI</code></td>
|
| 2019 |
|
| 2020 |
|
| 2021 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 2022 |
|
| 2023 |
|
| 2024 | <span class="param-type">string</span>
|
| 2025 |
|
| 2026 |
|
| 2027 |
|
| 2028 |
|
| 2029 | </td>
|
| 2030 |
|
| 2031 |
|
| 2032 | <td class="attributes" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 2033 |
|
| 2034 | <optional><br>
|
| 2035 |
|
| 2036 |
|
| 2037 |
|
| 2038 |
|
| 2039 |
|
| 2040 | </td>
|
| 2041 |
|
| 2042 |
|
| 2043 |
|
| 2044 | <td class="default" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 2045 |
|
| 2046 | <a href="https://developer.mozilla.org/en-US/docs/Web/API/Window/location">window.location</a>.href
|
| 2047 |
|
| 2048 | </td>
|
| 2049 |
|
| 2050 |
|
| 2051 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The URI that we want to work with. If not provided, it will try to use the current URL (by using <a href="https://developer.mozilla.org/en-US/docs/Web/API/Window/location">window.location</a>.href).</p></td>
|
| 2052 | </tr>
|
| 2053 |
|
| 2054 |
|
| 2055 | </tbody>
|
| 2056 | </table>
|
| 2057 |
|
| 2058 |
|
| 2059 |
|
| 2060 |
|
| 2061 | <dl class="details">
|
| 2062 |
|
| 2063 |
|
| 2064 |
|
| 2065 |
|
| 2066 |
|
| 2067 |
|
| 2068 |
|
| 2069 |
|
| 2070 |
|
| 2071 |
|
| 2072 |
|
| 2073 |
|
| 2074 |
|
| 2075 |
|
| 2076 |
|
| 2077 |
|
| 2078 |
|
| 2079 |
|
| 2080 |
|
| 2081 |
|
| 2082 |
|
| 2083 |
|
| 2084 |
|
| 2085 |
|
| 2086 |
|
| 2087 |
|
| 2088 |
|
| 2089 |
|
| 2090 |
|
| 2091 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
| 2092 | <dd class="tag-source">
|
| 2093 | <ul class="dummy">
|
| 2094 | <li>
|
| 2095 | <a href="CrossBase_net_CB_Net.js.html">CrossBase/net/CB_Net.js</a>,
|
| 2096 | <a href="CrossBase_net_CB_Net.js.html#sunlight-1-line-294">line 294</a>
|
| 2097 | </li>
|
| 2098 | </ul>
|
| 2099 | </dd>
|
| 2100 |
|
| 2101 |
|
| 2102 |
|
| 2103 |
|
| 2104 |
|
| 2105 |
|
| 2106 |
|
| 2107 | </dl>
|
| 2108 |
|
| 2109 |
|
| 2110 |
|
| 2111 |
|
| 2112 |
|
| 2113 |
|
| 2114 |
|
| 2115 |
|
| 2116 |
|
| 2117 |
|
| 2118 |
|
| 2119 |
|
| 2120 |
|
| 2121 | <h5>Returns:</h5>
|
| 2122 |
|
| 2123 |
|
| 2124 | <div class="param-desc">
|
| 2125 | <p>An empty string will be returned if the value of the given parameter cannot be found.</p>
|
| 2126 | </div>
|
| 2127 |
|
| 2128 |
|
| 2129 |
|
| 2130 | <dl>
|
| 2131 | <dt>
|
| 2132 | Type
|
| 2133 | </dt>
|
| 2134 | <dd>
|
| 2135 |
|
| 2136 | <span class="param-type">string</span>
|
| 2137 |
|
| 2138 |
|
| 2139 |
|
| 2140 | </dd>
|
| 2141 | </dl>
|
| 2142 |
|
| 2143 |
|
| 2144 |
|
| 2145 |
|
| 2146 |
|
| 2147 | </dd>
|
| 2148 |
|
| 2149 |
|
| 2150 |
|
| 2151 | <hr>
|
| 2152 | <dt>
|
| 2153 | <h4 class="name" id=".URIDecode"><span class="type-signature"><static> </span>URIDecode<span class="signature">(URI)</span><span class="type-signature"> → {string}</span></h4>
|
| 2154 |
|
| 2155 |
|
| 2156 | </dt>
|
| 2157 | <dd>
|
| 2158 |
|
| 2159 |
|
| 2160 | <div class="description">
|
| 2161 | <p>Encodes a given URI. Uses the native <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURI">decodeURI</a> function internally if available or fallbacks to the native <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/unescape">unescape</a> function otherwise.</p>
|
| 2162 | </div>
|
| 2163 |
|
| 2164 |
|
| 2165 |
|
| 2166 |
|
| 2167 |
|
| 2168 |
|
| 2169 |
|
| 2170 |
|
| 2171 | <h5>Parameters:</h5>
|
| 2172 |
|
| 2173 |
|
| 2174 | <table class="params table table-striped">
|
| 2175 | <thead>
|
| 2176 | <tr>
|
| 2177 |
|
| 2178 | <th style="width:12%; min-width:110px;">Name</th>
|
| 2179 |
|
| 2180 |
|
| 2181 | <th style="width:12%; min-width:110px;">Type</th>
|
| 2182 |
|
| 2183 |
|
| 2184 |
|
| 2185 |
|
| 2186 |
|
| 2187 | <th class="last" style="min-width:310px;">Description</th>
|
| 2188 | </tr>
|
| 2189 | </thead>
|
| 2190 |
|
| 2191 | <tbody>
|
| 2192 |
|
| 2193 |
|
| 2194 | <tr>
|
| 2195 |
|
| 2196 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>URI</code></td>
|
| 2197 |
|
| 2198 |
|
| 2199 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 2200 |
|
| 2201 |
|
| 2202 | <span class="param-type">string</span>
|
| 2203 | |
|
| 2204 |
|
| 2205 | <span class="param-type">number</span>
|
| 2206 |
|
| 2207 |
|
| 2208 |
|
| 2209 |
|
| 2210 | </td>
|
| 2211 |
|
| 2212 |
|
| 2213 |
|
| 2214 |
|
| 2215 |
|
| 2216 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The URI that we want to decode. Normally, it should be either a string or a number.</p></td>
|
| 2217 | </tr>
|
| 2218 |
|
| 2219 |
|
| 2220 | </tbody>
|
| 2221 | </table>
|
| 2222 |
|
| 2223 |
|
| 2224 |
|
| 2225 |
|
| 2226 | <dl class="details">
|
| 2227 |
|
| 2228 |
|
| 2229 |
|
| 2230 |
|
| 2231 |
|
| 2232 |
|
| 2233 |
|
| 2234 |
|
| 2235 |
|
| 2236 |
|
| 2237 |
|
| 2238 |
|
| 2239 |
|
| 2240 |
|
| 2241 |
|
| 2242 |
|
| 2243 |
|
| 2244 |
|
| 2245 |
|
| 2246 |
|
| 2247 |
|
| 2248 |
|
| 2249 |
|
| 2250 |
|
| 2251 |
|
| 2252 |
|
| 2253 |
|
| 2254 |
|
| 2255 |
|
| 2256 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
| 2257 | <dd class="tag-source">
|
| 2258 | <ul class="dummy">
|
| 2259 | <li>
|
| 2260 | <a href="CrossBase_net_CB_Net.js.html">CrossBase/net/CB_Net.js</a>,
|
| 2261 | <a href="CrossBase_net_CB_Net.js.html#sunlight-1-line-100">line 100</a>
|
| 2262 | </li>
|
| 2263 | </ul>
|
| 2264 | </dd>
|
| 2265 |
|
| 2266 |
|
| 2267 |
|
| 2268 |
|
| 2269 |
|
| 2270 |
|
| 2271 |
|
| 2272 | <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
|
| 2273 | <dd class="tag-todo">
|
| 2274 | <ul>
|
| 2275 | <li>Think about using another thing since <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/unescape">unescape</a> maybe is not a good fallback. Probably a polyfill to simulate the <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURI">decodeURI</a> function.</li>
|
| 2276 | </ul>
|
| 2277 | </dd>
|
| 2278 |
|
| 2279 | </dl>
|
| 2280 |
|
| 2281 |
|
| 2282 |
|
| 2283 |
|
| 2284 |
|
| 2285 |
|
| 2286 |
|
| 2287 |
|
| 2288 |
|
| 2289 |
|
| 2290 |
|
| 2291 |
|
| 2292 |
|
| 2293 | <h5>Returns:</h5>
|
| 2294 |
|
| 2295 |
|
| 2296 |
|
| 2297 |
|
| 2298 | <dl>
|
| 2299 | <dt>
|
| 2300 | Type
|
| 2301 | </dt>
|
| 2302 | <dd>
|
| 2303 |
|
| 2304 | <span class="param-type">string</span>
|
| 2305 |
|
| 2306 |
|
| 2307 |
|
| 2308 | </dd>
|
| 2309 | </dl>
|
| 2310 |
|
| 2311 |
|
| 2312 |
|
| 2313 |
|
| 2314 |
|
| 2315 | </dd>
|
| 2316 |
|
| 2317 |
|
| 2318 |
|
| 2319 | <hr>
|
| 2320 | <dt>
|
| 2321 | <h4 class="name" id=".URIEncode"><span class="type-signature"><static> </span>URIEncode<span class="signature">(URI)</span><span class="type-signature"> → {string}</span></h4>
|
| 2322 |
|
| 2323 |
|
| 2324 | </dt>
|
| 2325 | <dd>
|
| 2326 |
|
| 2327 |
|
| 2328 | <div class="description">
|
| 2329 | <p>Encodes a given URI. Uses the native <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURI">encodeURI</a> function internally if available or fallbacks to the native <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/escape">escape</a> function otherwise.</p>
|
| 2330 | </div>
|
| 2331 |
|
| 2332 |
|
| 2333 |
|
| 2334 |
|
| 2335 |
|
| 2336 |
|
| 2337 |
|
| 2338 |
|
| 2339 | <h5>Parameters:</h5>
|
| 2340 |
|
| 2341 |
|
| 2342 | <table class="params table table-striped">
|
| 2343 | <thead>
|
| 2344 | <tr>
|
| 2345 |
|
| 2346 | <th style="width:12%; min-width:110px;">Name</th>
|
| 2347 |
|
| 2348 |
|
| 2349 | <th style="width:12%; min-width:110px;">Type</th>
|
| 2350 |
|
| 2351 |
|
| 2352 |
|
| 2353 |
|
| 2354 |
|
| 2355 | <th class="last" style="min-width:310px;">Description</th>
|
| 2356 | </tr>
|
| 2357 | </thead>
|
| 2358 |
|
| 2359 | <tbody>
|
| 2360 |
|
| 2361 |
|
| 2362 | <tr>
|
| 2363 |
|
| 2364 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>URI</code></td>
|
| 2365 |
|
| 2366 |
|
| 2367 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 2368 |
|
| 2369 |
|
| 2370 | <span class="param-type">string</span>
|
| 2371 | |
|
| 2372 |
|
| 2373 | <span class="param-type">number</span>
|
| 2374 |
|
| 2375 |
|
| 2376 |
|
| 2377 |
|
| 2378 | </td>
|
| 2379 |
|
| 2380 |
|
| 2381 |
|
| 2382 |
|
| 2383 |
|
| 2384 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The URI that we want to encode. Normally, it should be either a string or a number.</p></td>
|
| 2385 | </tr>
|
| 2386 |
|
| 2387 |
|
| 2388 | </tbody>
|
| 2389 | </table>
|
| 2390 |
|
| 2391 |
|
| 2392 |
|
| 2393 |
|
| 2394 | <dl class="details">
|
| 2395 |
|
| 2396 |
|
| 2397 |
|
| 2398 |
|
| 2399 |
|
| 2400 |
|
| 2401 |
|
| 2402 |
|
| 2403 |
|
| 2404 |
|
| 2405 |
|
| 2406 |
|
| 2407 |
|
| 2408 |
|
| 2409 |
|
| 2410 |
|
| 2411 |
|
| 2412 |
|
| 2413 |
|
| 2414 |
|
| 2415 |
|
| 2416 |
|
| 2417 |
|
| 2418 |
|
| 2419 |
|
| 2420 |
|
| 2421 |
|
| 2422 |
|
| 2423 |
|
| 2424 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
| 2425 | <dd class="tag-source">
|
| 2426 | <ul class="dummy">
|
| 2427 | <li>
|
| 2428 | <a href="CrossBase_net_CB_Net.js.html">CrossBase/net/CB_Net.js</a>,
|
| 2429 | <a href="CrossBase_net_CB_Net.js.html#sunlight-1-line-81">line 81</a>
|
| 2430 | </li>
|
| 2431 | </ul>
|
| 2432 | </dd>
|
| 2433 |
|
| 2434 |
|
| 2435 |
|
| 2436 |
|
| 2437 |
|
| 2438 |
|
| 2439 |
|
| 2440 | <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
|
| 2441 | <dd class="tag-todo">
|
| 2442 | <ul>
|
| 2443 | <li>Think about using another thing since <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/escape">escape</a> maybe is not a good fallback. Probably a polyfill to simulate the <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURI">encodeURI</a> function.</li>
|
| 2444 | </ul>
|
| 2445 | </dd>
|
| 2446 |
|
| 2447 | </dl>
|
| 2448 |
|
| 2449 |
|
| 2450 |
|
| 2451 |
|
| 2452 |
|
| 2453 |
|
| 2454 |
|
| 2455 |
|
| 2456 |
|
| 2457 |
|
| 2458 |
|
| 2459 |
|
| 2460 |
|
| 2461 | <h5>Returns:</h5>
|
| 2462 |
|
| 2463 |
|
| 2464 |
|
| 2465 |
|
| 2466 | <dl>
|
| 2467 | <dt>
|
| 2468 | Type
|
| 2469 | </dt>
|
| 2470 | <dd>
|
| 2471 |
|
| 2472 | <span class="param-type">string</span>
|
| 2473 |
|
| 2474 |
|
| 2475 |
|
| 2476 | </dd>
|
| 2477 | </dl>
|
| 2478 |
|
| 2479 |
|
| 2480 |
|
| 2481 |
|
| 2482 |
|
| 2483 | </dd>
|
| 2484 |
|
| 2485 |
|
| 2486 |
|
| 2487 | <hr>
|
| 2488 | <dt>
|
| 2489 | <h4 class="name" id=".URIValueDecode"><span class="type-signature"><static> </span>URIValueDecode<span class="signature">(value)</span><span class="type-signature"> → {string}</span></h4>
|
| 2490 |
|
| 2491 |
|
| 2492 | </dt>
|
| 2493 | <dd>
|
| 2494 |
|
| 2495 |
|
| 2496 | <div class="description">
|
| 2497 | <p>Decodes a given URI value. Uses the native <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent">decodeURIComponent</a> function internally if available or fallbacks to the native <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/unescape">unescape</a> function otherwise.</p>
|
| 2498 | </div>
|
| 2499 |
|
| 2500 |
|
| 2501 |
|
| 2502 |
|
| 2503 |
|
| 2504 |
|
| 2505 |
|
| 2506 |
|
| 2507 | <h5>Parameters:</h5>
|
| 2508 |
|
| 2509 |
|
| 2510 | <table class="params table table-striped">
|
| 2511 | <thead>
|
| 2512 | <tr>
|
| 2513 |
|
| 2514 | <th style="width:12%; min-width:110px;">Name</th>
|
| 2515 |
|
| 2516 |
|
| 2517 | <th style="width:12%; min-width:110px;">Type</th>
|
| 2518 |
|
| 2519 |
|
| 2520 |
|
| 2521 |
|
| 2522 |
|
| 2523 | <th class="last" style="min-width:310px;">Description</th>
|
| 2524 | </tr>
|
| 2525 | </thead>
|
| 2526 |
|
| 2527 | <tbody>
|
| 2528 |
|
| 2529 |
|
| 2530 | <tr>
|
| 2531 |
|
| 2532 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>value</code></td>
|
| 2533 |
|
| 2534 |
|
| 2535 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 2536 |
|
| 2537 |
|
| 2538 | <span class="param-type">string</span>
|
| 2539 | |
|
| 2540 |
|
| 2541 | <span class="param-type">number</span>
|
| 2542 |
|
| 2543 |
|
| 2544 |
|
| 2545 |
|
| 2546 | </td>
|
| 2547 |
|
| 2548 |
|
| 2549 |
|
| 2550 |
|
| 2551 |
|
| 2552 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The value that we want to decode. Normally, it should be either a string or a number.</p></td>
|
| 2553 | </tr>
|
| 2554 |
|
| 2555 |
|
| 2556 | </tbody>
|
| 2557 | </table>
|
| 2558 |
|
| 2559 |
|
| 2560 |
|
| 2561 |
|
| 2562 | <dl class="details">
|
| 2563 |
|
| 2564 |
|
| 2565 |
|
| 2566 |
|
| 2567 |
|
| 2568 |
|
| 2569 |
|
| 2570 |
|
| 2571 |
|
| 2572 |
|
| 2573 |
|
| 2574 |
|
| 2575 |
|
| 2576 |
|
| 2577 |
|
| 2578 |
|
| 2579 |
|
| 2580 |
|
| 2581 |
|
| 2582 |
|
| 2583 |
|
| 2584 |
|
| 2585 |
|
| 2586 |
|
| 2587 |
|
| 2588 |
|
| 2589 |
|
| 2590 |
|
| 2591 |
|
| 2592 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
| 2593 | <dd class="tag-source">
|
| 2594 | <ul class="dummy">
|
| 2595 | <li>
|
| 2596 | <a href="CrossBase_net_CB_Net.js.html">CrossBase/net/CB_Net.js</a>,
|
| 2597 | <a href="CrossBase_net_CB_Net.js.html#sunlight-1-line-62">line 62</a>
|
| 2598 | </li>
|
| 2599 | </ul>
|
| 2600 | </dd>
|
| 2601 |
|
| 2602 |
|
| 2603 |
|
| 2604 |
|
| 2605 |
|
| 2606 |
|
| 2607 |
|
| 2608 | <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
|
| 2609 | <dd class="tag-todo">
|
| 2610 | <ul>
|
| 2611 | <li>Think about using another thing since <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/unescape">unescape</a> maybe is not a good fallback. Probably a polyfill to simulate the <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent">decodeURIComponent</a> function.</li>
|
| 2612 | </ul>
|
| 2613 | </dd>
|
| 2614 |
|
| 2615 | </dl>
|
| 2616 |
|
| 2617 |
|
| 2618 |
|
| 2619 |
|
| 2620 |
|
| 2621 |
|
| 2622 |
|
| 2623 |
|
| 2624 |
|
| 2625 |
|
| 2626 |
|
| 2627 |
|
| 2628 |
|
| 2629 | <h5>Returns:</h5>
|
| 2630 |
|
| 2631 |
|
| 2632 |
|
| 2633 |
|
| 2634 | <dl>
|
| 2635 | <dt>
|
| 2636 | Type
|
| 2637 | </dt>
|
| 2638 | <dd>
|
| 2639 |
|
| 2640 | <span class="param-type">string</span>
|
| 2641 |
|
| 2642 |
|
| 2643 |
|
| 2644 | </dd>
|
| 2645 | </dl>
|
| 2646 |
|
| 2647 |
|
| 2648 |
|
| 2649 |
|
| 2650 |
|
| 2651 | </dd>
|
| 2652 |
|
| 2653 |
|
| 2654 |
|
| 2655 | <hr>
|
| 2656 | <dt>
|
| 2657 | <h4 class="name" id=".URIValueEncode"><span class="type-signature"><static> </span>URIValueEncode<span class="signature">(value)</span><span class="type-signature"> → {string}</span></h4>
|
| 2658 |
|
| 2659 |
|
| 2660 | </dt>
|
| 2661 | <dd>
|
| 2662 |
|
| 2663 |
|
| 2664 | <div class="description">
|
| 2665 | <p>Encodes a given URI value. Uses the native <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent">encodeURIComponent</a> function internally if available or fallbacks to the native <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/escape">escape</a> function otherwise.</p>
|
| 2666 | </div>
|
| 2667 |
|
| 2668 |
|
| 2669 |
|
| 2670 |
|
| 2671 |
|
| 2672 |
|
| 2673 |
|
| 2674 |
|
| 2675 | <h5>Parameters:</h5>
|
| 2676 |
|
| 2677 |
|
| 2678 | <table class="params table table-striped">
|
| 2679 | <thead>
|
| 2680 | <tr>
|
| 2681 |
|
| 2682 | <th style="width:12%; min-width:110px;">Name</th>
|
| 2683 |
|
| 2684 |
|
| 2685 | <th style="width:12%; min-width:110px;">Type</th>
|
| 2686 |
|
| 2687 |
|
| 2688 |
|
| 2689 |
|
| 2690 |
|
| 2691 | <th class="last" style="min-width:310px;">Description</th>
|
| 2692 | </tr>
|
| 2693 | </thead>
|
| 2694 |
|
| 2695 | <tbody>
|
| 2696 |
|
| 2697 |
|
| 2698 | <tr>
|
| 2699 |
|
| 2700 | <td class="name" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><code>value</code></td>
|
| 2701 |
|
| 2702 |
|
| 2703 | <td class="type" style="width:12%; min-width:110px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
|
| 2704 |
|
| 2705 |
|
| 2706 | <span class="param-type">string</span>
|
| 2707 | |
|
| 2708 |
|
| 2709 | <span class="param-type">number</span>
|
| 2710 |
|
| 2711 |
|
| 2712 |
|
| 2713 |
|
| 2714 | </td>
|
| 2715 |
|
| 2716 |
|
| 2717 |
|
| 2718 |
|
| 2719 |
|
| 2720 | <td class="description last" style="min-width:310px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;"><p>The value that we want to encode. Normally, it should be either a string or a number.</p></td>
|
| 2721 | </tr>
|
| 2722 |
|
| 2723 |
|
| 2724 | </tbody>
|
| 2725 | </table>
|
| 2726 |
|
| 2727 |
|
| 2728 |
|
| 2729 |
|
| 2730 | <dl class="details">
|
| 2731 |
|
| 2732 |
|
| 2733 |
|
| 2734 |
|
| 2735 |
|
| 2736 |
|
| 2737 |
|
| 2738 |
|
| 2739 |
|
| 2740 |
|
| 2741 |
|
| 2742 |
|
| 2743 |
|
| 2744 |
|
| 2745 |
|
| 2746 |
|
| 2747 |
|
| 2748 |
|
| 2749 |
|
| 2750 |
|
| 2751 |
|
| 2752 |
|
| 2753 |
|
| 2754 |
|
| 2755 |
|
| 2756 |
|
| 2757 |
|
| 2758 |
|
| 2759 |
|
| 2760 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
| 2761 | <dd class="tag-source">
|
| 2762 | <ul class="dummy">
|
| 2763 | <li>
|
| 2764 | <a href="CrossBase_net_CB_Net.js.html">CrossBase/net/CB_Net.js</a>,
|
| 2765 | <a href="CrossBase_net_CB_Net.js.html#sunlight-1-line-43">line 43</a>
|
| 2766 | </li>
|
| 2767 | </ul>
|
| 2768 | </dd>
|
| 2769 |
|
| 2770 |
|
| 2771 |
|
| 2772 |
|
| 2773 |
|
| 2774 |
|
| 2775 |
|
| 2776 | <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
|
| 2777 | <dd class="tag-todo">
|
| 2778 | <ul>
|
| 2779 | <li>Think about using another thing since <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/escape">escape</a> maybe is not a good fallback. Probably a polyfill to simulate the <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent">encodeURIComponent</a> function.</li>
|
| 2780 | </ul>
|
| 2781 | </dd>
|
| 2782 |
|
| 2783 | </dl>
|
| 2784 |
|
| 2785 |
|
| 2786 |
|
| 2787 |
|
| 2788 |
|
| 2789 |
|
| 2790 |
|
| 2791 |
|
| 2792 |
|
| 2793 |
|
| 2794 |
|
| 2795 |
|
| 2796 |
|
| 2797 | <h5>Returns:</h5>
|
| 2798 |
|
| 2799 |
|
| 2800 |
|
| 2801 |
|
| 2802 | <dl>
|
| 2803 | <dt>
|
| 2804 | Type
|
| 2805 | </dt>
|
| 2806 | <dd>
|
| 2807 |
|
| 2808 | <span class="param-type">string</span>
|
| 2809 |
|
| 2810 |
|
| 2811 |
|
| 2812 | </dd>
|
| 2813 | </dl>
|
| 2814 |
|
| 2815 |
|
| 2816 |
|
| 2817 |
|
| 2818 |
|
| 2819 | </dd>
|
| 2820 |
|
| 2821 |
|
| 2822 |
|
| 2823 | <hr>
|
| 2824 | <dt>
|
| 2825 | <h4 class="name" id=".URLDecode"><span class="type-signature"><static> </span>URLDecode<span class="signature">()</span><span class="type-signature"></span></h4>
|
| 2826 |
|
| 2827 |
|
| 2828 | </dt>
|
| 2829 | <dd>
|
| 2830 |
|
| 2831 |
|
| 2832 | <div class="description">
|
| 2833 | <p>Alias for <a href="CB_Net.html#.URIDecode"><code>CB_Net.URIDecode</code></a>.</p>
|
| 2834 | </div>
|
| 2835 |
|
| 2836 |
|
| 2837 |
|
| 2838 |
|
| 2839 |
|
| 2840 |
|
| 2841 |
|
| 2842 |
|
| 2843 |
|
| 2844 |
|
| 2845 | <dl class="details">
|
| 2846 |
|
| 2847 |
|
| 2848 |
|
| 2849 |
|
| 2850 |
|
| 2851 |
|
| 2852 |
|
| 2853 |
|
| 2854 |
|
| 2855 |
|
| 2856 |
|
| 2857 |
|
| 2858 |
|
| 2859 |
|
| 2860 |
|
| 2861 |
|
| 2862 |
|
| 2863 |
|
| 2864 |
|
| 2865 |
|
| 2866 |
|
| 2867 |
|
| 2868 |
|
| 2869 |
|
| 2870 |
|
| 2871 |
|
| 2872 |
|
| 2873 |
|
| 2874 |
|
| 2875 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
| 2876 | <dd class="tag-source">
|
| 2877 | <ul class="dummy">
|
| 2878 | <li>
|
| 2879 | <a href="CrossBase_net_CB_Net.js.html">CrossBase/net/CB_Net.js</a>,
|
| 2880 | <a href="CrossBase_net_CB_Net.js.html#sunlight-1-line-88">line 88</a>
|
| 2881 | </li>
|
| 2882 | </ul>
|
| 2883 | </dd>
|
| 2884 |
|
| 2885 |
|
| 2886 |
|
| 2887 |
|
| 2888 |
|
| 2889 | <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
|
| 2890 | <dd class="tag-see">
|
| 2891 | <ul>
|
| 2892 | <li><a href="CB_Net.html#.URIDecode"><code>CB_Net.URIDecode</code></a></li>
|
| 2893 | </ul>
|
| 2894 | </dd>
|
| 2895 |
|
| 2896 |
|
| 2897 |
|
| 2898 | </dl>
|
| 2899 |
|
| 2900 |
|
| 2901 |
|
| 2902 |
|
| 2903 |
|
| 2904 |
|
| 2905 |
|
| 2906 |
|
| 2907 |
|
| 2908 |
|
| 2909 |
|
| 2910 |
|
| 2911 |
|
| 2912 |
|
| 2913 |
|
| 2914 | </dd>
|
| 2915 |
|
| 2916 |
|
| 2917 |
|
| 2918 | <hr>
|
| 2919 | <dt>
|
| 2920 | <h4 class="name" id=".URLEncode"><span class="type-signature"><static> </span>URLEncode<span class="signature">()</span><span class="type-signature"></span></h4>
|
| 2921 |
|
| 2922 |
|
| 2923 | </dt>
|
| 2924 | <dd>
|
| 2925 |
|
| 2926 |
|
| 2927 | <div class="description">
|
| 2928 | <p>Alias for <a href="CB_Net.html#.URIEncode"><code>CB_Net.URIEncode</code></a>.</p>
|
| 2929 | </div>
|
| 2930 |
|
| 2931 |
|
| 2932 |
|
| 2933 |
|
| 2934 |
|
| 2935 |
|
| 2936 |
|
| 2937 |
|
| 2938 |
|
| 2939 |
|
| 2940 | <dl class="details">
|
| 2941 |
|
| 2942 |
|
| 2943 |
|
| 2944 |
|
| 2945 |
|
| 2946 |
|
| 2947 |
|
| 2948 |
|
| 2949 |
|
| 2950 |
|
| 2951 |
|
| 2952 |
|
| 2953 |
|
| 2954 |
|
| 2955 |
|
| 2956 |
|
| 2957 |
|
| 2958 |
|
| 2959 |
|
| 2960 |
|
| 2961 |
|
| 2962 |
|
| 2963 |
|
| 2964 |
|
| 2965 |
|
| 2966 |
|
| 2967 |
|
| 2968 |
|
| 2969 |
|
| 2970 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
| 2971 | <dd class="tag-source">
|
| 2972 | <ul class="dummy">
|
| 2973 | <li>
|
| 2974 | <a href="CrossBase_net_CB_Net.js.html">CrossBase/net/CB_Net.js</a>,
|
| 2975 | <a href="CrossBase_net_CB_Net.js.html#sunlight-1-line-69">line 69</a>
|
| 2976 | </li>
|
| 2977 | </ul>
|
| 2978 | </dd>
|
| 2979 |
|
| 2980 |
|
| 2981 |
|
| 2982 |
|
| 2983 |
|
| 2984 | <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
|
| 2985 | <dd class="tag-see">
|
| 2986 | <ul>
|
| 2987 | <li><a href="CB_Net.html#.URIEncode"><code>CB_Net.URIEncode</code></a></li>
|
| 2988 | </ul>
|
| 2989 | </dd>
|
| 2990 |
|
| 2991 |
|
| 2992 |
|
| 2993 | </dl>
|
| 2994 |
|
| 2995 |
|
| 2996 |
|
| 2997 |
|
| 2998 |
|
| 2999 |
|
| 3000 |
|
| 3001 |
|
| 3002 |
|
| 3003 |
|
| 3004 |
|
| 3005 |
|
| 3006 |
|
| 3007 |
|
| 3008 |
|
| 3009 | </dd>
|
| 3010 |
|
| 3011 |
|
| 3012 |
|
| 3013 | <hr>
|
| 3014 | <dt>
|
| 3015 | <h4 class="name" id=".URLValueDecode"><span class="type-signature"><static> </span>URLValueDecode<span class="signature">()</span><span class="type-signature"></span></h4>
|
| 3016 |
|
| 3017 |
|
| 3018 | </dt>
|
| 3019 | <dd>
|
| 3020 |
|
| 3021 |
|
| 3022 | <div class="description">
|
| 3023 | <p>Alias for <a href="CB_Net.html#.URIValueDecode"><code>CB_Net.URIValueDecode</code></a>.</p>
|
| 3024 | </div>
|
| 3025 |
|
| 3026 |
|
| 3027 |
|
| 3028 |
|
| 3029 |
|
| 3030 |
|
| 3031 |
|
| 3032 |
|
| 3033 |
|
| 3034 |
|
| 3035 | <dl class="details">
|
| 3036 |
|
| 3037 |
|
| 3038 |
|
| 3039 |
|
| 3040 |
|
| 3041 |
|
| 3042 |
|
| 3043 |
|
| 3044 |
|
| 3045 |
|
| 3046 |
|
| 3047 |
|
| 3048 |
|
| 3049 |
|
| 3050 |
|
| 3051 |
|
| 3052 |
|
| 3053 |
|
| 3054 |
|
| 3055 |
|
| 3056 |
|
| 3057 |
|
| 3058 |
|
| 3059 |
|
| 3060 |
|
| 3061 |
|
| 3062 |
|
| 3063 |
|
| 3064 |
|
| 3065 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
| 3066 | <dd class="tag-source">
|
| 3067 | <ul class="dummy">
|
| 3068 | <li>
|
| 3069 | <a href="CrossBase_net_CB_Net.js.html">CrossBase/net/CB_Net.js</a>,
|
| 3070 | <a href="CrossBase_net_CB_Net.js.html#sunlight-1-line-50">line 50</a>
|
| 3071 | </li>
|
| 3072 | </ul>
|
| 3073 | </dd>
|
| 3074 |
|
| 3075 |
|
| 3076 |
|
| 3077 |
|
| 3078 |
|
| 3079 | <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
|
| 3080 | <dd class="tag-see">
|
| 3081 | <ul>
|
| 3082 | <li><a href="CB_Net.html#.URIValueDecode"><code>CB_Net.URIValueDecode</code></a></li>
|
| 3083 | </ul>
|
| 3084 | </dd>
|
| 3085 |
|
| 3086 |
|
| 3087 |
|
| 3088 | </dl>
|
| 3089 |
|
| 3090 |
|
| 3091 |
|
| 3092 |
|
| 3093 |
|
| 3094 |
|
| 3095 |
|
| 3096 |
|
| 3097 |
|
| 3098 |
|
| 3099 |
|
| 3100 |
|
| 3101 |
|
| 3102 |
|
| 3103 |
|
| 3104 | </dd>
|
| 3105 |
|
| 3106 |
|
| 3107 |
|
| 3108 | <hr>
|
| 3109 | <dt>
|
| 3110 | <h4 class="name" id=".URLValueEncode"><span class="type-signature"><static> </span>URLValueEncode<span class="signature">()</span><span class="type-signature"></span></h4>
|
| 3111 |
|
| 3112 |
|
| 3113 | </dt>
|
| 3114 | <dd>
|
| 3115 |
|
| 3116 |
|
| 3117 | <div class="description">
|
| 3118 | <p>Alias for <a href="CB_Net.html#.URIValueEncode"><code>CB_Net.URIValueEncode</code></a>.</p>
|
| 3119 | </div>
|
| 3120 |
|
| 3121 |
|
| 3122 |
|
| 3123 |
|
| 3124 |
|
| 3125 |
|
| 3126 |
|
| 3127 |
|
| 3128 |
|
| 3129 |
|
| 3130 | <dl class="details">
|
| 3131 |
|
| 3132 |
|
| 3133 |
|
| 3134 |
|
| 3135 |
|
| 3136 |
|
| 3137 |
|
| 3138 |
|
| 3139 |
|
| 3140 |
|
| 3141 |
|
| 3142 |
|
| 3143 |
|
| 3144 |
|
| 3145 |
|
| 3146 |
|
| 3147 |
|
| 3148 |
|
| 3149 |
|
| 3150 |
|
| 3151 |
|
| 3152 |
|
| 3153 |
|
| 3154 |
|
| 3155 |
|
| 3156 |
|
| 3157 |
|
| 3158 |
|
| 3159 |
|
| 3160 | <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
|
| 3161 | <dd class="tag-source">
|
| 3162 | <ul class="dummy">
|
| 3163 | <li>
|
| 3164 | <a href="CrossBase_net_CB_Net.js.html">CrossBase/net/CB_Net.js</a>,
|
| 3165 | <a href="CrossBase_net_CB_Net.js.html#sunlight-1-line-31">line 31</a>
|
| 3166 | </li>
|
| 3167 | </ul>
|
| 3168 | </dd>
|
| 3169 |
|
| 3170 |
|
| 3171 |
|
| 3172 |
|
| 3173 |
|
| 3174 | <dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
|
| 3175 | <dd class="tag-see">
|
| 3176 | <ul>
|
| 3177 | <li><a href="CB_Net.html#.URIValueEncode"><code>CB_Net.URIValueEncode</code></a></li>
|
| 3178 | </ul>
|
| 3179 | </dd>
|
| 3180 |
|
| 3181 |
|
| 3182 |
|
| 3183 | </dl>
|
| 3184 |
|
| 3185 |
|
| 3186 |
|
| 3187 |
|
| 3188 |
|
| 3189 |
|
| 3190 |
|
| 3191 |
|
| 3192 |
|
| 3193 |
|
| 3194 |
|
| 3195 |
|
| 3196 |
|
| 3197 |
|
| 3198 |
|
| 3199 | </dd>
|
| 3200 |
|
| 3201 | </dl>
|
| 3202 |
|
| 3203 |
|
| 3204 |
|
| 3205 |
|
| 3206 |
|
| 3207 | </article>
|
| 3208 |
|
| 3209 | </section>
|
| 3210 |
|
| 3211 |
|
| 3212 |
|
| 3213 |
|
| 3214 | </div>
|
| 3215 | </div>
|
| 3216 |
|
| 3217 | <div class="clearfix"></div>
|
| 3218 |
|
| 3219 |
|
| 3220 | <div class="col-md-3">
|
| 3221 | <div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
|
| 3222 | </div>
|
| 3223 |
|
| 3224 |
|
| 3225 | </div>
|
| 3226 | </div>
|
| 3227 |
|
| 3228 |
|
| 3229 | <div class="modal fade" id="searchResults">
|
| 3230 | <div class="modal-dialog">
|
| 3231 | <div class="modal-content">
|
| 3232 | <div class="modal-header">
|
| 3233 | <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button>
|
| 3234 | <h4 class="modal-title">Search results</h4>
|
| 3235 | </div>
|
| 3236 | <div class="modal-body"></div>
|
| 3237 | <div class="modal-footer">
|
| 3238 | <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
|
| 3239 | </div>
|
| 3240 | </div>
|
| 3241 | </div>
|
| 3242 | </div>
|
| 3243 |
|
| 3244 |
|
| 3245 | <footer>
|
| 3246 |
|
| 3247 |
|
| 3248 | <span class="copyright">
|
| 3249 | <a href="printable/" target="_blank">See a more printer-friendly version</a><hr /><span style="color:#000000">© <address style="display:inline; font-style:normal;"><a href="https://crossbrowdy.com/" target="_blank">CrossBrowdy</a> API documentation</address> by <a href="https://joanalbamaldonado.com/" target="_blank">Joan Alba Maldonado</a> - <a href="https://creativecommons.org/licenses/by/4.0/" target="_blank">Creative Commons Attribution 4.0 International</a><br />DocStrap Copyright © 2012-2015 The contributors to the JSDoc3 and DocStrap projects.</span>
|
| 3250 | </span>
|
| 3251 |
|
| 3252 | <span class="jsdoc-message">
|
| 3253 | Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
|
| 3254 |
|
| 3255 | on Mon Feb 3rd 2020
|
| 3256 |
|
| 3257 | using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
|
| 3258 | </span>
|
| 3259 | </footer>
|
| 3260 |
|
| 3261 | <script src="scripts/docstrap.lib.js"></script>
|
| 3262 | <script src="scripts/toc.js"></script>
|
| 3263 |
|
| 3264 | <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
|
| 3265 |
|
| 3266 |
|
| 3267 | <script>
|
| 3268 | $( function () {
|
| 3269 | $( "[id*='$']" ).each( function () {
|
| 3270 | var $this = $( this );
|
| 3271 |
|
| 3272 | $this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
|
| 3273 | } );
|
| 3274 |
|
| 3275 | $( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
|
| 3276 | var $this = $( this );
|
| 3277 |
|
| 3278 | var example = $this.find( "code" );
|
| 3279 | exampleText = example.html();
|
| 3280 | var lang = /{@lang (.*?)}/.exec( exampleText );
|
| 3281 | if ( lang && lang[1] ) {
|
| 3282 | exampleText = exampleText.replace( lang[0], "" );
|
| 3283 | example.html( exampleText );
|
| 3284 | lang = lang[1];
|
| 3285 | } else {
|
| 3286 | var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
|
| 3287 | lang = langClassMatch ? langClassMatch[1] : "javascript";
|
| 3288 | }
|
| 3289 |
|
| 3290 | if ( lang ) {
|
| 3291 |
|
| 3292 | $this
|
| 3293 | .addClass( "sunlight-highlight-" + lang )
|
| 3294 | .addClass( "linenums" )
|
| 3295 | .html( example.html() );
|
| 3296 |
|
| 3297 | }
|
| 3298 | } );
|
| 3299 |
|
| 3300 | Sunlight.highlightAll( {
|
| 3301 | lineNumbers : true,
|
| 3302 | showMenu : true,
|
| 3303 | enableDoclinks : true
|
| 3304 | } );
|
| 3305 |
|
| 3306 | $.catchAnchorLinks( {
|
| 3307 | navbarOffset: 10
|
| 3308 | } );
|
| 3309 | $( "#toc" ).toc( {
|
| 3310 | anchorName : function ( i, heading, prefix ) {
|
| 3311 | return $( heading ).attr( "id" ) || ( prefix + i );
|
| 3312 | },
|
| 3313 | selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
|
| 3314 | showAndHide : false,
|
| 3315 | smoothScrolling: true
|
| 3316 | } );
|
| 3317 |
|
| 3318 | $( "#main span[id^='toc']" ).addClass( "toc-shim" );
|
| 3319 | $( '.dropdown-toggle' ).dropdown();
|
| 3320 |
|
| 3321 | $( "table" ).each( function () {
|
| 3322 | var $this = $( this );
|
| 3323 | $this.addClass('table');
|
| 3324 | } );
|
| 3325 |
|
| 3326 | } );
|
| 3327 | </script>
|
| 3328 |
|
| 3329 |
|
| 3330 |
|
| 3331 |
|
| 3332 |
|
| 3333 | <script>
|
| 3334 | $( function () {
|
| 3335 | $( '#main' ).localScroll( {
|
| 3336 | offset : { top : 60 }
|
| 3337 | } );
|
| 3338 | $( "dt.name" ).each( function () {
|
| 3339 | var $this = $( this ).find("h4");
|
| 3340 | var icon = $( "<i/>" ).addClass( "icon-plus-sign" ).addClass( "pull-right" ).addClass( "icon-white" );
|
| 3341 | var dt = $(this);
|
| 3342 | var children = dt.next( "dd" );
|
| 3343 |
|
| 3344 | dt.prepend( icon ).css( {cursor : "pointer"} );
|
| 3345 | dt.addClass( "member-collapsed" ).addClass( "member" );
|
| 3346 |
|
| 3347 |
|
| 3348 | children.hide();
|
| 3349 |
|
| 3350 | dt.children().on( "click", function () {
|
| 3351 | children = dt.next( "dd" );
|
| 3352 | children.slideToggle( "fast", function () {
|
| 3353 |
|
| 3354 | if ( children.is( ":visible" ) ) {
|
| 3355 | icon.addClass( "icon-minus-sign" ).removeClass( "icon-plus-sign" ).removeClass( "icon-white" );
|
| 3356 | dt.addClass( "member-open" ).animate( "member-collapsed" );
|
| 3357 | } else {
|
| 3358 | icon.addClass( "icon-plus-sign" ).removeClass( "icon-minus-sign" ).addClass( "icon-white" );
|
| 3359 | dt.addClass( "member-collapsed" ).removeClass( "member-open" );
|
| 3360 | }
|
| 3361 | } );
|
| 3362 | } );
|
| 3363 |
|
| 3364 | } );
|
| 3365 | } );
|
| 3366 | </script>
|
| 3367 |
|
| 3368 |
|
| 3369 |
|
| 3370 |
|
| 3371 |
|
| 3372 |
|
| 3373 | <script type="text/javascript">
|
| 3374 | $(document).ready(function() {
|
| 3375 | SearcherDisplay.init();
|
| 3376 | });
|
| 3377 | </script>
|
| 3378 |
|
| 3379 |
|
| 3380 | </body>
|
| 3381 | </html> |
| \ | No newline at end of file |