.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)
.\"
.\" 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 "GitLab::API::v4::Paginator 3pm"
.TH GitLab::API::v4::Paginator 3pm "2019-01-28" "perl v5.24.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"
GitLab::API::v4::Paginator \- Iterate through paginated GitLab v4 API records.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
There should be no need to create objects of this type
directly, instead use \*(L"paginator\*(R" in GitLab::API::v4 which
simplifies things a bit.
.SH "REQUIRED ARGUMENTS"
.IX Header "REQUIRED ARGUMENTS"
.SS "method"
.IX Subsection "method"
The name of the method subroutine to call on the \*(L"api\*(R" object
to get records from.
.PP
This method must accept a hash ref of parameters as the last
argument, adhere to the \f(CW\*(C`page\*(C'\fR and \f(CW\*(C`per_page\*(C'\fR parameters, and
return an array ref.
.SS "api"
.IX Subsection "api"
The GitLab::API::v4 object.
.SH "OPTIONAL ARGUMENTS"
.IX Header "OPTIONAL ARGUMENTS"
.SS "args"
.IX Subsection "args"
The arguments to use when calling the \*(L"method\*(R", the same arguments
you would use when you call the method yourself on the \*(L"api\*(R"
object, minus the \f(CW\*(C`\e%params\*(C'\fR hash ref.
.SS "params"
.IX Subsection "params"
The \f(CW\*(C`\e%params\*(C'\fR hash ref argument.
.SH "METHODS"
.IX Header "METHODS"
.SS "next_page"
.IX Subsection "next_page"
.Vb 1
\&    while (my $records = $paginator\->next_page()) { ... }
.Ve
.PP
Returns an array ref of records for the next page.
.SS "next"
.IX Subsection "next"
.Vb 1
\&    while (my $record = $paginator\->next()) { ... }
.Ve
.PP
Returns the next record in the current page.  If all records have
been exhausted then \*(L"next_page\*(R" will automatically be called.
This way if you want to ignore pagination you can just call \f(CW\*(C`next\*(C'\fR
over and over again to walk through all the records.
.SS "all"
.IX Subsection "all"
.Vb 1
\&    my $records = $paginator\->all();
.Ve
.PP
This is just an alias for calling \*(L"next_page\*(R" over and over
again to build an array ref of all records.
.SS "reset"
.IX Subsection "reset"
.Vb 1
\&    $paginator\->reset();
.Ve
.PP
Reset the paginator back to its original state on the first page
with no records retrieved yet.
.SH "AUTHORS"
.IX Header "AUTHORS"
See \*(L"\s-1AUTHOR\*(R"\s0 in GitLab::API::v4 and \*(L"\s-1CONTRIBUTORS\*(R"\s0 in GitLab::API::v4.
.SH "LICENSE"
.IX Header "LICENSE"
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.