Class JTwitterStatuses

Description
Description | Vars | Methods (details)

Twitter API Statuses class for the Joomla Platform.

  • since: 12.3

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

JTwitterObject
   |
   --JTwitterStatuses
Method Summary
Description | Vars | Methods (details)
array deleteTweet (integer $id, [boolean $trim_user = null])
array getMentions ([integer $count = 20], [boolean $include_rts = null], [boolean $entities = null], [integer $since_id = 0], [integer $max_id = 0], [boolean $trim_user = null], [string $contributor = null])
array getOembed ([integer $id = null], [string $url = null], [integer $maxwidth = null], [boolean $hide_media = null], [boolean $hide_thread = null], [boolean $omit_script = null], [string $align = null], [string $related = null], [string $lang = null])
array getRetweeters (integer $id, [integer $count = 20], [integer $cursor = null], [boolean $stringify_ids = null])
array getRetweetsById (integer $id, [integer $count = 20], [boolean $trim_user = null])
array getRetweetsOfMe ([integer $count = 20], [integer $since_id = 0], [boolean $entities = null], [boolean $user_entities = null], [integer $max_id = 0], [boolean $trim_user = null])
array getTweetById (integer $id, [boolean $trim_user = null], [boolean $entities = null], [boolean $my_retweet = null])
array getUserTimeline (mixed $user, [integer $count = 20], [boolean $include_rts = null], [boolean $no_replies = null], [integer $since_id = 0], [integer $max_id = 0], [boolean $trim_user = null], [boolean $contributor = null])
array retweet (integer $id, [boolean $trim_user = null])
array tweet (string $status, [integer $in_reply_to_status_id = null], [float $lat = null], [float $long = null], [string $place_id = null], [boolean $display_coordinates = null], [boolean $trim_user = null])
array tweetWithMedia (string $status, string $media, [integer $in_reply_to_status_id = null], [float $lat = null], [float $long = null], [string $place_id = null], [boolean $display_coordinates = null], [boolean $sensitive = null])
Variables
Description | Vars (details) | Methods (details)

Inherited Variables

Inherited from JTwitterObject

JTwitterObject::$client
 JTwitterObject::$oauth
 JTwitterObject::$options
Methods
Description | Vars Methods (details)
deleteTweet (line 447)

Method to delete the status specified by the required ID parameter.

  • return: The decoded JSON response
  • since: 12.3
  • access: public
array deleteTweet (integer $id, [boolean $trim_user = null])
  • integer $id: The numerical ID of the desired status.
  • boolean $trim_user: When set to true, each tweet returned in a timeline will include a user object including only the status author's numerical ID.
getMentions (line 243)

Method to retrieve the most recent mentions for the authenticating user.

  • return: The decoded JSON response
  • since: 12.3
  • throws: RuntimeException
  • access: public
array getMentions ([integer $count = 20], [boolean $include_rts = null], [boolean $entities = null], [integer $since_id = 0], [integer $max_id = 0], [boolean $trim_user = null], [string $contributor = null])
  • 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
  • boolean $include_rts: When set to true, the timeline will contain native retweets in addition to the standard stream of tweets.
  • 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.
  • 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 $trim_user: When set to true, each tweet returned in a timeline will include a user object including only the status author's numerical ID.
  • string $contributor: This parameter enhances the contributors element of the status response to include the screen_name of the contributor.
getOembed (line 588)

Method to get information allowing the creation of an embedded representation of a Tweet on third party sites.

Note: either the id or url parameters must be specified in a request. It is not necessary to include both.

  • return: The decoded JSON response
  • since: 12.3
  • throws: RuntimeException
  • access: public
array getOembed ([integer $id = null], [string $url = null], [integer $maxwidth = null], [boolean $hide_media = null], [boolean $hide_thread = null], [boolean $omit_script = null], [string $align = null], [string $related = null], [string $lang = null])
  • integer $id: The Tweet/status ID to return embed code for.
  • string $url: The URL of the Tweet/status to be embedded.
  • integer $maxwidth: The maximum width in pixels that the embed should be rendered at. This value is constrained to be between 250 and 550 pixels.
  • boolean $hide_media: Specifies whether the embedded Tweet should automatically expand images which were uploaded via POST statuses/update_with_media.
  • boolean $hide_thread: Specifies whether the embedded Tweet should automatically show the original message in the case that the embedded Tweet is a reply.
  • boolean $omit_script: Specifies whether the embedded Tweet HTML should include a <script> element pointing to widgets.js. In cases where a page already includes widgets.js, setting this value to true will prevent a redundant script element from being included.
  • string $align: Specifies whether the embedded Tweet should be left aligned, right aligned, or centered in the page. Valid values are left, right, center, and none.
  • string $related: A value for the TWT related parameter, as described in Web Intents. This value will be forwarded to all Web Intents calls.
  • string $lang: Language code for the rendered embed. This will affect the text and localization of the rendered HTML.
getRetweeters (line 372)

Method to show user objects of up to 100 members who retweeted the status.

  • return: The decoded JSON response
  • since: 12.3
  • access: public
