<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: Dir</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: Dir</h1>
<section>
<header>
<h2>
Dir
</h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="Dir"><span class="type-signature"></span>new Dir<span class="signature">(obj)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Creates a new Dir reference, based on output from the <code>p4 dirs</code> command.</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>Initialize the instance with data from the server (typical)</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_Dir.js.html">models/Dir.js</a>, <a href="models_Dir.js.html#line12">line 12</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<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 directory.</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_Dir.js.html">models/Dir.js</a>, <a href="models_Dir.js.html#line20">line 20</a>
</li></ul></dd>
</dl>
<h4 class="name" id="dir"><span class="type-signature">(readonly) </span>dir<span class="type-signature"> :string</span></h4>
<div class="description">
<p>The directory path in the 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_Dir.js.html">models/Dir.js</a>, <a href="models_Dir.js.html#line25">line 25</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>For consistency with Node operations</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_Dir.js.html">models/Dir.js</a>, <a href="models_Dir.js.html#line38">line 38</a>
</li></ul></dd>
</dl>
<h4 class="name" id="pathId"><span class="type-signature">(readonly) </span>pathId<span class="type-signature"> :Array.<string></span></h4>
<div class="description">
<p>For consistency with Node operations</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.<string></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="models_Dir.js.html">models/Dir.js</a>, <a href="models_Dir.js.html#line51">line 51</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:36 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.Dir.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. |
||