It's happening now, watch the livestream.

RatingCompat

class RatingCompat : Parcelable
kotlin.Any
   ↳ android.support.v4.media.RatingCompat

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

static Int

A rating style with 0 to 3 stars.

static Int

A rating style with 0 to 4 stars.

static Int

A rating style with 0 to 5 stars.

static Int

A rating style with a single degree of rating, "heart" vs "no heart".

static Int

Indicates a rating style is not supported.

static Int

A rating style expressed as a percentage.

static Int

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

Public methods

Int

static RatingCompat!
fromRating(ratingObj: Any!)

Creates an instance from a framework android.media.Rating object.

Float

Return the percentage-based rating value.

Any!

Gets the underlying framework android.media.Rating object.

Int

Return the rating style.

Float

Return the star-based rating value.

Boolean

Return whether the rating is "heart selected".

Boolean

Return whether there is a rating value available.

Boolean

Return whether the rating is "thumb up".

static RatingCompat!

Return a Rating instance with a heart-based rating.

static RatingCompat!

Return a Rating instance with a percentage-based rating.

static RatingCompat!
newStarRating(starRatingStyle: Int, starRating: Float)

Return a Rating instance with a star-based rating.

static RatingCompat!
newThumbRating(thumbIsUp: Boolean)

Return a Rating instance with a thumb-based rating.

static RatingCompat!
newUnratedRating(ratingStyle: Int)

Return a Rating instance with no rating.

String

Unit
writeToParcel(dest: Parcel!, flags: Int)

Properties

static Creator<RatingCompat!>!

Constants

RATING_3_STARS

static val RATING_3_STARS: Int

A rating style with 0 to 3 stars.

Value: 3

RATING_4_STARS

static val RATING_4_STARS: Int

A rating style with 0 to 4 stars.

Value: 4

RATING_5_STARS

static val RATING_5_STARS: Int

A rating style with 0 to 5 stars.

Value: 5

RATING_HEART

static val RATING_HEART: 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).

Value: 1

RATING_NONE

static val RATING_NONE: 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.

Value: 0

RATING_PERCENTAGE

static val RATING_PERCENTAGE: Int

A rating style expressed as a percentage.

Value: 6

RATING_THUMB_UP_DOWN

static val RATING_THUMB_UP_DOWN: Int

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

Value: 2

Public methods

describeContents

fun describeContents(): Int

fromRating

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 android.media.Rating object, or null if none.
Return
RatingCompat!: An equivalent RatingCompat object, or null if none.

getPercentRating

fun getPercentRating(): Float

Return the percentage-based rating value.

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

Return
Any!: An equivalent android.media.Rating object, or null if none.

getRatingStyle

fun getRatingStyle(): Int

Return the rating style.

Return
Int: one of RATING_HEART, RATING_THUMB_UP_DOWN, RATING_3_STARS, RATING_4_STARS, RATING_5_STARS, or RATING_PERCENTAGE.

getStarRating

fun getStarRating(): Float

Return the star-based rating value.

Return
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".

Return
Boolean: true if the rating is "heart selected", false if the rating is "heart unselected", if the rating style is not RATING_HEART or if it is unrated.

isRated

fun isRated(): Boolean

Return whether there is a rating value available.

Return
Boolean: true if the instance was not created with newUnratedRating(int).

isThumbUp

fun isThumbUp(): Boolean

Return whether the rating is "thumb up".

Return
Boolean: true if the rating is "thumb up", false if the rating is "thumb down", if the rating style is not RATING_THUMB_UP_DOWN or if it is unrated.

newHeartRating

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".
Return
RatingCompat!: a new Rating instance.

newPercentageRating

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
Return
RatingCompat!: null if the rating is out of range, a new Rating instance otherwise.

newStarRating

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 RATING_3_STARS, RATING_4_STARS, RATING_5_STARS.
starRating Int: a number ranging from 0.0f to 3.0f, 4.0f or 5.0f according to the rating style.
Return
RatingCompat!: null if the rating style is invalid, or the rating is out of range, a new Rating instance otherwise.

newThumbRating

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".
Return
RatingCompat!: a new Rating instance.

newUnratedRating

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 RATING_HEART, RATING_THUMB_UP_DOWN, RATING_3_STARS, RATING_4_STARS, RATING_5_STARS, or RATING_PERCENTAGE.
Return
RatingCompat!: null if an invalid rating style is passed, a new Rating instance otherwise.

toString

fun toString(): String

writeToParcel

fun writeToParcel(dest: Parcel!, flags: Int): Unit

Properties

CREATOR

static val CREATOR: Creator<RatingCompat!>!