doc/Video.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Class: Video</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">Class: Video</h1>
    
    
<section>
    
<header>
    <h2>
    Video
    </h2>
    
</header>  

<article>
    <div class="container-overview">
    
    
<dt>
    <h4 class="name" id="Video"><span class="type-signature"></span>new Video<span class="signature">()</span><span class="type-signature"></span></h4>
    
    
</dt>
<dd>
    
    
    <div class="description">
        Class describes video-specific fields and request logic
    </div>
    

<dl class="details">
    
        
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="video.js.html">entities/video.js</a>, line 1
    </li></ul></dd>
    
    
</dl>

    
</dd>

    
    </div>
    
    
        <h3 class="subsection-title">Extends</h3>
        
        <ul>
            <li><a href="EntityBase.html">EntityBase</a></li>
        </ul>
    
    
        <h3 class="subsection-title">Methods</h3>
        
        <dl>
            
<dt>
    <h4 class="name" id="add"><span class="type-signature"></span>add<span class="signature">(objectToAdd)</span><span class="type-signature"></span></h4>
    
    
</dt>
<dd>
    
    
    <div class="description">
        Adds object or array to collection.
    </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>objectToAdd</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">Object</span>
|

<span class="param-type">Array</span>


            </td>
            
            
            <td class="description last">Object or array to add to collection.</td>
        </tr>
	
	
	</tbody>
</table>
    
    
<dl class="details">
    
        
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="EntityBase.html#add">EntityBase#add</a>
    </li></dd>
    
    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="collection.js.html">collection.js</a>, line 40
    </li></ul></dd>
    
    
</dl>

    
</dd>

        
<dt>
    <h4 class="name" id="each"><span class="type-signature"></span>each<span class="signature">(functionToApply)</span><span class="type-signature"></span></h4>
    
    
</dt>
<dd>
    
    
    <div class="description">
        Applies function to every element in collection.
    </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>functionToApply</code></td>
            
            
            <td class="type">
            
            </td>
            
            
            <td class="description last">Function to apply to elements.</td>
        </tr>
	
	
	</tbody>
</table>
    
    
<dl class="details">
    
        
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="EntityBase.html#each">EntityBase#each</a>
    </li></dd>
    
    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="collection.js.html">collection.js</a>, line 16
    </li></ul></dd>
    
    
</dl>

    
</dd>

        
<dt>
    <h4 class="name" id="fields"><span class="type-signature"></span>fields<span class="signature">(multipleArgs)</span><span class="type-signature"></span></h4>
    
    
</dt>
<dd>
    
    
    <div class="description">
        Determines list of fields to be retrieved from server. For example by "a.shows(LGI.Guide.channel.id, LGI.Guide.channel.name);"
    </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>multipleArgs</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">string</span>


            </td>
            
            
            <td class="description last">You can add unlimited number of strings as multiple parameters.</td>
        </tr>
	
	
	</tbody>
</table>
    
    
<dl class="details">
    
        
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="EntityBase.html#fields">EntityBase#fields</a>
    </li></dd>
    
    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="entitybase.js.html">entitybase.js</a>, line 30
    </li></ul></dd>
    
    
</dl>

    
</dd>

        
<dt>
    <h4 class="name" id="filter"><span class="type-signature"></span>filter<span class="signature">(multipleArgs)</span><span class="type-signature"></span></h4>
    
    
</dt>
<dd>
    
    
    <div class="description">
        Filters data by some of entity properties. For example "a.filter(LGI.Guide.channel.id.equalTo(1));"
    </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>multipleArgs</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">string</span>


            </td>
            
            
            <td class="description last">You can add unlimited number of strings as multiple parameters.</td>
        </tr>
	
	
	</tbody>
</table>
    
    
<dl class="details">
    
        
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="EntityBase.html#filter">EntityBase#filter</a>
    </li></dd>
    
    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="entitybase.js.html">entitybase.js</a>, line 61
    </li></ul></dd>
    
    
</dl>

    
</dd>

        
<dt>
    <h4 class="name" id="findAll"><span class="type-signature"></span>findAll<span class="signature">(callback)</span><span class="type-signature"></span></h4>
    
    
</dt>
<dd>
    
    
    <div class="description">
        Retrieves all pages of data one by one and then executes callback.
    </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>callback</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">Function</span>


            </td>
            
            
            <td class="description last">Callback to execute and pass response to.</td>
        </tr>
	
	
	</tbody>
</table>
    
    
<dl class="details">
    
        
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="EntityBase.html#findAll">EntityBase#findAll</a>
    </li></dd>
    
    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="entitybase.js.html">entitybase.js</a>, line 96
    </li></ul></dd>
    
    
</dl>

    
</dd>

        
<dt>
    <h4 class="name" id="findNext"><span class="type-signature"></span>findNext<span class="signature">(callback)</span><span class="type-signature"></span></h4>
    
    
</dt>
<dd>
    
    
    <div class="description">
        Retrieves next page of data.
    </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>callback</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">Function</span>


            </td>
            
            
            <td class="description last">Callback to execute and pass response to.</td>
        </tr>
	
	
	</tbody>
</table>
    
    
<dl class="details">
    
        
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="EntityBase.html#findNext">EntityBase#findNext</a>
    </li></dd>
    
    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="entitybase.js.html">entitybase.js</a>, line 86
    </li></ul></dd>
    
    
</dl>

    
</dd>

        
<dt>
    <h4 class="name" id="findOne"><span class="type-signature"></span>findOne<span class="signature">(callback)</span><span class="type-signature"></span></h4>
    
    
</dt>
<dd>
    
    
    <div class="description">
        Retrieves one page of data.
    </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>callback</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">Function</span>


            </td>
            
            
            <td class="description last">Callback to execute and pass response to.</td>
        </tr>
	
	
	</tbody>
