rt4-doc-html 4.4.2-2 / usr / share / doc / rt4-doc-html / RT / Users.html

<ul id="index">
  <li><a href="#NAME">NAME</a></li>
  <li><a href="#SYNOPSIS">SYNOPSIS</a></li>
  <li><a href="#DESCRIPTION">DESCRIPTION</a></li>
  <li><a href="#METHODS">METHODS</a>
    <ul>
      <li><a href="#PrincipalsAlias">PrincipalsAlias</a></li>
      <li><a href="#LimitToEnabled">LimitToEnabled</a></li>
      <li><a href="#LimitToDeleted">LimitToDeleted</a></li>
      <li><a href="#LimitToEmail">LimitToEmail</a></li>
      <li><a href="#MemberOfGroup-PRINCIPAL_ID">MemberOfGroup PRINCIPAL_ID</a></li>
      <li><a href="#LimitToPrivileged">LimitToPrivileged</a></li>
      <li><a href="#LimitToUnprivileged">LimitToUnprivileged</a></li>
      <li><a href="#WhoHaveRight-Right-name-Object-rt_object-IncludeSuperusers-undef-IncludeSubgroupMembers-undef-IncludeSystemRights-undef-EquivObjects">WhoHaveRight { Right =&gt; &#39;name&#39;, Object =&gt; $rt_object , IncludeSuperusers =&gt; undef, IncludeSubgroupMembers =&gt; undef, IncludeSystemRights =&gt; undef, EquivObjects =&gt; [ ] }</a></li>
      <li><a href="#WhoBelongToGroups-Groups-ARRAYREF-IncludeSubgroupMembers-1-IncludeUnprivileged-0">WhoBelongToGroups { Groups =&gt; ARRAYREF, IncludeSubgroupMembers =&gt; 1, IncludeUnprivileged =&gt; 0 }</a></li>
      <li><a href="#SimpleSearch">SimpleSearch</a></li>
    </ul>
  </li>
</ul>

<h1 id="NAME"><a href="#___top">NAME</a></h1>

<pre><code>  RT::Users - Collection of RT::User objects</code></pre>

<h1 id="SYNOPSIS"><a href="#___top">SYNOPSIS</a></h1>

<pre><code>  use RT::Users;</code></pre>

<h1 id="DESCRIPTION"><a href="#___top">DESCRIPTION</a></h1>

<h1 id="METHODS"><a href="#___top">METHODS</a></h1>

<h2 id="PrincipalsAlias"><a href="#___top">PrincipalsAlias</a></h2>

<p>Returns the string that represents this Users object&#39;s primary &quot;Principals&quot; alias.</p>

<h2 id="LimitToEnabled"><a href="#___top">LimitToEnabled</a></h2>

<p>Only find items that haven&#39;t been disabled</p>

<h2 id="LimitToDeleted"><a href="#___top">LimitToDeleted</a></h2>

<p>Only find items that have been deleted.</p>

<h2 id="LimitToEmail"><a href="#___top">LimitToEmail</a></h2>

<p>Takes one argument. an email address. limits the returned set to that email address</p>

<h2 id="MemberOfGroup-PRINCIPAL_ID"><a href="#___top">MemberOfGroup PRINCIPAL_ID</a></h2>

<p>takes one argument, a group&#39;s principal id. Limits the returned set to members of a given group</p>

<h2 id="LimitToPrivileged"><a href="#___top">LimitToPrivileged</a></h2>

<p>Limits to users who can be made members of ACLs and groups</p>

<h2 id="LimitToUnprivileged"><a href="#___top">LimitToUnprivileged</a></h2>

<p>Limits to unprivileged users only</p>

<h2 id="WhoHaveRight-Right-name-Object-rt_object-IncludeSuperusers-undef-IncludeSubgroupMembers-undef-IncludeSystemRights-undef-EquivObjects"><a href="#___top">WhoHaveRight { Right =&gt; &#39;name&#39;, Object =&gt; $rt_object , IncludeSuperusers =&gt; undef, IncludeSubgroupMembers =&gt; undef, IncludeSystemRights =&gt; undef, EquivObjects =&gt; [ ] }</a></h2>

<p>find all users who the right Right for this group, either individually or as members of groups</p>

<p>If passed a queue object, with no id, it will find users who have that right for _any_ queue</p>

<h2 id="WhoBelongToGroups-Groups-ARRAYREF-IncludeSubgroupMembers-1-IncludeUnprivileged-0"><a href="#___top">WhoBelongToGroups { Groups =&gt; ARRAYREF, IncludeSubgroupMembers =&gt; 1, IncludeUnprivileged =&gt; 0 }</a></h2>

<p>Return members who belong to any of the groups passed in the groups whose IDs are included in the Groups arrayref.</p>

<p>If IncludeSubgroupMembers is true (default) then members of any group that&#39;s a member of one of the passed groups are returned. If it&#39;s cleared then only direct member users are returned.</p>

<p>If IncludeUnprivileged is false (default) then only privileged members are returned; otherwise either privileged or unprivileged group members may be returned.</p>

<h2 id="SimpleSearch"><a href="#___top">SimpleSearch</a></h2>

<p>Does a &#39;simple&#39; search of Users against a specified Term.</p>

<p>This Term is compared to a number of fields using various types of SQL comparison operators.</p>

<p>Ensures that the returned collection of Users will have a value for Return.</p>

<p>This method is passed the following. You must specify a Term and a Return.</p>

<pre><code>    Privileged - Whether or not to limit to Privileged Users (0 or 1)
    Fields     - Hashref of data - defaults to C&lt;$UserSearchFields&gt; emulate that if you want to override
    Term       - String that is in the fields specified by Fields
    Return     - What field on the User you want to be sure isn&#39;t empty
    Exclude    - Array reference of ids to exclude
    Max        - What to limit this collection to</code></pre>

<a href="./../">&larr; Back to index</a>