GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  WEBSERVICE::GDATA::ERROR (3)

.ds Aq ’

NAME

WebService::GData::Error - create an error and parse errors from Google data APIs v2.

CONTENTS

SYNOPSIS



    use WebService::GData::Error;

    #create an error object that you can throw by dying...
    my $error = new WebService::GData::Error(401,Unauthorized);
    # $error->code;
    # $error->content;

    #create an error object in response to a Google Service.
    my $error = new WebService::GData::Error(401,$responseFromAService);
    print $error->code;
    print $error->content;#raw xml content

    my @errors = $error->errors;#send back WebService::GData::Error::Entry objects

    foreach my $error (@{$error->errors}){
        print $error->code;
        print $error->internalreason;
        print $error->domain;
        print $error->location->{type};#this is just a hash
        print $error->location->{content};#this is just a hash
    }



DESCRIPTION

inherits from WebService::GData.

This package can parse error response from Google APIs service. You can also create your own basic error. All WebService::GData::* classes die a WebService::GData::Error object when something goes wrong. You should use an eval {}; block to catch the error.

Example:



    use WebService::GData::Base;

    my $base = new WebService::GData::Base();
       
    eval {
        $base->get($url);
    };
       
    #$error is a WebService::GData::Error;
       
    if(my $error=$@){
        #error->code,$error->content, $error->errors
    }



    CONSTRUCTOR

new

Create a WebService::GData::Error instance. Will parse the contents that you can access via the errors() method of the instance.

<B>ParametersB>
code:* - This could be an http status or a short string error_code.
content:Scalar - The string can be a Google xml error response, in which case, it will get parsed.

<B>ReturnsB>
WebService::GData::Error

Example:



    use WebService::GData::Error;

    #create an error object that you can throw by dying...
    my $error = new WebService::GData::Error(401,Unauthorized);



    GET METHODS

code

Get back the error code.

<B>ParametersB>
none
<B>ReturnsB>
code:Scalar
Example:


    use WebService::GData::Error;

    #create an error object that you can throw by dying...
    my $error = new WebService::GData::Error(401,Unauthorized);
       $error->code;#401



content

  Get back the raw content of the error.

When getting an error from querying one of Google data services, you will get a raw xml response containing possible errors. In such case,you should loop through the result by using the errors() instance which send back WebService::GData::Error::Entry.

<B>ParametersB>
none

<B>ReturnsB>
content:Scalar

Example:



    use WebService::GData::Error;

    #create an error object that you can throw by dying...
    my $error = new WebService::GData::Error(401,Unauthorized);
       $error->content;#Unauthorized



errors

  Get back a reference array filled with WebService::GData::Error::Entry. When getting an error from querying one of Google data services, you will get an xml response containing possible errors. In such a case,you should loop through the result of errors. Errors always send back a reference array (even if there is no error).

<B>ParametersB>
none

<B>ReturnsB>
WebService::GData::Error::Entry:ArrayRef

Example:



    my @errors = $error->errors;#send back WebService::GData::Error::Entry objects

    foreach my $error (@{$error->errors}){
        print $error->code;
        print $error->internalreason;
        print $error->domain;
        print $error->location->{type};#this is just a hash
        print $error->location->{content};#this is just a hash
    }



BUGS AND LIMITATIONS

If you do me the favor to _use_ this module and find a bug, please email me i will try to do my best to fix it (patches welcome)!

AUTHOR

shiriru <shirirulestheworld[arobas]gmail.com>

LICENSE AND COPYRIGHT

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

POD ERRORS

Hey! <B>The above document had some coding errors, which are explained below:B>
Around line 153: =back without =over
Around line 181: =back without =over
Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 WEBSERVICE::GDATA::ERROR (3) 2010-11-01

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.