Getting Started

Copiez une invite de configuration avec les étapes d'installation et le guide markdown complet pour ce plugin.

        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.

Installation

Vous pouvez utiliser notre configuration assistée par l'IA pour installer le plugin. Ajoutez les Capgo compétences à votre outil d'IA en utilisant la commande suivante :

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

Ensuite, utilisez la prompt suivante :

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

Si vous préférez la configuration manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à la plateforme ci-dessous :

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

Importer

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

API : Présentation

`checkAgeSignals`

Demander les signaux d'âge actuels pour l'utilisateur actif.

Disponible uniquement sur les appareils Android avec Google Play installé.

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

await AgeSignals.checkAgeSignals();

Référence de type

`CheckAgeSignalsResult`

Résultat structuré retourné par .

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`

Valeurs de statut signalées par 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',
}

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.

Continuez de Getting Started

Si vous utilisez Accueil pour planifier votre tableau de bord et vos opérations API, connectez-l’à API : Vue d'ensemble pour plus de détails sur l'implémentation dans API : Vue d'ensemble Introduction pour plus de détails sur l'implémentation dans l'Introduction Clés API pour plus de détails sur l'implémentation dans les Clés API Appareils pour plus de détails sur l'implémentation dans les Appareils Paquets pour les détails d'implémentation dans les Paquets.