IContentRatingBuilder

​

Interface IContentRatingBuilder

interface IContentRatingBuilder

Extends com.amazon.apmf.IStandard Builder for [IContentRating] objects; raises [InvalidRatingsIdentifierError] if the combination of ratings system, rating, and content descriptors is invalid.

​

Methods

​

ratingsSystem()

IContentRatingBuilder* ratingsSystem(string ratingsSystem)

Set required ratingsSystem property for the rating to be built.

​

Parameters

ratingsSystem

string — Required the unique string identifier for the ratings system

​

Returns

IContentRatingBuilder* self for fluent builder syntax

---

​

rating()

IContentRatingBuilder* rating(string rating)

Set required rating property for the rating to be built.

​

Parameters

rating

string — Required the string identifier for the particular rating within the [IContentRating] to be built’s ratingSystem.

​

Returns

IContentRatingBuilder* self for fluent builder syntax

---

​

contentDescriptors()

IContentRatingBuilder* contentDescriptors(string[] contentDescriptors)

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[] — Required a unordered array of 0 or more content descriptor identifiers. Duplicates are removed in the built [IContentRating]

​

Returns

IContentRatingBuilder* self for fluent builder syntax

---

​

build()

IContentRating* build()

Builds a [IContentRating] object.

​

Returns

IContentRating* the newly built [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.

---