\JTwitterLists
Twitter API Lists class for the Joomla Platform.
Synopsis
class JTwitterLists
extends JTwitterObject
{
- // Inherited members from JTwitterObject
- protected JRegistry $options;
- protected JHttp $client;
- protected JTwitterOAuth $oauth;
- // methods
- public array getLists()
- public array getStatuses()
- public array getSubscribers()
- public array deleteMembers()
- public array subscribe()
- public array isMember()
- public array isSubscriber()
- public array unsubscribe()
- public array addMembers()
- public array getMembers()
- public array getListById()
- public array getSubscriptions()
- public array update()
- public array create()
- public array delete()
- // Inherited methods from JTwitterObject
- public void __construct()
- public void checkRateLimit()
- public string fetchUrl()
- public array getRateLimit()
- public array sendRequest()
- public mixed getOption()
- public JTwitterObject setOption()
Hierarchy
Extends
Members
protected
- $client — JHttp
- $oauth — JTwitterOAuth
- $options — JRegistry
Methods
public
- addMembers() — Method to add multiple members to a list, by specifying a comma-separated list of member ids or screen names.
- create() — Method to create a new list for the authenticated user.
- delete() — Method to delete a specified list.
- deleteMembers() — Method to remove multiple members from a list, by specifying a comma-separated list of member ids or screen names.
- getListById() — Method to get the specified list.
- getLists() — Method to get all lists the authenticating or specified user subscribes to, including their own.
- getMembers() — Method to get the members of the specified list.
- getStatuses() — Method to get tweet timeline for members of the specified list
- getSubscribers() — Method to get the subscribers of the specified list.
- getSubscriptions() — 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.
- isMember() — Method to check if the specified user is a member of the specified list.
- isSubscriber() — Method to check if the specified user is a subscriber of the specified list.
- subscribe() — Method to subscribe the authenticated user to the specified list.
- unsubscribe() — Method to unsubscribe the authenticated user from the specified list.
- update() — Method to update the specified list
Inherited from JTwitterObject
public
- checkRateLimit() — Method to check the rate limit for the requesting IP address
- fetchUrl() — Method to build and return a full request URL for the request. This method will add appropriate pagination details if necessary and also prepend the API url to have a complete URL for the request.
- getOption() — Get an option from the JTwitterObject instance.
- getRateLimit() — Method to retrieve the rate limit for the requesting IP address
- sendRequest() — Method to send the request.
- setOption() — Set an option for the JTwitterObject instance.