Home       Trees       Indices       Help   
Pinder
Package pinder :: Module campfire :: Class Campfire

Class Campfire

source code

object --+
         |
        Campfire

Creates a connection to the Campfire account with the given subdomain.

Instance Methods
 
__init__(self, subdomain)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature		 source code
 
login(self, email, password)
Logs into Campfire with the given email and password.		 source code
 
logout(self)
Logs out from Campfire.		 source code
 
create_room(self, name, topic='')
Creates a Campfire room with the given name and an optional topic.		 source code
 
find_room_by_name(self, name)
Finds a Campfire room with the given name.		 source code
 
find_or_create_room_by_name(self, name)
Finds a Campfire room with the given name.		 source code
 
users(self, *room_names)
Lists the users chatting in any room or in the given room(s).		 source code
 
rooms_names(self)
Lists the names of the rooms available in the Campfire subdomain.		 source code
 
rooms(self)
Lists the available rooms.		 source code
 
transcripts(self, room_id=None)
Gets the dates of the transcripts by room filtered by the given id if any.		 source code

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Instance Variables
  subdomain
The Campfire's subdomain.
  logged_in
True if the user is logged in Campfire, False otherwise.
  cookie
Contains the connection cookie.
  uri
The urlparsed URI of the Campfire account.
Properties

Inherited from object: __class__

Method Details

__init__(self, subdomain)
(Constructor)

source code 

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__
(inherited documentation)

login(self, email, password)

source code 

Logs into Campfire with the given email and password.

Returns True if logged in, False otherwise.

logout(self)

source code 

Logs out from Campfire.

Returns True if logged out, False otherwise.

create_room(self, name, topic='')

source code 

Creates a Campfire room with the given name and an optional topic.

Returns None if the room has not been created.

find_room_by_name(self, name)

source code 

Finds a Campfire room with the given name.

Returns a Room instance if found, None otherwise.

find_or_create_room_by_name(self, name)

source code 

Finds a Campfire room with the given name. If the room is not present it will be created.

Returns a Room instance.

users(self, *room_names)

source code 

Lists the users chatting in any room or in the given room(s).

Returns a set of the users.

rooms_names(self)

source code 

Lists the names of the rooms available in the Campfire subdomain.

Returns a list of the names of the rooms.

rooms(self)

source code 

Lists the available rooms.

Returns a list of Room objects.

transcripts(self, room_id=None)

source code 

Gets the dates of the transcripts by room filtered by the given id if any.

Returns a dictionary of all the dates by room.


   Home       Trees       Indices       Help   
Pinder
Generated by Epydoc 3.0.1 on Sun May 18 15:07:02 2008 http://epydoc.sourceforge.net