Docs For Class JTwitterFavorites

Description

Twitter API Favorites class for the Joomla Platform.

since: 12.3

Located in /libraries/joomla/twitter/favorites.php (line 19)

JTwitterObject
   |
   --JTwitterFavorites

Method Summary

array createFavorites (integer $id, [boolean $entities = null])

array deleteFavorites (integer $id, [boolean $entities = null])

array getFavorites ([mixed $user = null], [integer $count = 20], [integer $since_id = 0], [integer $max_id = 0], [boolean $entities = null])

Variables

Inherited Variables

Inherited from JTwitterObject

JTwitterObject::$client
JTwitterObject::$oauth
JTwitterObject::$options

Methods

createFavorites (line 90)

Method to favorite the status specified in the ID parameter as the authenticating user

return: The decoded JSON response
since: 12.3
access: public

array createFavorites (integer $id, [boolean $entities = null])

integer $id: The numerical ID of the desired status.
boolean $entities: When set to true, each tweet will include a node called "entities,". This node offers a variety of metadata about the tweet in a discreet structure, including: user_mentions, urls, and hashtags.

deleteFavorites (line 118)

Method to un-favorites the status specified in the ID parameter as the authenticating user.

return: The decoded JSON response
since: 12.3
access: public

array deleteFavorites (integer $id, [boolean $entities = null])

integer $id: The numerical ID of the desired status.
boolean $entities: When set to true, each tweet will include a node called "entities,". This node offers a variety of metadata about the tweet in a discreet structure, including: user_mentions, urls, and hashtags.

getFavorites (line 36)

Method to get the most recent favorite statuses for the authenticating or specified user.

return: The decoded JSON response
since: 12.3
access: public

array getFavorites ([mixed $user = null], [integer $count = 20], [integer $since_id = 0], [integer $max_id = 0], [boolean $entities = null])

mixed $user: Either an integer containing the user ID or a string containing the screen name.
integer $count: Specifies the number of tweets to try and retrieve, up to a maximum of 200. Retweets are always included in the count, so it is always suggested to set $include_rts to true
integer $since_id: Returns results with an ID greater than (that is, more recent than) the specified ID.
integer $max_id: Returns results with an ID less than (that is, older than) the specified ID.
boolean $entities: When set to true, each tweet will include a node called "entities,". This node offers a variety of metadata about the tweet in a discreet structure, including: user_mentions, urls, and hashtags.

Inherited Methods

Inherited From JTwitterObject

JTwitterObject::__construct()
JTwitterObject::checkRateLimit()
JTwitterObject::fetchUrl()
JTwitterObject::getOption()
JTwitterObject::getRateLimit()
JTwitterObject::sendRequest()
JTwitterObject::setOption()