source: perl/modules/Facebook/README @ fb06a17

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