Class JTwitterUsers

Description
Description | Vars | Methods (details)

Twitter API Users class for the Joomla Platform.

  • since: 12.3

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

JTwitterObject
   |
   --JTwitterUsers
Method Summary
Description | Vars | Methods (details)
array getContributees (mixed $user, [boolean $entities = null], [boolean $skip_status = null])
array getContributors (mixed $user, [boolean $entities = null], [boolean $skip_status = null])
array getSuggestions ([boolean $lang = null])
array getSuggestionsSlug (string $slug, [boolean $lang = null])
array getSuggestionsSlugMembers (string $slug)
array getUser (mixed $user, [boolean $entities = null])
array getUserProfileBanner (mixed $user)
array getUsersLookup ([string $screen_name = null], [string $id = null], [boolean $entities = null])
array searchUsers (string $query, [integer $page = 0], [integer $count = 0], [boolean $entities = null])
Variables
Description | Vars (details) | Methods (details)

Inherited Variables

Inherited from JTwitterObject

JTwitterObject::$client
 JTwitterObject::$oauth
 JTwitterObject::$options
Methods
Description | Vars Methods (details)
getContributees (line 205)

Method to get an array of users that the specified user can contribute to.

  • return: The decoded JSON response
  • since: 12.3
  • throws: RuntimeException
  • access: public
array getContributees (mixed $user, [boolean $entities = null], [boolean $skip_status = null])
  • mixed $user: Either an integer containing the user ID or a string containing the screen name.
  • boolean $entities: Set to true to return IDs as strings, false to return as integers.
  • boolean $skip_status: When set to either true, t or 1 statuses will not be included in the returned user objects.
getContributors (line 256)

Method to get an array of users who can contribute to the specified account.

  • return: The decoded JSON response
  • since: 12.3
  • throws: RuntimeException
  • access: public
array getContributors (mixed $user, [boolean $entities = null], [boolean $skip_status = null])
  • mixed $user: Either an integer containing the user ID or a string containing the screen name.
  • boolean $entities: Set to true to return IDs as strings, false to return as integers.
  • boolean $skip_status: When set to either true, t or 1 statuses will not be included in the returned user objects.
getSuggestions (line 304)

Method access to Twitter's suggested user list.

  • return: The decoded JSON response
  • since: 12.3
  • access: public
array getSuggestions ([boolean $lang = null])
  • boolean $lang: Restricts the suggested categories to the requested language.
getSuggestionsSlug (line 334)

method to access the users in a given category of the Twitter suggested user list.

  • return: The decoded JSON response
  • since: 12.3
  • access: public
array getSuggestionsSlug (string $slug, [boolean $lang = null])
  • string $slug: The short name of list or a category.
  • boolean $lang: Restricts the suggested categories to the requested language.
getSuggestionsSlugMembers (line 364)

Method to access the users in a given category of the Twitter suggested user list and return their most recent status if they are not a protected user.

  • return: The decoded JSON response
  • since: 12.3
  • access: public
array getSuggestionsSlugMembers (string $slug)
  • string $slug: The short name of list or a category.
getUser (line 160)

Method to get extended information of a given user, specified by ID or screen name as per the required id parameter.

  • return: The decoded JSON response
  • since: 12.3
  • throws: RuntimeException
  • access: public
array getUser (mixed $user, [boolean $entities = null])
  • mixed $user: Either an integer containing the user ID or a string containing the screen name.
  • boolean $entities: Set to true to return IDs as strings, false to return as integers.
getUserProfileBanner (line 76)

Method to access the profile banner in various sizes for the user with the indicated screen_name.

  • return: The decoded JSON response
  • since: 12.3
  • access: public
array getUserProfileBanner (mixed $user)
  • mixed $user: Either an integer containing the user ID or a string containing the screen name.
getUsersLookup (line 34)

Method to get up to 100 users worth of extended information, specified by either ID, screen name, or combination of the two.

  • return: The decoded JSON response
  • since: 12.3
  • throws: RuntimeException
  • access: public
array getUsersLookup ([string $screen_name = null], [string $id = null], [boolean $entities = 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.
  • boolean $entities: When set to either true, t or 1, 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.
searchUsers (line 117)

Method used to search for users

  • return: The decoded JSON response
  • since: 12.3
  • throws: RuntimeException
  • access: public
array searchUsers (string $query, [integer $page = 0], [integer $count = 0], [boolean $entities = null])
  • string $query: The search query to run against people search.
  • integer $page: Specifies the page of results to retrieve.
  • integer $count: The number of people to retrieve. Maximum of 20 allowed per page.
  • boolean $entities: When set to either true, t or 1, 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.

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:16:41 +0100 by phpDocumentor 1.4.3