IParentalControlsComponentV2
这是用于连接家长监护的顶层组件。IParentalControlsComponentV2是IParentalControlsComponent的实验性扩展,它可授予IParentalControlsPreferenceWriter和通用PIN验证工作流程的访问权限:invokeValidatePinWorkflow。
扩展
方法
gateContentPlayback()
gateContentPlayback(
contentRating?):Promise<IGateContentPlaybackResponse>
参数
contentRating?
IContentRating
对候选播放内容进行评级。此字段是可选的,可以省略,例如在评级信息不可用的情况下;在这种情况下,无论当前的限制级别如何,家长监护都将要求进行PIN验证。
返回值
Promise<IGateContentPlaybackResponse>
一个Promise,解析为IGateContentPlaybackResponse,表示请求的结果(如果需要,还有PIN验证)。
简述
调用PIN验证以查看可能受限的内容。
此方法委托家长监护来决定是否需要进行PIN验证,然后才允许查看带有已通过评级信息的内容。评级参数是可选的;如果未提供评级信息(例如无法提供评级信息),则此方法默认为需要PIN验证。
如果传递的评级信息比当前限制级别首选项所允许的“更严格”,则此方法将以不可避免的模态对话框的形式要求用户进行PIN验证;也就是说,用户必须成功验证其PIN或取消验证。尝试避开PIN验证(例如通过按返回或遥控器上的提供者快捷方式)将隐式地取消PIN验证。调用者应采取的操作将在已解析的IGateContentPlaybackResponse#canPlaybackProceed值中转达。
一旦家长监护解析了请求,返回的Promise就会得到解析(要么是因为PIN质询已成功验证,要么是不必要的)。模态对话框“没有超时”,因此集成者应考虑到Promise可能无法立即解析。家长监护对话框将保持在前台(作为调用应用上的叠加),直到解析为止。
前提条件
调用者需要权限com.amazon.kepler.parental_controls.gates.restricted-content-playback才能调用此方法。
前提条件
调用者必须是当前在前台运行的交互式应用。
继承自
IParentalControlsComponentV2.gateContentPlayback
getContentRestrictionLevelsByDescendingRestrictedness()
getContentRestrictionLevelsByDescendingRestrictedness():
Promise<string[]>
根据该设备的当前观看区域,获取该设备所有内容限制级别的完全限定名称。
返回值
Promise<string[]>
所有内容限制级别以最大限制程度到最小限制程度的顺序排列,例如,对于美国观看区域为 [General、Family、...、Mature]。
继承自
IParentalControlsComponentV2.getContentRestrictionLevelsByDescendingRestrictedness
getMajorVersion()
getMajorVersion():
number
返回值
number
继承自
IParentalControlsComponentV2.getMajorVersion
getMinorVersion()
getMinorVersion():
number
返回值
number
继承自
IParentalControlsComponentV2.getMinorVersion
getPatchVersion()
getPatchVersion():
number
返回值
number
继承自
IParentalControlsComponentV2.getPatchVersion
invokeChangePinWorkflow()
invokeChangePinWorkflow():
Promise<IChangePinResponse>
调用一个工作流程,无论是否启用PCON,用户都可以从先前存在的PIN更改其PCON PIN。此工作流程将首先提示PIN验证,用户必须成功验证其现有PIN或取消验证。之后,用户可以设置新的PIN。请注意,这将覆盖之前的PIN。
如果尝试避开PIN验证或设定的PIN工作流程(例如通过按返回或遥控器上的提供者快捷方式),将隐式地取消PIN验证。调用者应采取的操作将在传递给IChangePinListener的IChangePinResponse#wasPinChanged值中传递。
一旦PCON解析了请求,就会调用{!ref changePinListener}侦听器。模态对话框没有超时,因此集成者应考虑到侦听器可能无法立即被调用。在解析之前,PCON对话框将保持在前台。
返回值
Promise<IChangePinResponse>
一个ISubscription实例,可用于取消侦听器的回调并将请求上下文与回调关联。
抛出
如果调用者的应用清单中没有声明所需的权限,则会出现SecurityError。
!前提条件 调用者需要权限com.amazon.kepler.parental_controls.gates.change-pin
!前提条件 调用者必须是当前在前台运行的交互式应用。
!前提条件 设备必须连接互联网,或者必须缓存先前成功完成PIN验证时所用的PIN。如果没有互联网连接,则无法完成首次设置。
invokeValidatePinWorkflow()
invokeValidatePinWorkflow():
Promise<IValidatePinResponse>
返回值
Promise<IValidatePinResponse>
一个ISubscription实例,可用于取消侦听器的回调并将请求上下文与回调关联。
简述
调用通用PIN验证工作流程来限制受限用户的操作。
此方法将以不可避免的模态对话框的形式要求用户进行PIN验证;也就是说,用户必须成功验证其PIN或取消验证。尝试避开PIN验证(例如通过按返回或遥控器上的提供者快捷方式)将隐式地取消PIN验证。调用者应采取的操作将在传递给IValidatePinListener的IValidatePinResponse#isPinValid值中传递。
PIN未传递给此方法,而是直接使用模态对话框从用户那里收集。
一旦家长监护解析了请求,就会调用{@ref IValidatePinListener}侦听器(要么是因为PIN验证已成功,要么是不必要的)。模态对话框没有超时,因此集成者应考虑到侦听器可能无法立即被调用。家长监护对话框将保持在前台(作为调用应用上的叠加),直到解析为止。
前提条件
调用者需要权限com.amazon.kepler.parental_controls.gates.validate-pin才能调用此方法。
前提条件
调用者必须是当前在前台运行的交互式应用。
继承自
IParentalControlsComponentV2.invokeValidatePinWorkflow
isContentRestricted()
isContentRestricted(
contentRating?):Promise<boolean>
根据当前内容限制级别(又名观看限制),查询具有所提供评级的内容在设备上是否被视为受限。如果为true,则应禁用该内容的自动播放预览内容等功能。
对于使用此API方法的交互式版本(其在内容受到限制时会提示用户输入PIN),请使用gateContentPlayback。
参数
contentRating?
IContentRating
返回值
Promise<boolean>
继承自
IParentalControlsComponentV2.isContentRestricted
makePreferenceReader()
makePreferenceReader():
IParentalControlsPreferenceReader
构造一个IParentalControlsPreferenceReader对象,用于获取“家长监护”首选项设置的当前状态并确定是否启用了家长监护。
返回值
IParentalControlsPreferenceReader
继承自
IParentalControlsComponentV2.makePreferenceReader
makePreferenceWriter()
makePreferenceWriter():
IParentalControlsPreferenceWriter
构造一个IParentalControlsPreferenceWriter对象,用于设置家长监护首选项设置的当前状态并调用“家长监护”启用工作流程。
返回值
IParentalControlsPreferenceWriter
继承自
IParentalControlsComponentV2.makePreferenceWriter
Last updated: 2025年9月30日

