Docs For Class Horde_Service_Twitter

Horde_Service_Twitter_Statuses

Description

Horde_Service_Twitter_Statuses class for updating, retrieving user statuses.

author: Michael J. Rubinsky <mrubinsk@horde.org>
license: BSD

Located in /Twitter/Statuses.php (line 12)

Method Summary

Horde_Service_Twitter_Statuses __construct (Horde_Service_Twitter $twitter)

string destroy (string $id)

unknown_type followers ([array $params = array()])

unknown_type friends ([array $params = array()])

string friendsTimeline ([array $params = array()])

string homeTimeline ([array $params = array()])

string mentions ([array $params = array()])

string publicTimeline ()

string retweet ( $id)

string retweetedByMe ([array $params = array()])

string retweetedToMe ([array $params = array()])

string retweetsOfMe ([array $params = array()])

string show ( $id)

string update (string $status, [array $params = array()])

string userTimeline ([array $params = array()])

Methods

Constructor __construct (line 33)

Constructor

access: public

Horde_Service_Twitter_Statuses __construct (Horde_Service_Twitter $twitter)

Horde_Service_Twitter $twitter

destroy (line 59)

Destroy the specified status update, obviously only if the current user is the author of the update.

http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-statuses%C2%A0destroy

access: public

string destroy (string $id)

string $id: The status id

followers (line 323)

Returns a user's followers, each with current status inline. They are ordered by the order in which they were added as friends, 100 at a time.

http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-statuses%C2%A0friends

access: public

unknown_type followers ([array $params = array()])

array $params: Parameters for the friends_timeline call

     id         - For this user id or screen name.
                  Current user if left out.
     user_id    - Specfies the ID of the user for whom to return the
                  user_timeline. Helpful for disambiguating when a valid
                  user ID is also a valid screen name.
     screen_id  - Specfies the screen name of the user for whom to return
                  the user_timeline. Helpful for disambiguating when a
                  valid screen name is also a user ID.
     page       - The page number to return (note there are pagination limits)

friends (line 297)

Returns a user's friends, each with current status inline. They are ordered by the order in which they were added as friends, 100 at a time.

http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-statuses%C2%A0friends

access: public

unknown_type friends ([array $params = array()])

array $params: Parameters for the friends_timeline call

     id         - For this user id or screen name.
                  Current user if left out.
     user_id    - Specfies the ID of the user for whom to return the
                  user_timeline. Helpful for disambiguating when a valid
                  user ID is also a valid screen name.
     screen_id  - Specfies the screen name of the user for whom to return
                  the user_timeline. Helpful for disambiguating when a
                  valid screen name is also a user ID.
     page       - The page number to return (note there are pagination limits)

friendsTimeline (line 109)

Obtain the friendsTimeline.

http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-statuses-friends_timeline

NOTE: According to the API docs, this method is deprecated and will be going away in a future version of the API. This is to be replaced by home_timeline.

http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-statuses-home_timeline

access: public

string friendsTimeline ([array $params = array()])

array $params: Parameters for the friends_timeline call

     since_id         - Only tweets more recent the indicated tweet id
     max_id           - Only tweets older then the indeicated tweet id
     count            - Only return this many tweets (twitter limit = 200)
     page             - The page number to return (note there are
                        pagination limits)
     include_rts      - Include retweets
     include_entities - Include twitter entities (will be mandatory in
                        future twitter api release).

homeTimeline (line 132)

Returns the 20 most recent statuses, including retweets, posted by the authenticating user and that user's friends. This is the equivalent of /timeline/home on the Web.

http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-statuses-home_timeline

access: public

string homeTimeline ([array $params = array()])

array $params: Parameters for the friends_timeline call

     since_id   - Only tweets more recent the indicated tweet id
     max_id     - Only tweets older then the indeicated tweet id
     count      - Only return this many tweets (twitter limit = 200)
     page       - The page number to return (note there are pagination limits)

mentions (line 271)

Obtain most recent 'mentions' for the current user. (i.e. all messages that contain @username in the text).

http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-statuses-mentions

access: public

string mentions ([array $params = array()])

array $params: Parameters for the friends_timeline call

     since_id   - Only tweets more recent the indicated tweet id
     max_id     - Only tweets older then the indeicated tweet id
     count      - Only return this many tweets (twitter limit = 200)
     page       - The page number to return (note there are pagination limits)

publicTimeline (line 220)

Obtain the last 20 tweets from the public timeline. This is cached every 60 seconds on Twitter's servers so we should eventually ensure this is only actually requested every 60 seconds or greater.

access: public

string publicTimeline ()

retweet (line 206)

Retweets a tweet. Requires the id parameter of the tweet you are retweeting. Request must be a POST or PUT.

Returns the original tweet with retweet details embedded.

access: public

string retweet ( $id)

retweetedByMe (line 151)

Returns the 20 most recent retweets posted by the authenticating user.

access: public

string retweetedByMe ([array $params = array()])

array $params: Parameters for the friends_timeline call

     since_id   - Only tweets more recent the indicated tweet id
     max_id     - Only tweets older then the indeicated tweet id
     count      - Only return this many tweets (twitter limit = 200)
     page       - The page number to return (note there are pagination limits)

retweetedToMe (line 171)

Returns the 20 most recent retweets posted by the authenticating user's friends.

access: public

string retweetedToMe ([array $params = array()])

array $params: Parameters for the friends_timeline call

     since_id   - Only tweets more recent the indicated tweet id
     max_id     - Only tweets older then the indeicated tweet id
     count      - Only return this many tweets (twitter limit = 200)
     page       - The page number to return (note there are pagination limits)

retweetsOfMe (line 191)

Returns the 20 most recent tweets of the authenticated user that have been retweeted by others.

access: public

string retweetsOfMe ([array $params = array()])

array $params: Parameters for the friends_timeline call

     since_id   - Only tweets more recent the indicated tweet id
     max_id     - Only tweets older then the indeicated tweet id
     count      - Only return this many tweets (twitter limit = 200)
     page       - The page number to return (note there are pagination limits)

show (line 43)

Obtain the requested status

return: The method call results.
access: public

string show ( $id)

update (line 76)

Update the current user's status.

access: public

string update (string $status, [array $params = array()])

string $status: The new status text.

array $params: Any additional parameters.

     in_reply_to_status_id  - the status id this tweet is in response to.

userTimeline (line 249)

Obtain the friendsTimeline.

http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-statuses-user_timeline

access: public

string userTimeline ([array $params = array()])

array $params: Parameters for the friends_timeline call

     id         - For this user id or screen name.
                  Current user if left out.
     user_id    - Specfies the ID of the user for whom to return the
                  user_timeline. Helpful for disambiguating when a valid
                  user ID is also a valid screen name.
     screen_id  - Specfies the screen name of the user for whom to return
                  the user_timeline. Helpful for disambiguating when a
                  valid screen name is also a user ID.
     since_id   - Only tweets more recent the indicated tweet id
     max_id     - Only tweets older then the indeicated tweet id
     count      - Only return this many tweets (twitter limit = 200)
     page       - The page number to return (note there are pagination limits)

Documentation generated on Sun, 13 May 2012 04:49:38 +0000 by phpDocumentor 1.4.3