Methods
makePreferenceReader()
makePreferenceReader(): IParentalControlsPreferenceReader Construct an IParentalControlsPreferenceReader object, used for getting the current state of Parental Controls preference settings and determining whether Parental Controls is enabled.Returns
IParentalControlsPreferenceReadergateContentPlayback()
gateContentPlayback(contentRating?:any): Promise<IGateContentPlaybackResponse>
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 resolved IGateContentPlaybackResponse#canPlaybackProceed
value.
The returned Promise is resolved 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 Promise may not be resolved
immediately. The parental controls dialog will remain in the foreground
(as an overlay over the calling app) until it is resolved.
Parameters
contentRating?
any
rating 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
Promise<IGateContentPlaybackResponse>
a Promise that resolves to an IGateContentPlaybackResponse indicating
the outcome of the request (and PIN challenge if it was required).
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.
getMajorVersion()
getMajorVersion():number
Returns
number
getMinorVersion()
getMinorVersion():number
Returns
number
getPatchVersion()
getPatchVersion():number
Returns
number
