appsuite_media_api_common_core/com.tomtom.ivi.appsuite.media.api.common.core/IviMediaRating

IviMediaRating

@IviExperimental(reasons = [])

class IviMediaRating(val type: IviMediaRating.Type = Type.UNSUPPORTED, initialValue: Float = UNRATED) : Serializable

Rating assigned to an IviMediaItem.

The type determines the allowed value range for initialValue.

Parameters

type

Type of rating.

initialValue

The initial rating value. Values outside of the allowed range for the selected type will be considered as no rating.

Constructors

IviMediaRating

fun IviMediaRating(type: IviMediaRating.Type = Type.UNSUPPORTED, initialValue: Float = UNRATED)

Types

Companion

object Companion

Type

@IviExperimental(reasons = [])

enum Type : Enum<IviMediaRating.Type>

Rating type. When UNSUPPORTED, the rating is ignored.

Properties

type

val type: IviMediaRating.Type

value

val value: Float

Retrieve the given rating value. May be UNRATED.

Functions

equals

open operator override fun equals(other: Any?): Boolean

The equality check is overridden to ensure identical IviMediaItems containing IviMediaRating will be equal.

hashCode

open override fun hashCode(): Int

hasHeart

fun hasHeart(): Boolean

Retrieve whether a heart rating was given.

hasThumbsDown

fun hasThumbsDown(): Boolean

Retrieve whether a thumbs down rating was given.

hasThumbsUp

fun hasThumbsUp(): Boolean

Retrieve whether a thumbs up rating was given.

isRated

fun isRated(): Boolean

Retrieve whether a rating is present or not.

toString

open override fun toString(): String

Extensions

asRatingCompat

@IviInternal

fun IviMediaRating.asRatingCompat(): RatingCompat?

Converts IviMediaRating to a RatingCompat, if possible, or null.