.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Net::Google::Response 3"
.TH Net::Google::Response 3 "2008-01-01" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
Net::Google::Response \- simple OOP\-ish interface to the Google SOAP
API search responses
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\& my $service = Net::Google->new(key=>LOCAL_GOOGLE_KEY);
\& my $session = $service->search();
.Ve
.PP
.Vb 1
\& $session->query(qw(Perl modules));
.Ve
.PP
.Vb 3
\& # You are probably better off calling
\& # $session->results() but if you want
\& # the raw response object(s) here ya go :
.Ve
.PP
.Vb 2
\& my $responses = $session->response();
\& my $count     = scalar(@$responses);
.Ve
.PP
.Vb 1
\& # $r is a Net::Google::Response object
.Ve
.PP
.Vb 3
\& foreach my $r (@$responses) {
\&     print sprintf("%s : %s\en",$r->searchQuery(),$r->estimatedTotalResults());
\& }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Provides a simple OOP-ish interface to the Google \s-1SOAP\s0 \s-1API\s0 for
searching.  This package is used by \fINet::Google\fR.
.PP
The Net::Google::Response object is used to contain response
information provided by the Google search service in response to a
search query.  The Response object allows the client program to easily
access the data returned from a search.
.PP
Response data is accessed using methods with identical names to the
elements of a search response (as documented in the Google Web APIs
Reference, section 3).  For instance, the first example in the \s-1SYNOPSIS\s0
section, above, would return the estimated number of total results for
the query.
.PP
Response objects may contain other response objects, where an element
would return an array of other elements.  For instance, calling
\&\f(CW\*(C`$response\->resultElements()\*(C'\fR will return a reference to an array
of Net::Google::Response objects, each one representing one result
from the search.
.PP
The Response module will automatically provide methods for the search
response, as described by the service \s-1WSDL\s0 file.  The results format
is described by the Google APIs documentation, to which you should
refer for the most up-to-date information.  As of the April 8th, 2002
release of the Google APIs, the methods below are provided for each
search result.
.SH "PACKAGE METHODS"
.IX Header "PACKAGE METHODS"
.Sh "_\|_PACKAGE_\|_\->new(\e%args)"
.IX Subsection "__PACKAGE__->new(%args)"
.SH "\fINet::Google::Response\fP OBJECT METHODS"
.IX Header "Net::Google::Response OBJECT METHODS"
.Sh "$response\->\fIdocumentFiltering()\fP"
.IX Subsection "$response->documentFiltering()"
Returns 0 if false, 1 if true.
.Sh "$response\->\fIsearchComments()\fP"
.IX Subsection "$response->searchComments()"
Returns a string.
.Sh "$response\->\fIestimatedTotalResultsCount()\fP"
.IX Subsection "$response->estimatedTotalResultsCount()"
Returns an integer.
.Sh "$response\->\fIestimateIsExact()\fP"
.IX Subsection "$response->estimateIsExact()"
Returns 0 if false, 1 if true.
.Sh "$response\->\fIresultElements()\fP"
.IX Subsection "$response->resultElements()"
Returns a reference to an array of \fIResponse\fR objects.
.Sh "$response\->\fIsearchQuery()\fP"
.IX Subsection "$response->searchQuery()"
Returns a string.
.Sh "$response\->\fIstartIndex()\fP"
.IX Subsection "$response->startIndex()"
Returns an integer.
.Sh "$response\->\fIendIndex()\fP"
.IX Subsection "$response->endIndex()"
Returns an integer.
.Sh "$response\->\fIsearchTips()\fP"
.IX Subsection "$response->searchTips()"
Returns a string.
.Sh "$response\->\fIdirectoryCategories()\fP"
.IX Subsection "$response->directoryCategories()"
Returns a reference to an array of Response objects (one per directory
category \*(-- see below).
.Sh "$response\->\fIsearchTime()\fP"
.IX Subsection "$response->searchTime()"
Returns a float.
.Sh "$pkg\->\fIto_string()\fP"
.IX Subsection "$pkg->to_string()"
.SH "\fIResult\fP OBJECT METHODS"
.IX Header "Result OBJECT METHODS"
.Sh "$result\->\fItitle()\fP"
.IX Subsection "$result->title()"
Returns a string.
.Sh "$result\->\s-1\fIURL\s0()\fP"
.IX Subsection "$result->URL()"
Returns a string.
.Sh "$result\->\fIsnippet()\fP"
.IX Subsection "$result->snippet()"
Returns a string, formatted in \s-1HTML\s0.
.Sh "$result\->\fIcachedSize()\fP"
.IX Subsection "$result->cachedSize()"
Returns a string.
.Sh "$result\->\fIdirectoryTitle()\fP"
.IX Subsection "$result->directoryTitle()"
Returns a string.
.Sh "$result\->\fIsummary()\fP"
.IX Subsection "$result->summary()"
Returns a string.
.Sh "$result\->\fIhostName()\fP"
.IX Subsection "$result->hostName()"
Returns a string.
.Sh "$result\->\fIdirectoryCategory()\fP"
.IX Subsection "$result->directoryCategory()"
Returns a hash reference.
.SH "VERSION"
.IX Header "VERSION"
1.0
.SH "DATE"
.IX Header "DATE"
$Date: 2006/01/12 03:37:31 $
.SH "AUTHOR"
.IX Header "AUTHOR"
Aaron Straup Cope
.SH "CONTRIBUTORS"
.IX Header "CONTRIBUTORS"
Marc Hedlund <marc@precipice.org>
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Net::Google
.SH "LICENSE"
.IX Header "LICENSE"
Copyright (c) 2002\-2005, Aaron Straup Cope. All Rights Reserved.
.PP
This is free software, you may use it and distribute it under the
same terms as Perl itself.