Damien Krotkine > RT-Client-REST-0.36 > RT::Client::REST::User

Download:
RT-Client-REST-0.36.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  5
View/Report Bugs
Module Version: 0.02   Source   Latest Release: RT-Client-REST-0.49

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 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?).

email_address

E-mail address of the user.

real_name

Real name of the user.

gecos

Gecos.

comments

Comments about this 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.

syntax highlighting: