Overview

Packages

  • Service
    • Twitter

Classes

  • Horde_Service_Twitter
  • Horde_Service_Twitter_Account
  • Horde_Service_Twitter_Auth
  • Horde_Service_Twitter_Auth_Oauth
  • Horde_Service_Twitter_Exception
  • Horde_Service_Twitter_Request
  • Horde_Service_Twitter_Request_Oauth
  • Horde_Service_Twitter_Statuses
  • Overview
  • Package
  • Class
  • Tree

Class Horde_Service_Twitter_Statuses

Horde_Service_Twitter_Statuses class for updating, retrieving user statuses.

Copyright 2009-2012 Horde LLC (http://www.horde.org/)

Package: Service\Twitter
Category: Horde
License: BSD
Author: Michael J. Rubinsky mrubinsk@horde.org
Located at Horde/Service/Twitter/Statuses.php
Methods summary
public
# __construct( Horde_Service_Twitter $twitter )

Constructor

Constructor

Parameters

$twitter
public string
# show( mixed $id )

Obtain the requested status

Obtain the requested status

Returns

string
The method call results.
public string
# destroy( string $id )

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

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

Parameters

$id
The status id

Returns

string
public string
# update( string $status, array $params = array() )

Update the current user's status.

Update the current user's status.

Parameters

$status
The new status text.
$params
Any additional parameters. in_reply_to_status_id - the status id this tweet is in response to.

Returns

string
public string
# friendsTimeline( array $params = array() )

Obtain the friendsTimeline.

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

Parameters

$params
Parameters for the friends_timeline call <pre>since_id - Only tweets more recent the indicated tweet id max_id - Only tweets older then the indeicated tweet id <span class="php-keyword2">count</span> - Only <span class="php-keyword1">return</span> this many tweets (twitter limit = <span class="php-num">200</span>) page - The page number to <span class="php-keyword1">return</span> (note there are pagination limits) include_rts - <span class="php-keyword1">Include</span> retweets include_entities - <span class="php-keyword1">Include</span> twitter entities (will be mandatory in future twitter api release).</pre>

Returns

string
public string
# homeTimeline( array $params = array() )

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.

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

Parameters

$params
Parameters for the friends_timeline call <pre>since_id - Only tweets more recent the indicated tweet id max_id - Only tweets older then the indeicated tweet id <span class="php-keyword2">count</span> - Only <span class="php-keyword1">return</span> this many tweets (twitter limit = <span class="php-num">200</span>) page - The page number to <span class="php-keyword1">return</span> (note there are pagination limits)</pre>

Returns

string
public string
# retweetedByMe( array $params = array() )

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

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

Parameters

$params
Parameters for the friends_timeline call <pre>since_id - Only tweets more recent the indicated tweet id max_id - Only tweets older then the indeicated tweet id <span class="php-keyword2">count</span> - Only <span class="php-keyword1">return</span> this many tweets (twitter limit = <span class="php-num">200</span>) page - The page number to <span class="php-keyword1">return</span> (note there are pagination limits)</pre>

Returns

string
public string
# retweetedToMe( array $params = array() )

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

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

Parameters

$params
Parameters for the friends_timeline call <pre>since_id - Only tweets more recent the indicated tweet id max_id - Only tweets older then the indeicated tweet id <span class="php-keyword2">count</span> - Only <span class="php-keyword1">return</span> this many tweets (twitter limit = <span class="php-num">200</span>) page - The page number to <span class="php-keyword1">return</span> (note there are pagination limits)</pre>

Returns

string
public string
# retweetsOfMe( array $params = array() )

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

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

Parameters

$params
Parameters for the friends_timeline call <pre>since_id - Only tweets more recent the indicated tweet id max_id - Only tweets older then the indeicated tweet id <span class="php-keyword2">count</span> - Only <span class="php-keyword1">return</span> this many tweets (twitter limit = <span class="php-num">200</span>) page - The page number to <span class="php-keyword1">return</span> (note there are pagination limits)</pre>

Returns

string
public string
# retweet( mixed $id )

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.

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.

Returns

string

Params

string id The id for the tweet that is being retweeted.
public string
# publicTimeline( )

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.

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.

Returns

string
public string
# userTimeline( array $params = array() )

Obtain the friendsTimeline.

Obtain the friendsTimeline.

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

Parameters

$params
Parameters for the friends_timeline call <pre>id - <span class="php-keyword1">For</span> this user id <span class="php-keyword1">or</span> screen name. <span class="php-keyword2">Current</span> user <span class="php-keyword1">if</span> left out. user_id - Specfies the ID of the user <span class="php-keyword1">for</span> whom to <span class="php-keyword1">return</span> the user_timeline. Helpful <span class="php-keyword1">for</span> disambiguating when a valid user ID is also a valid screen name. screen_id - Specfies the screen name of the user <span class="php-keyword1">for</span> whom to <span class="php-keyword1">return</span> the user_timeline. Helpful <span class="php-keyword1">for</span> 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 <span class="php-keyword2">count</span> - Only <span class="php-keyword1">return</span> this many tweets (twitter limit = <span class="php-num">200</span>) page - The page number to <span class="php-keyword1">return</span> (note there are pagination limits)</pre>

Returns

string
public string
# mentions( array $params = array() )

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

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

Parameters

$params
Parameters for the friends_timeline call <pre>since_id - Only tweets more recent the indicated tweet id max_id - Only tweets older then the indeicated tweet id <span class="php-keyword2">count</span> - Only <span class="php-keyword1">return</span> this many tweets (twitter limit = <span class="php-num">200</span>) page - The page number to <span class="php-keyword1">return</span> (note there are pagination limits)</pre>

Returns

string
public unknown_type
# friends( array $params = array() )

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.

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

Parameters

$params
Parameters for the friends_timeline call <pre>id - <span class="php-keyword1">For</span> this user id <span class="php-keyword1">or</span> screen name. <span class="php-keyword2">Current</span> user <span class="php-keyword1">if</span> left out. user_id - Specfies the ID of the user <span class="php-keyword1">for</span> whom to <span class="php-keyword1">return</span> the user_timeline. Helpful <span class="php-keyword1">for</span> disambiguating when a valid user ID is also a valid screen name. screen_id - Specfies the screen name of the user <span class="php-keyword1">for</span> whom to <span class="php-keyword1">return</span> the user_timeline. Helpful <span class="php-keyword1">for</span> disambiguating when a valid screen name is also a user ID. page - The page number to <span class="php-keyword1">return</span> (note there are pagination limits)</pre>

Returns

unknown_type
public unknown_type
# followers( array $params = array() )

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.

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

Parameters

$params
Parameters for the friends_timeline call <pre>id - <span class="php-keyword1">For</span> this user id <span class="php-keyword1">or</span> screen name. <span class="php-keyword2">Current</span> user <span class="php-keyword1">if</span> left out. user_id - Specfies the ID of the user <span class="php-keyword1">for</span> whom to <span class="php-keyword1">return</span> the user_timeline. Helpful <span class="php-keyword1">for</span> disambiguating when a valid user ID is also a valid screen name. screen_id - Specfies the screen name of the user <span class="php-keyword1">for</span> whom to <span class="php-keyword1">return</span> the user_timeline. Helpful <span class="php-keyword1">for</span> disambiguating when a valid screen name is also a user ID. page - The page number to <span class="php-keyword1">return</span> (note there are pagination limits)</pre>

Returns

unknown_type
API documentation generated by ApiGen