blob: c00b3fbf4e69d202161a663240ca268310af0fb6 [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Module: odata/net</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Module: odata/net</h1>
<section>
<header>
<h2>
odata/net
</h2>
</header>
<article>
<div class="container-overview">
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="net-browser.js.html">odata/net-browser.js</a>, <a href="net-browser.js.html#line3">line 3</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name" id="createIFrame"><span class="type-signature">&lt;inner> </span>createIFrame<span class="signature">(url)</span><span class="type-signature"> &rarr; {HTMLElement}</span></h4>
</dt>
<dd>
<div class="description">
Creates an IFRAME tag for loading the JSONP script
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">The source URL of the script</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="net-browser.js.html">odata/net-browser.js</a>, <a href="net-browser.js.html#line53">line 53</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The IFRAME tag
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">HTMLElement</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="createXmlHttpRequest"><span class="type-signature">&lt;inner> </span>createXmlHttpRequest<span class="signature">()</span><span class="type-signature"> &rarr; {XmlHttpRequest}</span></h4>
</dt>
<dd>
<div class="description">
Creates a XmlHttpRequest object.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="net-browser.js.html">odata/net-browser.js</a>, <a href="net-browser.js.html#line70">line 70</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
XmlHttpRequest object.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">XmlHttpRequest</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="isAbsoluteUrl"><span class="type-signature">&lt;inner> </span>isAbsoluteUrl<span class="signature">(url)</span><span class="type-signature"> &rarr; {Boolean}</span></h4>
</dt>
<dd>
<div class="description">
Checks whether the specified URL is an absolute URL.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">URL to check.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="net-browser.js.html">odata/net-browser.js</a>, <a href="net-browser.js.html#line95">line 95</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
true if the url is an absolute URL; false otherwise.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Boolean</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="isAbsoluteUrl"><span class="type-signature">&lt;inner> </span>isAbsoluteUrl<span class="signature">(url)</span><span class="type-signature"> &rarr; {Boolean}</span></h4>
</dt>
<dd>
<div class="description">
Checks whether the specified URL is an absolute URL.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">URL to check.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="net.js.html">odata/net.js</a>, <a href="net.js.html#line53">line 53</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
true if the url is an absolute URL; false otherwise.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Boolean</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="isLocalUrl"><span class="type-signature">&lt;inner> </span>isLocalUrl<span class="signature">(url)</span><span class="type-signature"> &rarr; {Boolean}</span></h4>
</dt>
<dd>
<div class="description">
Checks whether the specified URL is local to the current context.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">URL to check.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="net-browser.js.html">odata/net-browser.js</a>, <a href="net-browser.js.html#line105">line 105</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
true if the url is a local URL; false otherwise.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Boolean</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="isLocalUrl"><span class="type-signature">&lt;inner> </span>isLocalUrl<span class="signature">(url)</span><span class="type-signature"> &rarr; {Boolean}</span></h4>
</dt>
<dd>
<div class="description">
Checks whether the specified URL is local to the current context.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">URL to check.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="net.js.html">odata/net.js</a>, <a href="net.js.html#line63">line 63</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
true if the url is a local URL; false otherwise.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Boolean</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="readResponseHeaders"><span class="type-signature">&lt;inner> </span>readResponseHeaders<span class="signature">(xhr, headers)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
Reads response headers into array.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>xhr</code></td>
<td class="type">
<span class="param-type">XMLHttpRequest</span>
</td>
<td class="description last">HTTP request with response available.</td>
</tr>
<tr>
<td class="name"><code>headers</code></td>
<td class="type">
<span class="param-type">Array</span>
</td>
<td class="description last">Target array to fill with name/value pairs.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="net-browser.js.html">odata/net-browser.js</a>, <a href="net-browser.js.html#line149">line 149</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="readResponseHeaders"><span class="type-signature">&lt;inner> </span>readResponseHeaders<span class="signature">(inHeader, outHeader)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
Reads response headers into array.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>inHeader</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>outHeader</code></td>
<td class="type">
<span class="param-type">Array</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="net.js.html">odata/net.js</a>, <a href="net.js.html#line80">line 80</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="removeCallback"><span class="type-signature">&lt;inner> </span>removeCallback<span class="signature">(name, tick)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
Removes a callback used for a JSONP request.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">Function name to remove.</td>
</tr>
<tr>
<td class="name"><code>tick</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">Tick count used on the callback.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="net-browser.js.html">odata/net-browser.js</a>, <a href="net-browser.js.html#line121">line 121</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="removeIFrame"><span class="type-signature">&lt;inner> </span>removeIFrame<span class="signature">(iframe)</span><span class="type-signature"> &rarr; {Object}</span></h4>
</dt>
<dd>
<div class="description">
Removes an iframe.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>iframe</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">The iframe to remove.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="net-browser.js.html">odata/net-browser.js</a>, <a href="net-browser.js.html#line136">line 136</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Null value to be assigned to iframe reference.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="writeHtmlToIFrame"><span class="type-signature">&lt;inner> </span>writeHtmlToIFrame<span class="signature">(iframe, html)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
Writes HTML to an IFRAME document.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>iframe</code></td>
<td class="type">
<span class="param-type">HTMLElement</span>
</td>
<td class="description last">The IFRAME element to write to.</td>
</tr>
<tr>
<td class="name"><code>html</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">The HTML to write.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="net-browser.js.html">odata/net-browser.js</a>, <a href="net-browser.js.html#line165">line 165</a>
</li></ul></dd>
</dl>
</dd>
</dl>
</article>
</section>
<section>
<header>
<h2>
odata/net
</h2>
</header>
<article>
<div class="container-overview">
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="net.js.html">odata/net.js</a>, <a href="net.js.html#line20">line 20</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name" id="createIFrame"><span class="type-signature">&lt;inner> </span>createIFrame<span class="signature">(url)</span><span class="type-signature"> &rarr; {HTMLElement}</span></h4>
</dt>
<dd>
<div class="description">
Creates an IFRAME tag for loading the JSONP script
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">The source URL of the script</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="net-browser.js.html">odata/net-browser.js</a>, <a href="net-browser.js.html#line53">line 53</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The IFRAME tag
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">HTMLElement</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="createXmlHttpRequest"><span class="type-signature">&lt;inner> </span>createXmlHttpRequest<span class="signature">()</span><span class="type-signature"> &rarr; {XmlHttpRequest}</span></h4>
</dt>
<dd>
<div class="description">
Creates a XmlHttpRequest object.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="net-browser.js.html">odata/net-browser.js</a>, <a href="net-browser.js.html#line70">line 70</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
XmlHttpRequest object.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">XmlHttpRequest</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="isAbsoluteUrl"><span class="type-signature">&lt;inner> </span>isAbsoluteUrl<span class="signature">(url)</span><span class="type-signature"> &rarr; {Boolean}</span></h4>
</dt>
<dd>
<div class="description">
Checks whether the specified URL is an absolute URL.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">URL to check.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="net-browser.js.html">odata/net-browser.js</a>, <a href="net-browser.js.html#line95">line 95</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
true if the url is an absolute URL; false otherwise.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Boolean</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="isAbsoluteUrl"><span class="type-signature">&lt;inner> </span>isAbsoluteUrl<span class="signature">(url)</span><span class="type-signature"> &rarr; {Boolean}</span></h4>
</dt>
<dd>
<div class="description">
Checks whether the specified URL is an absolute URL.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">URL to check.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="net.js.html">odata/net.js</a>, <a href="net.js.html#line53">line 53</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
true if the url is an absolute URL; false otherwise.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Boolean</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="isLocalUrl"><span class="type-signature">&lt;inner> </span>isLocalUrl<span class="signature">(url)</span><span class="type-signature"> &rarr; {Boolean}</span></h4>
</dt>
<dd>
<div class="description">
Checks whether the specified URL is local to the current context.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">URL to check.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="net-browser.js.html">odata/net-browser.js</a>, <a href="net-browser.js.html#line105">line 105</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
true if the url is a local URL; false otherwise.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Boolean</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="isLocalUrl"><span class="type-signature">&lt;inner> </span>isLocalUrl<span class="signature">(url)</span><span class="type-signature"> &rarr; {Boolean}</span></h4>
</dt>
<dd>
<div class="description">
Checks whether the specified URL is local to the current context.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">URL to check.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="net.js.html">odata/net.js</a>, <a href="net.js.html#line63">line 63</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
true if the url is a local URL; false otherwise.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Boolean</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="readResponseHeaders"><span class="type-signature">&lt;inner> </span>readResponseHeaders<span class="signature">(xhr, headers)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
Reads response headers into array.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>xhr</code></td>
<td class="type">
<span class="param-type">XMLHttpRequest</span>
</td>
<td class="description last">HTTP request with response available.</td>
</tr>
<tr>
<td class="name"><code>headers</code></td>
<td class="type">
<span class="param-type">Array</span>
</td>
<td class="description last">Target array to fill with name/value pairs.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="net-browser.js.html">odata/net-browser.js</a>, <a href="net-browser.js.html#line149">line 149</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="readResponseHeaders"><span class="type-signature">&lt;inner> </span>readResponseHeaders<span class="signature">(inHeader, outHeader)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
Reads response headers into array.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>inHeader</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>outHeader</code></td>
<td class="type">
<span class="param-type">Array</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="net.js.html">odata/net.js</a>, <a href="net.js.html#line80">line 80</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="removeCallback"><span class="type-signature">&lt;inner> </span>removeCallback<span class="signature">(name, tick)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
Removes a callback used for a JSONP request.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">Function name to remove.</td>
</tr>
<tr>
<td class="name"><code>tick</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">Tick count used on the callback.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="net-browser.js.html">odata/net-browser.js</a>, <a href="net-browser.js.html#line121">line 121</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="removeIFrame"><span class="type-signature">&lt;inner> </span>removeIFrame<span class="signature">(iframe)</span><span class="type-signature"> &rarr; {Object}</span></h4>
</dt>
<dd>
<div class="description">
Removes an iframe.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>iframe</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">The iframe to remove.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="net-browser.js.html">odata/net-browser.js</a>, <a href="net-browser.js.html#line136">line 136</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Null value to be assigned to iframe reference.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="writeHtmlToIFrame"><span class="type-signature">&lt;inner> </span>writeHtmlToIFrame<span class="signature">(iframe, html)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
Writes HTML to an IFRAME document.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>iframe</code></td>
<td class="type">
<span class="param-type">HTMLElement</span>
</td>
<td class="description last">The IFRAME element to write to.</td>
</tr>
<tr>
<td class="name"><code>html</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">The HTML to write.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="net-browser.js.html">odata/net-browser.js</a>, <a href="net-browser.js.html#line165">line 165</a>
</li></ul></dd>
</dl>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Index</a></h2><h3>Modules</h3><ul><li><a href="module-cache.html">cache</a></li><li><a href="source.html">cache/source</a></li><li><a href="module-odata.html">odata</a></li><li><a href="batch.html">odata/batch</a></li><li><a href="handler.html">odata/handler</a></li><li><a href="json.html">odata/json</a></li><li><a href="metadata.html">odata/metadata</a></li><li><a href="net.html">odata/net</a></li><li><a href="utils.html">odata/utils</a></li><li><a href="deferred.html">odatajs/deferred</a></li><li><a href="utils_.html">odatajs/utils</a></li><li><a href="xml.html">odatajs/xml</a></li><li><a href="module-store.html">store</a></li><li><a href="dom.html">store/dom</a></li><li><a href="indexeddb.html">store/indexeddb</a></li><li><a href="memory.html">store/memory</a></li></ul><h3>Classes</h3><ul><li><a href="DataCache.html">DataCache</a></li><li><a href="DataCacheOperation.html">DataCacheOperation</a></li><li><a href="DjsDeferred.html">DjsDeferred</a></li><li><a href="dom-DomStore.html">DomStore</a></li><li><a href="indexeddb-IndexedDBStore.html">IndexedDBStore</a></li><li><a href="memory-MemoryStore.html">MemoryStore</a></li><li><a href="ODataCacheSource.html">ODataCacheSource</a></li></ul><h3><a href="global.html">Global</a></h3>
</nav>
<br clear="both">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Thu Apr 09 2015 08:31:26 GMT+0200 (MESZ)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>