Class JTwitterLists

Description
Description | Vars | Methods (details)

Twitter API Lists class for the Joomla Platform.

  • since: 12.3

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

JTwitterObject
   |
   --JTwitterLists
Method Summary
Description | Vars | Methods (details)
array addMembers (mixed $list, [string $user_id = null], [string $screen_name = null], [mixed $owner = null])
array create (string $name, [string $mode = null], [string $description = null])
array delete (mixed $list, [mixed $owner = null])
array deleteMembers (mixed $list, [string $user_id = null], [string $screen_name = null], [mixed $owner = null])
array getListById (mixed $list, [mixed $owner = null])
array getLists (mixed $user, [boolean $reverse = null])
array getMembers (mixed $list, [mixed $owner = null], [boolean $entities = null], [boolean $skip_status = null])
array getStatuses (mixed $list, [mixed $owner = null], [integer $since_id = 0], [integer $max_id = 0], [integer $count = 0], [boolean $entities = null], [boolean $include_rts = null])
array getSubscribers (mixed $list, [mixed $owner = null], [integer $cursor = null], [boolean $entities = null], [boolean $skip_status = null])
array getSubscriptions (mixed $user, [integer $count = 0], [integer $cursor = null])
array isMember (mixed $list, mixed $user, [mixed $owner = null], [boolean $entities = null], [boolean $skip_status = null])
array isSubscriber (mixed $list, mixed $user, [mixed $owner = null], [boolean $entities = null], [boolean $skip_status = null])
array subscribe (mixed $list, [mixed $owner = null])
array unsubscribe (mixed $list, [mixed $owner = null])
array update (mixed $list, [mixed $owner = null], [string $name = null], [string $mode = null], [string $description = null])
Variables
Description | Vars (details) | Methods (details)

Inherited Variables

Inherited from JTwitterObject

JTwitterObject::$client
 JTwitterObject::$oauth
 JTwitterObject::$options
Methods
Description | Vars Methods (details)
addMembers (line 584)

Method to add multiple members to a list, by specifying a comma-separated list of member ids or screen names.

  • return: The decoded JSON response
  • since: 12.3
  • throws: RuntimeException
  • access: public
array addMembers (mixed $list, [string $user_id = null], [string $screen_name = null], [mixed $owner = null])
  • mixed $list: Either an integer containing the list ID or a string containing the list slug.
  • string $user_id: A comma separated list of user IDs, up to 100 are allowed in a single request.
  • string $screen_name: A comma separated list of screen names, up to 100 are allowed in a single request.
  • mixed $owner: Either an integer containing the user ID or a string containing the screen name of the owner.
create (line 900)

Method to create a new list for the authenticated user.

  • return: The decoded JSON response
  • since: 12.3
  • access: public
array create (string $name, [string $mode = null], [string $description = null])
  • string $name: The name of the list.
  • string $mode: Whether your list is public or private. Values can be public or private. If no mode is specified the list will be public.
  • string $description: The description to give the list.
delete (line 941)

Method to delete a specified list.

  • return: The decoded JSON response
  • since: 12.3
  • throws: RuntimeException
  • access: public
array delete (mixed $list, [mixed $owner = null])
  • mixed $list: Either an integer containing the list ID or a string containing the list slug.
  • mixed $owner: Either an integer containing the user ID or a string containing the screen name of the owner.
deleteMembers (line 246)

Method to remove multiple members from a list, by specifying a comma-separated list of member ids or screen names.

  • return: The decoded JSON response
  • since: 12.3
  • throws: RuntimeException
  • access: public
array deleteMembers (mixed $list, [string $user_id = null], [string $screen_name = null], [mixed $owner = null])
  • mixed $list: Either an integer containing the list ID or a string containing the list slug.
  • string $user_id: A comma separated list of user IDs, up to 100 are allowed in a single request.
  • string $screen_name: A comma separated list of screen names, up to 100 are allowed in a single request.
  • mixed $owner: Either an integer containing the user ID or a string containing the screen name of the owner.
getListById (line 720)

Method to get the specified list.

  • return: The decoded JSON response
  • since: 12.3
  • throws: RuntimeException
  • access: public
array getListById (mixed $list, [mixed $owner = null])
  • mixed $list: Either an integer containing the list ID or a string containing the list slug.
  • mixed $owner: Either an integer containing the user ID or a string containing the screen name.
getLists (line 33)

Method to get all lists the authenticating or specified user subscribes to, including their own.

  • return: The decoded JSON response
  • since: 12.3
  • throws: RuntimeException
  • access: public
array getLists (mixed $user, [boolean $reverse = null])
  • mixed $user: Either an integer containing the user ID or a string containing the screen name.
  • boolean $reverse: Set this to true if you would like owned lists to be returned first. See description above for information on how this parameter works.
getMembers (line 654)

Method to get the members of the specified list.

  • return: The decoded JSON response
  • since: 12.3
  • throws: RuntimeException
  • access: public
