c81d7d2bfb
Removed deprecations Removed new event system Added documentation for all events Added FAQ Changed Client.uid to Client.id Improved User model Prepared for support of pages
45 lines
1.1 KiB
ReStructuredText
45 lines
1.1 KiB
ReStructuredText
.. module:: fbchat
|
|
.. highlight:: python
|
|
.. _api:
|
|
|
|
Full API
|
|
========
|
|
|
|
If you are looking for information on a specific function, class, or method, this part of the documentation is for you.
|
|
|
|
|
|
.. _api_client:
|
|
|
|
Client
|
|
------
|
|
|
|
This is the main class of `fbchat`, which contains all the methods you use to interract with Facebook.
|
|
You can extend this class, and overwrite the events, to provide custom event handling (mainly used while listening)
|
|
|
|
.. autoclass:: Client(email, password, user_agent=None, max_tries=5, session_cookies=None, logging_level=logging.INFO)
|
|
:members:
|
|
|
|
|
|
.. _api_models:
|
|
|
|
Models
|
|
------
|
|
|
|
These models are used in various functions, both as inputs and return values.
|
|
A good tip is to write ``from fbchat.models import *`` at the start of your source, so you can use these models freely
|
|
|
|
.. automodule:: fbchat.models
|
|
:members:
|
|
:undoc-members:
|
|
|
|
|
|
.. _api_utils:
|
|
|
|
Utils
|
|
-----
|
|
|
|
These functions and values are used internally by fbchat, and are subject to change. Do **NOT** rely on these to be backwards compatible!
|
|
|
|
.. automodule:: fbchat.utils
|
|
:members:
|