<!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::Change — 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/Change.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 (C)</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">Change</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::Change </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::Change</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/change.rb</dd> </dl> <div class="clear"></div> <h2>Overview</h2><div class="docstring"> <div class="discussion"> <p>Represents typical changelist descriptions</p> <p>In the future, this may be used to represent changelist specifications, but currently only models output of the GET /v1/changes command.</p> <p>See also: - <a href="http://www.perforce.com/perforce/r14.2/manuals/cmdref/p4_changes.html">www.perforce.com/perforce/r14.2/manuals/cmdref/p4_changes.html</a> - <a href="http://www.perforce.com/perforce/r14.2/manuals/cmdref/p4_change.html">www.perforce.com/perforce/r14.2/manuals/cmdref/p4_change.html</a></p> </div> </div> <div class="tags"> </div><h2>Defined Under Namespace</h2> <p class="children"> <strong class="classes">Classes:</strong> <span class='object_link'><a href="Change/File.html" title="HelixWebServicesClient::Models::Change::File (class)">File</a></span> </p> <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="#change-instance_method" title="#change (instance method)">- (Object) <strong>change</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>A string ID of the change.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#client-instance_method" title="#client (instance method)">- (Object) <strong>client</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>String client ID the changelist is associated with.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#date-instance_method" title="#date (instance method)">- (Object) <strong>date</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>DateTime indicating when the change was created.</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>Textual string description of changelist.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#files-instance_method" title="#files (instance method)">- (Object) <strong>files</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>An array of Change::File models for this changelist, which describe the kinds of edits to the changelist.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#jobs-instance_method" title="#jobs (instance method)">- (Object) <strong>jobs</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>An array of job IDs fixed by this changelist.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#path-instance_method" title="#path (instance method)">- (Object) <strong>path</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>If path information exists, this is a depot path specifier that indicates what files this changelist affects.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#status-instance_method" title="#status (instance method)">- (Object) <strong>status</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>One of :pending, :shelved, :submitted, or :new.</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>One of :restricted or :public.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#user-instance_method" title="#user (instance method)">- (Object) <strong>user</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>Perforce login of the person who owns this changelist (a string).</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)">- (Change) <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 Change.</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::Change (class)">Change</a></span></tt>) <strong>initialize</strong>(obj = {}) </h3><div class="docstring"> <div class="discussion"> <p>Returns a new instance of Change</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/change.rb', line 50</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'>@path</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'>Path</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</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'>Path</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='ivar'>@change</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'>Change</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</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'>Change</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='ivar'>@date</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'>Date</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'>Date</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='ivar'>@client</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'>Client</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</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'>Client</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='ivar'>@user</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'>User</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</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'>User</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='ivar'>@status</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'>Status</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'>Status</span><span class='tstring_end'>'</span></span><span class='rparen'>)</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='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'>Description</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='comment'># Create copies of these arrays. It's unlikely they'll change but it's </span> <span class='comment'># probably not a good idea to just maintain references to the parent </span> <span class='ivar'>@jobs</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'>Jobs</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'>Jobs</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='ivar'>@files</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'>Files</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'>Files</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='ivar'>@files</span> <span class='op'>=</span> <span class='ivar'>@files</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_file'>file</span><span class='op'>|</span> <span class='id identifier rubyid_file'>file</span> <span class='op'>=</span> <span class='const'>Change</span><span class='op'>::</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_file'>file</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_file'>file</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Change</span><span class='op'>::</span><span class='const'>File</span><span class='rparen'>)</span> <span class='id identifier rubyid_file'>file</span> <span class='kw'>end</span> <span class='kw'>if</span> <span class='ivar'>@files</span> <span class='op'>&&</span> <span class='op'>!</span><span class='ivar'>@files</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</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="change=-instance_method"></span> <div class="method_details first"> <h3 class="signature first" id="change-instance_method"> - (<tt>Object</tt>) <strong>change</strong> </h3><div class="docstring"> <div class="discussion"> <p>A string ID of the change</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 22 23 24</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/change.rb', line 22</span> <span class='kw'>def</span> <span class='id identifier rubyid_change'>change</span> <span class='ivar'>@change</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id="client=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="client-instance_method"> - (<tt>Object</tt>) <strong>client</strong> </h3><div class="docstring"> <div class="discussion"> <p>String client ID the changelist is associated with</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 28 29 30</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/change.rb', line 28</span> <span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span> <span class='ivar'>@client</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id="date=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="date-instance_method"> - (<tt>Object</tt>) <strong>date</strong> </h3><div class="docstring"> <div class="discussion"> <p>DateTime indicating when the change was created</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 25 26 27</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/change.rb', line 25</span> <span class='kw'>def</span> <span class='id identifier rubyid_date'>date</span> <span class='ivar'>@date</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>Textual string description of changelist. Must be set for changes who have their <code>status</code> set to :submitted</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 41 42 43</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/change.rb', line 41</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="files=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="files-instance_method"> - (<tt>Object</tt>) <strong>files</strong> </h3><div class="docstring"> <div class="discussion"> <p>An array of Change::File models for this changelist, which describe the kinds of edits to the changelist.</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 48 49 50</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/change.rb', line 48</span> <span class='kw'>def</span> <span class='id identifier rubyid_files'>files</span> <span class='ivar'>@files</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id="jobs=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="jobs-instance_method"> - (<tt>Object</tt>) <strong>jobs</strong> </h3><div class="docstring"> <div class="discussion"> <p>An array of job IDs fixed by this changelist</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/change.rb', line 44</span> <span class='kw'>def</span> <span class='id identifier rubyid_jobs'>jobs</span> <span class='ivar'>@jobs</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id="path=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="path-instance_method"> - (<tt>Object</tt>) <strong>path</strong> </h3><div class="docstring"> <div class="discussion"> <p>If path information exists, this is a depot path specifier that indicates what files this changelist affects. (This is not documented.)</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 19 20 21</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/change.rb', line 19</span> <span class='kw'>def</span> <span class='id identifier rubyid_path'>path</span> <span class='ivar'>@path</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id="status=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="status-instance_method"> - (<tt>Object</tt>) <strong>status</strong> </h3><div class="docstring"> <div class="discussion"> <p>One of :pending, :shelved, :submitted, or :new. Probably :submitted</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/change.rb', line 34</span> <span class='kw'>def</span> <span class='id identifier rubyid_status'>status</span> <span class='ivar'>@status</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>One of :restricted or :public</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/change.rb', line 37</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="user=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="user-instance_method"> - (<tt>Object</tt>) <strong>user</strong> </h3><div class="docstring"> <div class="discussion"> <p>Perforce login of the person who owns this changelist (a string)</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 31 32 33</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/change.rb', line 31</span> <span class='kw'>def</span> <span class='id identifier rubyid_user'>user</span> <span class='ivar'>@user</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"> 77 78 79 80 81 82</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/change.rb', line 77</span> <span class='kw'>def</span> <span class='id identifier rubyid_to_internal_hash'>to_internal_hash</span> <span class='lbrace'>{</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Description</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='id identifier rubyid_description'>description</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Files</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='id identifier rubyid_files'>files</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&</span><span class='symbol'>:to_internal_hash</span><span class='rparen'>)</span> <span class='rbrace'>}</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> </div> </div> <div id="footer"> Generated on Thu Jul 16 12:13:03 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. |