array getRetweeters (integer $id, [integer $count = 20], [integer $cursor = null], [boolean $stringify_ids = null])
  • integer $id: The numerical ID of the desired status.
  • integer $count: Specifies the number of retweets to try and retrieve, up to a maximum of 100.
  • integer $cursor: Causes the list of IDs to be broken into pages of no more than 100 IDs at a time. The number of IDs returned is not guaranteed to be 100 as suspended users are filtered out after connections are queried. If no cursor is provided, a value of -1 will be assumed, which is the first "page."
  • boolean $stringify_ids: Set to true to return IDs as strings, false to return as integers.
getRetweetsById (line 415)

Method to get up to 100 of the first retweets of a given tweet.

  • return: The decoded JSON response
  • since: 12.3
  • access: public
array getRetweetsById (integer $id, [integer $count = 20], [boolean $trim_user = null])
  • integer $id: The numerical ID of the desired status.
  • 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
  • boolean $trim_user: When set to true, each tweet returned in a timeline will include a user object including only the status author's numerical ID.
getRetweetsOfMe (line 312)

Method to get the most recent tweets of the authenticated user that have been retweeted by others.

  • return: The decoded JSON response
  • since: 12.3
  • access: public
array getRetweetsOfMe ([integer $count = 20], [integer $since_id = 0], [boolean $entities = null], [boolean $user_entities = null], [integer $max_id = 0], [boolean $trim_user = null])
  • 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.
  • 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.
  • boolean $user_entities: The user entities node will be disincluded when set to false.
  • integer $max_id: Returns results with an ID less than (that is, older than) the specified ID.
  • boolean $trim_user: When set to true, each tweet returned in a timeline will include a user object including only the status author's numerical ID.
getTweetById (line 36)

Method to get a single tweet with the given ID.

  • return: The decoded JSON response
  • since: 12.3
  • access: public
array getTweetById (integer $id, [boolean $trim_user = null], [boolean $entities = null], [boolean $my_retweet = null])
  • integer $id: The ID of the tweet to retrieve.
  • boolean $trim_user: When set to true, each tweet returned in a timeline will include a user object including only the status author's numerical 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.
  • boolean $my_retweet: When set to either true, t or 1, any statuses returned that have been retweeted by the authenticating user will include an additional current_user_retweet node, containing the ID of the source status for the retweet.
getUserTimeline (line 89)

Method to retrieve the latest statuses from the specified user timeline.

  • return: The decoded JSON response
  • since: 12.3
  • throws: RuntimeException
  • access: public
array getUserTimeline (mixed $user, [integer $count = 20], [boolean $include_rts = null], [boolean $no_replies = null], [integer $since_id = 0], [integer $max_id = 0], [boolean $trim_user = null], [boolean $contributor = 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
  • boolean $include_rts: When set to true, the timeline will contain native retweets in addition to the standard stream of tweets.
  • boolean $no_replies: This parameter will prevent replies from appearing in the returned timeline. This parameter is only supported for JSON and XML responses.
  • 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 $trim_user: When set to true, each tweet returned in a timeline will include a user object including only the status author's numerical ID.
  • boolean $contributor: This parameter enhances the contributors element of the status response to include the screen_name of the contributor. By default only the user_id of the contributor is included.
retweet (line 475)

Method to retweet a tweet.

  • return: The decoded JSON response
  • since: 12.3
  • access: public
array retweet (integer $id, [boolean $trim_user = null])
  • integer $id: The numerical ID of the desired status.
  • boolean $trim_user: When set to true, each tweet returned in a timeline will include a user object including only the status author's numerical ID.
tweet (line 174)

Method to post a tweet.

  • return: The decoded JSON response
  • since: 12.3
  • access: public
array tweet (string $status, [integer $in_reply_to_status_id = null], [float $lat = null], [float $long = null], [string $place_id = null], [boolean $display_coordinates = null], [boolean $trim_user = null])
  • string $status: The text of the tweet.
  • integer $in_reply_to_status_id: The ID of an existing status that the update is in reply to.
  • float $lat: The latitude of the location this tweet refers to.
  • float $long: The longitude of the location this tweet refers to.
  • string $place_id: A place in the world.
  • boolean $display_coordinates: Whether or not to put a pin on the exact coordinates a tweet has been sent from.
  • boolean $trim_user: When set to true, each tweet returned in a timeline will include a user object including only the status author's numerical ID.
tweetWithMedia (line 509)

Method to post a tweet with media.

  • return: The decoded JSON response
  • since: 12.3
  • throws: RuntimeException
  • access: public
array tweetWithMedia (string $status, string $media, [integer $in_reply_to_status_id = null], [float $lat = null], [float $long = null], [string $place_id = null], [boolean $display_coordinates = null], [boolean $sensitive = null])
  • string $status: The text of the tweet.
  • string $media: File to upload
  • integer $in_reply_to_status_id: The ID of an existing status that the update is in reply to.
  • float $lat: The latitude of the location this tweet refers to.
  • float $long: The longitude of the location this tweet refers to.
  • string $place_id: A place in the world.
  • boolean $display_coordinates: Whether or not to put a pin on the exact coordinates a tweet has been sent from.
  • boolean $sensitive: Set to true for content which may not be suitable for every audience.

Inherited Methods

Inherited From JTwitterObject

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

Documentation generated on Tue, 19 Nov 2013 15:14:20 +0100 by phpDocumentor 1.4.3