Graphe d'héritage de JTwitterStatuses:

Fonctions membres publiques
	getTweetById ($id, $trimUser=null, $entities=null, $myRetweet=null)

	getUserTimeline ($user, $count=20, $includeRts=null, $noReplies=null, $sinceId=0, $maxId=0, $trimUser=null, $contributor=null)

	tweet ($status, $inReplyToStatusId=null, $lat=null, $long=null, $placeId=null, $displayCoordinates=null, $trimUser=null)

	getMentions ($count=20, $includeRts=null, $entities=null, $sinceId=0, $maxId=0, $trimUser=null, $contributor=null)

	getRetweetsOfMe ($count=20, $sinceId=0, $entities=null, $userEntities=null, $maxId=0, $trimUser=null)

	getRetweeters ($id, $count=20, $cursor=null, $stringifyIds=null)

	getRetweetsById ($id, $count=20, $trimUser=null)

	deleteTweet ($id, $trimUser=null)

	retweet ($id, $trimUser=null)

	tweetWithMedia ($status, $media, $inReplyToStatusId=null, $lat=null, $long=null, $placeId=null, $displayCoordinates=null, $sensitive=null)

	getOembed ($id=null, $url=null, $maxWidth=null, $hideMedia=null, $hideThread=null, $omitScript=null, $align=null, $related=null, $lang=null)

Fonctions membres publiques hérités de JTwitterObject
	__construct (Registry &$options=null, JHttp $client=null, JTwitterOAuth $oauth=null)

	checkRateLimit ($resource=null, $action=null)

	fetchUrl ($path, $parameters=null)

	getRateLimit ($resource)

	sendRequest ($path, $method='GET', $data=array(), $headers=array())

	getOption ($key)

	setOption ($key, $value)

Membres hérités additionnels
Attributs protégés hérités de JTwitterObject
	$options

	$client

	$oauth

Description détaillée

Twitter API Statuses class for the Joomla Platform.

Depuis: 3.1.4

Obsolète:: 4.0 Use the joomla/twitter package via Composer instead

Documentation des fonctions membres

◆ deleteTweet()

deleteTweet	(	$id,
		$trimUser = `null`
	)

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

Paramètres

integer	$id	The numerical ID of the desired status.
boolean	$trimUser	When set to true, each tweet returned in a timeline will include a user object including only the status author's numerical ID.

Renvoie: array The decoded JSON response

Depuis: 3.1.4

Références $data, $id, et $path.

◆ getMentions()

getMentions	(	$count = `20`,
		$includeRts = `null`,
		$entities = `null`,
		$sinceId = `0`,
		$maxId = `0`,
		$trimUser = `null`,
		$contributor = `null`
	)

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

Paramètres

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 $includeRts to true
boolean	$includeRts	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	$sinceId	Returns results with an ID greater than (that is, more recent than) the specified ID.
integer	$maxId	Returns results with an ID less than (that is, older than) the specified ID.
boolean	$trimUser	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.

Renvoie: array The decoded JSON response

Depuis: 3.1.4

Exceptions

RuntimeException

Références $count, $data, et $path.

◆ getOembed()

