.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)
.\"
.\" 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 turned on, 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
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "HTTP::OAI::UserAgent 3pm"
.TH HTTP::OAI::UserAgent 3pm "2016-07-15" "perl v5.22.2" "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"
HTTP::OAI::UserAgent \- Extension of the LWP::UserAgent for OAI HTTP requests
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module provides a simplified mechanism for making requests to an \s-1OAI\s0 repository, using the existing LWP::UserAgent module.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&        require HTTP::OAI::UserAgent;
\&
\&        my $ua = new HTTP::OAI::UserAgent;
\&
\&        my $response = $ua\->request(
\&                baseURL=>\*(Aqhttp://arXiv.org/oai1\*(Aq,
\&                verb=>\*(AqListRecords\*(Aq,
\&                from=>\*(Aq2001\-08\-01\*(Aq,
\&                until=>\*(Aq2001\-08\-31\*(Aq
\&        );
\&
\&        print $response\->content;
.Ve
.SH "METHODS"
.IX Header "METHODS"
.ie n .IP "$ua = new HTTP::OAI::UserAgent(proxy=>'www\-cache',...)" 4
.el .IP "\f(CW$ua\fR = new HTTP::OAI::UserAgent(proxy=>'www\-cache',...)" 4
.IX Item "$ua = new HTTP::OAI::UserAgent(proxy=>'www-cache',...)"
This constructor method returns a new instance of a HTTP::OAI::UserAgent module. All arguments are passed to the LWP::UserAgent constructor.
.ie n .IP "$r = $ua\->request($req)" 4
.el .IP "\f(CW$r\fR = \f(CW$ua\fR\->request($req)" 4
.IX Item "$r = $ua->request($req)"
Requests the \s-1HTTP\s0 response defined by \f(CW$req\fR, which is a HTTP::Request object.
.ie n .IP "$r = $ua\->request(baseURL=>$baseref, verb=>$verb, %opts)" 4
.el .IP "\f(CW$r\fR = \f(CW$ua\fR\->request(baseURL=>$baseref, verb=>$verb, \f(CW%opts\fR)" 4
.IX Item "$r = $ua->request(baseURL=>$baseref, verb=>$verb, %opts)"
Makes an \s-1HTTP\s0 request to the given \s-1OAI\s0 server (baseURL) with \s-1OAI\s0 arguments. Returns an HTTP::Response object.
.Sp
OAI-PMH related options:
.Sp
.Vb 5
\&        from => $from
\&        until => $until
\&        resumptionToken => $token
\&        metadataPrefix => $mdp
\&        set => $set
.Ve
.ie n .IP "$time_d = $ua\->delay( $time_d )" 4
.el .IP "\f(CW$time_d\fR = \f(CW$ua\fR\->delay( \f(CW$time_d\fR )" 4
.IX Item "$time_d = $ua->delay( $time_d )"
Return and optionally set a time (in seconds) to wait between requests. \f(CW$time_d\fR may be a \s-1CODEREF.\s0