source: perl/modules/Facebook/README @ 2f6c263

Last change on this file since 2f6c263 was 2f6c263, checked in by Edward Z. Yang <ezyang@mit.edu>, 10 years ago
Improve docs, error handling and refactor. Signed-off-by: Edward Z. Yang <ezyang@mit.edu>
  • Property mode set to 100644
File size: 2.9 KB
Line 
1NAME
2  Facebook.par - Facebook support for BarnOwl
3
4DESCRIPTION
5  The Facebook module implements Facebook support for BarnOwl.
6
7SYNOPSIS
8  (1) Create an empty file ~/.owl/facebook (you can use the command
9  `touch ~/.owl/facebook`), in order to enable the module.
10
11  (2) Run ":reload-module Facebook" inside BarnOwl.
12
13  (3) Follow the instructions in the admin message.  BarnOwl will
14  ask you to log in via an OAuth URL, and run ':facebook-auth'
15  with the resulting URL.  It will then ask you to record the
16  resulting access token in your ~/.owl/facebook file, so you do
17  not have to login on subsequent BarnOwl sesions.
18
19  This token is valid until you change your
20  Facebook password or you revoke permissions for Barnowl at:
21    http://www.facebook.com/settings/?tab=applications&app_id=235537266461636
22
23  (4) Start receiving wall updates in Barnowl!
24  You can post updates with the ":facebook" command.
25
26INFELICITIES
27  * Polling Facebook is pretty slow (on order of a second or more),
28    and blocks the entire BarnOwl interface.  We have a plan for
29    fixing this, which involves creating an async version of
30    Facebook::Graph.  I have been in contact with the original
31    author JT Smith about this.
32
33  * BarnOwl will not receive all comments for news feed items, only
34    comments for items that were recently published.  There is not
35    currently a way to see starks for conversations that you did not
36    participate in, and the only way to see starks for conversations
37    you did participate in are Facebook's email notifications.  (This
38    is a deficiency of the Facebook API, see http://bugs.developers.facebook.net/show_bug.cgi?id=18594.)
39
40  * By default, BarnOwl will not display posts from organizations (such
41    as bands you have liked) or application invites.  This is a
42    judgment of taste from the original author.  This is not currently
43    configurable.
44
45  * Users and applications that you have hidden via the Facebook
46    web interface will show up in the BarnOwl stream.  (This appears to
47    be a deficiency of the Facebook API, see
48    http://stackoverflow.com/questions/6405364/facebook-api-access-hide-posts-from-settings).
49    Users are encouraged to work around this by using traditional Zephyr
50    filters.
51
52  * We are missing support for some notable features, including
53    messaging (Facebook has not publically released the API for this,
54    though we could sign up for the whitelist), events (seeing
55    unresponded to events requires a custom FQL query
56    http://stackoverflow.com/questions/4752967/facebook-api-only-returns-25-events-max),
57    notifications (not supported in Graph API yet).
58
59WISHLIST
60  * Smarter name de-duplication (see Facebook/Handle.pm for details.)
61  * URL minification.
62  * Multiple accounts.  (Does anyone do this? I don't think so...)
63  * Zephyr class mirroring.
64
65POLLING
66  Facebook.par polls for normal messages once a minute. To disable
67  polling, you can unset the 'facebook:poll' variable in BarnOwl.
Note: See TracBrowser for help on using the repository browser.