/ 
WWW-Wookie-0.02
River stage zero No dependents
/ WWW::Wookie::User

NAME

WWW::Wookie::User - represent a possible user of a widget

VERSION

This document describes WWW::Wookie::User version 0.0.2

SYNOPSIS

use WWW::Wookie::User;
$u = WWW::Wookie::User->new($login, $nick);

DESCRIPTION

A user represents a possible user of a widget. This class provides a standard way of representing users in plugins for host environments.

SUBROUTINES/METHODS

new

Create a new user.

1. User login name as string
2. User display name as string
3. Optional thumbnail URL as string

getLoginName

Get the login name for this user. Returns the user login name as string.

getScreenName

Get the screen name for this user. This is the name that is intended to be displayed on screen. In many cases it will be the same as the login name. Returns the user display name as a string.

setLoginName

Set the login name for this user. this is the value that is used by the user to register on the system, it is guaranteed to be unique.

1. New login name as string

setScreenName

Set the screen name for this user. This is the value that should be displayed on screen. In many cases it will be the same as the login name.

1. New screen name as string

getThumbnailUrl

Get the URL for a thumbnail representing this user. Returns the user thumbnail icon url as string.

setThumbnailUrl

Set the URL for a thumbnail representing this user.

1. New thumbnail URL as string

CONFIGURATION AND ENVIRONMENT

DEPENDENCIES

Moose Moose::Util::TypeConstraints Readonly

INCOMPATIBILITIES

DIAGNOSTICS

BUGS AND LIMITATIONS

Please report any bugs or feature requests at RT for rt.cpan.org.

AUTHOR

Roland van Ipenburg <ipenburg@xs4all.nl>

LICENSE AND COPYRIGHT

Copyright 2010 Roland van Ipenburg

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

DISCLAIMER OF WARRANTY

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.