Class JTwitterFriends

Description
Description | Vars | Methods (details)

Twitter API Friends class for the Joomla Platform.

  • since: 12.3

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

JTwitterObject
   |
   --JTwitterFriends
Method Summary
Description | Vars | Methods (details)
array follow (mixed $user, [boolean $follow = false])
array getFollowerIds (mixed $user, [integer $cursor = null], [boolean $string_ids = null], [integer $count = 0])
array getFriendIds (mixed $user, [integer $cursor = null], [boolean $string_ids = null], [integer $count = 0])
array getFriendshipDetails (mixed $user_a, mixed $user_b)
array getFriendshipNoRetweetIds ([boolean $string_ids = null])
array getFriendshipsIncoming ([integer $cursor = null], [boolean $string_ids = null])
array getFriendshipsLookup ([string $screen_name = null], [string $id = null])
array getFriendshipsOutgoing ([integer $cursor = null], [boolean $string_ids = null])
array unfollow (mixed $user)
array updateFriendship (mixed $user, [boolean $device = null], [boolean $retweets = null])
Variables
Description | Vars (details) | Methods (details)

Inherited Variables

Inherited from JTwitterObject

JTwitterObject::$client
 JTwitterObject::$oauth
 JTwitterObject::$options
Methods
Description | Vars Methods (details)
follow (line 281)

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

  • return: The decoded JSON response
  • since: 12.3
  • throws: RuntimeException
  • access: public
array follow (mixed $user, [boolean $follow = false])
  • mixed $user: Either an integer containing the user ID or a string containing the screen name.
  • boolean $follow: Enable notifications for the target user.
getFollowerIds (line 149)

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

  • return: The decoded JSON response
  • since: 12.3
  • throws: RuntimeException
  • access: public
array getFollowerIds (mixed $user, [integer $cursor = null], [boolean $string_ids = null], [integer $count = 0])
  • 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 $string_ids: 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.
getFriendIds (line 36)

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

  • return: The decoded JSON response
  • since: 12.3
  • throws: RuntimeException
  • access: public
array getFriendIds (mixed $user, [integer $cursor = null], [boolean $string_ids = null], [integer $count = 0])
  • 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 $string_ids: 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.
getFriendshipDetails (line 92)

Method to display detailed friend information between two users.

  • return: The decoded JSON response
  • since: 12.3
  • throws: RuntimeException
  • access: public
array getFriendshipDetails (mixed $user_a, mixed $user_b)
  • mixed $user_a: Either an integer containing the user ID or a string containing the screen name of the first user.
  • mixed $user_b: Either an integer containing the user ID or a string containing the screen name of the second user.
getFriendshipNoRetweetIds (line 440)

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

  • return: The decoded JSON response
  • since: 12.3
  • access: public
array getFriendshipNoRetweetIds ([boolean $string_ids = null])
  • boolean $string_ids: Set to true to return IDs as strings, false to return as integers.
getFriendshipsIncoming (line 206)

Method to determine pending requests to follow the authenticating user.

  • return: The decoded JSON response
  • since: 12.3
  • access: public
array getFriendshipsIncoming ([integer $cursor = null], [boolean $string_ids = null])
  • 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 $string_ids: Set to true to return IDs as strings, false to return as integers.
getFriendshipsLookup (line 356)

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

  • return: The decoded JSON response
  • since: 12.3
  • throws: RuntimeException
  • access: public
array getFriendshipsLookup ([string $screen_name = null], [string $id = null])
  • string $screen_name: 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.
getFriendshipsOutgoing (line 244)

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

  • return: The decoded JSON response
  • since: 12.3
  • access: public
array getFriendshipsOutgoing ([integer $cursor = null], [boolean $string_ids = null])
  • 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 $string_ids: Set to true to return IDs as strings, false to return as integers.
unfollow (line 321)

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

  • return: The decoded JSON response
  • since: 12.3
  • throws: RuntimeException
  • access: public
array unfollow (mixed $user)
  • mixed $user: Either an integer containing the user ID or a string containing the screen name.
updateFriendship (line 395)

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

  • return: The decoded JSON response
  • since: 12.3
  • throws: RuntimeException
  • access: public
array updateFriendship (mixed $user, [boolean $device = null], [boolean $retweets = null])
  • 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.

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:03:48 +0100 by phpDocumentor 1.4.3