array getMembers (mixed $list, [mixed $owner = null], [boolean $entities = null], [boolean $skip_status = null])
  • mixed $list: Either an integer containing the list ID or a string containing the list slug.
  • mixed $owner: 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.
getStatuses (line 84)

Method to get tweet timeline for members of the specified list

  • return: The decoded JSON response
  • since: 12.3
  • throws: RuntimeException
  • access: public
array getStatuses (mixed $list, [mixed $owner = null], [integer $since_id = 0], [integer $max_id = 0], [integer $count = 0], [boolean $entities = null], [boolean $include_rts = null])
  • mixed $list: Either an integer containing the list ID or a string containing the list slug.
  • mixed $owner: Either an integer containing the user ID or a string containing the screen name.
  • integer $since_id: Returns results with an ID greater than (that is, more recent than) the specified ID.
  • integer $max_id: Returns results with an ID less than (that is, older than) or equal to the specified ID.
  • integer $count: Specifies the number of results to retrieve 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.
  • boolean $include_rts: When set to either true, t or 1, the list timeline will contain native retweets (if they exist) in addition to the standard stream of tweets.
getSubscribers (line 172)

Method to get the subscribers of the specified list.

  • return: The decoded JSON response
  • since: 12.3
  • throws: RuntimeException
  • access: public
array getSubscribers (mixed $list, [mixed $owner = null], [integer $cursor = null], [boolean $entities = null], [boolean $skip_status = null])
  • mixed $list: Either an integer containing the list ID or a string containing the list slug.
  • mixed $owner: Either an integer containing the user ID or a string containing the screen name.
  • integer $cursor: Breaks the results into pages. A single page contains 20 lists. Provide a value of -1 to begin paging.
  • 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.
getSubscriptions (line 774)

Method to get a collection of the lists the specified user is subscribed to, 20 lists per page by default. Does not include the user's own lists.

  • return: The decoded JSON response
  • since: 12.3
  • throws: RuntimeException
  • access: public
array getSubscriptions (mixed $user, [integer $count = 0], [integer $cursor = null])
  • mixed $user: Either an integer containing the user ID or a string containing the screen name.
  • integer $count: The amount of results to return per page. Defaults to 20. Maximum of 1,000 when using cursors.
  • integer $cursor: Breaks the results into pages. Provide a value of -1 to begin paging.
isMember (line 367)

Method to check if the specified user is a member of the specified list.

  • return: The decoded JSON response
  • since: 12.3
  • throws: RuntimeException
  • access: public
array isMember (mixed $list, mixed $user, [mixed $owner = null], [boolean $entities = null], [boolean $skip_status = null])
  • mixed $list: Either an integer containing the list ID or a string containing the list slug.
  • mixed $user: Either an integer containing the user ID or a string containing the screen name of the user to remove.
  • mixed $owner: Either an integer containing the user ID or a string containing the screen name of the owner.
  • 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.
isSubscriber (line 450)

Method to check if the specified user is a subscriber of the specified list.

  • return: The decoded JSON response
  • since: 12.3
  • throws: RuntimeException
  • access: public
array isSubscriber (mixed $list, mixed $user, [mixed $owner = null], [boolean $entities = null], [boolean $skip_status = null])
  • mixed $list: Either an integer containing the list ID or a string containing the list slug.
  • mixed $user: Either an integer containing the user ID or a string containing the screen name of the user to remove.
  • mixed $owner: Either an integer containing the user ID or a string containing the screen name of the owner.
  • 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.
subscribe (line 310)

Method to subscribe the authenticated user to the specified list.

  • return: The decoded JSON response
  • since: 12.3
  • throws: RuntimeException
  • access: public
array subscribe (mixed $list, [mixed $owner = null])
  • mixed $list: Either an integer containing the list ID or a string containing the list slug.
  • mixed $owner: Either an integer containing the user ID or a string containing the screen name of the owner.
unsubscribe (line 529)

Method to unsubscribe the authenticated user from the specified list.

  • return: The decoded JSON response
  • since: 12.3
  • throws: RuntimeException
  • access: public
array unsubscribe (mixed $list, [mixed $owner = null])
  • mixed $list: Either an integer containing the list ID or a string containing the list slug.
  • mixed $owner: Either an integer containing the user ID or a string containing the screen name of the owner.
update (line 828)

Method to update the specified list

  • return: The decoded JSON response
  • since: 12.3
  • throws: RuntimeException
  • access: public
array update (mixed $list, [mixed $owner = null], [string $name = null], [string $mode = null], [string $description = null])
  • mixed $list: Either an integer containing the list ID or a string containing the list slug.
  • mixed $owner: Either an integer containing the user ID or a string containing the screen name of the owner.
  • string $name: The name of the list.
  • string $mode: Whether your list is public or private. Values can be public or private. If no mode is specified the list will be public.
  • string $description: The description to give the list.

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:07:21 +0100 by phpDocumentor 1.4.3