快速入门

安装

你可以使用我们的 AI 辅助设置来安装插件。使用以下命令将 Capgo skills 添加到你的 AI 工具中：

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

然后使用以下 prompt：

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-age-range` plugin in my project.

如果你更想手动设置，请运行以下命令安装插件，并按照下方各平台的说明操作：

npm install @capgo/capacitor-age-range
npx cap sync

导入

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

快速入门

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

const result = await AgeRange.requestAgeRange({ ageGates: [13, 16, 18] });

常见坑点

• 并非身份证明：信号用于辅助合规 UX，而非政府身份证件。
• 未知状态：旧版 OS 的默认设计。
• 披露：需在隐私政策中说明用途。

API 概览

requestAgeRange

请求用户的年龄范围。

Android 端：查询 Google Play Age Signals API（无需用户提示）。 iOS 端：显示系统 DeclaredAgeRange 对话框（需要 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);
}

类型参考

RequestAgeRangeOptions

年龄范围请求的配置选项。

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

年龄范围请求的结果。

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

年龄范围请求的顶层状态。

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

年龄范围的声明或确定方式。

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

Android 特有的 Google Play 用户状态值。

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

单一事实来源

本页面由插件的 src/definitions.ts生成。当上游的公共 API 发生变化时，请重新运行 sync。

从入门指南继续

如果你正在使用 快速入门 要规划 dashboard 和 API 操作，请将其连接到 使用 @capgo/capacitor-age-range 在使用 @capgo/capacitor-age-range 时，获取原生能力的方法： API 概览 关于 API Overview 中的实现细节， 简介 关于 Introduction 中的实现细节， API 密钥 有关 API Keys 的实现细节，以及 设备 有关 Devices 的实现细节。