1Net::GitHub::V3::ResultUSseetr(3C)ontributed Perl DocumeNnetta:t:iGointHub::V3::ResultSet(3)
2
3
4

NAME

6       Net::GitHub::V3::ResultSet - GitHub query iteration helper
7

SYNOPSIS

9       For use by the role Net::GitHub::V3::Query:
10
11           use Net::GitHub::V3::ResultSet;
12
13           $result_set = Net::GitHub::V3::ResultSet->new( url => $url );
14           ...
15

DESCRIPTION

17       Objects in this class store the current status of a GitHub query while
18       the user iterates over individual items.  This happens behind the
19       scenes, users of Net::GitHub::V3 don't need to know about this class.
20
21       Each of the V3 submodules holds one of these objects for every
22       different pageable query which it handles.
23
24       The attributes have the following function:
25
26       url Required for creating the object: This is the URL where a pageable
27           GitHub query starts, and this URL will be used to identify the
28           pagination when retrieving the next object, and also for the first
29           call to the GitHub API.
30
31       results
32           An array reference holding the current page as retrieved by the
33           most recent call to the GitHub API.
34
35       cursor
36           An integer pointing to the "next" position within the current page
37           from which the next method will fetch an item.
38
39       done
40           A boolean indicating that there's no more item to be fetched from
41           the API: The current results are the last.
42
43       next_url
44           The url from which more results can be fetched.  Will be empty if
45           there are no more pages.
46
47
48
49perl v5.28.1                      2018-03-30     Net::GitHub::V3::ResultSet(3)
Impressum