jsdk-offical
Version:
JSDK is the most comprehensive TypeScript framework, like JDK.
794 lines • 59.9 kB
HTML
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>PageQuery | JSDK 2.7.0 API</title>
<meta name="description" content="Documentation for JSDK 2.7.0 API">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">JSDK 2.7.0 API</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../globals.html">Globals</a>
</li>
<li>
<a href="../modules/js.html">JS</a>
</li>
<li>
<a href="../modules/js.model.html">model</a>
</li>
<li>
<a href="js.model.pagequery.html">PageQuery</a>
</li>
</ul>
<h1>Interface PageQuery</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="js.net.httprequest.html" class="tsd-signature-type">HttpRequest</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">PageQuery</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="js.model.pagequery.html#async" class="tsd-kind-icon">async</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="js.model.pagequery.html#cache" class="tsd-kind-icon">cache</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="js.model.pagequery.html#complete" class="tsd-kind-icon">complete</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="js.model.pagequery.html#converts" class="tsd-kind-icon">converts</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="js.model.pagequery.html#crosscookie" class="tsd-kind-icon">cross<wbr>Cookie</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="js.model.pagequery.html#data" class="tsd-kind-icon">data</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="js.model.pagequery.html#error" class="tsd-kind-icon">error</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="js.model.pagequery.html#headers" class="tsd-kind-icon">headers</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="js.model.pagequery.html#ifmodified" class="tsd-kind-icon">if<wbr>Modified</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="js.model.pagequery.html#method" class="tsd-kind-icon">method</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="js.model.pagequery.html#overrideresponsemime" class="tsd-kind-icon">override<wbr>Response<wbr>Mime</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="js.model.pagequery.html#page" class="tsd-kind-icon">page</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="js.model.pagequery.html#pagesize" class="tsd-kind-icon">page<wbr>Size</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="js.model.pagequery.html#password" class="tsd-kind-icon">password</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="js.model.pagequery.html#progress" class="tsd-kind-icon">progress</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="js.model.pagequery.html#requestmime" class="tsd-kind-icon">request<wbr>Mime</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="js.model.pagequery.html#responsetype" class="tsd-kind-icon">response<wbr>Type</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="js.model.pagequery.html#success" class="tsd-kind-icon">success</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="js.model.pagequery.html#thread" class="tsd-kind-icon">thread</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="js.model.pagequery.html#timeout" class="tsd-kind-icon">timeout</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="js.model.pagequery.html#url" class="tsd-kind-icon">url</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="js.model.pagequery.html#username" class="tsd-kind-icon">username</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="js.model.pagequery.html#responsefilter" class="tsd-kind-icon">response<wbr>Filter</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="async" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> async</h3>
<div class="tsd-signature tsd-kind-icon">async<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="js.app.api.html">Api</a>.<a href="js.app.api.html#async">async</a></p>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>By default, all requests are sent asynchronously (i.e. this is set to true by default).</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="cache" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> cache</h3>
<div class="tsd-signature tsd-kind-icon">cache<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="js.app.api.html">Api</a>.<a href="js.app.api.html#cache">cache</a></p>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If set to false, it will force requested pages not to be cached by the browser. Note: Setting cache
to false will only work correctly with HEAD and GET requests. It works by appending "_={timestamp}"
to the GET parameters. The parameter is not needed for other types of requests, except in IE8 when a
POST is made to a URL that has already been requested by a GET.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="complete" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> complete</h3>
<div class="tsd-signature tsd-kind-icon">complete<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>res<span class="tsd-signature-symbol">: </span><a href="js.net.httpresponse.html" class="tsd-signature-type">HttpResponse</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="js.app.api.html">Api</a>.<a href="js.app.api.html#complete">complete</a></p>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A function to be called when this request finishes (after success and error callbacks are executed).</p>
</div>
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>res<span class="tsd-signature-symbol">: </span><a href="js.net.httpresponse.html" class="tsd-signature-type">HttpResponse</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>res: <a href="js.net.httpresponse.html" class="tsd-signature-type">HttpResponse</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="converts" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> converts</h3>
<div class="tsd-signature tsd-kind-icon">converts<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>arraybuffer<span class="tsd-signature-symbol">?: </span><T><span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">; </span>blob<span class="tsd-signature-symbol">?: </span><T><span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Blob</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">; </span>html<span class="tsd-signature-symbol">?: </span><T><span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLDocument</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">; </span>json<span class="tsd-signature-symbol">?: </span><T><span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><a href="../modules/js.lang.html#jsonobject" class="tsd-signature-type">JsonObject</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">; </span>text<span class="tsd-signature-symbol">?: </span><T><span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">; </span>xml<span class="tsd-signature-symbol">?: </span><T><span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">XMLDocument</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="js.app.api.html">Api</a>.<a href="js.app.api.html#converts">converts</a></p>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An object containing type converters. Each parser's value is a function that
returns the filtered response data of the type, will be replaced a default inner-parser.</p>
</div>
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> arraybuffer<span class="tsd-signature-symbol">?: </span><T><span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">T</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-variable tsd-has-type-parameter">
<li class="tsd-signature tsd-kind-icon"><T><span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T</h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>data: <span class="tsd-signature-type">ArrayBuffer</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
</li>
</ul>
</li>
</ul>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> blob<span class="tsd-signature-symbol">?: </span><T><span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Blob</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">T</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-variable tsd-has-type-parameter">
<li class="tsd-signature tsd-kind-icon"><T><span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Blob</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T</h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>data: <span class="tsd-signature-type">Blob</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
</li>
</ul>
</li>
</ul>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> html<span class="tsd-signature-symbol">?: </span><T><span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLDocument</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">T</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-variable tsd-has-type-parameter">
<li class="tsd-signature tsd-kind-icon"><T><span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLDocument</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T</h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>data: <span class="tsd-signature-type">HTMLDocument</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
</li>
</ul>
</li>
</ul>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> json<span class="tsd-signature-symbol">?: </span><T><span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><a href="../modules/js.lang.html#jsonobject" class="tsd-signature-type">JsonObject</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">T</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-variable tsd-has-type-parameter">
<li class="tsd-signature tsd-kind-icon"><T><span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><a href="../modules/js.lang.html#jsonobject" class="tsd-signature-type">JsonObject</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T</h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>data: <a href="../modules/js.lang.html#jsonobject" class="tsd-signature-type">JsonObject</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
</li>
</ul>
</li>
</ul>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> text<span class="tsd-signature-symbol">?: </span><T><span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">T</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-variable tsd-has-type-parameter">
<li class="tsd-signature tsd-kind-icon"><T><span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T</h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>data: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
</li>
</ul>
</li>
</ul>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> xml<span class="tsd-signature-symbol">?: </span><T><span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">XMLDocument</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">T</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-variable tsd-has-type-parameter">
<li class="tsd-signature tsd-kind-icon"><T><span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">XMLDocument</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T</h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>data: <span class="tsd-signature-type">XMLDocument</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="crosscookie" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> cross<wbr>Cookie</h3>
<div class="tsd-signature tsd-kind-icon">cross<wbr>Cookie<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="js.app.api.html">Api</a>.<a href="js.app.api.html#crosscookie">crossCookie</a></p>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>True when credentials are to be included in a cross-origin request. False when they are to be excluded in a cross-origin request and when cookies are to be ignored in its response. Initially false.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="data" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> data</h3>
<div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../modules/js.lang.html#jsonobject" class="tsd-signature-type">JsonObject</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">FormData</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Blob</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="js.app.api.html">Api</a>.<a href="js.app.api.html#data">data</a></p>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Data to be sent to the server.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="error" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> error</h3>
<div class="tsd-signature tsd-kind-icon">error<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>res<span class="tsd-signature-symbol">: </span><a href="js.net.httpresponse.html" class="tsd-signature-type">HttpResponse</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="js.app.api.html">Api</a>.<a href="js.app.api.html#error">error</a></p>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A function to be called if this request fails.</p>
</div>
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>res<span class="tsd-signature-symbol">: </span><a href="js.net.httpresponse.html" class="tsd-signature-type">HttpResponse</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>res: <a href="js.net.httpresponse.html" class="tsd-signature-type">HttpResponse</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="headers" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> headers</h3>
<div class="tsd-signature tsd-kind-icon">headers<span class="tsd-signature-symbol">:</span> <a href="../modules/js.lang.html#jsonobject" class="tsd-signature-type">JsonObject</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="js.app.api.html">Api</a>.<a href="js.app.api.html#headers">headers</a></p>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An object of additional header key/value pairs to send along with requests using the XMLHttpRequest
transport. The header X-Requested-With: XMLHttpRequest is always added, but its default
XMLHttpRequest value can be changed here.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="ifmodified" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> if<wbr>Modified</h3>
<div class="tsd-signature tsd-kind-icon">if<wbr>Modified<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="js.app.api.html">Api</a>.<a href="js.app.api.html#ifmodified">ifModified</a></p>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Allow the request to be successful only if the response has changed since the last request. This is
done by checking the Last-Modified header. Default value is false, ignoring the header. This technique
also checks the 'etag' specified by the server to catch unmodified data.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="method" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> method</h3>
<div class="tsd-signature tsd-kind-icon">method<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"HEAD"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"GET"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"POST"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"OPTIONS"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"PUT"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"DELETE"</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="js.app.api.html">Api</a>.<a href="js.app.api.html#method">method</a></p>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The HTTP method to use for the request.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="overrideresponsemime" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> override<wbr>Response<wbr>Mime</h3>
<div class="tsd-signature tsd-kind-icon">override<wbr>Response<wbr>Mime<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="js.app.api.html">Api</a>.<a href="js.app.api.html#overrideresponsemime">overrideResponseMime</a></p>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The XMLHttpRequest method overrideMimeType() specifies a MIME type other than the one provided by the server to be used instead when interpreting the data being transferred in a request. This may be used, for example, to force a stream to be treated and parsed as "text/xml", even if the server does not report it as such.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="page" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> page</h3>
<div class="tsd-signature tsd-kind-icon">page<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="pagesize" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> page<wbr>Size</h3>
<div class="tsd-signature tsd-kind-icon">page<wbr>Size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="password" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> password</h3>
<div class="tsd-signature tsd-kind-icon">password<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="js.app.api.html">Api</a>.<a href="js.app.api.html#password">password</a></p>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A password to be used with XMLHttpRequest in response to an HTTP access authentication request.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="progress" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> progress</h3>
<div class="tsd-signature tsd-kind-icon">progress<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ProgressEvent</span>, xhr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">XMLHttpRequest</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="js.app.api.html">Api</a>.<a href="js.app.api.html#progress">progress</a></p>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A function to be called if this request progress.</p>
</div>
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ProgressEvent</span>, xhr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">XMLHttpRequest</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>e: <span class="tsd-signature-type">ProgressEvent</span></h5>
</li>
<li>
<h5>xhr: <span class="tsd-signature-type">XMLHttpRequest</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="requestmime" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> request<wbr>Mime</h3>
<div class="tsd-signature tsd-kind-icon">request<wbr>Mime<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="js.app.api.html">Api</a>.<a href="js.app.api.html#requestmime">requestMime</a></p>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>When sending data to the server, use this content type. Default is
"application/x-www-form-urlencoded; charset=UTF-8", which is fine for most cases. If you explicitly
pass in a content-type to $.ajax(), then it is always sent to the server (even if no data is sent).
You can pass false to tell Http to not set any content type header. Note: The W3C
XMLHttpRequest specification dictates that the charset is always UTF-8; specifying another charset
will not force the browser to change the encoding. Note: For cross-domain requests, setting the
content type to anything other than application/x-www-form-urlencoded, multipart/form-data, or
text/plain will trigger the browser to send a preflight OPTIONS request to the server.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="responsetype" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> response<wbr>Type</h3>
<div class="tsd-signature tsd-kind-icon">response<wbr>Type<span class="tsd-signature-symbol">:</span> <a href="../modules/js.net.html#httpresponsetype" class="tsd-signature-type">HttpResponseType</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="js.app.api.html">Api</a>.<a href="js.app.api.html#responsetype">responseType</a></p>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>"xml": Returns a XML document that can be processed.<br>
"html": Returns HTML as plain text; included script tags are evaluated when inserted in the DOM.<br>
"json": Evaluates the response as JSON and returns a JavaScript object.<br>
"text": A plain text string.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="success" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> success</h3>
<div class="tsd-signature tsd-kind-icon">success<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>res<span class="tsd-signature-symbol">: </span><a href="js.net.httpresponse.html" class="tsd-signature-type">HttpResponse</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="js.app.api.html">Api</a>.<a href="js.app.api.html#success">success</a></p>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A function to be called if this request succeeds.</p>
</div>
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>res<span class="tsd-signature-symbol">: </span><a href="js.net.httpresponse.html" class="tsd-signature-type">HttpResponse</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>res: <a href="js.net.httpresponse.html" class="tsd-signature-type">HttpResponse</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="thread" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> thread</h3>
<div class="tsd-signature tsd-kind-icon">thread<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><a href="../modules/js.lang.html#threadpreload" class="tsd-signature-type">ThreadPreload</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="js.app.api.html">Api</a>.<a href="js.app.api.html#thread">thread</a></p>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Send in a new webwork thread.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="timeout" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> timeout</h3>
<div class="tsd-signature tsd-kind-icon">timeout<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="js.app.api.html">Api</a>.<a href="js.app.api.html#timeout">timeout</a></p>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Set a timeout (in milliseconds) for the request. A value of 0 means there will be no timeout.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="url" class="tsd-anchor"></a>
<h3>url</h3>
<div class="tsd-signature tsd-kind-icon">url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="js.app.api.html">Api</a>.<a href="js.app.api.html#url">url</a></p>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An URL string for ajax request.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="username" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> username</h3>
<div class="tsd-signature tsd-kind-icon">username<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="js.app.api.html">Api</a>.<a href="js.app.api.html#username">username</a></p>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A username to be used with XMLHttpRequest in response to an HTTP access authentication request.</p>
</div>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
<a name="responsefilter" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> response<wbr>Filter</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">response<wbr>Filter<span class="tsd-signature-symbol">(</span>raw<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, type<span class="tsd-signature-symbol">: </span><a href="../modules/js.net.html#httpresponsetype" class="tsd-signature-type">HttpResponseType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="js.app.api.html">Api</a>.<a href="js.app.api.html#responsefilter">responseFilter</a></p>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A function to be used to pre-handle the raw response data beforing parse the response.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>raw: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5>type: <a href="../modules/js.net.html#httpresponsetype" class="tsd-signature-type">HttpResponseType</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
<li class="current tsd-kind-namespace">
<a href="../modules/js.html">JS</a>
<ul>
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/js.an.html">an</a>
</li>
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/js.app.html">app</a>
</li>
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/js.core.html">core</a>
</li>
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/js.d2.html">d2</a>
</li>
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/js.ds.html">ds</a>
</li>
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/js.fx.html">fx</a>
</li>
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/js.input.html">input</a>
</li>
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/js.ioc.html">ioc</a>
</li>
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/js.lang.html">lang</a>
</li>
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/js.math.html">math</a>
</li>
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/js.media.html">media</a>
</li>
<li class="current tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/js.model.html">model</a>
<ul>
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/js.model.validator.html">validator</a>
</li>
</ul>
</li>
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/js.net.html">net</a>
</li>
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/js.store.html">store</a>
</li>
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/js.sugar.html">sugar</a>
</li>
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/js.ui.html">ui</a>
</li>
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/js.unit.html">unit</a>
</li>
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/js.util.html">util</a>
</li>
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/js.view.html">view</a>
</li>
</ul>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="../classes/js.model.ajaxproxy.html" class="tsd-kind-icon">Ajax<wbr>Proxy</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="../classes/js.model.field.html" class="tsd-kind-icon">Field</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="../classes/js.model.jsonproxy.html" class="tsd-kind-icon">Json<w