<!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::Client — 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/Client.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">Client</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::Client </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::Client</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/client.rb</dd> </dl> <div class="clear"></div> <h2>Overview</h2><div class="docstring"> <div class="discussion"> <p>Models the client spec used to define client workspaces in the Perforce system.</p> <p>See also: - <a href="http://www.perforce.com/perforce/r14.2/manuals/cmdref/p4_client.html">www.perforce.com/perforce/r14.2/manuals/cmdref/p4_client.html</a> - <a href="http://www.perforce.com/perforce/r14.2/manuals/cmdref/p4_clients.html">www.perforce.com/perforce/r14.2/manuals/cmdref/p4_clients.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 when the workspace was last used.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#alt_roots-instance_method" title="#alt_roots (instance method)">- (Object) <strong>alt_roots</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>Up to two alternate cleint workspace roots.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#change_view-instance_method" title="#change_view (instance method)">- (Object) <strong>change_view</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>Restricts access to depot paths to a particular point in time.</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>The client workspace name and primary ID.</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 description of the workspace.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#host-instance_method" title="#host (instance method)">- (Object) <strong>host</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>The name of the workstation this workspace resides.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#line_end-instance_method" title="#line_end (instance method)">- (Object) <strong>line_end</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>Configure CR/LF conversion.</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>A single string defining a set of switches the change behavior of different commands on the client.</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 login of the user who owns the workspace.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#root-instance_method" title="#root (instance method)">- (Object) <strong>root</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>Directory (on the local host) relative to which all files in the <code>view</code> are specified.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#server_id-instance_method" title="#server_id (instance method)">- (Object) <strong>server_id</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>If set, restricts the usage of the workspace to the named server.</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>Associates the workspace with the specified stream.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#stream_at_change-instance_method" title="#stream_at_change (instance method)">- (Object) <strong>stream_at_change</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>A changelist number that sets a back-in-time view of a stream.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#submit_options-instance_method" title="#submit_options (instance method)">- (Object) <strong>submit_options</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>A single string that governs default behavior of p4 submit on this client.</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 when the workspace was last modified.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#view-instance_method" title="#view (instance method)">- (Object) <strong>view</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>Array of strings that specifies the mappings between files in the depot and files in the workspace.</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)">- (Client) <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 Client.</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::Client (class)">Client</a></span></tt>) <strong>initialize</strong>(obj = {}) </h3><div class="docstring"> <div class="discussion"> <p>Returns a new instance of Client</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/client.rb', line 82</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'>@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'>@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='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'>Owner</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'>@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'>@host</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'>Host</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'>Host</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='ivar'>@root</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'>Root</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'>Root</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='ivar'>@alt_roots</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'>AltRoots</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'>AltRoots</span><span class='tstring_end'>'</span></span><span class='rparen'>)</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='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'>Options</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='ivar'>@submit_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'>SubmitOptions</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'>SubmitOptions</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='ivar'>@line_end</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'>LineEnd</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'>LineEnd</span><span class='tstring_end'>'</span></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='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'>Stream</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='ivar'>@stream_at_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'>StreamAtChange</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'>StreamAtChange</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='ivar'>@server_id</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'>ServerID</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'>ServerID</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='ivar'>@view</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'>View</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'>View</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='ivar'>@change_view</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'>ChangeView</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'>ChangeView</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 when the workspace was last used</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/client.rb', line 24</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="alt_roots=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="alt_roots-instance_method"> - (<tt>Object</tt>) <strong>alt_roots</strong> </h3><div class="docstring"> <div class="discussion"> <p>Up to two alternate cleint workspace roots</p> <p>This enables users to use the same Perforce client on multiple platforms</p> <p>See the command reference for more details: - <a href="http://www.perforce.com/perforce/r14.2/manuals/cmdref/p4_client.html">www.perforce.com/perforce/r14.2/manuals/cmdref/p4_client.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/client.rb', line 44</span> <span class='kw'>def</span> <span class='id identifier rubyid_alt_roots'>alt_roots</span> <span class='ivar'>@alt_roots</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id="change_view=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="change_view-instance_method"> - (<tt>Object</tt>) <strong>change_view</strong> </h3><div class="docstring"> <div class="discussion"> <p>Restricts access to depot paths to a particular point in time.</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 80 81 82</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/client.rb', line 80</span> <span class='kw'>def</span> <span class='id identifier rubyid_change_view'>change_view</span> <span class='ivar'>@change_view</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>The client workspace name and primary ID</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/client.rb', line 15</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="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 description of the workspace</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/client.rb', line 31</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="host=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="host-instance_method"> - (<tt>Object</tt>) <strong>host</strong> </h3><div class="docstring"> <div class="discussion"> <p>The name of the workstation this workspace resides. If set, client operations can <em>only</em> be run from this host.</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/client.rb', line 28</span> <span class='kw'>def</span> <span class='id identifier rubyid_host'>host</span> <span class='ivar'>@host</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id="line_end=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="line_end-instance_method"> - (<tt>Object</tt>) <strong>line_end</strong> </h3><div class="docstring"> <div class="discussion"> <p>Configure CR/LF conversion</p> <p>See the command reference for more details: - <a href="http://www.perforce.com/perforce/r14.2/manuals/cmdref/p4_client.html">www.perforce.com/perforce/r14.2/manuals/cmdref/p4_client.html</a></p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 64 65 66</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/client.rb', line 64</span> <span class='kw'>def</span> <span class='id identifier rubyid_line_end'>line_end</span> <span class='ivar'>@line_end</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>A single string defining a set of switches the change behavior of different commands on the client.</p> <p>See the command reference for more details: - <a href="http://www.perforce.com/perforce/r14.2/manuals/cmdref/p4_client.html">www.perforce.com/perforce/r14.2/manuals/cmdref/p4_client.html</a></p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 51 52 53</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/client.rb', line 51</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 login of the user who owns the workspace</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/client.rb', line 18</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="root=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="root-instance_method"> - (<tt>Object</tt>) <strong>root</strong> </h3><div class="docstring"> <div class="discussion"> <p>Directory (on the local host) relative to which all files in the <code>view</code> are specified. If you change this setting, you must 'physically' relocate any files that currently reside there.</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 36 37 38</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/client.rb', line 36</span> <span class='kw'>def</span> <span class='id identifier rubyid_root'>root</span> <span class='ivar'>@root</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id="server_id=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="server_id-instance_method"> - (<tt>Object</tt>) <strong>server_id</strong> </h3><div class="docstring"> <div class="discussion"> <p>If set, restricts the usage of the workspace to the named server.</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 73 74 75</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/client.rb', line 73</span> <span class='kw'>def</span> <span class='id identifier rubyid_server_id'>server_id</span> <span class='ivar'>@server_id</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>Associates the workspace with the specified stream.</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/client.rb', line 67</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="stream_at_change=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="stream_at_change-instance_method"> - (<tt>Object</tt>) <strong>stream_at_change</strong> </h3><div class="docstring"> <div class="discussion"> <p>A changelist number that sets a back-in-time view of a stream.</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/client.rb', line 70</span> <span class='kw'>def</span> <span class='id identifier rubyid_stream_at_change'>stream_at_change</span> <span class='ivar'>@stream_at_change</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id="submit_options=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="submit_options-instance_method"> - (<tt>Object</tt>) <strong>submit_options</strong> </h3><div class="docstring"> <div class="discussion"> <p>A single string that governs default behavior of p4 submit on this client.</p> <p>See the command reference for more details: - <a href="http://www.perforce.com/perforce/r14.2/manuals/cmdref/p4_client.html">www.perforce.com/perforce/r14.2/manuals/cmdref/p4_client.html</a></p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 58 59 60</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/client.rb', line 58</span> <span class='kw'>def</span> <span class='id identifier rubyid_submit_options'>submit_options</span> <span class='ivar'>@submit_options</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 when the workspace was last modified</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/client.rb', line 21</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> <span id="view=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="view-instance_method"> - (<tt>Object</tt>) <strong>view</strong> </h3><div class="docstring"> <div class="discussion"> <p>Array of strings that specifies the mappings between files in the depot and files in the workspace.</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 77 78 79</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/client.rb', line 77</span> <span class='kw'>def</span> <span class='id identifier rubyid_view'>view</span> <span class='ivar'>@view</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"> 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/client.rb', line 108</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'>Client:</span> <span class='ivar'>@client</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'>:Host</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@host</span> <span class='kw'>if</span> <span class='ivar'>@host</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'>:Root</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@root</span> <span class='kw'>if</span> <span class='ivar'>@root</span> <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:AltRoots</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@alt_roots</span> <span class='kw'>if</span> <span class='ivar'>@alt_roots</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'>:SubmitOptions</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@submit_options</span> <span class='kw'>if</span> <span class='ivar'>@submit_options</span> <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:LineEnd</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@line_end</span> <span class='kw'>if</span> <span class='ivar'>@line_end</span> <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:Stream</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@stream</span> <span class='kw'>if</span> <span class='ivar'>@stream</span> <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:StreamAtChange</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@stream_at_change</span> <span class='kw'>if</span> <span class='ivar'>@stream_at_change</span> <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:ServerID</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@server_id</span> <span class='kw'>if</span> <span class='ivar'>@server_id</span> <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:View</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@view</span> <span class='kw'>if</span> <span class='ivar'>@view</span> <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:ChangeView</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@change_view</span> <span class='kw'>if</span> <span class='ivar'>@change_view</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. |