Class JTwitterLists

Twitter API Lists class for the Joomla Platform.

JTwitterLists

Package: Joomla\Platform\Twitter
Deprecated: 4.0 Use the joomla/twitter package via Composer instead
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE
Since: 12.3
Located at joomla/twitter/lists.php

Methods summary

`public array`	# `getLists( mixed $user, boolean $reverse = null )` Method to get all lists the authenticating or specified user subscribes to, including their own. Method to get all lists the authenticating or specified user subscribes to, including their own. Parameters `$user` `mixed` - $user Either an integer containing the user ID or a string containing the screen name. `$reverse` `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. Returns `array` - The decoded JSON response Throws `RuntimeException` Since 12.3
`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 )` Method to get tweet timeline for members of the specified list Method to get tweet timeline for members of the specified list Parameters `$list` `mixed` - $list Either an integer containing the list ID or a string containing the list slug. `$owner` `mixed` - $owner Either an integer containing the user ID or a string containing the screen name. `$since_id` `integer` - $since_id Returns results with an ID greater than (that is, more recent than) the specified ID. `$max_id` `integer` - $max_id Returns results with an ID less than (that is, older than) or equal to the specified ID. `$count` `integer` - $count Specifies the number of results to retrieve 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. `$include_rts` `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. Returns `array` - The decoded JSON response Throws `RuntimeException` Since 12.3
`public array`	# `getSubscribers( mixed $list, mixed $owner = null, integer $cursor = null, boolean $entities = null, boolean $skip_status = null )` Method to get the subscribers of the specified list. Method to get the subscribers of the specified list. Parameters `$list` `mixed` - $list Either an integer containing the list ID or a string containing the list slug. `$owner` `mixed` - $owner Either an integer containing the user ID or a string containing the screen name. `$cursor` `integer` - $cursor Breaks the results into pages. A single page contains 20 lists. Provide a value of -1 to begin paging. `$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 `RuntimeException` Since 12.3
`public array`	# `deleteMembers( mixed $list, string $user_id = null, string $screen_name = null, mixed $owner = null )` Method to remove multiple members from a list, by specifying a comma-separated list of member ids or screen names. Method to remove multiple members from a list, by specifying a comma-separated list of member ids or screen names. Parameters `$list` `mixed` - $list Either an integer containing the list ID or a string containing the list slug. `$user_id` `string` - $user_id A comma separated list of user IDs, up to 100 are allowed in a single request. `$screen_name` `string` - $screen_name A comma separated list of screen names, up to 100 are allowed in a single request. `$owner` `mixed` - $owner Either an integer containing the user ID or a string containing the screen name of the owner. Returns `array` - The decoded JSON response Throws `RuntimeException` Since 12.3
`public array`	# `subscribe( mixed $list, mixed $owner = null )` Method to subscribe the authenticated user to the specified list. Method to subscribe the authenticated user to the specified list. Parameters `$list` `mixed` - $list Either an integer containing the list ID or a string containing the list slug. `$owner` `mixed` - $owner Either an integer containing the user ID or a string containing the screen name of the owner. Returns `array` - The decoded JSON response Throws `RuntimeException` Since 12.3
`public array`	# `isMember( mixed $list, mixed $user, mixed $owner = null, boolean $entities = null, boolean $skip_status = null )` Method to check if the specified user is a member of the specified list. Method to check if the specified user is a member of the specified list. Parameters `$list` `mixed` - $list Either an integer containing the list ID or a string containing the list slug. `$user` `mixed` - $user Either an integer containing the user ID or a string containing the screen name of the user to remove. `$owner` `mixed` - $owner Either an integer containing the user ID or a string containing the screen name of the owner. `$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 `RuntimeException` Since 12.3
`public array`	# `isSubscriber( mixed $list, mixed $user, mixed $owner = null, boolean $entities = null, boolean $skip_status = null )` Method to check if the specified user is a subscriber of the specified list. Method to check if the specified user is a subscriber of the specified list. Parameters `$list` `mixed` - $list Either an integer containing the list ID or a string containing the list slug. `$user` `mixed` - $user Either an integer containing the user ID or a string containing the screen name of the user to remove. `$owner` `mixed` - $owner Either an integer containing the user ID or a string containing the screen name of the owner. `$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 `RuntimeException` Since 12.3
`public array`	# `unsubscribe( mixed $list, mixed $owner = null )` Method to unsubscribe the authenticated user from the specified list. Method to unsubscribe the authenticated user from the specified list. Parameters `$list` `mixed` - $list Either an integer containing the list ID or a string containing the list slug. `$owner` `mixed` - $owner Either an integer containing the user ID or a string containing the screen name of the owner. Returns `array` - The decoded JSON response Throws `RuntimeException` Since 12.3
`public array`	# `addMembers( mixed $list, string $user_id = null, string $screen_name = null, mixed $owner = null )` Method to add multiple members to a list, by specifying a comma-separated list of member ids or screen names. Method to add multiple members to a list, by specifying a comma-separated list of member ids or screen names. Parameters `$list` `mixed` - $list Either an integer containing the list ID or a string containing the list slug. `$user_id` `string` - $user_id A comma separated list of user IDs, up to 100 are allowed in a single request. `$screen_name` `string` - $screen_name A comma separated list of screen names, up to 100 are allowed in a single request. `$owner` `mixed` - $owner Either an integer containing the user ID or a string containing the screen name of the owner. Returns `array` - The decoded JSON response Throws `RuntimeException` Since 12.3
`public array`	# `getMembers( mixed $list, mixed $owner = null, boolean $entities = null, boolean $skip_status = null )` Method to get the members of the specified list. Method to get the members of the specified list. Parameters `$list` `mixed` - $list Either an integer containing the list ID or a string containing the list slug. `$owner` `mixed` - $owner 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 `RuntimeException` Since 12.3
`public array`	# `getListById( mixed $list, mixed $owner = null )` Method to get the specified list. Method to get the specified list. Parameters `$list` `mixed` - $list Either an integer containing the list ID or a string containing the list slug. `$owner` `mixed` - $owner Either an integer containing the user ID or a string containing the screen name. Returns `array` - The decoded JSON response Throws `RuntimeException` Since 12.3
`public array`	# `getSubscriptions( mixed $user, integer $count = 0, integer $cursor = null )` 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. 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. Parameters `$user` `mixed` - $user Either an integer containing the user ID or a string containing the screen name. `$count` `integer` - $count The amount of results to return per page. Defaults to 20. Maximum of 1,000 when using cursors. `$cursor` `integer` - $cursor Breaks the results into pages. Provide a value of -1 to begin paging. Returns `array` - The decoded JSON response Throws `RuntimeException` Since 12.3
`public array`	# `update( mixed $list, mixed $owner = null, string $name = null, string $mode = null, string $description = null )` Method to update the specified list Method to update the specified list Parameters `$list` `mixed` - $list Either an integer containing the list ID or a string containing the list slug. `$owner` `mixed` - $owner Either an integer containing the user ID or a string containing the screen name of the owner. `$name` `string` - $name The name of the list. `$mode` `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. `$description` `string` - $description The description to give the list. Returns `array` - The decoded JSON response Throws `RuntimeException` Since 12.3
`public array`	# `create( string $name, string $mode = null, string $description = null )` Method to create a new list for the authenticated user. Method to create a new list for the authenticated user. Parameters `$name` `string` - $name The name of the list. `$mode` `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. `$description` `string` - $description The description to give the list. Returns `array` - The decoded JSON response Since 12.3
`public array`	# `delete( mixed $list, mixed $owner = null )` Method to delete a specified list. Method to delete a specified list. Parameters `$list` `mixed` - $list Either an integer containing the list ID or a string containing the list slug. `$owner` `mixed` - $owner Either an integer containing the user ID or a string containing the screen name of the owner. Returns `array` - The decoded JSON response Throws `RuntimeException` Since 12.3

Methods inherited from JTwitterObject

__construct(), checkRateLimit(), fetchUrl(), getOption(), getRateLimit(), sendRequest(), setOption()

Magic methods summary

Properties summary

Properties inherited from JTwitterObject

$client, $oauth, $options

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JTwitterLists

Methods summary

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Since

Parameters

Returns

Throws

Since

Methods inherited from JTwitterObject

Magic methods summary

Properties summary

Properties inherited from JTwitterObject