.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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
..
.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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Net::Google::AuthSub::Response 3pm"
.TH Net::Google::AuthSub::Response 3pm "2022-10-13" "perl v5.34.0" "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::Google::AuthSub::Response \- a response from a Net::Google::AuthSub request
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    my $response = $auth\->login($user, $pass);
\&    
\&    if ($response\->is_success) {
\&        print "Yay!\en";
\&    } else {
\&        if ($response\->error eq \*(AqCaptchaRequired\*(Aq) {
\&            print "Captcha Image ".$response\->captchaurl;
\&        }
\&    }
.Ve
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS "new ""HTTP::Response"" ""base url"""
.el .SS "new \f(CWHTTP::Response\fP \f(CWbase url\fP"
.IX Subsection "new HTTP::Response base url"
Create a new response.
.SS "is_success"
.IX Subsection "is_success"
Returns whether the response was a sucess or not.
.SH "SUCCESS METHODS"
.IX Header "SUCCESS METHODS"
Methods available if the response was a success.
.SS "auth"
.IX Subsection "auth"
The authorisation token if the response is a success.
.SS "sid"
.IX Subsection "sid"
Not used yet.
.SS "lsid"
.IX Subsection "lsid"
Not used yet.
.SH "ERROR METHODS"
.IX Header "ERROR METHODS"
Methods available if the response was an error.
.SS "error"
.IX Subsection "error"
The error code. Can be one of
.IP "BadAuthentication" 4
.IX Item "BadAuthentication"
The login request used a username or password that is not recognized.
.IP "NotVerified" 4
.IX Item "NotVerified"
The account email address has not been verified. The user will need to 
access their Google account directly to resolve the issue before logging 
in using a non-Google application.
.IP "TermsNotAgreed" 4
.IX Item "TermsNotAgreed"
The user has not agreed to terms. The user will need to access their 
Google account directly to resolve the issue before logging in using a 
non-Google application.
.IP "CaptchaRequired" 4
.IX Item "CaptchaRequired"
A \s-1CAPTCHA\s0 is required. (A response with this error code will also 
contain an image \s-1URL\s0 and a \s-1CAPTCHA\s0 token.)
.IP "Unknown" 4
.IX Item "Unknown"
The error is unknown or unspecified; the request contained invalid input 
or was malformed.
.IP "AccountDeleted" 4
.IX Item "AccountDeleted"
The user account has been deleted.
.IP "AccountDisabled" 4
.IX Item "AccountDisabled"
The user account has been disabled.
.IP "ServiceDisabled" 4
.IX Item "ServiceDisabled"
The user's access to the specified service has been disabled. (The user 
account may still be valid.)
.IP "ServiceUnavailable" 4
.IX Item "ServiceUnavailable"
The service is not available; try again later.
.SS "url"
.IX Subsection "url"
The url of a page describing the error.
.SS "captchatoken"
.IX Subsection "captchatoken"
The token required to authenticate a captcha.
.SS "captchaurl"
.IX Subsection "captchaurl"
The full url of the captcha image.