Package pinder :: Module room :: Class Room

Class Room

source code

object --+
         |
        Room

Instance Methods
 
__init__(self, campfire, room_id, data, connector)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
 
__repr__(self)
repr(x)
source code
 
__eq__(self, other) source code
 
join(self)
Joins the room.
source code
 
leave(self)
Leaves the room.
source code
 
lock(self)
Locks the room to prevent new users from entering.
source code
 
unlock(self)
Unlocks the room.
source code
 
users(self)
Gets info about users chatting in the room.
source code
 
transcript(self, date=None)
Gets the transcript for the given date (a datetime.date instance) or today.
source code
 
speak(self, message)
Sends a message to the room.
source code
 
paste(self, message)
Pastes a message to the room.
source code
 
sound(self, message)
Plays a sound into the room.
source code
 
fetch_tweet(self, twitter_status_url)
Fetches a tweet from a Twitter status URL.
source code
 
update(self, name, topic)
Updates name and/or topic of the room.
source code
 
uploads(self)
Lists recently uploaded files.
source code
 
upload(self, fileobj)
Uploads the content of the given file-like object to the room.
source code
 
get_upload(self, upload_id) source code
 
recent_messages(self, limit=100, since_message_id=None)
Returns upto limit (max 100) messages optionally starting from since_message_id.
source code
 
highlight_message(self, message_id)
Highlights a message.
source code
 
remove_highlight_from_message(self, message_id)
Removes a highlight from a message.
source code
 
listen(self, callback, errback, start_reactor=True)
Listens on room conversation calling the callback on each message.
source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties

Inherited from object: __class__

Method Details

__init__(self, campfire, room_id, data, connector)
(Constructor)

source code 

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__
(inherited documentation)

__repr__(self)
(Representation operator)

source code 

repr(x)

Overrides: object.__repr__
(inherited documentation)

speak(self, message)

source code 

Sends a message to the room. Returns the message content.

paste(self, message)

source code 

Pastes a message to the room. Returns the message content.

sound(self, message)

source code 

Plays a sound into the room. Returns the message content.

fetch_tweet(self, twitter_status_url)

source code 

Fetches a tweet from a Twitter status URL. Returns the message content.

listen(self, callback, errback, start_reactor=True)

source code 

Listens on room conversation calling the callback on each message. The errback will be called upon networking problems, parsing errors and on shutdown. The callback's argument is the message. The errback's is the exception. start_reactor as True starts Twisted's reactor