/ 
WWW-Google-CustomSearch-0.17
River stage zero No dependents
/ WWW::Google::CustomSearch::Result

NAME

WWW::Google::CustomSearch::Result - Placeholder for Google JSON/Atom Custom Search Result.

VERSION

Version 0.17

DESCRIPTION

Provides the interface to the individual search results based on the search criteria.

METHODS

kind()

Returns the 'kind' attribute of the search result.

use strict; use warnings;
use WWW::Google::CustomSearch;

my $api_key = 'Your_API_Key';
my $cx      = 'Search_Engine_Identifier';
my $engine  = WWW::Google::CustomSearch->new(api_key => $api_key, cx => $cx);
my $result  = $engine->search("Google");
print "Kind: ", $result->kind, "\n";

formattedTotalResults()

Returns the 'formattedTotalResults' attribute of the search result.

use strict; use warnings;
use WWW::Google::CustomSearch;

my $api_key = 'Your_API_Key';
my $cx      = 'Search_Engine_Identifier';
my $engine  = WWW::Google::CustomSearch->new(api_key => $api_key, cx => $cx);
my $result  = $engine->search("Google");
print "Formatted Total Results: ", $result->formattedTotalResults, "\n";

formattedSearchTime()

Returns the 'formattedSearchTime' attribute of the search result.

use strict; use warnings;
use WWW::Google::CustomSearch;

my $api_key = 'Your_API_Key';
my $cx      = 'Search_Engine_Identifier';
my $engine  = WWW::Google::CustomSearch->new(api_key => $api_key, cx => $cx);
my $result  = $engine->search("Google");
print "Formatted Search Time: ", $result->formattedSearchTime, "\n";

totalResults()

Returns the 'totalResults' attribute of the search result.

use strict; use warnings;
use WWW::Google::CustomSearch;

my $api_key = 'Your_API_Key';
my $cx      = 'Search_Engine_Identifier';
my $engine  = WWW::Google::CustomSearch->new(api_key => $api_key, cx => $cx);
my $result  = $engine->search("Google");
print "Total Results: ", $result->totalResults, "\n";

searchTime()

Returns the 'searchTime' attribute of the search result.

use strict; use warnings;
use WWW::Google::CustomSearch;

my $api_key = 'Your_API_Key';
my $cx      = 'Search_Engine_Identifier';
my $engine  = WWW::Google::CustomSearch->new(api_key => $api_key, cx => $cx);
my $result  = $engine->search("Google");
print "Search Time: ", $result->searchTime, "\n";

url_template()

Returns the URL template attribute of the search result.

use strict; use warnings;
use WWW::Google::CustomSearch;

my $api_key = 'Your_API_Key';
my $cx      = 'Search_Engine_Identifier';
my $engine  = WWW::Google::CustomSearch->new(api_key => $api_key, cx => $cx);
my $result  = $engine->search("Google");
print "URL Template: ", $result->url_template, "\n";

url_type()

Returns the URL Type attribute of the search result.

use strict; use warnings;
use WWW::Google::CustomSearch;

my $api_key = 'Your_API_Key';
my $cx      = 'Search_Engine_Identifier';
my $engine  = WWW::Google::CustomSearch->new(api_key => $api_key, cx => $cx);
my $result  = $engine->search("Google");
print "URL Type: ", $result->url_type, "\n";

request()

Returns the request WWW::Google::CustomSearch::Request object used in the last search.

use strict; use warnings;
use WWW::Google::CustomSearch;

my $api_key = 'Your_API_Key';
my $cx      = 'Search_Engine_Identifier';
my $engine  = WWW::Google::CustomSearch->new(api_key => $api_key, cx => $cx);
my $result  = $engine->search("Google");
my $request = $result->request;

nextPage()

Returns the next page WWW::Google::CustomSearch::Page object which can be used to fetch the next page result.

use strict; use warnings;
use WWW::Google::CustomSearch;

my $api_key = 'Your_API_Key';
my $cx      = 'Search_Engine_Identifier';
my $engine  = WWW::Google::CustomSearch->new(api_key => $api_key, cx => $cx);
my $result  = $engine->search("Google");
my $page    = $result->nextPage;

previousPage()

Returns the previous page WWW::Google::CustomSearch::Page object which can be used to fetch the previous page result.

use strict; use warnings;
use WWW::Google::CustomSearch;

my $api_key = 'Your_API_Key';
my $cx      = 'Search_Engine_Identifier';
my $engine  = WWW::Google::CustomSearch->new(api_key => $api_key, cx => $cx, start => 2);
my $result  = $engine->search("Google");
my $page    = $result->previousPage;

items()

Returns list of search item WWW::Google::CustomSearch::Item based on the search criteria.

use strict; use warnings;
use WWW::Google::CustomSearch;

my $api_key = 'Your_API_Key';
my $cx      = 'Search_Engine_Identifier';
my $engine  = WWW::Google::CustomSearch->new(api_key => $api_key, cx => $cx);
my $result  = $engine->search("Google");
my $items   = $result->items;

AUTHOR

Mohammad S Anwar, <mohammad.anwar at yahoo.com>

BUGS

Please report any bugs or feature requests to bug-www-google-customsearch at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=WWW-Google-CustomSearch. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc WWW::Google::CustomSearch::Result

You can also look for information at:

LICENSE AND COPYRIGHT

Copyright 2014 Mohammad S Anwar.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License.By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you,you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement,then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.