getOembed	(	$id = `null`,
		$url = `null`,
		$maxWidth = `null`,
		$hideMedia = `null`,
		$hideThread = `null`,
		$omitScript = `null`,
		$align = `null`,
		$related = `null`,
		$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.

Paramètres

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	$hideMedia	Specifies whether the embedded Tweet should automatically expand images which were uploaded via POST statuses/update_with_media.
boolean	$hideThread	Specifies whether the embedded Tweet should automatically show the original message in the case that the embedded Tweet is a reply.
boolean	$omitScript	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.

Renvoie: array The decoded JSON response

Depuis: 3.1.4

Exceptions

RuntimeException

Références $data, $id, $lang, $path, $url, et elseif.

◆ getRetweeters()

getRetweeters	(	$id,
		$count = `20`,
		$cursor = `null`,
		$stringifyIds = `null`
	)

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

Paramètres

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	$stringifyIds	Set to true to return IDs as strings, false to return as integers.

Renvoie: array The decoded JSON response

Depuis: 3.1.4

Références $count, $data, $id, et $path.

◆ getRetweetsById()

getRetweetsById	(	$id,
		$count = `20`,
		$trimUser = `null`
	)

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

Paramètres

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 $includeRts to true
boolean	$trimUser	When set to true, each tweet returned in a timeline will include a user object including only the status author's numerical ID.

Renvoie: array The decoded JSON response

Depuis: 3.1.4

Références $count, $data, $id, et $path.

◆ getRetweetsOfMe()

getRetweetsOfMe	(	$count = `20`,
		$sinceId = `0`,
		$entities = `null`,
		$userEntities = `null`,
		$maxId = `0`,
		$trimUser = `null`
	)

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

Paramètres

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 $includeRts to true
integer	$sinceId	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	$userEntities	The user entities node will be disincluded when set to false.
integer	$maxId	Returns results with an ID less than (that is, older than) the specified ID.
boolean	$trimUser	When set to true, each tweet returned in a timeline will include a user object including only the status author's numerical ID.

Renvoie: array The decoded JSON response

Depuis: 3.1.4

Références $count, $data, et $path.

◆ getTweetById()

getTweetById	(	$id,
		$trimUser = `null`,
		$entities = `null`,
		$myRetweet = `null`
	)

Method to get a single tweet with the given ID.

Paramètres

integer	$id	The ID of the tweet to retrieve.
boolean	$trimUser	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	$myRetweet	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.

Renvoie: array The decoded JSON response

Depuis: 3.1.4

Références $data, $id, et $path.

◆ getUserTimeline()

getUserTimeline	(	$user,
		$count = `20`,
		$includeRts = `null`,
		$noReplies = `null`,
		$sinceId = `0`,
		$maxId = `0`,
		$trimUser = `null`,
		$contributor = `null`
	)

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

Paramètres

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 $includeRts to true
boolean	$includeRts	When set to true, the timeline will contain native retweets in addition to the standard stream of tweets.
boolean	$noReplies	This parameter will prevent replies from appearing in the returned timeline. This parameter is only supported for JSON and XML responses.
integer	$sinceId	Returns results with an ID greater than (that is, more recent than) the specified ID.
integer	$maxId	Returns results with an ID less than (that is, older than) the specified ID.
boolean	$trimUser	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.

Renvoie: array The decoded JSON response

Depuis: 3.1.4

Exceptions

RuntimeException

Références $count, $data, $path, $user, et elseif.

◆ retweet()

retweet	(	$id,
		$trimUser = `null`
	)

Method to retweet a tweet.

Paramètres

integer	$id	The numerical ID of the desired status.
boolean	$trimUser	When set to true, each tweet returned in a timeline will include a user object including only the status author's numerical ID.

Renvoie: array The decoded JSON response

Depuis: 3.1.4

Références $data, $id, et $path.

◆ tweet()

tweet	(	$status,
		$inReplyToStatusId = `null`,
		$lat = `null`,
		$long = `null`,
		$placeId = `null`,
		$displayCoordinates = `null`,
		$trimUser = `null`
	)

Method to post a tweet.

Paramètres

string	$status	The text of the tweet.
integer	$inReplyToStatusId	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	$placeId	A place in the world.
boolean	$displayCoordinates	Whether or not to put a pin on the exact coordinates a tweet has been sent from.
boolean	$trimUser	When set to true, each tweet returned in a timeline will include a user object including only the status author's numerical ID.

Renvoie: array The decoded JSON response

Depuis: 3.1.4

Références $data, et $path.

◆ tweetWithMedia()

tweetWithMedia	(	$status,
		$media,
		$inReplyToStatusId = `null`,
		$lat = `null`,
		$long = `null`,
		$placeId = `null`,
		$displayCoordinates = `null`,
		$sensitive = `null`
	)

Method to post a tweet with media.

Paramètres

string	$status	The text of the tweet.
string	$media	File to upload
integer	$inReplyToStatusId	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	$placeId	A place in the world.
boolean	$displayCoordinates	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.

Renvoie: array The decoded JSON response

Depuis: 3.1.4

Exceptions

RuntimeException

Références $data, et $path.

La documentation de cette classe a été générée à partir du fichier suivant :

twitter/statuses.php

Fonctions membres publiques

Membres hérités additionnels

Description détaillée

Documentation des fonctions membres

◆ deleteTweet()

◆ getMentions()

◆ getOembed()

◆ getRetweeters()

◆ getRetweetsById()

◆ getRetweetsOfMe()

◆ getTweetById()

◆ getUserTimeline()

◆ retweet()

◆ tweet()

◆ tweetWithMedia()