ItemReview SFO
Properties
Â
Field | Type | Comment/Sample |
---|
Â
Methods
Method | Returns | Parameters | Parameter Types | Comments/Sample |
---|---|---|---|---|
getOverall() | BigDecimal | Â | Â | overall rating |
getOverallAsStars | string | Â | Â | html version of overall rating with stars images |
getOverallAsStars(string[]) | string | string[] | Â |
|
getRatingScore() | BigDecimal | Â | Â | Â |
isRecommendToFriend() | boolean | Â | Â | Â |
getTitle() | string | Â | Â | Â |
getDate() | string | Â | Â | MM/dd/yyyy format |
getDateMillis() | long | Â | Â | review date in milliseconds |
getDateAsObject() | Date | Â | Â | Â |
getRatings() | ItemReviewRating[] | Â | Â | Â |
getReview() | string | Â | Â | text commentary portion of review |
getReviewOid() | integer | Â | Â | unique id of review |
getReviewerNickname() | string | Â | Â | Â |
getReviewerLocation() | string | Â | Â | Â |
getReviewerQuestions() | ItemReviewerQuestion[] | Â | Â | Â |
getHelpfulYesUrl() | string | Â | Â | url of the cgi used to vote yes. |
getHelpfulNoUrl() | string | Â | Â | url of the cgi used to vote no. |
getHelpfulYesVotes() | integer | Â | Â | Â |
getHelpfulNoVotes() | integer | Â | Â | Â |
getSortOrderFeatured() | integer | Â | Â | pass this result (sortOrderId) of this to $formatHelper.sortReviews(reviews, sortOrderId) to sort reviews by 'featured' flag |
| integer | Â | Â | pass this result (sortOrderId) of this to $formatHelper.sortReviews(reviews, sortOrderId) to sort reviews by order date |
getSortOrderRating() | integer | Â | Â | pass this result (sortOrderId) of this to $formatHelper.sortReviews(reviews, sortOrderId) to sort reviews by rating |
getSortOrderHelpfulness() | integer | Â | Â | pass this result (sortOrderId) of this to $formatHelper.sortReviews(reviews, sortOrderId) to sort reviews by helpfulness |
getSortOrderLength() | integer | Â | Â | pass this result (sortOrderId) of this to $formatHelper.sortReviews(reviews, sortOrderId) to sort reviews by review length |
getHelpfulNetVotes() | integer | Â | Â | net summary of yes minus no votes |
isFeatured() | boolean | Â | Â | true if this review is featured, else false |
getReviewerRank() | integer* | Â | Â | if the review has an active customer profile tied to it, this returns the review rank, else null. Be careful with this method as it returns an object (Integer) and not a primitive. So you must check for a null condition before blindly using. |
isReviewerExpert() | boolean | Â | Â | true if the reviewer is considered an expert by the merchant. |
getEdit() | string | Â | Â | if (and only if) the merchant is logged in, this returns an anchor <a> tag that will open a separate browser window allowing the merchant to edit the review directly. |