Package pinder :: Module room :: Class Room

Class Room

object --+
         |
        Room

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

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)

 

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

Overrides: object.__init__
(inherited documentation)

__repr__(self)
(Representation operator)

 

repr(x)

Overrides: object.__repr__
(inherited documentation)

speak(self, message)

 

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

paste(self, message)

 

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

sound(self, message)

 

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

fetch_tweet(self, twitter_status_url)

 

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

listen(self, callback, errback)

 

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.