Interface IParentalControlsComponent
interface IParentalControlsComponent
Extends com.amazon.apmf.IStandard
This is the top-level component used for interfacing with parental controls.
Methods
makePreferenceReader()
Construct an [IParentalControlsPreferenceReader] object, used for getting the current state of Parental Controls preference settings and determining whether Parental Controls is enabled.IParentalControlsPreferenceReader*makePreferenceReader()
Returns
IParentalControlsPreferenceReader*
[IParentalControlsPreferenceReader] object
gateContentPlayback()
Invoke PIN challenge for viewing potentially restricted content. This method delegates to parental controls to decide whether a PIN challenge is required before permitting the viewing of content with the passed rating information. The ratings parameter is optional; if ratings information is not supplied (such as in the case that it is not available) this method defaults to requiring the PIN challenge. If the rating information passed is more restrictive than permitted by the current restriction level preference, this method will present a PIN challenge to the user in the form of an unescapable modal dialog; that is, the user must either successfully validate their PIN or cancel the validation. Attempts to navigate away from the PIN challenge (such as by pressing back or a provider shortcut on the remote) will implicitly cancel PIN validation. The action that should be taken by the caller is relayed in the [IGateContentPlaybackResponse#canPlaybackProceed] value passed to the [IGateContentPlaybackListener]. The [IGateContentPlaybackListener] listener is invoked once the request has been resolved by parental controls (either because the PIN challenge was successfully validated or was unnecessary). The modal dialog has no timeout, so integrators should take into account that the listener may not be invoked immediately. The parental controls dialog will remain in the foreground (as an overlay over the calling app) until it is resolved.com.amazon.apmf.ISubscription*gateContentPlayback(IGateContentPlaybackListener*listener,com.amazon.kepler.media.content_metadata.IContentRating?contentRatingDesc)
Parameters
listener
IGateContentPlaybackListener* — Required
the listener that is invoked once this
request is resolved; indicates outcome of whether playback may proceed.
This listener will be invoked on a thread owned by the API
implementation; the caller should take care to synchonize with the UI
thread if needed.
contentRatingDesc
com.amazon.kepler.media.content_metadata.IContentRating? — Optional
rating description for the content that is a
candidate for playback. This field is optional and may be ommitted such
as in the case that ratings information is unavailable; in that case parental controls
will require a PIN challenge irrespective of the current restriction
level.
Returns
com.amazon.apmf.ISubscription*
an instance of [ISubscription] that can be
used to cancel the listener from being called back and associate request
context to the callback.
Caller requires privilege
com.amazon.kepler.parental_controls.gates.restricted-content-playback
to invoke this method.
Caller must be an interactive application that is presently running in the
foreground.
