Roland van Ipenburg > WWW-Wookie > WWW::Wookie::User

Download:
WWW-Wookie-0.100.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  1
View/Report Bugs
Module Version: 0.100   Source  

NAME ^

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

VERSION ^

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

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 ^

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 2016 by Roland van Ipenburg

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.14.0 or, at your option, any later version of Perl 5 you may have available.

DISCLAIMER OF WARRANTY ^

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENSE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

syntax highlighting: