Package pinder :: Module campfire :: Class Campfire

Class Campfire

source code

object --+
         |
        Campfire

Initialize a Campfire client with the given subdomain and token.

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

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=True, connector=<class 'pinder.connector.HTTPConnector'>)
(Constructor)

source code 

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

Overrides: object.__init__
(inherited documentation)

find_room_by_name(self, name)

source code 

Finds a Campfire room with the given name.

Returns a Room instance if found, None otherwise.