rt::client::rest::user(3pm) [debian man page]

RT::Client::REST::User(3pm)				User Contributed Perl Documentation			       RT::Client::REST::User(3pm)

NAME

       RT::Client::REST::User -- user object representation.

SYNOPSIS

	 my $rt = RT::Client::REST->new(server => $ENV{RTSERVER});

	 my $user = RT::Client::REST::User->new(
	   rt  => $rt,
	   id  => $id,
	 )->retrieve;

DESCRIPTION

       RT::Client::REST::User is based on RT::Client::REST::Object.  The representation allows one to retrieve, edit, comment on, and create users
       in RT.

       Note: RT currently does not allow REST client to search users.

ATTRIBUTES

       id
	 For retrieval, you can specify either the numeric ID of the user or his username.  After the retrieval, however, this attribute will be
	 set to the numeric id.

       name
	 This is the username of the user.

       password
	 User's password.  Reading it will only give you a bunch of stars (what else would you expect?).

       privileged
	 Can the user have special rights?

       disabled
	 Can this user access RT?

       email_address
	 E-mail address of the user, EmailAddress.

       real_name
	 Real name of the user, RealName.

       gecos
	 Gecos.

       comments
	 Comments about this user.

       nickname
	 Nickname of this user.

       lang
	 Language for this user.

       organization
       address_one
	 First line of the street address, Address1.

       address_two
	 Second line of the street address, Address2.

       city
	 City segment of user's address.

       zip
	 ZIP or Postal code segment of user's address.

       country
	 Country segment of user's address.

       home_phone
	 User's home phone number, HomePhone.

       work_phone
	 User's work phone number, WorkPhone.

       cell_phone
	 User's cell phone number, MobilePhone.

       pager
	 User's pager number, PagerPhone.

       contactinfo
	 Contact info (Extra Info field).

       signature
	 Signature for the user.

DB METHODS

       For full explanation of these, please see "DB METHODS" in RT::Client::REST::Object documentation.

       retrieve
	 Retrieve RT user from database.

       store
	 Create or update the user.

       search
	 Currently RT does not allow REST clients to search users.

INTERNAL METHODS

       rt_type
	 Returns 'user'.

SEE ALSO

       RT::Client::REST, RT::Client::REST::Object, RT::Client::REST::SearchResult.

AUTHOR

       Dmitri Tikhonov <dtikhonov@yahoo.com>

LICENSE

       Perl license with the exception of RT::Client::REST, which is GPLed.

perl v5.14.2							    2012-01-20					       RT::Client::REST::User(3pm)

Check Out this Related Man Page

RT::Client::REST::SearchResult(3pm)			User Contributed Perl Documentation		       RT::Client::REST::SearchResult(3pm)

NAME

       RT::Client::REST::SearchResult -- Search results representation.

SYNOPSIS

	 my $iterator = $search->get_iterator;
	 my $count = $iterator->count;

	 while (defined(my $obj = &$iterator)) {
	   # do something with the $obj
	 }

DESCRIPTION

       This class is a representation of a search result.  This is the type of the object you get back when you call method "search()" on
       RT::Client::REST::Object-derived objects.  It makes it easy to iterate over results and find out just how many there are.

METHODS

       count
	   Returns the number of search results.  This number will always be the same unless you stick your fat dirty fingers into the object and
	   abuse it.  This number is not affected by calls to "get_iterator()".

       get_iterator
	   Returns a reference to a subroutine which is used to iterate over the results.

	   Evaluating it in scalar context, returns the next object or "undef" if all the results have already been iterated over.  Note that for
	   each object to be instantiated with correct values, retrieve() method is called on the object before returning it to the caller.

	   Evaluating the subroutine reference in list context returns a list of all results fully instantiated.  WARNING: this may be expensive,
	   as each object is issued retrieve() method.	Subsequent calls to the iterator result in empty list.

	   You may safely mix calling the iterator in scalar and list context.	For example:

	     $iterator = $search->get_iterator;

	     $first = &$iterator;
	     $second = &$iterator;
	     @the_rest = &$iterator;

	   You can get as many iterators as you want -- they will not step on each other's toes.

       new You should not have to call it yourself, but just for the sake of completeness, here are the arguments:

	     my $search = RT::Client::REST::SearchResult->new(
	       ids => [1 .. 10],
	       object => sub {	     # Yup, that's a closure.
		 RT::Client::REST::Ticket->new(
		   id => shift,
		   rt => $rt,
		 );
	       },
	     );

SEE ALSO

       RT::Client::REST::Object, RT::Client::REST.

AUTHOR

       Dmitri Tikhonov <dtikhonov@yahoo.com>

perl v5.14.2							    2011-12-27				       RT::Client::REST::SearchResult(3pm)

Linux and UNIX Man Pages

rt::client::rest::user(3pm) [debian man page]

Check Out this Related Man Page