RatingCompat
class RatingCompat : Parcelable
A class to encapsulate rating information used as content metadata. A rating is defined by its rating style (see RATING_HEART, RATING_THUMB_UP_DOWN, RATING_3_STARS, RATING_4_STARS, RATING_5_STARS or RATING_PERCENTAGE) and the actual rating value (which may be defined as "unrated"), both of which are defined when the rating instance is constructed through one of the factory methods.
Summary
Constants |
|
|---|---|
const Parcelable.Creator<RatingCompat!>! |
|
const Int |
RATING_3_STARS = 3A rating style with 0 to 3 stars. |
const Int |
RATING_4_STARS = 4A rating style with 0 to 4 stars. |
const Int |
RATING_5_STARS = 5A rating style with 0 to 5 stars. |
const Int |
RATING_HEART = 1A rating style with a single degree of rating, "heart" vs "no heart". |
const Int |
RATING_NONE = 0Indicates a rating style is not supported. |
const Int |
A rating style expressed as a percentage. |
const Int |
A rating style for "thumb up" vs "thumb down". |
Public functions |
|
|---|---|
Int |
|
java-static RatingCompat! |
fromRating(ratingObj: Any!)Creates an instance from a framework |
Float |
Return the percentage-based rating value. |
Any! |
Gets the underlying framework |
Int |
Return the rating style. |
Float |
Return the star-based rating value. |
Boolean |
hasHeart()Return whether the rating is "heart selected". |
Boolean |
isRated()Return whether there is a rating value available. |
Boolean |
Return whether the rating is "thumb up". |
java-static RatingCompat! |
newHeartRating(hasHeart: Boolean)Return a Rating instance with a heart-based rating. |
java-static RatingCompat! |
newPercentageRating(percent: Float)Return a Rating instance with a percentage-based rating. |
java-static RatingCompat! |
newStarRating(starRatingStyle: Int, starRating: Float)Return a Rating instance with a star-based rating. |
java-static RatingCompat! |
newThumbRating(thumbIsUp: Boolean)Return a Rating instance with a thumb-based rating. |
java-static RatingCompat! |
newUnratedRating(ratingStyle: Int)Return a Rating instance with no rating. |
String! |
toString() |
Unit |
writeToParcel(dest: Parcel!, flags: Int) |
Constants
RATING_HEART
const val RATING_HEART = 1: Int
A rating style with a single degree of rating, "heart" vs "no heart". Can be used to indicate the content referred to is a favorite (or not).
RATING_NONE
const val RATING_NONE = 0: Int
Indicates a rating style is not supported. A Rating will never have this type, but can be used by other classes to indicate they do not support Rating.
RATING_PERCENTAGE
const val RATING_PERCENTAGE = 6: Int
A rating style expressed as a percentage.
RATING_THUMB_UP_DOWN
const val RATING_THUMB_UP_DOWN = 2: Int
A rating style for "thumb up" vs "thumb down".
Public functions
fromRating
java-static fun fromRating(ratingObj: Any!): RatingCompat!
Creates an instance from a framework android.media.Rating object.
This method is only supported on API 19+.
| Parameters | |
|---|---|
ratingObj: Any! |
A |
| Returns | |
|---|---|
RatingCompat! |
An equivalent |
getPercentRating
fun getPercentRating(): Float
Return the percentage-based rating value.
| Returns | |
|---|---|
Float |
a rating value greater or equal to 0.0f, or a negative value if the rating style is not percentage-based, or if it is unrated. |
getRating
fun getRating(): Any!
Gets the underlying framework android.media.Rating object.
This method is only supported on API 19+.
| Returns | |
|---|---|
Any! |
An equivalent |
getRatingStyle
fun getRatingStyle(): Int
Return the rating style.
| Returns | |
|---|---|
Int |
one of |
getStarRating
fun getStarRating(): Float
Return the star-based rating value.
| Returns | |
|---|---|
Float |
a rating value greater or equal to 0.0f, or a negative value if the rating style is not star-based, or if it is unrated. |
hasHeart
fun hasHeart(): Boolean
Return whether the rating is "heart selected".
| Returns | |
|---|---|
Boolean |
true if the rating is "heart selected", false if the rating is "heart unselected", if the rating style is not |
isRated
fun isRated(): Boolean
Return whether there is a rating value available.
| Returns | |
|---|---|
Boolean |
true if the instance was not created with |
isThumbUp
fun isThumbUp(): Boolean
Return whether the rating is "thumb up".
| Returns | |
|---|---|
Boolean |
true if the rating is "thumb up", false if the rating is "thumb down", if the rating style is not |
newHeartRating
java-static fun newHeartRating(hasHeart: Boolean): RatingCompat!
Return a Rating instance with a heart-based rating. Create and return a new Rating instance with a rating style of RATING_HEART, and a heart-based rating.
| Parameters | |
|---|---|
hasHeart: Boolean |
true for a "heart selected" rating, false for "heart unselected". |
| Returns | |
|---|---|
RatingCompat! |
a new Rating instance. |
newPercentageRating
java-static fun newPercentageRating(percent: Float): RatingCompat!
Return a Rating instance with a percentage-based rating. Create and return a new Rating instance with a RATING_PERCENTAGE rating style, and a rating of the given percentage.
| Parameters | |
|---|---|
percent: Float |
the value of the rating |
| Returns | |
|---|---|
RatingCompat! |
null if the rating is out of range, a new Rating instance otherwise. |
newStarRating
java-static fun newStarRating(starRatingStyle: Int, starRating: Float): RatingCompat!
Return a Rating instance with a star-based rating. Create and return a new Rating instance with one of the star-base rating styles and the given integer or fractional number of stars. Non integer values can for instance be used to represent an average rating value, which might not be an integer number of stars.
| Parameters | |
|---|---|
starRatingStyle: Int |
one of |
starRating: Float |
a number ranging from 0.0f to 3.0f, 4.0f or 5.0f according to the rating style. |
| Returns | |
|---|---|
RatingCompat! |
null if the rating style is invalid, or the rating is out of range, a new Rating instance otherwise. |
newThumbRating
java-static fun newThumbRating(thumbIsUp: Boolean): RatingCompat!
Return a Rating instance with a thumb-based rating. Create and return a new Rating instance with a RATING_THUMB_UP_DOWN rating style, and a "thumb up" or "thumb down" rating.
| Parameters | |
|---|---|
thumbIsUp: Boolean |
true for a "thumb up" rating, false for "thumb down". |
| Returns | |
|---|---|
RatingCompat! |
a new Rating instance. |
newUnratedRating
java-static fun newUnratedRating(ratingStyle: Int): RatingCompat!
Return a Rating instance with no rating. Create and return a new Rating instance with no rating known for the given rating style.
| Parameters | |
|---|---|
ratingStyle: Int |
one of |
| Returns | |
|---|---|
RatingCompat! |
null if an invalid rating style is passed, a new Rating instance otherwise. |