Graphe d'héritage de JTwitterFriends:

Fonctions membres publiques
	getFriendIds ($user, $cursor=null, $stringIds=null, $count=0)

	getFriendshipDetails ($userA, $userB)

	getFollowerIds ($user, $cursor=null, $stringIds=null, $count=0)

	getFriendshipsIncoming ($cursor=null, $stringIds=null)

	getFriendshipsOutgoing ($cursor=null, $stringIds=null)

	follow ($user, $follow=false)

	unfollow ($user)

	getFriendshipsLookup ($screenName=null, $id=null)

	updateFriendship ($user, $device=null, $retweets=null)

	getFriendshipNoRetweetIds ($stringIds=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 Friends 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

◆ follow()

follow	(	$user,
		$follow = `false`
	)

Allows the authenticating users to follow the user specified in the ID parameter.

Paramètres

mixed	$user	Either an integer containing the user ID or a string containing the screen name.
boolean	$follow	Enable notifications for the target user.

Renvoie: array The decoded JSON response

Depuis: 3.1.4

Exceptions

RuntimeException

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

◆ getFollowerIds()

getFollowerIds	(	$user,
		$cursor = `null`,
		$stringIds = `null`,
		$count = `0`
	)

Method to get an array of user IDs the specified user is followed by.

Paramètres

mixed	$user	Either an integer containing the user ID or a string containing the screen name.
integer	$cursor	Causes the list of IDs to be broken into pages of no more than 5000 IDs at a time. The number of IDs returned is not guaranteed to be 5000 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	$stringIds	Set to true to return IDs as strings, false to return as integers.
integer	$count	Specifies the number of IDs attempt retrieval of, up to a maximum of 5,000 per distinct request.

Renvoie: array The decoded JSON response

Depuis: 3.1.4

Exceptions

RuntimeException

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

◆ getFriendIds()

getFriendIds	(	$user,
		$cursor = `null`,
		$stringIds = `null`,
		$count = `0`
	)

Method to get an array of user IDs the specified user follows.

Paramètres

mixed	$user	Either an integer containing the user ID or a string containing the screen name.
integer	$cursor	Causes the list of connections to be broken into pages of no more than 5000 IDs at a time. The number of IDs returned is not guaranteed to be 5000 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	$stringIds	Set to true to return IDs as strings, false to return as integers.
integer	$count	Specifies the number of IDs attempt retrieval of, up to a maximum of 5,000 per distinct request.

Renvoie: array The decoded JSON response

Depuis: 3.1.4

Exceptions

RuntimeException

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

◆ getFriendshipDetails()

getFriendshipDetails	(	$userA,
		$userB
	)

Method to display detailed friend information between two users.

Paramètres

mixed	$userA	Either an integer containing the user ID or a string containing the screen name of the first user.
mixed	$userB	Either an integer containing the user ID or a string containing the screen name of the second user.

Renvoie: array The decoded JSON response

Depuis: 3.1.4

Exceptions

RuntimeException

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

◆ getFriendshipNoRetweetIds()

getFriendshipNoRetweetIds ( $stringIds = null )

Method to get the user ids that currently authenticated user does not want to see retweets from.

Paramètres

boolean $stringIds 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 $data, et $path.

◆ getFriendshipsIncoming()

getFriendshipsIncoming	(	$cursor = `null`,
		$stringIds = `null`
	)

Method to determine pending requests to follow the authenticating user.

Paramètres

integer	$cursor	Causes the list of IDs to be broken into pages of no more than 5000 IDs at a time. The number of IDs returned is not guaranteed to be 5000 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	$stringIds	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 $data, et $path.

◆ getFriendshipsLookup()

getFriendshipsLookup	(	$screenName = `null`,
		$id = `null`
	)

Method to get the relationship of the authenticating user to the comma separated list of up to 100 screen_names or user_ids provided.

Paramètres

string	$screenName	A comma separated list of screen names, up to 100 are allowed in a single request.
string	$id	A comma separated list of user IDs, up to 100 are allowed in a single request.

Renvoie: array The decoded JSON response

Depuis: 3.1.4

Exceptions

RuntimeException

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

◆ getFriendshipsOutgoing()

getFriendshipsOutgoing	(	$cursor = `null`,
		$stringIds = `null`
	)

Method to determine every protected user for whom the authenticating user has a pending follow request.

Paramètres

integer	$cursor	Causes the list of IDs to be broken into pages of no more than 5000 IDs at a time. The number of IDs returned is not guaranteed to be 5000 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	$stringIds	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 $data, et $path.

◆ unfollow()

unfollow ( $user )

Allows the authenticating users to unfollow the user specified in the ID parameter.

Paramètres

mixed $user Either an integer containing the user ID or a string containing the screen name.

Renvoie: array The decoded JSON response

Depuis: 3.1.4

Exceptions

RuntimeException

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

◆ updateFriendship()

updateFriendship	(	$user,
		$device = `null`,
		$retweets = `null`
	)

Allows one to enable or disable retweets and device notifications from the specified user.

Paramètres

mixed	$user	Either an integer containing the user ID or a string containing the screen name.
boolean	$device	Enable/disable device notifications from the target user.
boolean	$retweets	Enable/disable retweets from the target user.

Renvoie: array The decoded JSON response

Depuis: 3.1.4

Exceptions

RuntimeException

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

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

friends.php

Fonctions membres publiques

Membres hérités additionnels

Description détaillée

Documentation des fonctions membres

◆ follow()

◆ getFollowerIds()

◆ getFriendIds()

◆ getFriendshipDetails()

◆ getFriendshipNoRetweetIds()

◆ getFriendshipsIncoming()

◆ getFriendshipsLookup()

◆ getFriendshipsOutgoing()

◆ unfollow()

◆ updateFriendship()