Joshua Daniel Rotenberg > WebService-Yelp > WebService::Yelp::Message

Download:
WebService-Yelp-0.03.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Source  

NAME ^

  WebService::Yelp::Message - Yelp.com API Message Class

SYNOPSIS ^

 use strict;
 use WebService::Yelp;

 my $yelp = WebService::Yelp->new({ywsid => 'XXXXXXXXXXXX'});

 my $biz_res = $yelp->search_review_hood({
                                             term => 'cream puffs',
                                             location => 'San Francisco',
                                             };
 my $message = $biz_res->message();

 if($message->code() == 0) {
   # everything is ok, continue with search results processing
 }
 else {
   print "search failed with code:" . $message->code() . ":" . 
     $message->text();
 }

DESCRIPTION ^

This class represents the status of a search result. A code of 0 means success, otherwise something bad happened.

  http://www.yelp.com/developers/documentation/search_api

METHODS (Read Only) ^

code

The response code

text

The response message.

version

The API version

syntax highlighting: