{
    "content": [
        {
            "type": "text",
            "text": "# Net::Twitter::Role::API::Lists (perldoc)\n\n## NAME\n\nNet::Twitter::Role::API::Lists - Twitter Lists API support for Net::Twitter\n\n## SYNOPSIS\n\nuse Net::Twitter;\nmy $nt = Net::Twitter->new(traits => ['API::Lists'], ...);\n$list = $nt->createlist($owner, { name => $name, description => $desc });\n$list = $nt->updatelist($owner, $listid, { description => $desc });\n$lists = $nt->getlists($owner);\n$lists = $nt->listlists($owner);\n$list = $nt->getlist($owner, $listid);\n$list = $nt->deletelist($owner, $listid);\n$statuses = $nt->liststatuses($owner, $listid);\n$lists = $nt->listmemberships($owner);\n$lists = $nt->listsubscriptions($owner);\n$users = $nt->listmembers($owner, $listid);\n$userorundef = $nt->listmembers($owner, $listid, { id => $userid });\n$user = $nt->addlistmember($owner, $listid, $userid);\n$users = $nt->addlistmembers($owner, $listid, { screenname => \\@screennames });\n$user = $nt->deletelistmember($owner, $listid, $userid);\n$user = $nt->removelistmember($owner, $listid, $userid);\n$userorundef = $nt->islistmember($owner, $listid, $userid);\n$users = $nt->listsubscribers($owner, $listid);\n$list = $nt->subscribelist($owner, $listid);\n$list = $nt->unsubscribelist($owner, $listid);\n$userorundef = $nt->issubscribedlist($owner, $listid, $userid);\n$userorundef = $nt->islistsubscriber($owner, $listid, $userid);\n#############################\n# With the cursor parameter #\n#############################\n$r = $nt->getlist($user, $listid, { cursor => $cursor });\n$lists = $r->{lists};\n$r = $nt->listmemberships($user, { cursor => $cursor });\n$lists = $r->{lists};\n$r = $nt->listsubscriptions($user, { cursor => $cursor });\n$lists = $r->{lists};\n$r = $nt->listmembers($owner, $listid, { cursor => $cursor });\n$users = $r->{users};\n$r = $nt->listsubscribers($owner, $listid, { cursor => $cursor });\n$users = $r->{users};\n\n## DESCRIPTION\n\nNet::Twitter::Role::API::Lists provides a trait for the Twitter Lists API methods. See\nNet::Twitter for full documentation.\n\n## Sections\n\n- **NAME**\n- **VERSION**\n- **SYNOPSIS**\n- **DEPRECATION NOTICE**\n- **DESCRIPTION**\n- **SEE ALSO**\n- **AUTHOR**\n- **COPYRIGHT**\n- **LICENSE**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n"
        }
    ],
    "structuredContent": {
        "command": "Net::Twitter::Role::API::Lists",
        "section": "",
        "mode": "perldoc",
        "summary": "Net::Twitter::Role::API::Lists - Twitter Lists API support for Net::Twitter",
        "synopsis": "use Net::Twitter;\nmy $nt = Net::Twitter->new(traits => ['API::Lists'], ...);\n$list = $nt->createlist($owner, { name => $name, description => $desc });\n$list = $nt->updatelist($owner, $listid, { description => $desc });\n$lists = $nt->getlists($owner);\n$lists = $nt->listlists($owner);\n$list = $nt->getlist($owner, $listid);\n$list = $nt->deletelist($owner, $listid);\n$statuses = $nt->liststatuses($owner, $listid);\n$lists = $nt->listmemberships($owner);\n$lists = $nt->listsubscriptions($owner);\n$users = $nt->listmembers($owner, $listid);\n$userorundef = $nt->listmembers($owner, $listid, { id => $userid });\n$user = $nt->addlistmember($owner, $listid, $userid);\n$users = $nt->addlistmembers($owner, $listid, { screenname => \\@screennames });\n$user = $nt->deletelistmember($owner, $listid, $userid);\n$user = $nt->removelistmember($owner, $listid, $userid);\n$userorundef = $nt->islistmember($owner, $listid, $userid);\n$users = $nt->listsubscribers($owner, $listid);\n$list = $nt->subscribelist($owner, $listid);\n$list = $nt->unsubscribelist($owner, $listid);\n$userorundef = $nt->issubscribedlist($owner, $listid, $userid);\n$userorundef = $nt->islistsubscriber($owner, $listid, $userid);\n#############################\n# With the cursor parameter #\n#############################\n$r = $nt->getlist($user, $listid, { cursor => $cursor });\n$lists = $r->{lists};\n$r = $nt->listmemberships($user, { cursor => $cursor });\n$lists = $r->{lists};\n$r = $nt->listsubscriptions($user, { cursor => $cursor });\n$lists = $r->{lists};\n$r = $nt->listmembers($owner, $listid, { cursor => $cursor });\n$users = $r->{users};\n$r = $nt->listsubscribers($owner, $listid, { cursor => $cursor });\n$users = $r->{users};",
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [],
        "examples": [],
        "see_also": [],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "VERSION",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "SYNOPSIS",
                "lines": 57,
                "subsections": []
            },
            {
                "name": "DEPRECATION NOTICE",
                "lines": 9,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 3,
                "subsections": []
            },
            {
                "name": "SEE ALSO",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "AUTHOR",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "COPYRIGHT",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "LICENSE",
                "lines": 3,
                "subsections": []
            }
        ],
        "sections": {
            "NAME": {
                "content": "Net::Twitter::Role::API::Lists - Twitter Lists API support for Net::Twitter\n",
                "subsections": []
            },
            "VERSION": {
                "content": "version 4.01043\n",
                "subsections": []
            },
            "SYNOPSIS": {
                "content": "use Net::Twitter;\n\nmy $nt = Net::Twitter->new(traits => ['API::Lists'], ...);\n\n$list = $nt->createlist($owner, { name => $name, description => $desc });\n$list = $nt->updatelist($owner, $listid, { description => $desc });\n\n$lists = $nt->getlists($owner);\n$lists = $nt->listlists($owner);\n\n$list = $nt->getlist($owner, $listid);\n$list = $nt->deletelist($owner, $listid);\n\n$statuses = $nt->liststatuses($owner, $listid);\n\n$lists = $nt->listmemberships($owner);\n$lists = $nt->listsubscriptions($owner);\n\n$users = $nt->listmembers($owner, $listid);\n\n$userorundef = $nt->listmembers($owner, $listid, { id => $userid });\n\n$user = $nt->addlistmember($owner, $listid, $userid);\n$users = $nt->addlistmembers($owner, $listid, { screenname => \\@screennames });\n\n$user = $nt->deletelistmember($owner, $listid, $userid);\n$user = $nt->removelistmember($owner, $listid, $userid);\n\n$userorundef = $nt->islistmember($owner, $listid, $userid);\n\n$users = $nt->listsubscribers($owner, $listid);\n\n$list = $nt->subscribelist($owner, $listid);\n$list = $nt->unsubscribelist($owner, $listid);\n\n$userorundef = $nt->issubscribedlist($owner, $listid, $userid);\n$userorundef = $nt->islistsubscriber($owner, $listid, $userid);\n\n#############################\n# With the cursor parameter #\n#############################\n\n$r = $nt->getlist($user, $listid, { cursor => $cursor });\n$lists = $r->{lists};\n\n$r = $nt->listmemberships($user, { cursor => $cursor });\n$lists = $r->{lists};\n\n$r = $nt->listsubscriptions($user, { cursor => $cursor });\n$lists = $r->{lists};\n\n$r = $nt->listmembers($owner, $listid, { cursor => $cursor });\n$users = $r->{users};\n\n$r = $nt->listsubscribers($owner, $listid, { cursor => $cursor });\n$users = $r->{users};\n",
                "subsections": []
            },
            "DEPRECATION NOTICE": {
                "content": "This module implements methods for the original Twitter Lists API. Twitter has deprecated these\nAPI methods and reimplemented them with a saner semantics. The new methods are implemented in\nthe API::REST trait, Net::Twitter::Role::API::REST. This module provides backwards compatibility\nfor code written to use the original Lists API. To use the new API methods, simply remove this\ntrait from your code and change the arguments to its methods to match the new semantics.\n\nThis module may be dropped from Net::Twitter in a future release. It will remain as long as\nTwitter still provides the underlying API end-points.\n",
                "subsections": []
            },
            "DESCRIPTION": {
                "content": "Net::Twitter::Role::API::Lists provides a trait for the Twitter Lists API methods. See\nNet::Twitter for full documentation.\n",
                "subsections": []
            },
            "SEE ALSO": {
                "content": "Net::Twitter\n",
                "subsections": []
            },
            "AUTHOR": {
                "content": "Marc Mims <marc@questright.com>\n",
                "subsections": []
            },
            "COPYRIGHT": {
                "content": "Copyright (c) 2009-2016 Marc Mims\n",
                "subsections": []
            },
            "LICENSE": {
                "content": "This library is free software. You may redistribute and modify it under the same terms as Perl\nitself.\n",
                "subsections": []
            }
        }
    }
}