<!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::Group — 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/Group.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 (G)</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">Group</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::Group </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::Group</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/group.rb</dd> </dl> <div class="clear"></div> <h2>Overview</h2><div class="docstring"> <div class="discussion"> <p>Models the output of the group spec.</p> <p>See also: - <a href="http://www.perforce.com/perforce/r14.2/manuals/cmdref/p4_group.html">www.perforce.com/perforce/r14.2/manuals/cmdref/p4_group.html</a> - <a href="http://www.perforce.com/perforce/r14.2/manuals/cmdref/p4_groups.html">www.perforce.com/perforce/r14.2/manuals/cmdref/p4_groups.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="#group-instance_method" title="#group (instance method)">- (Object) <strong>group</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>The name and primary ID of the group.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#max_lock_time-instance_method" title="#max_lock_time (instance method)">- (Object) <strong>max_lock_time</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>The maximum length of time (in milliseconds) that any one operation can lock any database table when scanning data.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#max_results-instance_method" title="#max_results (instance method)">- (Object) <strong>max_results</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>The maximum number of results that members of this group can acccess from the service from a single command.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#max_scan_rows-instance_method" title="#max_scan_rows (instance method)">- (Object) <strong>max_scan_rows</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>The maximum number of rows that members of this group can scan from the service from a single command.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#owners-instance_method" title="#owners (instance method)">- (Object) <strong>owners</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>Array of names of other Perforce users, that are allowed to admin this group.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#password_timeout-instance_method" title="#password_timeout (instance method)">- (Object) <strong>password_timeout</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>The length of time (in seconds) for which passwords for users in this group remain valid.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#subgroups-instance_method" title="#subgroups (instance method)">- (Object) <strong>subgroups</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>Array of names of other Perforce groups.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#timeout-instance_method" title="#timeout (instance method)">- (Object) <strong>timeout</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>The duration (in sections) of the validity of a session ticket created by.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#users-instance_method" title="#users (instance method)">- (Object) <strong>users</strong> </a> </span> <span class="summary_desc"><div class='inline'> <p>An array of the Perforce usernames of the group members.</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)">- (Group) <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 Group.</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::Group (class)">Group</a></span></tt>) <strong>initialize</strong>(obj = {}) </h3><div class="docstring"> <div class="discussion"> <p>Returns a new instance of Group</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 46 47 48 49 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 76 77 78 79 80 81 82</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/group.rb', line 46</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'>@group</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'>Group</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'>Group</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='ivar'>@max_results</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'>MaxResults</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</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'>MaxResults</span><span class='tstring_end'>'</span></span><span class='rparen'>)</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'>MaxResults</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='op'>!=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>unset</span><span class='tstring_end'>'</span></span> <span class='ivar'>@max_results</span> <span class='op'>=</span> <span class='kw'>nil</span> <span class='kw'>if</span> <span class='ivar'>@max_results</span> <span class='op'>==</span> <span class='int'>0</span> <span class='ivar'>@max_scan_rows</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'>MaxScanRows</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</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'>MaxScanRows</span><span class='tstring_end'>'</span></span><span class='rparen'>)</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'>MaxScanRows</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='op'>!=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>unset</span><span class='tstring_end'>'</span></span> <span class='ivar'>@max_scan_rows</span> <span class='op'>=</span> <span class='kw'>nil</span> <span class='kw'>if</span> <span class='ivar'>@max_scan_rows</span> <span class='op'>==</span> <span class='int'>0</span> <span class='ivar'>@max_lock_time</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'>MaxLockTime</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</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'>MaxLockTime</span><span class='tstring_end'>'</span></span><span class='rparen'>)</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'>MaxLockTime</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='op'>!=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>unset</span><span class='tstring_end'>'</span></span> <span class='ivar'>@max_lock_time</span> <span class='op'>=</span> <span class='kw'>nil</span> <span class='kw'>if</span> <span class='ivar'>@max_lock_time</span> <span class='op'>==</span> <span class='int'>0</span> <span class='ivar'>@timeout</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'>Timeout</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</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'>Timeout</span><span class='tstring_end'>'</span></span><span class='rparen'>)</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'>Timeout</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='op'>!=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>unset</span><span class='tstring_end'>'</span></span> <span class='ivar'>@timeout</span> <span class='op'>=</span> <span class='kw'>nil</span> <span class='kw'>if</span> <span class='ivar'>@timeout</span> <span class='op'>==</span> <span class='int'>0</span> <span class='ivar'>@password_timeout</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'>PasswordTimeout</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</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'>PasswordTimeout</span><span class='tstring_end'>'</span></span><span class='rparen'>)</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'>PasswordTimeout</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='op'>!=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>unset</span><span class='tstring_end'>'</span></span> <span class='ivar'>@password_timeout</span> <span class='op'>=</span> <span class='kw'>nil</span> <span class='kw'>if</span> <span class='ivar'>@password_timeout</span> <span class='op'>==</span> <span class='int'>0</span> <span class='ivar'>@users</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'>Users</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'>Users</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='ivar'>@users</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span> <span class='kw'>unless</span> <span class='ivar'>@users</span> <span class='ivar'>@subgroups</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'>Subgroups</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'>Subgroups</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='ivar'>@subgroups</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span> <span class='kw'>unless</span> <span class='ivar'>@subgroups</span> <span class='ivar'>@owners</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'>Owners</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'>Owners</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='ivar'>@owners</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span> <span class='kw'>unless</span> <span class='ivar'>@owners</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="group=-instance_method"></span> <div class="method_details first"> <h3 class="signature first" id="group-instance_method"> - (<tt>Object</tt>) <strong>group</strong> </h3><div class="docstring"> <div class="discussion"> <p>The name and primary ID of the group</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 12 13 14</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/group.rb', line 12</span> <span class='kw'>def</span> <span class='id identifier rubyid_group'>group</span> <span class='ivar'>@group</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id="max_lock_time=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="max_lock_time-instance_method"> - (<tt>Object</tt>) <strong>max_lock_time</strong> </h3><div class="docstring"> <div class="discussion"> <p>The maximum length of time (in milliseconds) that any one operation can lock any database table when scanning data.</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/group.rb', line 24</span> <span class='kw'>def</span> <span class='id identifier rubyid_max_lock_time'>max_lock_time</span> <span class='ivar'>@max_lock_time</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id="max_results=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="max_results-instance_method"> - (<tt>Object</tt>) <strong>max_results</strong> </h3><div class="docstring"> <div class="discussion"> <p>The maximum number of results that members of this group can acccess from the service from a single command</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 16 17 18</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/group.rb', line 16</span> <span class='kw'>def</span> <span class='id identifier rubyid_max_results'>max_results</span> <span class='ivar'>@max_results</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id="max_scan_rows=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="max_scan_rows-instance_method"> - (<tt>Object</tt>) <strong>max_scan_rows</strong> </h3><div class="docstring"> <div class="discussion"> <p>The maximum number of rows that members of this group can scan from the service from a single command.</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 20 21 22</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/group.rb', line 20</span> <span class='kw'>def</span> <span class='id identifier rubyid_max_scan_rows'>max_scan_rows</span> <span class='ivar'>@max_scan_rows</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id="owners=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="owners-instance_method"> - (<tt>Object</tt>) <strong>owners</strong> </h3><div class="docstring"> <div class="discussion"> <p>Array of names of other Perforce users, that are allowed to admin this group. This is independent of group membership. A group owner should also be a part of the users group if they are intended to take part in the group</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/group.rb', line 44</span> <span class='kw'>def</span> <span class='id identifier rubyid_owners'>owners</span> <span class='ivar'>@owners</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id="password_timeout=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="password_timeout-instance_method"> - (<tt>Object</tt>) <strong>password_timeout</strong> </h3><div class="docstring"> <div class="discussion"> <p>The length of time (in seconds) for which passwords for users in this group remain valid. To disable password aging, use a value of unset.</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 32 33 34</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/group.rb', line 32</span> <span class='kw'>def</span> <span class='id identifier rubyid_password_timeout'>password_timeout</span> <span class='ivar'>@password_timeout</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id="subgroups=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="subgroups-instance_method"> - (<tt>Object</tt>) <strong>subgroups</strong> </h3><div class="docstring"> <div class="discussion"> <p>Array of names of other Perforce groups</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 38 39 40</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/group.rb', line 38</span> <span class='kw'>def</span> <span class='id identifier rubyid_subgroups'>subgroups</span> <span class='ivar'>@subgroups</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id="timeout=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="timeout-instance_method"> - (<tt>Object</tt>) <strong>timeout</strong> </h3><div class="docstring"> <div class="discussion"> <p>The duration (in sections) of the validity of a session ticket created by</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/group.rb', line 28</span> <span class='kw'>def</span> <span class='id identifier rubyid_timeout'>timeout</span> <span class='ivar'>@timeout</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <span id="users=-instance_method"></span> <div class="method_details "> <h3 class="signature " id="users-instance_method"> - (<tt>Object</tt>) <strong>users</strong> </h3><div class="docstring"> <div class="discussion"> <p>An array of the Perforce usernames of the group members.</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 35 36 37</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/group.rb', line 35</span> <span class='kw'>def</span> <span class='id identifier rubyid_users'>users</span> <span class='ivar'>@users</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"> 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/models/group.rb', line 84</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'>Group:</span> <span class='ivar'>@group</span> <span class='rbrace'>}</span> <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:MaxResults</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@max_results</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='kw'>if</span> <span class='ivar'>@max_results</span> <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:MaxScanRows</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@max_scan_rows</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='kw'>if</span> <span class='ivar'>@max_scan_rows</span> <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:MaxLockTime</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@max_lock_time</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='kw'>if</span> <span class='ivar'>@max_lock_time</span> <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:Timeout</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@timeout</span> <span class='kw'>if</span> <span class='ivar'>@timeout</span> <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:PasswordTimeout</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@password_timeout</span> <span class='kw'>if</span> <span class='ivar'>@password_timeout</span> <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:Users</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@users</span> <span class='kw'>if</span> <span class='ivar'>@users</span> <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:Subgroups</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@subgroups</span> <span class='kw'>if</span> <span class='ivar'>@subgroups</span> <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:Owners</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@owners</span> <span class='kw'>if</span> <span class='ivar'>@owners</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 Thu Jul 16 12:13:02 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. |