Class JTwitterBlock
Twitter API Block class for the Joomla Platform.
-
JTwitterObject
-
JTwitterBlock
Methods summary
public
array
|
#
getBlocking( boolean $stringify_ids = null, integer $cursor = null )
Method to get the user ids the authenticating user is blocking.
Method to get the user ids the authenticating user is blocking.
Parameters
- $stringify_ids
boolean - $stringify_ids Provide this option to have ids returned as strings instead.- $cursor
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." Returns
array - The decoded JSON response
Since
12.3
|
public
array
|
#
block( mixed $user, boolean $entities = null, boolean $skip_status = null )
Method to block the specified user from following the authenticating
user.
Method to block the specified user from following the authenticating
user.
Parameters
- $user
mixed - $user Either an integer containing the user ID or a string containing the screen
name.- $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.- $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
|
#
unblock( mixed $user, boolean $entities = null, boolean $skip_status = null )
Method to unblock the specified user from following the authenticating
user.
Method to unblock the specified user from following the authenticating
user.
Parameters
- $user
mixed - $user Either an integer containing the user ID or a string containing the screen
name.- $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.- $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
|
__construct(),
checkRateLimit(),
fetchUrl(),
getOption(),
getRateLimit(),
sendRequest(),
setOption()
Magic methods summary
Properties summary
$client,
$oauth,
$options
