IContentRatingBuilder

Builder for IContentRating objects; raises InvalidRatingsIdentifierError if the combination of ratings system, rating, and content descriptors is invalid.

​

Methods

​

ratingsSystem()

ratingsSystem(ratingsSystem: string): IContentRatingBuilder

Set required ratingsSystem property for the rating to be built.

​

Parameters

ratingsSystem

string the unique string identifier for the ratings system

​

Returns

IContentRatingBuilder

---

​

rating()

rating(rating: string): IContentRatingBuilder

Set required rating property for the rating to be built.

​

Parameters

rating

string the string identifier for the particular rating within the IContentRating to be built’s ratingSystem.

​

Returns

IContentRatingBuilder

---

​

contentDescriptors()

contentDescriptors(contentDescriptors: string[]): IContentRatingBuilder

Set optionally specified content descriptors for the rating to be built. The default (if this method is not called) is an empty array.

​

Parameters

contentDescriptors

string[] a unordered array of 0 or more content descriptor identifiers. Duplicates are removed in the built IContentRating

​

Returns

IContentRatingBuilder

---

​

build()

build(): Promise<IContentRating>

Builds an IContentRating object.

​

Throws

• InvalidRatingsIdentifierError if the passed parameters do not correspond to a valid standardized rating-in-rating-system coordinate or if one or more content descriptors is invalid.
• InvalidArgumentError if a required builder property (such as ratingsSystem) is missing.

​

Returns

Promise<IContentRating>