Ian Malpass > WebService-Etsy > WebService::Etsy::Response

Download:
WebService-Etsy-0.7.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  1
View/Report Bugs
Source  

NAME ^

WebService::Etsy::Response - Returned data 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 Resource objects
    for my $shop ( @$resp ) {
        print $shop->shop_name, "\n";
    }

DESCRIPTION ^

This class encapsulates the response from the API, as described at http://developer.etsy.com/docs#api_response_structure.

Arrayification

For convenience, the Response object behaves like an arrayref of Resource objects when used as such.

Stringification

When used in a scalar context, the Response object will return a comma-separated list of stringified Resource objects. This is noteworthy for the case of

    print $api->getServerEpoch() . "\n";

which will print the epoch directly, without having to do something like

    print $api->getServerEpoch()->results->[ 0 ]->value . "\n";

METHODS ^

results()

An arrayref of WebService::Etsy::Resource objects. Using the Response object as an arrayref accesses this results arrayref.

params()

A hashref of the parameters supplied to the method call.

count()

The number of results found (not necessarily the number returned).

type()

The Resource objects' type.

AUTOLOADED METHODS ^

As a convenience, the Response object will accept method calls the belong to its Resource objects. The method calls will be executed on the first object in the results arrayref. This allows you to use the Response object just like a Resource object, which is useful when a method call (e.g. getUserDetails) is expected to return one and only one result.

Note that WebService::Etsy::Method objects include methods that collide with WebService::Etsy::Response object methods, in which case you'll need to use the longer form of $resp->[ 0 ]->method() (although this shouldn't matter too much since there aren't currently any API methods that return only one method result).

These methods are generated using AUTOLOAD, and so won't be picked up by can() etc.

SEE ALSO ^

http://developer.etsy.com/docs#api_response_structure, WebService::Etsy::Resource.

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.

syntax highlighting: