Save the date! Android Dev Summit is coming to Sunnyvale, CA on Oct 23-24, 2019.

Rating2

class Rating2 : VersionedParcelable
kotlin.Any
   ↳ androidx.media2.Rating2

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

Indicates a rating style is not supported.

static Int

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

static Int

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

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 expressed as a percentage.

Public methods
Boolean

Return whether the rating is "heart selected".

Int

Boolean

Return whether there is a rating value available.

Boolean

Return whether the rating is "thumb up".

Float

Return the percentage-based rating value.

Boolean
equals(other: Any?)

String

Int

Return the rating style.

Float

Return the star-based rating value.

static Rating2?
newUnratedRating(ratingStyle: Int)

Return a Rating2 instance with no rating.

static Rating2?

Return a Rating2 instance with a heart-based rating.

static Rating2?
newThumbRating(thumbIsUp: Boolean)

Return a Rating2 instance with a thumb-based rating.

static Rating2?
newStarRating(starRatingStyle: Int, starRating: Float)

Return a Rating2 instance with a star-based rating.

static Rating2?

Return a Rating2 instance with a percentage-based rating.

Constants

RATING_NONE

static val RATING_NONE: Int

Indicates a rating style is not supported. A Rating2 will never have this type, but can be used by other classes to indicate they do not support Rating2.

Value: 0

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_THUMB_UP_DOWN

static val RATING_THUMB_UP_DOWN: Int

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

Value: 2

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_PERCENTAGE

static val RATING_PERCENTAGE: Int

A rating style expressed as a percentage.

Value: 6

Public methods

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.

hashCode

fun hashCode(): Int

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.

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.

equals

fun equals(other: Any?): Boolean

toString

fun toString(): String

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.

newUnratedRating

@Nullable static fun newUnratedRating(ratingStyle: Int): Rating2?

Return a Rating2 instance with no rating. Create and return a new Rating2 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
Rating2?: null if an invalid rating style is passed, a new Rating2 instance otherwise.

newHeartRating

@Nullable static fun newHeartRating(hasHeart: Boolean): Rating2?

Return a Rating2 instance with a heart-based rating. Create and return a new Rating2 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
Rating2?: a new Rating2 instance.

newThumbRating

@Nullable static fun newThumbRating(thumbIsUp: Boolean): Rating2?

Return a Rating2 instance with a thumb-based rating. Create and return a new Rating2 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
Rating2?: a new Rating2 instance.

newStarRating

@Nullable static fun newStarRating(starRatingStyle: Int, starRating: Float): Rating2?

Return a Rating2 instance with a star-based rating. Create and return a new Rating2 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
Rating2?: null if the rating style is invalid, or the rating is out of range, a new Rating2 instance otherwise.

newPercentageRating

@Nullable static fun newPercentageRating(percent: Float): Rating2?

Return a Rating2 instance with a percentage-based rating. Create and return a new Rating2 instance with a RATING_PERCENTAGE rating style, and a rating of the given percentage.

Parameters
percent Float: the value of the rating
Return
Rating2?: null if the rating is out of range, a new Rating2 instance otherwise.