RatingCompat

const val RATING_3_STARS = 3: Int

A rating style with 0 to 3 stars.

const val RATING_4_STARS = 4: Int

A rating style with 0 to 4 stars.

const val RATING_5_STARS = 5: Int

A rating style with 0 to 5 stars.

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).

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.

const val RATING_PERCENTAGE = 6: Int

A rating style expressed as a percentage.

const val RATING_THUMB_UP_DOWN = 2: Int

A rating style for "thumb up" vs "thumb down".

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+.

fun getPercentRating(): Float

Return the percentage-based rating value.

fun getRating(): Any!

Gets the underlying framework android.media.Rating object.

This method is only supported on API 19+.

fun getRatingStyle(): Int

Return the rating style.

fun getStarRating(): Float

Return the star-based rating value.

fun hasHeart(): Boolean

Return whether the rating is "heart selected".

fun isRated(): Boolean

Return whether there is a rating value available.

fun isThumbUp(): Boolean

Return whether the rating is "thumb up".

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.

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.

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.

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.

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.