.. _plugin:twitter:

=======
TWITTER
=======
| 

about
-----
| 

:author:  FeedBackLoop <feedbackloop@gmail.com>
:contact: FREENODE/#fbf
:distribution: core
:license:  

| 

description
-----------
| 

 a twitter plugin for the FBFBOT, currently post only .. uses tweepy oauth. 



| 

commands
--------
| 


    :commands in this plugin: twitter-cmnd .. twitter-auth .. twitter .. twitter-confirm .. twitter-friends

| 

1) *twitter .. [handle_twitter]*

    :description:  arguments: <txt> - send a twitter message. 

    :permissions: USER .. GUEST

    :code: :ref:`fbf.plugs.extra.twitter_twitter_command`.

    :examples:

    ::

        <user> ;twitter just found the http://jsonbot.org project
        <output> the twitter plugin needs the credentials.py file in the .fbf/config dir. see the examples directory


2) *twitter-auth .. [handle_twitter_auth]*

    :description:  no arguments - get url to get the auth PIN needed for the twitter-confirm command. 

    :permissions: OPER .. USER .. GUEST

    :code: :ref:`fbf.plugs.extra.twitter_twitter-auth_command`.
3) *twitter-cmnd .. [handle_twittercmnd]*

    :description:  arguments: <API cmnd> - do a twitter API cmommand. 

    :permissions: OPER

    :code: :ref:`fbf.plugs.extra.twitter_twitter-cmnd_command`.

    :examples:

    ::

        <user> ;twitter-cmnd home_timeline
        <output> the twitter plugin needs the credentials.py file in the .fbf/config dir. see the examples dir


4) *twitter-confirm .. [handle_twitter_confirm]*

    :description:  arguments: <PIN code> - confirm auth with PIN. 

    :permissions: OPER .. USER .. GUEST

    :code: :ref:`fbf.plugs.extra.twitter_twitter-confirm_command`.
5) *twitter-friends .. [handle_twitterfriends]*

    :description:  no arguments - show friends timeline (your normal twitter feed). 

    :permissions: OPER .. USER .. GUEST

    :code: :ref:`fbf.plugs.extra.twitter_twitter-friends_command`.

    :examples:

    ::

        <user> ;twitter-friends
        <output> the twitter plugin needs the credentials.py file in the .fbf/config dir. see the examples directory