Class JTwitterUsers
Twitter API Users class for the Joomla Platform.
-
JTwitterObject
-
JTwitterUsers
Methods summary
public
array
|
#
getUsersLookup( string $screen_name = null, string $id = null, boolean $entities = null )
Method to get up to 100 users worth of extended information, specified by
either ID, screen name, or combination of the two.
Method to get up to 100 users worth of extended information, specified by
either ID, screen name, or combination of the two.
Parameters
- $screen_name
string - $screen_name A comma separated list of screen names, up to 100 are allowed in a
single request.- $id
string - $id A comma separated list of user IDs, up to 100 are allowed in a single
request.- $entities
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. Returns
array - The decoded JSON response
Throws
Since
12.3
|
public
array
|
#
getUserProfileBanner( mixed $user )
Method to access the profile banner in various sizes for the user with the
indicated screen_name.
Method to access the profile banner in various sizes for the user with the
indicated screen_name.
Parameters
- $user
mixed - $user Either an integer containing the user ID or a string containing the screen
name. Returns
array - The decoded JSON response
Since
12.3
|
public
array
|
#
searchUsers( string $query, integer $page = 0, integer $count = 0, boolean $entities = null )
Method used to search for users
Method used to search for users
Parameters
- $query
string - $query The search query to run against people search.- $page
integer - $page Specifies the page of results to retrieve.- $count
integer - $count The number of people to retrieve. Maximum of 20 allowed per page.- $entities
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. Returns
array - The decoded JSON response
Throws
Since
12.3
|
public
array
|
#
getUser( mixed $user, boolean $entities = null )
Method to get extended information of a given user, specified by ID or screen
name as per the required id parameter.
Method to get extended information of a given user, specified by ID or screen
name as per the required id parameter.
Parameters
- $user
mixed - $user Either an integer containing the user ID or a string containing the screen
name.- $entities
boolean - $entities Set to true to return IDs as strings, false to return as integers. Returns
array - The decoded JSON response
Throws
Since
12.3
|
public
array
|
#
getContributees( mixed $user, boolean $entities = null, boolean $skip_status = null )
Method to get an array of users that the specified user can contribute
to.
Method to get an array of users that the specified user can contribute
to.
Parameters
- $user
mixed - $user Either an integer containing the user ID or a string containing the screen
name.- $entities
boolean - $entities Set to true to return IDs as strings, false to return as integers.- $skip_status
boolean - $skip_status When set to either true, t or 1 statuses will not be included in
the returned user objects. Returns
array - The decoded JSON response
Throws
Since
12.3
|
public
array
|
#
getContributors( mixed $user, boolean $entities = null, boolean $skip_status = null )
Method to get an array of users who can contribute to the specified
account.
Method to get an array of users who can contribute to the specified
account.
Parameters
- $user
mixed - $user Either an integer containing the user ID or a string containing the screen
name.- $entities
boolean - $entities Set to true to return IDs as strings, false to return as integers.- $skip_status
boolean - $skip_status When set to either true, t or 1 statuses will not be included in
the returned user objects. Returns
array - The decoded JSON response
Throws
Since
12.3
|
public
array
|
#
getSuggestions( boolean $lang = null )
Method access to Twitter's suggested user list.
Method access to Twitter's suggested user list.
Parameters
- $lang
boolean - $lang Restricts the suggested categories to the requested language. Returns
array - The decoded JSON response
Since
12.3
|
public
array
|
#
getSuggestionsSlug( string $slug, boolean $lang = null )
method to access the users in a given category of the Twitter suggested user
list.
method to access the users in a given category of the Twitter suggested user
list.
Parameters
- $slug
string - $slug The short name of list or a category.- $lang
boolean - $lang Restricts the suggested categories to the requested language. Returns
array - The decoded JSON response
Since
12.3
|
public
array
|
#
getSuggestionsSlugMembers( string $slug )
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.
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.
Parameters
- $slug
string - $slug The short name of list or a category. Returns
array - The decoded JSON response
Since
12.3
|
__construct(),
checkRateLimit(),
fetchUrl(),
getOption(),
getRateLimit(),
sendRequest(),
setOption()
Magic methods summary
Properties summary
$client,
$oauth,
$options
