Démarrage

Installer

bun add @capgo/capacitor-age-range
bunx cap sync

Importer

import { AgeRange } from '@capgo/capacitor-age-range';

API Vue d'ensemble

requestAgeRange

Demander la plage d'âge de l'utilisateur.

Sur Android : interroge les signaux d'âge Google Play API (sans invitation de l'utilisateur). Sur iOS : présente le dialogue système DeclaredAgeRange (exige iOS 26.2+).

import { AgeRange } from '@capgo/capacitor-age-range';

const result = await AgeRange.requestAgeRange({ ageGates: [13, 16, 18] });
if (result.status === 'SHARING') {
  console.log('Age range:', result.ageLower, '-', result.ageUpper);
}

Référence de type

RequestAgeRangeOptions

Options pour la demande d'âge

export interface RequestAgeRangeOptions {
  /**
   * Age thresholds for the request.
   *
   * On iOS: these are passed to `requestAgeRange(ageGates:)` as the
   * age boundaries presented in the system dialog. Common values: [13, 16, 18].
   *
   * On Android: this parameter is ignored (Play Age Signals returns
   * predefined ranges: 0-12, 13-15, 16-17, 18+).
   *
   * @default [13, 16, 18]
   * @since 8.0.0
   */
  ageGates?: number[];
}

AgeRangeResult

Résultat de la demande d'âge

export interface AgeRangeResult {
  /**
   * The outcome status of the age range request.
   *
   * @since 8.0.0
   */
  status: AgeRangeStatus;

  /**
   * Inclusive lower bound of the user's age range.
   *
   * Present when age data is available.
   *
   * @since 8.0.0
   */
  ageLower?: number;

  /**
   * Inclusive upper bound of the user's age range.
   *
   * May be absent if the user is in the highest age bracket (e.g. 18+).
   *
   * @since 8.0.0
   */
  ageUpper?: number;

  /**
   * How the age was declared/determined.
   *
   * On iOS: 'SELF_DECLARED' or 'GUARDIAN_DECLARED'.
   * On Android: 'SUPERVISED' (guardian-managed) or 'VERIFIED' (Google-verified 18+).
   *
   * @since 8.0.0
   */
  declarationSource?: DeclarationSource;

  /**
   * Android-only. The user's Google Play verification status.
   *
   * @since 8.0.0
   */
  androidUserStatus?: AndroidUserStatus;

  /**
   * Android-only. Effective date for the most recent guardian-approved change.
   *
   * @since 8.0.0
   */
  mostRecentApprovalDate?: string;

  /**
   * Android-only. Install identifier for supervised installs in Google Play.
   *
   * @since 8.0.0
   */
  installId?: string;
}

AgeRangeStatus

Statut principal de la demande d'âge

export type AgeRangeStatus =
  /**
   * The user shared their age range (iOS) or age signals are available (Android).
   */
  | 'SHARING'
  /**
   * The user declined to share their age range.
   */
  | 'DECLINED_SHARING'
  /**
   * The age range API is not available on this device/OS version.
   */
  | 'NOT_AVAILABLE'
  /**
   * An error occurred while requesting the age range.
   */
  | 'ERROR';

DeclarationSource

Comment l'âge a été déclaré ou déterminé

export type DeclarationSource =
  /** The user self-declared their age (iOS). */
  | 'SELF_DECLARED'
  /** A guardian declared the user's age (iOS Family Sharing or Android supervised). */
  | 'GUARDIAN_DECLARED'
  /** Google has verified the user is 18+ (Android only). */
  | 'VERIFIED'
  /** Source is unknown or not provided by the platform. */
  | 'UNKNOWN';

AndroidUserStatus

Valeurs d'état de l'utilisateur Android spécifiques à Google Play.

export type AndroidUserStatus =
  | 'VERIFIED'
  | 'SUPERVISED'
  | 'SUPERVISED_APPROVAL_PENDING'
  | 'SUPERVISED_APPROVAL_DENIED'
  | 'UNKNOWN'
  | 'EMPTY';

Source De Vérité

Cette page est générée à partir du plugin’s src/definitions.tsRe-run la synchronisation lorsque le public API change en amont.