.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16) .\" .\" Standard preamble: .\" ======================================================================== .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. \*(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- .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\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" 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::Amazon::Property 3pm" .TH Net::Amazon::Property 3pm "2011-10-29" "perl v5.14.2" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Net::Amazon::Property \- Baseclass for products on amazon.com .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use Net::Amazon; \& \& # ... \& \& if($resp\->is_success()) { \& for my $prop ($resp\->properties) { \& print $_\->ProductName(), " ", \& $_\->Manufacturer(), " ", \& $_\->OurPrice(), "\en"; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\f(CW\*(C`Net::Amazon::Property\*(C'\fR is the baseclass for results returned from Amazon web service queries. The term 'properties' is used as a generic description for an item on amazon.com. .PP Typically, the \f(CW\*(C`properties()\*(C'\fR method of a \f(CW\*(C`Net::Amazon::Response::*\*(C'\fR object will return one or more objects of class \f(CW\*(C`Net::Amazon::Property\*(C'\fR or one of its subclasses, e.g. \f(CW\*(C`Net::Amazon::Property::Book\*(C'\fR or \&\f(CW\*(C`Net::Amazon::Property::CD\*(C'\fR. .PP While \f(CW\*(C`Net::Amazon::Property\*(C'\fR objects expose accessors for all fields returned in the \s-1XML\s0 response (like \f(CW\*(C`OurPrice()\*(C'\fR, \f(CW\*(C`ListPrice()\*(C'\fR, \&\f(CW\*(C`Manufacturer()\*(C'\fR, \f(CW\*(C`Asin()\*(C'\fR, \f(CW\*(C`Catalog()\*(C'\fR, \f(CW\*(C`ProductName()\*(C'\fR, subclasses might define their own accessors to more class-specific fields (like the i\f(CW\*(C`Net::Amazon::Property::Book\*(C'\fR's \f(CW\*(C`authors()\*(C'\fR method returning a list of authors, while \f(CW\*(C`Net::Amazon::Property\*(C'\fR's \f(CW\*(C`Authors()\*(C'\fR method will return a reference to a sub-hash containing a \f(CW\*(C`Author\*(C'\fR field, just like the response's \s-1XML\s0 contained it). .SS "\s-1METHODS\s0" .IX Subsection "METHODS" Methods vary, depending on the item returned from a query. Here's the most common ones. They're all accessors, meaning they can be used like \f(CW\*(C`Method()\*(C'\fR to retrieve the value or like \f(CW\*(C`Method($value)\*(C'\fR to set the value of the field. .IP "\fIAsin()\fR" 4 .IX Item "Asin()" The item's \s-1ASIN\s0 number. This option is deprecated, please use \s-1ASIN\s0. .IP "\s-1\fIASIN\s0()\fR" 4 .IX Item "ASIN()" The item's \s-1ASIN\s0 number. .IP "\fIProductName()\fR" 4 .IX Item "ProductName()" Book title, \s-1CD\s0 album name or item name. This option is actually an alias for the method title, and is actually dependent upon the type of item returned. .IP "\fIAvailability()\fR" 4 .IX Item "Availability()" Text string describing if the item is available. Examples: \&\f(CW"Usually ships within 24 hours"\fR or \&\f(CW"Out of Print\-\-Limited Availability"\fR. .IP "\fICatalog()\fR" 4 .IX Item "Catalog()" Shows the catalog the item was found in: \f(CW\*(C`Book\*(C'\fR, \f(CW\*(C`Music\*(C'\fR, \f(CW\*(C`Classical\*(C'\fR, \&\f(CW\*(C`Electronics\*(C'\fR etc. .IP "\fIAuthors()\fR" 4 .IX Item "Authors()" Returns a sub-hash with a \f(CW\*(C`Author\*(C'\fR key, which points to either a single \&\f(CW$scalar\fR or to a reference of an array containing author names as scalars. .IP "\fIReleaseDate()\fR" 4 .IX Item "ReleaseDate()" Item's release date, format is \*(L"\s-1NN\s0 Monthname, Year\*(R". .IP "\fIManufacturer()\fR" 4 .IX Item "Manufacturer()" Music label, publishing company or manufacturer .IP "\fIImageUrlSmall()\fR" 4 .IX Item "ImageUrlSmall()" \&\s-1URL\s0 to a small (thumbnail) image of the item .IP "\fIImageUrlMedium()\fR" 4 .IX Item "ImageUrlMedium()" \&\s-1URL\s0 to a medium-size image of the item .IP "\fIImageUrlLarge()\fR" 4 .IX Item "ImageUrlLarge()" \&\s-1URL\s0 to a large image of the item .IP "\fIListPrice()\fR" 4 .IX Item "ListPrice()" List price of the item .IP "\fIOurPrice()\fR" 4 .IX Item "OurPrice()" Amazon price of the item .IP "\fIUsedPrice()\fR" 4 .IX Item "UsedPrice()" Used price of the item .IP "\fIRawListPrice()\fR" 4 .IX Item "RawListPrice()" Unformatted list price as an integer, without currency symbol. .IP "\fICurrencyCode()\fR" 4 .IX Item "CurrencyCode()" The currency code for the \*(L"\fIListPrice()\fR\*(R", e.g. \f(CW\*(C`USD\*(C'\fR. .IP "\fISalesRank()\fR" 4 .IX Item "SalesRank()" Sales rank of the item (contains digits and commas, like 1,000,001) .IP "\fIMedia()\fR" 4 .IX Item "Media()" Type of media (Paperback, etc.). .IP "\fINumMedia()\fR" 4 .IX Item "NumMedia()" Number of media the item carries (1,2 CDs etc.). .IP "\fIProductDescription()\fR" 4 .IX Item "ProductDescription()" Lengthy textual description of the product. .IP "\fICollectiblePrice()\fR" 4 .IX Item "CollectiblePrice()" Lowest price in \*(L"Collectible\*(R" category. .IP "\fICollectibleCount()\fR" 4 .IX Item "CollectibleCount()" Number of offerings in \*(L"Collectible\*(R" category. .IP "\fINumberOfOfferings()\fR" 4 .IX Item "NumberOfOfferings()" Total number of offerings in all categories. .IP "\fIUsedCount()\fR" 4 .IX Item "UsedCount()" Number of offerings in \*(L"Used\*(R" category. .IP "\fITotalOffers()\fR" 4 .IX Item "TotalOffers()" Number of offerings of the product. .IP "\fIThirdPartyNewPrice()\fR" 4 .IX Item "ThirdPartyNewPrice()" Lowest price in \*(L"Third Party New\*(R" category. .IP "\fIThirdPartyNewCount()\fR" 4 .IX Item "ThirdPartyNewCount()" Number of offerings in \*(L"Third Party New\*(R" category. .IP "\fISmallImageWidth()\fR" 4 .IX Item "SmallImageWidth()" Return the width of the small image in pixels. .IP "\fISmallImageHeight()\fR" 4 .IX Item "SmallImageHeight()" Return the height of the small image in pixels. .IP "\fIMediumImageWidth()\fR" 4 .IX Item "MediumImageWidth()" Return the width of the medium image in pixels. .IP "\fIMediumImageHeight()\fR" 4 .IX Item "MediumImageHeight()" Return the height of the medium image in pixels. .IP "\fILargeImageWidth()\fR" 4 .IX Item "LargeImageWidth()" Return the width of the large image in pixels. .IP "\fILargeImageHeight()\fR" 4 .IX Item "LargeImageHeight()" Return the height of the large image in pixels. .IP "\fISuperSaverShipping()\fR" 4 .IX Item "SuperSaverShipping()" Boolean value that indicates if the product is eligible for super saver shipping. .IP "\fIyear()\fR" 4 .IX Item "year()" The release year extracted from \fIReleaseDate()\fR. .IP "\fIbrowse_nodes()\fR" 4 .IX Item "browse_nodes()" Returns a list of browse nodes (text string categories) for this item. .IP "\fIsimilar_asins()\fR" 4 .IX Item "similar_asins()" Returns a list of ASINs of similar items for this item. .IP "\fISimilarProducts()\fR" 4 .IX Item "SimilarProducts()" Returns a list of ASINs and titles of similar items for this item. .PP Please check the subclasses of \f(CW\*(C`Net::Amazon::Property\*(C'\fR for specialized methods. .SH "AUTHOR" .IX Header "AUTHOR" Mike Schilli, .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" Copyright 2003 by Mike Schilli .PP This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.