<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: Depot</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: Depot</h1>
<section>
<header>
<h2>
Depot
</h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="Depot"><span class="type-signature"></span>new Depot<span class="signature">(obj)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Initialize a new depot instance.</p>
</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>obj</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>Data from the server, which doesn't follow typical
javaScript naming conventions.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="models_Depot.js.html">models/Depot.js</a>, <a href="models_Depot.js.html#line13">line 13</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="address"><span class="type-signature"></span>address<span class="type-signature"> :string</span></h4>
<div class="description">
<p>If <code>type</code> is 'remote', this is the P4PORT address of the remote server.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="models_Depot.js.html">models/Depot.js</a>, <a href="models_Depot.js.html#line74">line 74</a>
</li></ul></dd>
</dl>
<h4 class="name" id="children"><span class="type-signature"></span>children<span class="type-signature"> :Array.<PathItem></span></h4>
<div class="description">
<p>The immediate directories and files under this depot.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.<PathItem></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="models_Depot.js.html">models/Depot.js</a>, <a href="models_Depot.js.html#line21">line 21</a>
</li></ul></dd>
</dl>
<h4 class="name" id="data"><span class="type-signature">(readonly) </span>data<span class="type-signature"> :object</span></h4>
<div class="description">
<p>The representation of the depot suitable to POST back to the Helix
Web Services Perforce API.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">object</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="models_Depot.js.html">models/Depot.js</a>, <a href="models_Depot.js.html#line168">line 168</a>
</li></ul></dd>
</dl>
<h4 class="name" id="date"><span class="type-signature">(readonly) </span>date<span class="type-signature"> :Date</span></h4>
<div class="description">
<p>The created date of the depot</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Date</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="models_Depot.js.html">models/Depot.js</a>, <a href="models_Depot.js.html#line42">line 42</a>
</li></ul></dd>
</dl>
<h4 class="name" id="depot"><span class="type-signature"></span>depot<span class="type-signature"> :string</span></h4>
<div class="description">
<p>The name of the Depot</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="models_Depot.js.html">models/Depot.js</a>, <a href="models_Depot.js.html#line26">line 26</a>
</li></ul></dd>
</dl>
<h4 class="name" id="description"><span class="type-signature"></span>description<span class="type-signature"> :string</span></h4>
<div class="description">
<p>A short description of the depot's purpose.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="models_Depot.js.html">models/Depot.js</a>, <a href="models_Depot.js.html#line106">line 106</a>
</li></ul></dd>
</dl>
<h4 class="name" id="map"><span class="type-signature"></span>map<span class="type-signature"> :string</span></h4>
<div class="description">
<p>If <code>type</code> is 'local', 'spec', or 'archive', this points to the relative
location of the depot subdirectory.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="models_Depot.js.html">models/Depot.js</a>, <a href="models_Depot.js.html#line89">line 89</a>
</li></ul></dd>
</dl>
<h4 class="name" id="name"><span class="type-signature">(readonly) </span>name<span class="type-signature"> :string</span></h4>
<div class="description">
<p>Used by our underlying Node representation</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="models_Depot.js.html">models/Depot.js</a>, <a href="models_Depot.js.html#line182">line 182</a>
</li></ul></dd>
</dl>
<h4 class="name" id="owner"><span class="type-signature"></span>owner<span class="type-signature"> :string</span></h4>
<div class="description">
<p>The user login that owns the Depot.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="models_Depot.js.html">models/Depot.js</a>, <a href="models_Depot.js.html#line122">line 122</a>
</li></ul></dd>
</dl>
<h4 class="name" id="pathId"><span class="type-signature">(readonly) </span>pathId<span class="type-signature"> :string</span></h4>
<div class="description">
<p>Used by our underlying Node representation</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="models_Depot.js.html">models/Depot.js</a>, <a href="models_Depot.js.html#line195">line 195</a>
</li></ul></dd>
</dl>
<h4 class="name" id="specMap"><span class="type-signature"></span>specMap<span class="type-signature"> :string</span></h4>
<div class="description">
<p>When type is 'spec', this an optional description of what specs should
be saved.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="models_Depot.js.html">models/Depot.js</a>, <a href="models_Depot.js.html#line155">line 155</a>
</li></ul></dd>
</dl>
<h4 class="name" id="suffix"><span class="type-signature"></span>suffix<span class="type-signature"> :string</span></h4>
<div class="description">
<p>If the <code>type</code> is 'spec', this holds an optional suffix for generated
paths to objects in the spec depot.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="models_Depot.js.html">models/Depot.js</a>, <a href="models_Depot.js.html#line138">line 138</a>
</li></ul></dd>
</dl>
<h4 class="name" id="type"><span class="type-signature"></span>type<span class="type-signature"> :string</span></h4>
<div class="description">
<p>The Depot type, one of 'local', 'remote', 'spec', 'stream', 'unload', or
'archive'.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="models_Depot.js.html">models/Depot.js</a>, <a href="models_Depot.js.html#line57">line 57</a>
</li></ul></dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="HelixWebServicesClient.html">HelixWebServicesClient</a></li><li><a href="models.Depot.html">Depot</a></li><li><a href="models.Dir.html">Dir</a></li><li><a href="models.File.html">File</a></li></ul><h3>Mixins</h3><ul><li><a href="Node.html">Node</a></li></ul><h3>Global</h3><ul><li><a href="global.html#addSessionExpiredHandler">addSessionExpiredHandler</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Wed Jun 24 2015 12:48:35 GMT-0700 (PDT)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html> | # | Change | User | Description | Committed | |
|---|---|---|---|---|---|
| #1 | 15741 | ptomiak | Branch HWS for my use. | ||
| //guest/perforce_software/helix-web-services/main/build/doc/helix_web_services_client_js/models.Depot.html | |||||
| #2 | 14151 | tjuricek |
Add depot tree control and selection to the create projects page. Styling and error checking is kept to a minimum for the time being. Our goal is just internal workflow and feedback. |
||
| #1 | 14108 | tjuricek |
Added models for handling Perforce server depot listing and traversal. This is not complete, however, the models are a start to making it easy to generate a tree control. (Most tree controls in the wild assume you know the tree structure from the start, which is not true in our case.) The tricky bit is making it easy to build the tree out given that you're visiting only one directory at a time. |
||