.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "Net::GitHub::V3::Query 3pm"
.TH Net::GitHub::V3::Query 3pm "2018-04-07" "perl v5.26.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Net::GitHub::V3::Query \- Base Query role for Net::GitHub::V3
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    package Net::GitHub::V3::XXX;
\&
\&    use Moo;
\&    with \*(AqNet::GitHub::V3::Query\*(Aq;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
set Authentication and call \s-1API\s0
.SS "\s-1ATTRIBUTES\s0"
.IX Subsection "ATTRIBUTES"
.IP "login" 4
.IX Item "login"
.PD 0
.IP "pass" 4
.IX Item "pass"
.IP "access_token" 4
.IX Item "access_token"
.PD
Either set access_token from OAuth or login:pass for Basic Authentication
.Sp
<http://developer.github.com/>
.IP "raw_string" 4
.IX Item "raw_string"
.PD 0
.IP "raw_response" 4
.IX Item "raw_response"
.IP "api_throttle" 4
.IX Item "api_throttle"
.PD
\&\s-1API\s0 throttling is enabled by default, set api_throttle to 0 to disable it.
.IP "rate_limit" 4
.IX Item "rate_limit"
The maximum number of queries allowed per hour. 60 for anonymous users and
5,000 for authenticated users.
.IP "rate_limit_remaining" 4
.IX Item "rate_limit_remaining"
The number of requests remaining in the current rate limit window.
.IP "rate_limit_reset" 4
.IX Item "rate_limit_reset"
The time the current rate limit resets in \s-1UTC\s0 epoch seconds.
.IP "last_page" 4
.IX Item "last_page"
Denotes the index of the last page in the pagination
.IP "RaiseError" 4
.IX Item "RaiseError"
.SS "\s-1METHODS\s0"
.IX Subsection "METHODS"
.PD 0
.IP "query" 4
.IX Item "query"
.PD
Refer Net::GitHub::V3
.IP "next_page" 4
.IX Item "next_page"
Calls \f(CW\*(C`query\*(C'\fR with \f(CW\*(C`next_url\*(C'\fR. See Net::GitHub::V3
.IP "prev_page" 4
.IX Item "prev_page"
Calls \f(CW\*(C`query\*(C'\fR with \f(CW\*(C`prev_url\*(C'\fR. See Net::GitHub::V3
.IP "first_page" 4
.IX Item "first_page"
Calls \f(CW\*(C`query\*(C'\fR with \f(CW\*(C`first_url\*(C'\fR. See Net::GitHub::V3
.IP "last_page" 4
.IX Item "last_page"
Calls \f(CW\*(C`query\*(C'\fR with \f(CW\*(C`last_url\*(C'\fR. See Net::GitHub::V3
.IP "set_next_page" 4
.IX Item "set_next_page"
Adjusts next_url to be a new url in the pagination space
I.E. you are jumping to a new index in the pagination
.IP "result_sets" 4
.IX Item "result_sets"
For internal use by the item-per-item pagination: This is a store of
the state(s) for the pagination.  Each entry maps the initial \s-1URL\s0 of a
GitHub query to a Net::GitHub::V3::ResultSet object.
.IP "next($url)" 4
.IX Item "next($url)"
Returns the next item for the query which started at \f(CW$url\fR, or undef if
there are no more items.
.IP "close($url)" 4
.IX Item "close($url)"
Terminates the item-per-item pagination for the query which started at
\&\f(CW$url\fR.
.PP
\fI\s-1NG_DEBUG\s0\fR
.IX Subsection "NG_DEBUG"
.PP
export NG_DEBUG=1 to view the request \s-1URL\s0
.PP
\&\s-1NG_DEBUG\s0 > 1 to view request/response string
.SH "AUTHOR & COPYRIGHT & LICENSE"
.IX Header "AUTHOR & COPYRIGHT & LICENSE"
Refer Net::GitHub