HeartRating

Added in 1.0.0
Deprecated in 1.3.0

class HeartRating : Rating

A class for rating with a single degree of rating, "heart" vs "no heart". This can be used to indicate the content referred to is a favorite (or not).

Summary

Public constructors

Creates a unrated HeartRating instance.
HeartRating(hasHeart: Boolean)

Creates a HeartRating instance.

Public functions
Boolean
equals(obj: Any!)
Boolean

Returns whether the rating is "heart selected".
Int
Boolean

Returns whether there is a rating value available.
String!

Public constructors

HeartRating

Added in 1.0.0
Deprecated in 1.3.0
HeartRating()

Creates a unrated HeartRating instance.

HeartRating

Added in 1.0.0
Deprecated in 1.3.0
HeartRating(hasHeart: Boolean)

Creates a HeartRating instance.

Parameters
hasHeart: Boolean

true for a "heart selected" rating, false for "heart unselected".

Public functions

equals

fun equals(obj: Any!): Boolean

hasHeart

Added in 1.0.0
Deprecated in 1.3.0
fun hasHeart(): Boolean

Returns whether the rating is "heart selected".

Returns
Boolean

true if the rating is "heart selected", false if the rating is "heart unselected", or if it is unrated.

hashCode

fun hashCode(): Int

isRated

Added in 1.0.0
Deprecated in 1.3.0
fun isRated(): Boolean

Returns whether there is a rating value available.

Returns
Boolean

true if there is an available rating value.

toString

fun toString(): String!