Package pinder :: Module campfire :: Class Campfire

Class Campfire

object --+
         |
        Campfire

Initialize a Campfire client with the given subdomain and token. Accepts a third boolean parameter to enable SSL (defaults to false).

Instance Methods
 
__init__(self, subdomain, token, ssl=False, connector=<class 'pinder.connector.HTTPConnector'>)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
 
rooms(self)
Returns the rooms available in the Campfire account
 
joined_rooms(self)
Returns the rooms you've joined
 
rooms_joined(self)
Returns the rooms you've joined
 
rooms_names(self)
Returns the rooms names available in the Campfire account
 
room(self, room_id)
Returns the room info for the room with the given id.
 
find_room_by_name(self, name)
Finds a Campfire room with the given name.
 
users(self, *rooms_ids)
Returns info about users in any room or in the given room(s).
 
user(self, user_id)
Returns info about the user with the given user_id.
 
me(self)
Returns info about the authenticated user.
 
search(self, term)
Returns all the messages containing the given term.

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

Properties

Inherited from object: __class__

Method Details

__init__(self, subdomain, token, ssl=False, connector=<class 'pinder.connector.HTTPConnector'>)
(Constructor)

 

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

Overrides: object.__init__
(inherited documentation)

find_room_by_name(self, name)

 

Finds a Campfire room with the given name.

Returns a Room instance if found, None otherwise.