Flickr::API::Response.3pm

Langue: en

Version: 2005-07-11 (mandriva - 01/05/08)

Section: 3 (Bibliothèques de fonctions)

NAME

Flickr::API::Response - A response from the flickr API.

SYNOPSIS

   use Flickr::API;
   use Flickr::API::Response;
 
   my $api = new Flickr::API({'key' => 'your_api_key'});
 
   my $response = $api->execute_method('flickr.test.echo', {
                 'foo' => 'bar',
                 'baz' => 'quux',
         });
 
   print "Success: $response->{success}\n";
 
 

DESCRIPTION

This object encapsulates a response from the Flickr API. It's a subclass of "HTTP::Response" with the following additional keys:
   {
         'success' => 1,
         'tree' => XML::Parser::Lite::Tree,
         'error_code' => 0,
         'error_message' => '',
   }
 
 

The "_request" key contains the request object that this response was generated from. This request will be a "Flickr::API::Request" object, which is a subclass of "HTTP:Request".

The "sucess" key contains 1 or 0, indicating whether the request suceeded. If it failed, "error_code" and "error_message" explain what went wrong. If it suceeded, "tree" contains an "XML::Parser::Lite::Tree" object of the response XML.

AUTHOR

Copyright (C) 2004, Cal Henderson, <cal@iamcal.com>

SEE ALSO

Flickr::API, XML::Parser::Lite