Class JTwitterStatuses

Twitter API Statuses class for the Joomla Platform.

JTwitterStatuses

Package: Joomla\Platform\Twitter
Deprecated: 4.0 Use the joomla/twitter package via Composer instead
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE
Since: 12.3
Located at joomla/twitter/statuses.php

Methods summary

`public array`	# `getTweetById( integer $id, boolean $trim_user = null, boolean $entities = null, boolean $my_retweet = null )` Method to get a single tweet with the given ID. Method to get a single tweet with the given ID. Parameters `$id` `integer` - $id The ID of the tweet to retrieve. `$trim_user` `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. `$entities` `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. `$my_retweet` `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. Returns `array` - The decoded JSON response Since 12.3
`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 )` Method to retrieve the latest statuses from the specified user timeline. Method to retrieve the latest statuses from the specified user timeline. Parameters `$user` `mixed` - $user Either an integer containing the user ID or a string containing the screen name. `$count` `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 `$include_rts` `boolean` - $include_rts When set to true, the timeline will contain native retweets in addition to the standard stream of tweets. `$no_replies` `boolean` - $no_replies This parameter will prevent replies from appearing in the returned timeline. This parameter is only supported for JSON and XML responses. `$since_id` `integer` - $since_id Returns results with an ID greater than (that is, more recent than) the specified ID. `$max_id` `integer` - $max_id Returns results with an ID less than (that is, older than) the specified ID. `$trim_user` `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. `$contributor` `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. Returns `array` - The decoded JSON response Throws `RuntimeException` Since 12.3
`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 )` Method to post a tweet. Method to post a tweet. Parameters `$status` `string` - $status The text of the tweet. `$in_reply_to_status_id` `integer` - $in_reply_to_status_id The ID of an existing status that the update is in reply to. `$lat` `float` - $lat The latitude of the location this tweet refers to. `$long` `float` - $long The longitude of the location this tweet refers to. `$place_id` `string` - $place_id A place in the world. `$display_coordinates` `boolean` - $display_coordinates Whether or not to put a pin on the exact coordinates a tweet has been sent from. `$trim_user` `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. Returns `array` - The decoded JSON response Since 12.3
`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 )` Method to retrieve the most recent mentions for the authenticating user. Method to retrieve the most recent mentions for the authenticating user. Parameters `$count` `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 `$include_rts` `boolean` - $include_rts When set to true, the timeline will contain native retweets in addition to the standard stream of tweets. `$entities` `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. `$since_id` `integer` - $since_id Returns results with an ID greater than (that is, more recent than) the specified ID. `$max_id` `integer` - $max_id Returns results with an ID less than (that is, older than) the specified ID. `$trim_user` `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. `$contributor` `string` - $contributor This parameter enhances the contributors element of the status response to include the screen_name of the contributor. Returns `array` - The decoded JSON response Throws `RuntimeException` Since 12.3
`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 )` Method to get the most recent tweets of the authenticated user that have been retweeted by others. Method to get the most recent tweets of the authenticated user that have been retweeted by others. Parameters `$count` `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 `$since_id` `integer` - $since_id Returns results with an ID greater than (that is, more recent than) the specified ID. `$entities` `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. `$user_entities` `boolean` - $user_entities The user entities node will be disincluded when set to false. `$max_id` `integer` - $max_id Returns results with an ID less than (that is, older than) the specified ID. `$trim_user` `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. Returns `array` - The decoded JSON response Since 12.3
`public array`	# `getRetweeters( integer $id, integer $count = 20, integer $cursor = null, boolean $stringify_ids = null )` Method to show user objects of up to 100 members who retweeted the status. Method to show user objects of up to 100 members who retweeted the status. Parameters `$id` `integer` - $id The numerical ID of the desired status. `$count` `integer` - $count Specifies the number of retweets to try and retrieve, up to a maximum of 100. `$cursor` `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." `$stringify_ids` `boolean` - $stringify_ids Set to true to return IDs as strings, false to return as integers. Returns `array` - The decoded JSON response Since 12.3
`public array`	# `getRetweetsById( integer $id, integer $count = 20, boolean $trim_user = null )` Method to get up to 100 of the first retweets of a given tweet. Method to get up to 100 of the first retweets of a given tweet. Parameters `$id` `integer` - $id The numerical ID of the desired status. `$count` `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 `$trim_user` `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. Returns `array` - The decoded JSON response Since 12.3
`public array`	# `deleteTweet( integer $id, boolean $trim_user = null )` Method to delete the status specified by the required ID parameter. Method to delete the status specified by the required ID parameter. Parameters `$id` `integer` - $id The numerical ID of the desired status. `$trim_user` `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. Returns `array` - The decoded JSON response Since 12.3
`public array`	# `retweet( integer $id, boolean $trim_user = null )` Method to retweet a tweet. Method to retweet a tweet. Parameters `$id` `integer` - $id The numerical ID of the desired status. `$trim_user` `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. Returns `array` - The decoded JSON response Since 12.3
`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 )` Method to post a tweet with media. Method to post a tweet with media. Parameters `$status` `string` - $status The text of the tweet. `$media` `string` - $media File to upload `$in_reply_to_status_id` `integer` - $in_reply_to_status_id The ID of an existing status that the update is in reply to. `$lat` `float` - $lat The latitude of the location this tweet refers to. `$long` `float` - $long The longitude of the location this tweet refers to. `$place_id` `string` - $place_id A place in the world. `$display_coordinates` `boolean` - $display_coordinates Whether or not to put a pin on the exact coordinates a tweet has been sent from. `$sensitive` `boolean` - $sensitive Set to true for content which may not be suitable for every audience. Returns `array` - The decoded JSON response Throws `RuntimeException` Since 12.3
`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 )` 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. 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. Parameters `$id` `integer` - $id The Tweet/status ID to return embed code for. `$url` `string` - $url The URL of the Tweet/status to be embedded. `$maxwidth` `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. `$hide_media` `boolean` - $hide_media Specifies whether the embedded Tweet should automatically expand images which were uploaded via POST statuses/update_with_media. `$hide_thread` `boolean` - $hide_thread Specifies whether the embedded Tweet should automatically show the original message in the case that the embedded Tweet is a reply. `$omit_script` `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. `$align` `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. `$related` `string` - $related A value for the TWT related parameter, as described in Web Intents. This value will be forwarded to all Web Intents calls. `$lang` `string` - $lang Language code for the rendered embed. This will affect the text and localization of the rendered HTML. Returns `array` - The decoded JSON response Throws `RuntimeException` Since 12.3

Methods inherited from JTwitterObject

__construct(), checkRateLimit(), fetchUrl(), getOption(), getRateLimit(), sendRequest(), setOption()

Magic methods summary

Properties summary

Properties inherited from JTwitterObject

$client, $oauth, $options

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JTwitterStatuses

Methods summary

Parameters

Returns

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Methods inherited from JTwitterObject

Magic methods summary

Properties summary

Properties inherited from JTwitterObject