Prise en main

Installer

Vous pouvez utiliser notre configuration assistée par IA pour installer le plugin. Ajoutez les skills Capgo à votre outil d'IA avec la commande suivante :

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

Utilisez ensuite le prompt suivant :

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 une installation manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à chaque plateforme ci-dessous :

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

Importer

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

Démarrage rapide

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

const result = await AgeSignals.checkAgeSignals();
console.log(result);

Erreurs courantes

• Sync native : exécuter npx cap sync après les mises à jour du plugin.
• Source de vérité : fiez-vous src/definitions.ts au repo GitHub.

Aperçu de API

checkAgeSignals

Récupère les Play Age Signals actuels pour l'utilisateur actif.

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

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

const result = await AgeSignals.checkAgeSignals();
console.log(result);

Référence de type

CheckAgeSignalsResult

Résultat structuré renvoyé 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 rapporté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 de src/definitions.ts. Relancez la synchronisation lorsque l’API public change en amont.

Continuer depuis Getting Started

Si vous utilisez Prise en main pour planifier les opérations du dashboard et de API, connectez-l’avec Aperçu de API pour les détails d'implémentation dans « Vue d'ensemble de API », Introduction pour les détails d'implémentation dans l'introduction, Clés API pour les détails d'implémentation dans API Keys, Appareils pour les détails d'implémentation dans Devices, et Bundles pour les détails d'implémentation dans Bundles.