ageRange

Type Event
Revision Release 2025.3721
Keywords age range, age verification, parental controls, Screen Time, ageRange
See also plugin.ageRange.init()
plugin.ageRange.requestAgeRange()
plugin.ageRange.*

Overview

The following event properties are passed to the listener function specified in plugin.ageRange.init().

Properties

event.name

String. The name of the event. Always "ageRange".

event.isError

Boolean. Indicates whether an error occurred. If true, check event.errorMessage for details.

event.errorMessage

String. Error message if event.isError is true.

event.isAvailable

Boolean. Indicates whether the age range service is available on this device.

event.declined

Boolean. Indicates whether the user declined to share their age range.

event.lowerBound

Number. The lower bound of the user’s age range (e.g., 13, 18, 21). Only present if age range was shared.

event.upperBound

Number. The upper bound of the user’s age range. Only present if age range was shared and there is an upper limit.

event.userStatus

String. The user’s verification status. Possible values include: - "verified" — User is a verified adult (18+) with no parental controls - "supervised" — User has active parental controls - "declined" — User declined to share age range - "notAvailable" — Age range service not available - "error" — An error occurred

event.hasParentalControls

Boolean. Indicates whether the user has active parental controls (Screen Time restrictions). Only present if age range was shared.