Docs For Class JTwitterBlock

Description

Twitter API Block class for the Joomla Platform.

since: 12.3

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

JTwitterObject
   |
   --JTwitterBlock

Method Summary

array block (mixed $user, [boolean $entities = null], [boolean $skip_status = null])

array getBlocking ([boolean $stringify_ids = null], [integer $cursor = null])

array unblock (mixed $user, [boolean $entities = null], [boolean $skip_status = null])

Variables

Inherited Variables

Inherited from JTwitterObject

JTwitterObject::$client
JTwitterObject::$oauth
JTwitterObject::$options

Methods

block (line 72)

Method to block the specified user from following the authenticating user.

return: The decoded JSON response
since: 12.3
throws: RuntimeException
access: public

array block (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: 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.
boolean $skip_status: When set to either true, t or 1 statuses will not be included in the returned user objects.

getBlocking (line 33)

Method to get the user ids the authenticating user is blocking.

return: The decoded JSON response
since: 12.3
access: public

array getBlocking ([boolean $stringify_ids = null], [integer $cursor = null])

boolean $stringify_ids: Provide this option to have ids returned as strings instead.
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."

unblock (line 124)

Method to unblock the specified user from following the authenticating user.

return: The decoded JSON response
since: 12.3
throws: RuntimeException
access: public

array unblock (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: 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.
boolean $skip_status: When set to either true, t or 1 statuses will not be included in the returned user objects.

Inherited Methods

Inherited From JTwitterObject

JTwitterObject::__construct()
JTwitterObject::checkRateLimit()
JTwitterObject::fetchUrl()
JTwitterObject::getOption()
JTwitterObject::getRateLimit()
JTwitterObject::sendRequest()
JTwitterObject::setOption()