</table>
    
    
<dl class="details">
    
        
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="EntityBase.html#findOne">EntityBase#findOne</a>
    </li></dd>
    
    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="entitybase.js.html">entitybase.js</a>, line 75
    </li></ul></dd>
    
    
</dl>

    
</dd>

        
<dt>
    <h4 class="name" id="get"><span class="type-signature"></span>get<span class="signature">(index)</span><span class="type-signature"></span></h4>
    
    
</dt>
<dd>
    
    
    <div class="description">
        Retrieves collection item by index.
    </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>index</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">Number</span>


            </td>
            
            
            <td class="description last">Index of object to retrieve from collection.</td>
        </tr>
	
	
	</tbody>
</table>
    
    
<dl class="details">
    
        
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="EntityBase.html#get">EntityBase#get</a>
    </li></dd>
    
    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="collection.js.html">collection.js</a>, line 53
    </li></ul></dd>
    
    
</dl>

    
</dd>

        
<dt>
    <h4 class="name" id="limit"><span class="type-signature"></span>limit<span class="signature">(limitTo)</span><span class="type-signature"></span></h4>
    
    
</dt>
<dd>
    
    
    <div class="description">
        Adds limitation to response data length. For example "a.limit(10);"
    </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>limitTo</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">number</span>


            </td>
            
            
            <td class="description last">Number of maximum data elements in response.</td>
        </tr>
	
	
	</tbody>
</table>
    
    
<dl class="details">
    
        
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="EntityBase.html#limit">EntityBase#limit</a>
    </li></dd>
    
    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="entitybase.js.html">entitybase.js</a>, line 19
    </li></ul></dd>
    
    
</dl>

    
</dd>

        
<dt>
    <h4 class="name" id="reset"><span class="type-signature"></span>reset<span class="signature">()</span><span class="type-signature"></span></h4>
    
    
</dt>
<dd>
    
    
    <div class="description">
        Resets data.
    </div>
    

<dl class="details">
    
        
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="EntityBase.html#reset">EntityBase#reset</a>
    </li></dd>
    
    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="collection.js.html">collection.js</a>, line 71
    </li></ul></dd>
    
    
</dl>

    
</dd>

        
<dt>
    <h4 class="name" id="sort"><span class="type-signature"></span>sort<span class="signature">(field, <span class="optional">order</span>)</span><span class="type-signature"></span></h4>
    
    
</dt>
<dd>
    
    
    <div class="description">
        Sets sorting field and order. For example "a.sort(LGI.Guide.broadcast.startTime);"
    </div>
    

        <h5>Parameters:</h5>
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		
		<th>Argument</th>
		
		
		<th>Default</th>
		
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr>
            
                <td class="name"><code>field</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">string</span>


            </td>
            
            
                <td class="attributes">
                
                    
                </td>
            
            
                <td class="default">
                
                </td>
            
            
            <td class="description last">Field to sort records by.</td>
        </tr>
	
	
        <tr>
            
                <td class="name"><code>order</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">string</span>


            </td>
            
            
                <td class="attributes">
                
                    &lt;optional><br>
                
                    
                </td>
            
            
                <td class="default">
                
                    "asc"
                
                </td>
            
            
            <td class="description last">Determines order we want to sort records with - ascendant (asc) or descendant (desc).</td>
        </tr>
	
	
	</tbody>
</table>
    
    
<dl class="details">
    
        
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="EntityBase.html#sort">EntityBase#sort</a>
    </li></dd>
    
    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="entitybase.js.html">entitybase.js</a>, line 47
    </li></ul></dd>
    
    
</dl>

    
</dd>

        
<dt>
    <h4 class="name" id="toArray"><span class="type-signature"></span>toArray<span class="signature">()</span><span class="type-signature"></span></h4>
    
    
</dt>
<dd>
    
    
    <div class="description">
        Returns data as array.
    </div>
    

<dl class="details">
    
        
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="EntityBase.html#toArray">EntityBase#toArray</a>
    </li></dd>
    
    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="collection.js.html">collection.js</a>, line 62
    </li></ul></dd>
    
    
</dl>

    
</dd>

        
<dt>
    <h4 class="name" id="where"><span class="type-signature"></span>where<span class="signature">(filter)</span><span class="type-signature"></span></h4>
    
    
</dt>
<dd>
    
    
    <div class="description">
        Returns all records which matches conditionalObject. For example if it is {a: 1} - method will return only objects from collection where 'a' property is present and is equal to 1
    </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>filter</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>
            
            
            <td class="description last">Filter descriptor object.</td>
        </tr>
	
	
	</tbody>
</table>
    
    
<dl class="details">
    
        
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="EntityBase.html#where">EntityBase#where</a>
    </li></dd>
    
    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="collection.js.html">collection.js</a>, line 25
    </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-utils.html">utils</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractField.html">AbstractField</a></li><li><a href="Broadcast.html">Broadcast</a></li><li><a href="Channel.html">Channel</a></li><li><a href="Collection.html">Collection</a></li><li><a href="EntityBase.html">EntityBase</a></li><li><a href="NumericField.html">NumericField</a></li><li><a href="PrependField.html">PrependField</a></li><li><a href="Region.html">Region</a></li><li><a href="Request.html">Request</a></li><li><a href="TextField.html">TextField</a></li><li><a href="Video.html">Video</a></li></ul><h3>Namespaces</h3><ul><li><a href="LGI.Guide.config.html">config</a></li></ul>
</nav>

<br clear="both">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> on Mon Aug 25 2014 16:57:52 GMT+0200 (CEST)
</footer>

<script> prettyPrint(); </script>
</body>
</html>