API Documentation
\

\Horde_Service_Twitter_Statuses

Horde_Service_Twitter_Statuses class for updating, retrieving user statuses.

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

Summary

Methods
Properties
Constants
__construct()
show()
destroy()
update()
friendsTimeline()
homeTimeline()
retweetedByMe()
retweetedToMe()
retweetsOfMe()
retweet()
publicTimeline()
userTimeline()
mentions()
friends()
followers()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$_endpoint
$_format
N/A

Properties

$_endpoint

$_endpoint : string

Endpoint for status api requests

Type

string

$_format

$_format : string

Format to use json or xml

Type

string

Methods

__construct()

__construct(\Horde_Service_Twitter  $twitter)

Constructor

Parameters

\Horde_Service_Twitter $twitter

show()

show(  $id) : string

Obtain the requested status

Parameters

$id

Returns

string —

The method call results.

update()

update(string  $status, array  $params = array()) : string

Update the current user's status.

Parameters

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.

Returns

string

friendsTimeline()

friendsTimeline(array  $params = array()) : string

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

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).

Returns

string

homeTimeline()

homeTimeline(array  $params = array()) : string

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

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)

Returns

string

retweetedByMe()

retweetedByMe(array  $params = array()) : string

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

Parameters

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)

Returns

string

retweetedToMe()

retweetedToMe(array  $params = array()) : string

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

Parameters

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)

Returns

string

retweetsOfMe()

retweetsOfMe(array  $params = array()) : string

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

Parameters

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)

Returns

string

retweet()

retweet(  $id) : string

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.

Parameters

$id

Returns

string

publicTimeline()

publicTimeline() : string

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

userTimeline()

userTimeline(array  $params = array()) : string

Obtain the friendsTimeline.

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

Parameters

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)

Returns

string

mentions()

mentions(array  $params = array()) : string

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

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)

Returns

string

friends()

friends(array  $params = array()) : \unknown_type

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

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)

Returns

\unknown_type

followers()

followers(array  $params = array()) : \unknown_type

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

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)

Returns

\unknown_type