Trading_ResponseAttributeSetType Class Reference
Inherits from | NSObject |
Conforms to | PicoBindable |
Declared in | Trading_ResponseAttributeSetType.h Trading_ResponseAttributeSetType.m |
Tasks
-
approximatePages
As calculating the potentially large number of pages can affect this call's
property
performance, and since the actual number of products returned per page can
vary in each response, we cannot provide a precise total page count.
Therefore, this is an estimated page count based on TotalProducts and other
factors, such as the number of records eBay’s search engine has examined so
far in the product database. Once PageNumber approaches or exceeds this
page count, we examine more records in the database and we may recalculate
this value. If you estimate the number of pages yourself by using
TotalProducts, EntriesPerPage, and MaxChildrenPerFamily (which is also an
approximate value), your result will not necessarily match
ApproximatePages. -
attributeSetID
Numeric value that identifies the attribute set in a language-independent way.
property
Unique across all eBay sites. Corresponds to a characteristic set associated
with the current set of search results.
Always returned when AttributeSet is returned. -
hasMore
If true, the query results contain additional pages (higher than the current
property
page number). You can retrieve more results by incrementing the PageNumber
value that was passed in the request. -
productFamilies
ProductFamilies represents one product family. Multiple ProductFamilies
property
properties can be returned. A product family identifies a group of related
products. For example, the movie “My Favorite Movie: The Sequel” might be
released on DVD, but there might be several editions of the DVD (e.g., in
different languages) with different ISBN numbers. All variations are part of
the same product family (“My Favorite Movie: The Sequel” in the DVD format).
See “Limit the Quantity of Products Returned Per Family” in the eBay Web
Services Guide. Always returned when AttributeSet is returned. -
productFinderConstraints
A list of attributes (constraints) that were specified in the search request.
property
This information is useful when multiple queries were specified in a
GetProductSearchResults request. Use this information to map each query to
each result in the response object. Applicable when the search request was
constructed based on a product finder. -
tooManyMatchesFound
If too many search results match the query, the TooManyMatchesFound tag is
property
returned with a value of true, and a warning is returned. If this occurs, it
may be a good idea to ask the user to specify more details to narrow the
search (e.g., specify “My Favorite Movie” instead of “My”).
Always returns false for GetProductFamilyMembers. -
totalProducts
The total quantity of products that match the query (within
property
the characteristic set). This can exceed the actual number of products
returned in the current virtual page. Always returned when AttributeSet is
returned. -
any
(public property)
property
Properties
any
(public property)
@property (nonatomic, retain) NSMutableArray *any
Discussion
(public property)
entry type : PicoAnyElement, wrapper for primitive anyelement
Declared In
Trading_ResponseAttributeSetType.h
approximatePages
As calculating the potentially large number of pages can affect this call's
performance, and since the actual number of products returned per page can
vary in each response, we cannot provide a precise total page count.
Therefore, this is an estimated page count based on TotalProducts and other
factors, such as the number of records eBay’s search engine has examined so
far in the product database. Once PageNumber approaches or exceeds this
page count, we examine more records in the database and we may recalculate
this value. If you estimate the number of pages yourself by using
TotalProducts, EntriesPerPage, and MaxChildrenPerFamily (which is also an
approximate value), your result will not necessarily match
ApproximatePages.
@property (nonatomic, retain) NSNumber *approximatePages
Discussion
As calculating the potentially large number of pages can affect this call's
performance, and since the actual number of products returned per page can
vary in each response, we cannot provide a precise total page count.
Therefore, this is an estimated page count based on TotalProducts and other
factors, such as the number of records eBay’s search engine has examined so
far in the product database. Once PageNumber approaches or exceeds this
page count, we examine more records in the database and we may recalculate
this value. If you estimate the number of pages yourself by using
TotalProducts, EntriesPerPage, and MaxChildrenPerFamily (which is also an
approximate value), your result will not necessarily match
ApproximatePages.
type : NSNumber, wrapper for primitive int
Declared In
Trading_ResponseAttributeSetType.h
attributeSetID
Numeric value that identifies the attribute set in a language-independent way.
Unique across all eBay sites. Corresponds to a characteristic set associated
with the current set of search results.
Always returned when AttributeSet is returned.
@property (nonatomic, retain) NSNumber *attributeSetID
Discussion
Numeric value that identifies the attribute set in a language-independent way.
Unique across all eBay sites. Corresponds to a characteristic set associated
with the current set of search results.
Always returned when AttributeSet is returned.
type : NSNumber, wrapper for primitive int
Declared In
Trading_ResponseAttributeSetType.h
hasMore
If true, the query results contain additional pages (higher than the current
page number). You can retrieve more results by incrementing the PageNumber
value that was passed in the request.
@property (nonatomic, retain) NSNumber *hasMore
Discussion
If true, the query results contain additional pages (higher than the current
page number). You can retrieve more results by incrementing the PageNumber
value that was passed in the request.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_ResponseAttributeSetType.h
productFamilies
ProductFamilies represents one product family. Multiple ProductFamilies
properties can be returned. A product family identifies a group of related
products. For example, the movie “My Favorite Movie: The Sequel” might be
released on DVD, but there might be several editions of the DVD (e.g., in
different languages) with different ISBN numbers. All variations are part of
the same product family (“My Favorite Movie: The Sequel” in the DVD format).
See “Limit the Quantity of Products Returned Per Family” in the eBay Web
Services Guide. Always returned when AttributeSet is returned.
@property (nonatomic, retain) NSMutableArray *productFamilies
Discussion
ProductFamilies represents one product family. Multiple ProductFamilies
properties can be returned. A product family identifies a group of related
products. For example, the movie “My Favorite Movie: The Sequel” might be
released on DVD, but there might be several editions of the DVD (e.g., in
different languages) with different ISBN numbers. All variations are part of
the same product family (“My Favorite Movie: The Sequel” in the DVD format).
See “Limit the Quantity of Products Returned Per Family” in the eBay Web
Services Guide. Always returned when AttributeSet is returned.
entry type : class Trading_ProductFamilyType
Declared In
Trading_ResponseAttributeSetType.h
productFinderConstraints
A list of attributes (constraints) that were specified in the search request.
This information is useful when multiple queries were specified in a
GetProductSearchResults request. Use this information to map each query to
each result in the response object. Applicable when the search request was
constructed based on a product finder.
@property (nonatomic, retain) NSMutableArray *productFinderConstraints
Discussion
A list of attributes (constraints) that were specified in the search request.
This information is useful when multiple queries were specified in a
GetProductSearchResults request. Use this information to map each query to
each result in the response object. Applicable when the search request was
constructed based on a product finder.
entry type : class Trading_ProductFinderConstraintType
Declared In
Trading_ResponseAttributeSetType.h
tooManyMatchesFound
If too many search results match the query, the TooManyMatchesFound tag is
returned with a value of true, and a warning is returned. If this occurs, it
may be a good idea to ask the user to specify more details to narrow the
search (e.g., specify “My Favorite Movie” instead of “My”).
Always returns false for GetProductFamilyMembers.
@property (nonatomic, retain) NSNumber *tooManyMatchesFound
Discussion
If too many search results match the query, the TooManyMatchesFound tag is
returned with a value of true, and a warning is returned. If this occurs, it
may be a good idea to ask the user to specify more details to narrow the
search (e.g., specify “My Favorite Movie” instead of “My”).
Always returns false for GetProductFamilyMembers.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_ResponseAttributeSetType.h
totalProducts
The total quantity of products that match the query (within
the characteristic set). This can exceed the actual number of products
returned in the current virtual page. Always returned when AttributeSet is
returned.
@property (nonatomic, retain) NSNumber *totalProducts
Discussion
The total quantity of products that match the query (within
the characteristic set). This can exceed the actual number of products
returned in the current virtual page. Always returned when AttributeSet is
returned.
type : NSNumber, wrapper for primitive int
Declared In
Trading_ResponseAttributeSetType.h