<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title> Class: HelixWebServicesClient::Models::Stream — Documentation by YARD 0.8.7.6 </title> <link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" /> <link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" /> <script type="text/javascript" charset="utf-8"> hasFrames = window.top.frames.main ? true : false; relpath = '../../'; framesUrl = "../../frames.html#!HelixWebServicesClient/Models/Stream.html"; </script> <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script> <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script> </head> <body> <div id="header"> <div id="menu"> <a href="../../_index.html">Index (S)</a> » <span class='title'><span class='object_link'><a href="../../HelixWebServicesClient.html" title="HelixWebServicesClient (class)">HelixWebServicesClient</a></span></span> » <span class='title'><span class='object_link'><a href="../Models.html" title="HelixWebServicesClient::Models (module)">Models</a></span></span> » <span class="title">Stream</span> <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div> </div> <div id="search"> <a class="full_list_link" id="class_list_link" href="../../class_list.html"> Class List </a> <a class="full_list_link" id="method_list_link" href="../../method_list.html"> Method List </a> <a class="full_list_link" id="file_list_link" href="../../file_list.html"> File List </a> </div> <div class="clear"></div> </div> <iframe id="search_frame"></iframe> <div id="content"><h1>Class: HelixWebServicesClient::Models::Stream </h1> <dl class="box"> <dt class="r1">Inherits:</dt> <dd class="r1"> <span class="inheritName">Object</span> <ul class="fullTree"> <li>Object</li> <li class="next">HelixWebServicesClient::Models::Stream</li> </ul> <a href="#" class="inheritanceTree">show all</a> </dd> <dt class="r2 last">Defined in:</dt> <dd class="r2 last">lib/helix_web_services_client/models/stream.rb</dd> </dl> <div class="clear"></div> <h2>Overview</h2><div class="docstring"> <div class="discussion"> <p>Model of stream specifications in the Perforce server.</p> <p>See also: - <a href="http://www.perforce.com/perforce/doc.current/manuals/cmdref/p4_stream.html">www.perforce.com/perforce/doc.current/manuals/cmdref/p4_stream.html</a> - <a href="http://www.perforce.com/perforce/doc.current/manuals/cmdref/p4_streams.html">www.perforce.com/perforce/doc.current/manuals/cmdref/p4_streams.html</a></p> </div> </div> <div class="tags"> </div> <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2> <ul class="summary"> <li class="public "> <span class="summary_signature"> <a href="#access-instance_method" title="#access (instance method)">- (Object) <strong>access</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>DateTime the stream was last accessed by any p4 command.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#description-instance_method" title="#description (instance method)">- (Object) <strong>description</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>Description of the stream.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#ignored-instance_method" title="#ignored (instance method)">- (Object) <strong>ignored</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>An array of path specifications that should be ignored in client views.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#name-instance_method" title="#name (instance method)">- (Object) <strong>name</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>Display name for the stream.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#options-instance_method" title="#options (instance method)">- (Object) <strong>options</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>Settings that configure stream behavior.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#owner-instance_method" title="#owner (instance method)">- (Object) <strong>owner</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>Perforce user or group that owns the stream.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#parent-instance_method" title="#parent (instance method)">- (Object) <strong>parent</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>The stream parent, or :none if the <code>type</code> is :mainline.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#paths-instance_method" title="#paths (instance method)">- (Object) <strong>paths</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>Array of path definitions.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#remapped-instance_method" title="#remapped (instance method)">- (Object) <strong>remapped</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>Array of remap definitions.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#stream-instance_method" title="#stream (instance method)">- (Object) <strong>stream</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>The stream name, which is also it's depot path, in the form //[depot name]/[stream name].</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#type-instance_method" title="#type (instance method)">- (Object) <strong>type</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>The stream's type determines the expected flow of change.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#update-instance_method" title="#update (instance method)">- (Object) <strong>update</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>DateTime the spec was last modified.</p> </div></span> </li> </ul> <h2> Instance Method Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small> </h2> <ul class="summary"> <li class="public "> <span class="summary_signature"> <a href="#initialize-instance_method" title="#initialize (instance method)">- (Stream) <strong>initialize</strong>(obj = {}) </a> </span> <span class="note title constructor">constructor</span> <span class="summary_desc"><div class='inline'> <p>A new instance of Stream.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#to_internal_hash-instance_method" title="#to_internal_hash (instance method)">- (Object) <strong>to_internal_hash</strong> </a> </span> <span class="summary_desc"><div class='inline'></div></span> </li> </ul> <div id="constructor_details" class="method_details_list"> <h2>Constructor Details</h2> <div class="method_details first"> <h3 class="signature first" id="initialize-instance_method"> - (<tt><span class='object_link'><a href="" title="HelixWebServicesClient::Models::Stream (class)">Stream</a></span></tt>) <strong>initialize</strong>(obj = {}) </h3><div class="docstring"> <div class="discussion"> <p>Returns a new instance of Stream</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/stream.rb', line 72</span> <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_obj'>obj</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> <span class='ivar'>@stream</span> <span class='op'>=</span> <span class='id identifier rubyid_obj'>obj</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Stream</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='ivar'>@update</span> <span class='op'>=</span> <span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_at'>at</span><span class='lparen'>(</span><span class='id identifier rubyid_obj'>obj</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Update</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_datetime'>to_datetime</span> <span class='kw'>if</span> <span class='id identifier rubyid_obj'>obj</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Update</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='ivar'>@access</span> <span class='op'>=</span> <span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_at'>at</span><span class='lparen'>(</span><span class='id identifier rubyid_obj'>obj</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Access</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_datetime'>to_datetime</span> <span class='kw'>if</span> <span class='id identifier rubyid_obj'>obj</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Access</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='ivar'>@owner</span> <span class='op'>=</span> <span class='id identifier rubyid_obj'>obj</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Owner</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='ivar'>@name</span> <span class='op'>=</span> <span class='id identifier rubyid_obj'>obj</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Name</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='ivar'>@parent</span> <span class='op'>=</span> <span class='id identifier rubyid_obj'>obj</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Parent</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='ivar'>@type</span> <span class='op'>=</span> <span class='id identifier rubyid_obj'>obj</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Type</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span> <span class='kw'>if</span> <span class='id identifier rubyid_obj'>obj</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Type</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='ivar'>@description</span> <span class='op'>=</span> <span class='id identifier rubyid_obj'>obj</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Description</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='ivar'>@options</span> <span class='op'>=</span> <span class='id identifier rubyid_obj'>obj</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Options</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='ivar'>@paths</span> <span class='op'>=</span> <span class='id identifier rubyid_obj'>obj</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Paths</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&</span><span class='symbol'>:clone</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_obj'>obj</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Paths</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='ivar'>@remapped</span> <span class='op'>=</span> <span class='id identifier rubyid_obj'>obj</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Remapped</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&</span><span class='symbol'>:clone</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_obj'>obj</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Remapped</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='ivar'>@ignored</span> <span class='op'>=</span> <span class='id identifier rubyid_obj'>obj</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Ignored</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&</span><span class='symbol'>:clone</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_obj'>obj</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Ignored</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='comment'># If the user has defined symbols in the Ruby-ish API, then use that </span> <span class='comment'># too, but we expect the data to be in the right format. </span> <span class='id identifier rubyid_obj'>obj</span><span class='period'>.</span><span class='id identifier rubyid_each_key'>each_key</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='op'>|</span> <span class='id identifier rubyid_accessor'>accessor</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_key'>key</span><span class='embexpr_end'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span> <span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='id identifier rubyid_accessor'>accessor</span><span class='comma'>,</span> <span class='id identifier rubyid_obj'>obj</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='id identifier rubyid_accessor'>accessor</span><span class='rparen'>)</span> <span class='kw'>end</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> </div> <div id="instance_attr_details" class="attr_details"> <h2>Instance Attribute Details</h2> <span id="access=-instance_method"></span> <div class="method_details first"> <h3 class="signature first" id="access-instance_method"> - (<tt>Object</tt>) <strong>access</strong> </h3><div class="docstring"> <div class="discussion"> <p>DateTime the stream was last accessed by any p4 command.</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 21 22 23</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/stream.rb', line 21</span> <span class='kw'>def</span> <span class='id identifier rubyid_access'>access</span> <span class='ivar'>@access</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id="description=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="description-instance_method"> - (<tt>Object</tt>) <strong>description</strong> </h3><div class="docstring"> <div class="discussion"> <p>Description of the stream</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 37 38 39</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/stream.rb', line 37</span> <span class='kw'>def</span> <span class='id identifier rubyid_description'>description</span> <span class='ivar'>@description</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id="ignored=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="ignored-instance_method"> - (<tt>Object</tt>) <strong>ignored</strong> </h3><div class="docstring"> <div class="discussion"> <p>An array of path specifications that should be ignored in client views.</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 70 71 72</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/stream.rb', line 70</span> <span class='kw'>def</span> <span class='id identifier rubyid_ignored'>ignored</span> <span class='ivar'>@ignored</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id="name=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="name-instance_method"> - (<tt>Object</tt>) <strong>name</strong> </h3><div class="docstring"> <div class="discussion"> <p>Display name for the stream. This is modifiable.</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 27 28 29</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/stream.rb', line 27</span> <span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span> <span class='ivar'>@name</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id="options=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="options-instance_method"> - (<tt>Object</tt>) <strong>options</strong> </h3><div class="docstring"> <div class="discussion"> <p>Settings that configure stream behavior. This is a single string with different values, e.g. “locked all toparent fromparent”:</p> <p>See also: - <a href="http://www.perforce.com/perforce/doc.current/manuals/cmdref/p4_stream.html">www.perforce.com/perforce/doc.current/manuals/cmdref/p4_stream.html</a></p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 44 45 46</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/stream.rb', line 44</span> <span class='kw'>def</span> <span class='id identifier rubyid_options'>options</span> <span class='ivar'>@options</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id="owner=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="owner-instance_method"> - (<tt>Object</tt>) <strong>owner</strong> </h3><div class="docstring"> <div class="discussion"> <p>Perforce user or group that owns the stream.</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 24 25 26</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/stream.rb', line 24</span> <span class='kw'>def</span> <span class='id identifier rubyid_owner'>owner</span> <span class='ivar'>@owner</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id="parent=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="parent-instance_method"> - (<tt>Object</tt>) <strong>parent</strong> </h3><div class="docstring"> <div class="discussion"> <p>The stream parent, or :none if the <code>type</code> is :mainline</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 30 31 32</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/stream.rb', line 30</span> <span class='kw'>def</span> <span class='id identifier rubyid_parent'>parent</span> <span class='ivar'>@parent</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id="paths=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="paths-instance_method"> - (<tt>Object</tt>) <strong>paths</strong> </h3><div class="docstring"> <div class="discussion"> <p>Array of path definitions.</p> <p>Paths define how files are incorporated into the stream structure. Specify paths using the following format:</p> <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_path_type'>path_type</span> <span class='id identifier rubyid_view_path'>view_path</span> <span class='lbracket'>[</span><span class='id identifier rubyid_depot_path'>depot_path</span><span class='rbracket'>]</span> </code></pre> <p>where path_type is a single keyword, view_path is a file path with no leading slashes, and the optional depot_path is a file path beginning with //.</p> <p>Default: <code>share ...</code></p> <p>See also: - <a href="http://www.perforce.com/perforce/doc.current/manuals/cmdref/p4_stream.html">www.perforce.com/perforce/doc.current/manuals/cmdref/p4_stream.html</a></p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 61 62 63</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/stream.rb', line 61</span> <span class='kw'>def</span> <span class='id identifier rubyid_paths'>paths</span> <span class='ivar'>@paths</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id="remapped=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="remapped-instance_method"> - (<tt>Object</tt>) <strong>remapped</strong> </h3><div class="docstring"> <div class="discussion"> <p>Array of remap definitions.</p> <p>See also: - <a href="http://www.perforce.com/perforce/doc.current/manuals/cmdref/p4_stream.html">www.perforce.com/perforce/doc.current/manuals/cmdref/p4_stream.html</a></p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 67 68 69</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/stream.rb', line 67</span> <span class='kw'>def</span> <span class='id identifier rubyid_remapped'>remapped</span> <span class='ivar'>@remapped</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id="stream=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="stream-instance_method"> - (<tt>Object</tt>) <strong>stream</strong> </h3><div class="docstring"> <div class="discussion"> <p>The stream name, which is also it's depot path, in the form //[depot name]/[stream name].</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 15 16 17</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/stream.rb', line 15</span> <span class='kw'>def</span> <span class='id identifier rubyid_stream'>stream</span> <span class='ivar'>@stream</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id="type=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="type-instance_method"> - (<tt>Object</tt>) <strong>type</strong> </h3><div class="docstring"> <div class="discussion"> <p>The stream's type determines the expected flow of change. Valid stream types are :mainline, :virtual, :development, and :release.</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 34 35 36</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/stream.rb', line 34</span> <span class='kw'>def</span> <span class='id identifier rubyid_type'>type</span> <span class='ivar'>@type</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id="update=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="update-instance_method"> - (<tt>Object</tt>) <strong>update</strong> </h3><div class="docstring"> <div class="discussion"> <p>DateTime the spec was last modified.</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 18 19 20</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/stream.rb', line 18</span> <span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span> <span class='ivar'>@update</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> </div> <div id="instance_method_details" class="method_details_list"> <h2>Instance Method Details</h2> <div class="method_details first"> <h3 class="signature first" id="to_internal_hash-instance_method"> - (<tt>Object</tt>) <strong>to_internal_hash</strong> </h3><table class="source_code"> <tr> <td> <pre class="lines"> 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/stream.rb', line 94</span> <span class='kw'>def</span> <span class='id identifier rubyid_to_internal_hash'>to_internal_hash</span> <span class='id identifier rubyid_hash'>hash</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>Stream:</span> <span class='ivar'>@stream</span> <span class='rbrace'>}</span> <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:Owner</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@owner</span> <span class='kw'>if</span> <span class='ivar'>@owner</span> <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:Name</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@name</span> <span class='kw'>if</span> <span class='ivar'>@name</span> <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:Parent</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@parent</span> <span class='kw'>if</span> <span class='ivar'>@parent</span> <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:Type</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@type</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='kw'>if</span> <span class='ivar'>@type</span> <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:Description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@description</span> <span class='kw'>if</span> <span class='ivar'>@description</span> <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:Options</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@options</span> <span class='kw'>if</span> <span class='ivar'>@options</span> <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:Paths</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@paths</span> <span class='kw'>if</span> <span class='ivar'>@paths</span> <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:Remapped</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@remapped</span> <span class='kw'>if</span> <span class='ivar'>@remapped</span> <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:Ignored</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@ignored</span> <span class='kw'>if</span> <span class='ivar'>@ignored</span> <span class='id identifier rubyid_hash'>hash</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> </div> </div> <div id="footer"> Generated on Wed Jul 15 15:50:09 2015 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.8.7.6 (ruby-2.2.1). </div> </body> </html>
# | Change | User | Description | Committed | |
---|---|---|---|---|---|
#6 | 15676 | tjuricek | HWS/NOARCH/2015.1.main/201509092205 | ||
#5 | 15073 | tjuricek | Update Auth::Middleware and add spec | ||
#4 | 15053 | tjuricek |
Revise the client API to use the new login method. The current specs will need to be revised since data normalization is moving out of the server and into the client. |
||
#3 | 15038 | tjuricek | Document 'login' auth method and client programming overview. | ||
#2 | 15032 | tjuricek |
Starting config and doc revisions. System is now broken while revisions underway. Configuration of the p4d connection is now done via a single HWSSettings middleware object injected into the Rack env. The HWSP4Cleanup middleware now cleans up any p4 injected into the Rack env. The Auth::App class now mostly just contains one method to generate a p4 ticket. /auth/v1/login. Added yard documentation for the main project. Yard docs have been reconfigured to dump into build/ directories. This should probably be done with each release. Hm... The top level rake file contains a task, 'all:doc', to update our documentation. This should probably be run for each checkin. Hm... Specs are now using Rack::Test on top of a 'live' p4d. I'd suggest you still use the p4util mechanism, which now dumps to a /tmp folder, so we can safely add P4IGNORE rules back into your local .p4config file. Old 'perforce' application now called 'helix_versioning_engine'. Removing cache data. Helix Sync may be slow. It may also get axed. We'll see. |
||
#1 | 14049 | tjuricek |
Add methods to generate client workspaces for a user. The Qt SDK was updated based on immediate need. Also, add Ruby client SDK documentation to the docs site. Everything is early, but there's *some* reference available at least. |