IContentRatingLevel - Amazon Vega Docs

Represents the rating level within the ratings scale for a specific ratings system.

Properties

ratingsSystem

readonly ratingsSystem: string

Returns the unique identifying key for a “ratings system”, an specific industry ratings standard.

point to documentation for supported ratings systems

rating

readonly rating: string

Returns the unique identifying key for a rating that is a valid rating within the ratings system returned by ratingsSystem.

point to documentation for ratings scales of supported ratings systems

Methods

isLessOrEquallyRestrictiveThan()

isLessOrEquallyRestrictiveThan(other: IContentRatingLevel): Promise<boolean>

Compares two ratings levels to determine whether one is less-or-equally as restrictive as another. Note, this is a partial function over the domain of IContentRatingLevel objects; only rating levels of the same ratings system may be compared.

Parameters

other

IContentRatingLevel

Throws

NoncomparableRatingsError when attempting to compare ratings levels from different ratings systems.

Returns

Promise<boolean> true if this object is less restrictive or equally restrictive to other else false.

Examples

Given a={us_mpaa, G} and b={us_mpaa, PG-13}:
- `a->isLessOrEquallyRestrictiveThan(b) => true`
- `b->isLessOrEquallyRestrictiveThan(a) => false`
- `a->isLessOrEquallyRestrictiveThan(a) => true`



Given c={us_tv, TV-Y}:
- `a->isLessOrEquallyRestrictiveThan(c) => raises NoncomparableRatingsError`
- `c->isLessOrEquallyRestrictiveThan(a) => raises NoncomparableRatingsError`

​Properties

​ratingsSystem

​rating

​Methods

​isLessOrEquallyRestrictiveThan()

​Parameters