NAME
E2::Room - A module for loading rooms on http://everything2.com.
SYNOPSIS
use E2::Room;
my $room = new E2::Room;
$room->login( "username", "password" ); # See E2::Interface
if( $room->load( "test" ) ) { # See E2::Node
print 'Room name: ' . $room->title; # See E2::Node
print '\nDescription: . $group->description;
print '\nYou ' .
($room->can_enter ? "can" : "can't") .
"enter.\n";
}
DESCRIPTION
This module provides access to http://everything2.com's rooms. It inherits E2::Node.
CONSTRUCTOR
- new
-
new
creates a newE2::Room
object. Until that object is logged in in one way or another (see E2::Interface), it will use the "Guest User" account.
METHODS
- $room->clear
-
clear
clears all the information currently stored in $room. - $room->description
-
This method returns the description string of the currently-loaded room. It returns
undef
if no usergroup is loaded. - $room->can_enter
-
This method returns a boolean value: whether or not the currently-logged-in user can enter this room.
SEE ALSO
E2::Interface, E2::Node, http://everything2.com, http://everything2.com/?node=clientdev
AUTHOR
Jose M. Weeks <jose@joseweeks.com> (Simpleton on E2)
COPYRIGHT
This software is public domain.