net::google::authsub::response(3pm) [debian man page]
Net::Google::AuthSub::Response(3pm) User Contributed Perl Documentation Net::Google::AuthSub::Response(3pm)NAME
Net::Google::AuthSub::Response - a response from a Net::Google::AuthSub request
SYNOPSIS
my $response = $auth->login($user, $pass);
if ($response->is_success) {
print "Yay!
";
} else {
if ($response->error eq 'CaptchaRequired') {
print "Captcha Image ".$response->captchaurl;
}
}
METHODS
new "HTTP::Response" "base url"
Create a new response.
is_success
Returns whether the response was a sucess or not.
SUCCESS METHODS
Methods available if the response was a success.
auth
The authorisation token if the response is a success.
sid
Not used yet.
lsid
Not used yet.
ERROR METHODS
Methods available if the response was an error.
error
The error code. Can be one of
BadAuthentication
The login request used a username or password that is not recognized.
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.
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.
CaptchaRequired
A CAPTCHA is required. (A response with this error code will also contain an image URL and a CAPTCHA token.)
Unknown
The error is unknown or unspecified; the request contained invalid input or was malformed.
AccountDeleted
The user account has been deleted.
AccountDisabled
The user account has been disabled.
ServiceDisabled
The user's access to the specified service has been disabled. (The user account may still be valid.)
ServiceUnavailable
The service is not available; try again later.
url
The url of a page describing the error.
captchatoken
The token required to authenticate a captcha.
captchaurl
The full url of the captcha image.
perl v5.10.0 2009-05-09 Net::Google::AuthSub::Response(3pm)
Check Out this Related Man Page
WWW::CNic::Response(3pm) User Contributed Perl Documentation WWW::CNic::Response(3pm)NAME
WWW::CNic::Response - base class for WWW::CNic response objects.
SYNOPSIS
use WWW::CNic;
my $query = WWW::CNic->new( OPTIONS );
my $response = $query->execute();
DESCRIPTION
This is the base class for all response objects returned by WWW::CNic. Each query type returns a different object, all of which inherit
their basic functionality from this module.
This module should never be accessed directly, only through its children.
METHODS
All the child classes of WWW::CNic::Response inherit the following methods:
$response->is_success();
This returns true if the transaction was completed successfully. If there was a server-side error due to invalid data or a system error, or
there was an HTTP error this method will return undef.
$response->is_error();
This is the converse of "is_success". It returns true if there was an error.
$response->error();
This returns the error message generated, if any. This can be either a server-side error message or an HTTP error.
$response->message();
This returns the message returned when the transaction was successful.
$response->keys();
This returns an array containing all the keys returned by the server.
$response->response($key);
This returns the value corresponding to $key as returned by the server. This may be a scalar, or a reference to an array or hash, depending
on the context.
$response->dump();
This prints a human-readable dump of the data stored in the object to "STDOUT". Mainly useful in debugging.
COPYRIGHT
This module is (c) 2011 CentralNic Ltd. All rights reserved. This module is free software; you can redistribute it and/or modify it under
the same terms as Perl itself.
SEE ALSO
o http://toolkit.centralnic.com/
o WWW::CNic
perl v5.12.3 2011-05-13 WWW::CNic::Response(3pm)