开始使用

复制一个包含安装步骤和本插件的完整 Markdown 指南的配置提示。

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-android-age-signals`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/age-signals/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

安装

bun add @capgo/capacitor-android-age-signals
bunx cap sync

导入

import { AgeSignals } from '@capgo/capacitor-android-age-signals';

API概述

`checkAgeSignals`

获取当前活跃用户的Play年龄信号。

仅在安装了Google Play的Android设备上可用。

import { AgeSignals } from '@capgo/capacitor-android-age-signals';

await AgeSignals.checkAgeSignals();

类型参考

`CheckAgeSignalsResult`

由 . 返回的结构化结果

export interface CheckAgeSignalsResult {
  /**
   * The user's verification status as reported by Google Play.
   *
   * @since 0.0.1
   */
  userStatus: UserStatus;
  /**
   * Inclusive lower bound of the supervised user's age range.
   *
   * Present only when `userStatus` is `SUPERVISED`, `SUPERVISED_APPROVAL_PENDING`, or `SUPERVISED_APPROVAL_DENIED`.
   *
   * @since 0.0.1
   * @example 13
   */
  ageLower?: number;
  /**
   * Inclusive upper bound of the supervised user's age range.
   *
   * Present only when `userStatus` is `SUPERVISED`, `SUPERVISED_APPROVAL_PENDING`, or `SUPERVISED_APPROVAL_DENIED`
   * and the user's age is reported as less than 18.
   *
   * @since 0.0.1
   * @example 15
   */
  ageUpper?: number;
  /**
   * Effective date for the most recent significant change that received guardian approval.
   *
   * Present only when `userStatus` is `SUPERVISED_APPROVAL_PENDING` or `SUPERVISED_APPROVAL_DENIED`.
   *
   * @since 0.0.1
   * @example "2024-01-15"
   */
  mostRecentApprovalDate?: string;
  /**
   * Identifier assigned to supervised installs in Google Play for revocation notifications.
   *
   * Present only when `userStatus` is `SUPERVISED`, `SUPERVISED_APPROVAL_PENDING`, or `SUPERVISED_APPROVAL_DENIED`.
   *
   * @since 0.0.1
   * @example "abc123xyz"
   */
  installId?: string;
}

`UserStatus`

Google Play Age Signals 报告的状态值

export enum UserStatus {
  /**
   * The user is over 18 and their age has been verified by Google.
   *
   * @since 0.0.1
   */
  Verified = 'VERIFIED',
  /**
   * The user has a supervised Google Account managed by a guardian.
   *
   * Use `ageLower` and `ageUpper` to determine the user's age range.
   *
   * @since 0.0.1
   */
  Supervised = 'SUPERVISED',
  /**
   * The supervised user has pending significant changes awaiting guardian approval.
   *
   * Use `ageLower` and `ageUpper` to determine the user's age range and `mostRecentApprovalDate`
   * to identify the most recent approved change.
   *
   * @since 0.0.1
   */
  SupervisedApprovalPending = 'SUPERVISED_APPROVAL_PENDING',
  /**
   * The supervised user's guardian denied one or more significant changes.
   *
   * Use `ageLower` and `ageUpper` to determine the user's age range and `mostRecentApprovalDate`
   * to identify the last approved change.
   *
   * @since 0.0.1
   */
  SupervisedApprovalDenied = 'SUPERVISED_APPROVAL_DENIED',
  /**
   * The user is not verified or supervised in supported regions.
   *
   * You should prompt the user to resolve their status in the Play Store.
   *
   * @since 0.0.1
   */
  Unknown = 'UNKNOWN',
  /**
   * All other users return this value.
   *
   * @since 0.0.1
   */
  Empty = 'EMPTY',
}

真实来源

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