/ 
WebService-Etsy-0.4
River stage zero No dependents
/ WebService::Etsy::Result

NAME

WebService::Etsy::Result - Returned results from the Etsy API.

SYNOPSIS

my $resp = $api->getFeaturedSellers( detail_level => 'medium' );
# call methods on the object
print $resp->count . " featured sellers\n";
# use the object like an arrayref of results
for my $shop ( @$resp ) {
    # $shop is a WebService::Etsy::Result::Shop object
    print $shop->shop_name, "\n";
}

DESCRIPTION

The API returns different result types - shops, users, listings, methods, tags, ints, and strings.

Each return type has its own corresponding Perl class, with methods appropriate to its contents.

RESULT OBJECTS

WebService::Etsy::Result::String

The object behaves just like a string in scalar context. It does provide a value() method if you need it.

WebService::Etsy::Result::Int

The object behaves just like an integer in scalar context. It does provide a value() method if you need it.

WebService::Etsy::Result::Tag

The object behaves just like an string in scalar context. It does provide a value() method if you need it.

WebService::Etsy::Result::User

The object includes methods corresponding to the field values described at http://developer.etsy.com/docs#users.

Some of the methods may return undef if the relevant detail level was not requested.

WebService::Etsy::Result::Shop

The object includes methods corresponding to the field values described at http://developer.etsy.com/docs#shops. Note that it extends the WebService::Etsy::Result::User class.

Some of the methods may return undef if the relevant detail level was not requested.

WebService::Etsy::Result::Listing

The object includes methods corresponding to the field values described at http://developer.etsy.com/docs#listings.

Some of the methods may return undef if the relevant detail level was not requested.

WebService::Etsy::Result::GiftGuide

The object includes methods corresponding to the field values described at http://developer.etsy.com/docs#gift_guides.

WebService::Etsy::Result::Method

The object includes methods corresponding to the field values described at http://developer.etsy.com/docs#methods.

SEE ALSO

http://developer.etsy.com/docs#resource_types, WebService::Etsy::Response.

AUTHOR

Ian Malpass (ian-cpan@indecorous.com)

COPYRIGHT

Copyright 2009, Ian Malpass

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