| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8"> |
| <title>JSDoc: Module: odata/json</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/json</h1> |
| |
| |
| |
| |
| |
| <section> |
| |
| <header> |
| <h2> |
| odata/json |
| </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="json.js.html">odata/json.js</a>, <a href="json.js.html#line3">line 3</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <h3 class="subsection-title">Methods</h3> |
| |
| <dl> |
| |
| <dt> |
| <h4 class="name" id="addFullMetadataToJsonPayload"><span class="type-signature"><inner> </span>addFullMetadataToJsonPayload<span class="signature">(data, model, recognizeDates)</span><span class="type-signature"></span></h4> |
| |
| |
| </dt> |
| <dd> |
| |
| |
| <div class="description"> |
| Add metadata to an JSON payload complex object containing full metadata |
| </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>data</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Object</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Data structure to be extended</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>model</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Object</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Metadata model</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>recognizeDates</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Boolean</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Flag indicating whether datetime literal strings should be converted to JavaScript Date objects.</td> |
| </tr> |
| |
| |
| </tbody> |
| </table> |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-source">Source:</dt> |
| <dd class="tag-source"><ul class="dummy"><li> |
| <a href="json.js.html">odata/json.js</a>, <a href="json.js.html#line273">line 273</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </dd> |
| |
| |
| |
| <dt> |
| <h4 class="name" id="addMetadataToJsonMinimalPayloadCollection"><span class="type-signature"><inner> </span>addMetadataToJsonMinimalPayloadCollection<span class="signature">(data, model, collectionInfo, baseURI, recognizeDates)</span><span class="type-signature"></span></h4> |
| |
| |
| </dt> |
| <dd> |
| |
| |
| <div class="description"> |
| Add metadata to an JSON payload collection object containing minimal metadata |
| </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>data</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Object</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Data structure to be extended</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>model</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Object</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Metadata model</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>collectionInfo</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">String</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Information about the data (name,type,typename,...)</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>baseURI</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">String</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Base Url</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>recognizeDates</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Boolean</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Flag indicating whether datetime literal strings should be converted to JavaScript Date objects.</td> |
| </tr> |
| |
| |
| </tbody> |
| </table> |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-source">Source:</dt> |
| <dd class="tag-source"><ul class="dummy"><li> |
| <a href="json.js.html">odata/json.js</a>, <a href="json.js.html#line527">line 527</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </dd> |
| |
| |
| |
| <dt> |
| <h4 class="name" id="addMetadataToJsonMinimalPayloadComplex"><span class="type-signature"><inner> </span>addMetadataToJsonMinimalPayloadComplex<span class="signature">(data, property, baseURI, model, recognizeDates)</span><span class="type-signature"></span></h4> |
| |
| |
| </dt> |
| <dd> |
| |
| |
| <div class="description"> |
| Add metadata to an JSON payload complex object containing minimal metadata |
| </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>data</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Object</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Data structure to be extended</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>property</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">String</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Information about the data (name,type,typename,...)</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>baseURI</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">String</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Base Url</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>model</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Object</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Metadata model</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>recognizeDates</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Boolean</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Flag indicating whether datetime literal strings should be converted to JavaScript Date objects.</td> |
| </tr> |
| |
| |
| </tbody> |
| </table> |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-source">Source:</dt> |
| <dd class="tag-source"><ul class="dummy"><li> |
| <a href="json.js.html">odata/json.js</a>, <a href="json.js.html#line504">line 504</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </dd> |
| |
| |
| |
| <dt> |
| <h4 class="name" id="addMetadataToJsonMinimalPayloadEntity"><span class="type-signature"><inner> </span>addMetadataToJsonMinimalPayloadEntity<span class="signature">(data, objectInfo, baseURI, model, recognizeDates)</span><span class="type-signature"></span></h4> |
| |
| |
| </dt> |
| <dd> |
| |
| |
| <div class="description"> |
| Add metadata to an JSON payload entity object containing minimal metadata |
| </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>data</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Object</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Data structure to be extended</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>objectInfo</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">String</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Information about the data (name,type,typename,...)</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>baseURI</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">String</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Base Url</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>model</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Object</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Metadata model</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>recognizeDates</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Boolean</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Flag indicating whether datetime literal strings should be converted to JavaScript Date objects.</td> |
| </tr> |
| |
| |
| </tbody> |
| </table> |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-source">Source:</dt> |
| <dd class="tag-source"><ul class="dummy"><li> |
| <a href="json.js.html">odata/json.js</a>, <a href="json.js.html#line476">line 476</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </dd> |
| |
| |
| |
| <dt> |
| <h4 class="name" id="addMetadataToJsonMinimalPayloadFeed"><span class="type-signature"><inner> </span>addMetadataToJsonMinimalPayloadFeed<span class="signature">(data, model, feedInfo, baseURI, recognizeDates)</span><span class="type-signature"></span></h4> |
| |
| |
| </dt> |
| <dd> |
| |
| |
| <div class="description"> |
| Add metadata to an JSON payload feed object containing minimal metadata |
| </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>data</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Object</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Data structure to be extended</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>model</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Object</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Metadata model</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>feedInfo</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">String</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Information about the data (name,type,typename,...)</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>baseURI</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">String</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Base Url</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>recognizeDates</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Boolean</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Flag indicating whether datetime literal strings should be converted to JavaScript Date objects.</td> |
| </tr> |
| |
| |
| </tbody> |
| </table> |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-source">Source:</dt> |
| <dd class="tag-source"><ul class="dummy"><li> |
| <a href="json.js.html">odata/json.js</a>, <a href="json.js.html#line439">line 439</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </dd> |
| |
| |
| |
| <dt> |
| <h4 class="name" id="addMinimalMetadataToJsonPayload"><span class="type-signature"><inner> </span>addMinimalMetadataToJsonPayload<span class="signature">(data, model, recognizeDates)</span><span class="type-signature"> → {Object}</span></h4> |
| |
| |
| </dt> |
| <dd> |
| |
| |
| <div class="description"> |
| Add metadata to an JSON payload object containing minimal metadata |
| </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>data</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Object</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Json response payload object</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>model</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Object</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Object describing an OData conceptual schema</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>recognizeDates</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Boolean</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Flag indicating whether datetime literal strings should be converted to JavaScript Date objects.</td> |
| </tr> |
| |
| |
| </tbody> |
| </table> |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-source">Source:</dt> |
| <dd class="tag-source"><ul class="dummy"><li> |
| <a href="json.js.html">odata/json.js</a>, <a href="json.js.html#line388">line 388</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <h5>Returns:</h5> |
| |
| |
| <div class="param-desc"> |
| Object in the library's representation. |
| </div> |
| |
| |
| |
| <dl> |
| <dt> |
| Type |
| </dt> |
| <dd> |
| |
| <span class="param-type">Object</span> |
| |
| |
| </dd> |
| </dl> |
| |
| |
| |
| |
| </dd> |
| |
| |
| |
| <dt> |
| <h4 class="name" id="addType"><span class="type-signature"><inner> </span>addType<span class="signature">(data, name, value)</span><span class="type-signature"></span></h4> |
| |
| |
| </dt> |
| <dd> |
| |
| |
| <div class="description"> |
| Add an OData type tag to an JSON payload object |
| </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>data</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Object</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Data structure to be extended</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>name</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">String</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Name of the property whose type is set</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>value</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">String</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Type name</td> |
| </tr> |
| |
| |
| </tbody> |
| </table> |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-source">Source:</dt> |
| <dd class="tag-source"><ul class="dummy"><li> |
| <a href="json.js.html">odata/json.js</a>, <a href="json.js.html#line567">line 567</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </dd> |
| |
| |
| |
| <dt> |
| <h4 class="name" id="addTypeColNoEdm"><span class="type-signature"><inner> </span>addTypeColNoEdm<span class="signature">(data, name, typeName)</span><span class="type-signature"></span></h4> |
| |
| |
| </dt> |
| <dd> |
| |
| |
| <div class="description"> |
| Add an OData type tag to an JSON payload object collection (without "Edm." namespace) |
| </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>data</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Object</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Data structure to be extended</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>name</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">String</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Name of the property whose type is set</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>typeName</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">String</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Type name</td> |
| </tr> |
| |
| |
| </tbody> |
| </table> |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-source">Source:</dt> |
| <dd class="tag-source"><ul class="dummy"><li> |
| <a href="json.js.html">odata/json.js</a>, <a href="json.js.html#line580">line 580</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </dd> |
| |
| |
| |
| <dt> |
| <h4 class="name" id="addTypeNoEdm"><span class="type-signature"><inner> </span>addTypeNoEdm<span class="signature">(data, name, value)</span><span class="type-signature"></span></h4> |
| |
| |
| </dt> |
| <dd> |
| |
| |
| <div class="description"> |
| Add an OData type tag to an JSON payload object (without "Edm." namespace) |
| </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>data</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Object</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Data structure to be extended</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>name</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">String</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Name of the property whose type is set</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>value</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">String</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Type name</td> |
| </tr> |
| |
| |
| </tbody> |
| </table> |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-source">Source:</dt> |
| <dd class="tag-source"><ul class="dummy"><li> |
| <a href="json.js.html">odata/json.js</a>, <a href="json.js.html#line598">line 598</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </dd> |
| |
| |
| |
| <dt> |
| <h4 class="name" id="checkProperties"><span class="type-signature"><inner> </span>checkProperties<span class="signature">(data, objectInfoType, baseURI, model, recognizeDates)</span><span class="type-signature"></span></h4> |
| |
| |
| </dt> |
| <dd> |
| |
| |
| <div class="description"> |
| Loop through the properties of an JSON payload object, look up the type info of the property and call
the appropriate add*MetadataToJsonPayloadObject function |
| </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>data</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Object</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Data structure to be extended</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>objectInfoType</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">String</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Information about the data (name,type,typename,...)</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>baseURI</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">String</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Base Url</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>model</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Object</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Metadata model</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>recognizeDates</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Boolean</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Flag indicating whether datetime literal strings should be converted to JavaScript Date objects.</td> |
| </tr> |
| |
| |
| </tbody> |
| </table> |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-source">Source:</dt> |
| <dd class="tag-source"><ul class="dummy"><li> |
| <a href="json.js.html">odata/json.js</a>, <a href="json.js.html#line343">line 343</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </dd> |
| |
| |
| |
| <dt> |
| <h4 class="name" id="convertDates"><span class="type-signature"><inner> </span>convertDates<span class="signature">(data, propertyName, type)</span><span class="type-signature"></span></h4> |
| |
| |
| </dt> |
| <dd> |
| |
| |
| <div class="description"> |
| Convert the date/time format of an property from the JSON payload object (without "Edm." namespace) |
| </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>data</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Object</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Data structure to be extended</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>propertyName</code></td> |
| |
| |
| <td class="type"> |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Name of the property to be changed</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>type</code></td> |
| |
| |
| <td class="type"> |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Type</td> |
| </tr> |
| |
| |
| </tbody> |
| </table> |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-source">Source:</dt> |
| <dd class="tag-source"><ul class="dummy"><li> |
| <a href="json.js.html">odata/json.js</a>, <a href="json.js.html#line615">line 615</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </dd> |
| |
| |
| |
| <dt> |
| <h4 class="name" id="convertDatesNoEdm"><span class="type-signature"><inner> </span>convertDatesNoEdm<span class="signature">(data, propertyName, type)</span><span class="type-signature"></span></h4> |
| |
| |
| </dt> |
| <dd> |
| |
| |
| <div class="description"> |
| Convert the date/time format of an property from the JSON payload object |
| </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>data</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Object</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Data structure to be extended</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>propertyName</code></td> |
| |
| |
| <td class="type"> |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Name of the property to be changed</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>type</code></td> |
| |
| |
| <td class="type"> |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Type</td> |
| </tr> |
| |
| |
| </tbody> |
| </table> |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-source">Source:</dt> |
| <dd class="tag-source"><ul class="dummy"><li> |
| <a href="json.js.html">odata/json.js</a>, <a href="json.js.html#line632">line 632</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </dd> |
| |
| |
| |
| <dt> |
| <h4 class="name" id="createPayloadInfo"><span class="type-signature"><inner> </span>createPayloadInfo<span class="signature">(data, model)</span><span class="type-signature"></span></h4> |
| |
| |
| </dt> |
| <dd> |
| |
| |
| <div class="description"> |
| Infers the information describing the JSON payload from its metadata annotation, structure, and data model. |
| </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>data</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Object</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Json response payload object.</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>model</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Object</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Object describing an OData conceptual schema.
If the arguments passed to the function don't convey enough information about the payload to determine without doubt that the payload is a feed then it
will try to use the payload object structure instead. If the payload looks like a feed (has value property that is an array or non-primitive values) then
the function will report its kind as PAYLOADTYPE_FEED unless the inferFeedAsComplexType flag is set to true. This flag comes from the user request
and allows the user to control how the library behaves with an ambigous JSON payload.</td> |
| </tr> |
| |
| |
| </tbody> |
| </table> |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-source">Source:</dt> |
| <dd class="tag-source"><ul class="dummy"><li> |
| <a href="json.js.html">odata/json.js</a>, <a href="json.js.html#line949">line 949</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <h5>Returns:</h5> |
| |
| |
| <div class="param-desc"> |
| Object with kind and type fields. Null if there is no metadata annotation or the payload info cannot be obtained.. |
| </div> |
| |
| |
| |
| |
| |
| |
| </dd> |
| |
| |
| |
| <dt> |
| <h4 class="name" id="formatJsonRequestPayload"><span class="type-signature"><inner> </span>formatJsonRequestPayload<span class="signature">(data)</span><span class="type-signature"> → {String}</span></h4> |
| |
| |
| </dt> |
| <dd> |
| |
| |
| <div class="description"> |
| Convert OData objects for serialisation in to a new data structure |
| </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>data</code></td> |
| |
| |
| <td class="type"> |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Data to serialize.</td> |
| </tr> |
| |
| |
| </tbody> |
| </table> |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-source">Source:</dt> |
| <dd class="tag-source"><ul class="dummy"><li> |
| <a href="json.js.html">odata/json.js</a>, <a href="json.js.html#line204">line 204</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <h5>Returns:</h5> |
| |
| |
| <div class="param-desc"> |
| The string representation of data. |
| </div> |
| |
| |
| |
| <dl> |
| <dt> |
| Type |
| </dt> |
| <dd> |
| |
| <span class="param-type">String</span> |
| |
| |
| </dd> |
| </dl> |
| |
| |
| |
| |
| </dd> |
| |
| |
| |
| <dt> |
| <h4 class="name" id="formatLiteral"><span class="type-signature"><inner> </span>formatLiteral<span class="signature">(value, type)</span><span class="type-signature"> → {string}</span></h4> |
| |
| |
| </dt> |
| <dd> |
| |
| |
| <div class="description"> |
| Formats a value according to Uri literal format |
| </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>value</code></td> |
| |
| |
| <td class="type"> |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Value to be formatted.</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>type</code></td> |
| |
| |
| <td class="type"> |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Edm type of the value</td> |
| </tr> |
| |
| |
| </tbody> |
| </table> |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-source">Source:</dt> |
| <dd class="tag-source"><ul class="dummy"><li> |
| <a href="json.js.html">odata/json.js</a>, <a href="json.js.html#line649">line 649</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <h5>Returns:</h5> |
| |
| |
| <div class="param-desc"> |
| Value after formatting |
| </div> |
| |
| |
| |
| <dl> |
| <dt> |
| Type |
| </dt> |
| <dd> |
| |
| <span class="param-type">string</span> |
| |
| |
| </dd> |
| </dl> |
| |
| |
| |
| |
| </dd> |
| |
| |
| |
| <dt> |
| <h4 class="name" id="formatRawLiteral"><span class="type-signature"><inner> </span>formatRawLiteral<span class="signature">(value, type)</span><span class="type-signature"> → {string}</span></h4> |
| |
| |
| </dt> |
| <dd> |
| |
| |
| <div class="description"> |
| convert raw byteArray to hexString if the property is an binary property |
| </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>value</code></td> |
| |
| |
| <td class="type"> |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Value to be formatted.</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>type</code></td> |
| |
| |
| <td class="type"> |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Edm type of the value</td> |
| </tr> |
| |
| |
| </tbody> |
| </table> |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-source">Source:</dt> |
| <dd class="tag-source"><ul class="dummy"><li> |
| <a href="json.js.html">odata/json.js</a>, <a href="json.js.html#line688">line 688</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <h5>Returns:</h5> |
| |
| |
| <div class="param-desc"> |
| Value after formatting |
| </div> |
| |
| |
| |
| <dl> |
| <dt> |
| Type |
| </dt> |
| <dd> |
| |
| <span class="param-type">string</span> |
| |
| |
| </dd> |
| </dl> |
| |
| |
| |
| |
| </dd> |
| |
| |
| |
| <dt> |
| <h4 class="name" id="isJsonSerializableProperty"><span class="type-signature"><inner> </span>isJsonSerializableProperty<span class="signature">(attribute)</span><span class="type-signature"> → {boolean}</span></h4> |
| |
| |
| </dt> |
| <dd> |
| |
| |
| <div class="description"> |
| Determine form the attribute name if the attribute is a serializable property |
| </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>attribute</code></td> |
| |
| |
| <td class="type"> |
| |
| </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="json.js.html">odata/json.js</a>, <a href="json.js.html#line237">line 237</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <h5>Returns:</h5> |
| |
| |
| |
| |
| <dl> |
| <dt> |
| Type |
| </dt> |
| <dd> |
| |
| <span class="param-type">boolean</span> |
| |
| |
| </dd> |
| </dl> |
| |
| |
| |
| |
| </dd> |
| |
| |
| |
| <dt> |
| <h4 class="name" id="jsonGetEntryKey"><span class="type-signature"><inner> </span>jsonGetEntryKey<span class="signature">(data, data)</span><span class="type-signature"> → {string}</span></h4> |
| |
| |
| </dt> |
| <dd> |
| |
| |
| <div class="description"> |
| Gets the key of an entry. |
| </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>data</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Object</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">JSON entry.</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>data</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Object</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">EDM entity model for key loockup.</td> |
| </tr> |
| |
| |
| </tbody> |
| </table> |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-source">Source:</dt> |
| <dd class="tag-source"><ul class="dummy"><li> |
| <a href="json.js.html">odata/json.js</a>, <a href="json.js.html#line968">line 968</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <h5>Returns:</h5> |
| |
| |
| <div class="param-desc"> |
| Entry instance key. |
| </div> |
| |
| |
| |
| <dl> |
| <dt> |
| Type |
| </dt> |
| <dd> |
| |
| <span class="param-type">string</span> |
| |
| |
| </dd> |
| </dl> |
| |
| |
| |
| |
| </dd> |
| |
| |
| |
| <dt> |
| <h4 class="name" id="jsonIsPrimitiveType"><span class="type-signature"><inner> </span>jsonIsPrimitiveType<span class="signature">(typeName)</span><span class="type-signature"> → {Boolean}</span></h4> |
| |
| |
| </dt> |
| <dd> |
| |
| |
| <div class="description"> |
| Determines whether a type name is a primitive type in a JSON payload. |
| </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>typeName</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">String</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Type name to test.</td> |
| </tr> |
| |
| |
| </tbody> |
| </table> |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-source">Source:</dt> |
| <dd class="tag-source"><ul class="dummy"><li> |
| <a href="json.js.html">odata/json.js</a>, <a href="json.js.html#line996">line 996</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <h5>Returns:</h5> |
| |
| |
| <div class="param-desc"> |
| True if the type name an EDM primitive type or an OData spatial type; false otherwise. |
| </div> |
| |
| |
| |
| <dl> |
| <dt> |
| Type |
| </dt> |
| <dd> |
| |
| <span class="param-type">Boolean</span> |
| |
| |
| </dd> |
| </dl> |
| |
| |
| |
| |
| </dd> |
| |
| |
| |
| <dt> |
| <h4 class="name" id="jsonMakePayloadInfo"><span class="type-signature"><inner> </span>jsonMakePayloadInfo<span class="signature">(kind, type)</span><span class="type-signature"> → {Object}</span></h4> |
| |
| |
| </dt> |
| <dd> |
| |
| |
| <div class="description"> |
| Creates an object containing information for the json payload. |
| </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>kind</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">String</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">JSON payload kind</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>type</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">String</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Type name of the JSON payload.</td> |
| </tr> |
| |
| |
| </tbody> |
| </table> |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-source">Source:</dt> |
| <dd class="tag-source"><ul class="dummy"><li> |
| <a href="json.js.html">odata/json.js</a>, <a href="json.js.html#line262">line 262</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <h5>Returns:</h5> |
| |
| |
| <div class="param-desc"> |
| Object with kind and type fields. |
| </div> |
| |
| |
| |
| <dl> |
| <dt> |
| Type |
| </dt> |
| <dd> |
| |
| <span class="param-type">Object</span> |
| |
| |
| </dd> |
| </dl> |
| |
| |
| |
| |
| </dd> |
| |
| |
| |
| <dt> |
| <h4 class="name" id="jsonParser"><span class="type-signature"><inner> </span>jsonParser<span class="signature">(handler, text, context)</span><span class="type-signature"></span></h4> |
| |
| |
| </dt> |
| <dd> |
| |
| |
| <div class="description"> |
| Extend JSON OData payload with metadata |
| </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>handler</code></td> |
| |
| |
| <td class="type"> |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">This handler.</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>text</code></td> |
| |
| |
| <td class="type"> |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Payload text (this parser also handles pre-parsed objects).</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>context</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Object</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Object with parsing context.</td> |
| </tr> |
| |
| |
| </tbody> |
| </table> |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-source">Source:</dt> |
| <dd class="tag-source"><ul class="dummy"><li> |
| <a href="json.js.html">odata/json.js</a>, <a href="json.js.html#line96">line 96</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <h5>Returns:</h5> |
| |
| |
| <div class="param-desc"> |
| An object representation of the OData payload. |
| </div> |
| |
| |
| |
| |
| |
| |
| </dd> |
| |
| |
| |
| <dt> |
| <h4 class="name" id="jsonSerializer"><span class="type-signature"><inner> </span>jsonSerializer<span class="signature">(handler, data, context)</span><span class="type-signature"> → {String}</span></h4> |
| |
| |
| </dt> |
| <dd> |
| |
| |
| <div class="description"> |
| Serializes a ODataJs payload structure to the wire format which can be send to the server |
| </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>handler</code></td> |
| |
| |
| <td class="type"> |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">This handler.</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>data</code></td> |
| |
| |
| <td class="type"> |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Data to serialize.</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>context</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Object</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Object with serialization context.</td> |
| </tr> |
| |
| |
| </tbody> |
| </table> |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-source">Source:</dt> |
| <dd class="tag-source"><ul class="dummy"><li> |
| <a href="json.js.html">odata/json.js</a>, <a href="json.js.html#line182">line 182</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <h5>Returns:</h5> |
| |
| |
| <div class="param-desc"> |
| The string representation of data. |
| </div> |
| |
| |
| |
| <dl> |
| <dt> |
| Type |
| </dt> |
| <dd> |
| |
| <span class="param-type">String</span> |
| |
| |
| </dd> |
| </dl> |
| |
| |
| |
| |
| </dd> |
| |
| |
| |
| <dt> |
| <h4 class="name" id="minutesToOffset"><span class="type-signature"><inner> </span>minutesToOffset<span class="signature">(minutes)</span><span class="type-signature"> → {String}</span></h4> |
| |
| |
| </dt> |
| <dd> |
| |
| |
| <div class="description"> |
| Formats the given minutes into (+/-)hh:mm format. |
| </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>minutes</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Number</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Number of minutes to format.</td> |
| </tr> |
| |
| |
| </tbody> |
| </table> |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-source">Source:</dt> |
| <dd class="tag-source"><ul class="dummy"><li> |
| <a href="json.js.html">odata/json.js</a>, <a href="json.js.html#line701">line 701</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <h5>Returns:</h5> |
| |
| |
| <div class="param-desc"> |
| The minutes in (+/-)hh:mm format. |
| </div> |
| |
| |
| |
| <dl> |
| <dt> |
| Type |
| </dt> |
| <dd> |
| |
| <span class="param-type">String</span> |
| |
| |
| </dd> |
| </dl> |
| |
| |
| |
| |
| </dd> |
| |
| |
| |
| <dt> |
| <h4 class="name" id="parseContextUriFragment"><span class="type-signature"><inner> </span>parseContextUriFragment<span class="signature">(fragments, model)</span><span class="type-signature"> → {Object}</span></h4> |
| |
| |
| </dt> |
| <dd> |
| |
| |
| <div class="description"> |
| Creates an object containing information for the 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>fragments</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">String</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Uri fragment</td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>model</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">Object</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">Object describing an OData conceptual schema</td> |
| </tr> |
| |
| |
| </tbody> |
| </table> |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-source">Source:</dt> |
| <dd class="tag-source"><ul class="dummy"><li> |
| <a href="json.js.html">odata/json.js</a>, <a href="json.js.html#line753">line 753</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <h5>Returns:</h5> |
| |
| |
| <div class="param-desc"> |
| type(optional) object containing type information for entity- and complex-types ( null if a typeName is a primitive) |
| </div> |
| |
| |
| |
| <dl> |
| <dt> |
| Type |
| </dt> |
| <dd> |
| |
| <span class="param-type">Object</span> |
| |
| |
| </dd> |
| </dl> |
| |
| |
| |
| |
| </dd> |
| |
| |
| |
| <dt> |
| <h4 class="name" id="parseJsonDateString"><span class="type-signature"><inner> </span>parseJsonDateString<span class="signature">(value)</span><span class="type-signature"> → {Date}</span></h4> |
| |
| |
| </dt> |
| <dd> |
| |
| |
| <div class="description"> |
| Parses the JSON Date representation into a Date object. |
| </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>value</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">String</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last">String value.</td> |
| </tr> |
| |
| |
| </tbody> |
| </table> |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-source">Source:</dt> |
| <dd class="tag-source"><ul class="dummy"><li> |
| <a href="json.js.html">odata/json.js</a>, <a href="json.js.html#line721">line 721</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <h5>Returns:</h5> |
| |
| |
| <div class="param-desc"> |
| A Date object if the value matches one; falsy otherwise. |
| </div> |
| |
| |
| |
| <dl> |
| <dt> |
| Type |
| </dt> |
| <dd> |
| |
| <span class="param-type">Date</span> |
| |
| |
| </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> |
