Démarrage

Copiez un prompt de configuration avec les étapes d'installation et la guide markdown complète 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-inline-install`
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/android-inline-install/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.

Installer

bun add @capgo/capacitor-android-inline-install
bunx cap sync

Importer

import { AndroidInlineInstall } from '@capgo/capacitor-android-inline-install';

API Vue d'ensemble

`startInlineInstall`

Lancer un flux d'installation en ligne directe à l'aide de l'overlay Google Play.

Remarque : Seuls les applications éligibles peuvent utiliser l'installation en ligne directe. Voir : https://play.google.com/console/about/guides/premium-growth-tools/

import { AndroidInlineInstall } from '@capgo/capacitor-android-inline-install';

const result = await AndroidInlineInstall.startInlineInstall({
  id: 'com.example.app',
  referrer: 'my-referrer',
  overlay: true,
  fallback: true
});

if (result.started) {
  console.log('Install flow started');
  if (result.fallbackUsed) {
    console.log('Using fallback Play Store link');
  }
}

Référence de type

`StartInlineInstallOptions`

Options pour démarrer un flux d'installation en ligne.

export interface StartInlineInstallOptions {
  /** Package name of the app to be installed (target app). */
  id: string;
  /** Referrer string to pass to Play. Optional but recommended. */
  referrer?: string;
  /**
   * Package name of your app (caller). Defaults to the current app package
   * if omitted.
   */
  callerId?: string;
  /** Optional Custom Store Listing ID. */
  csl_id?: string;
  /** Whether to request the Play overlay. Defaults to true. */
  overlay?: boolean;
  /** If true, falls back to full Play Store deep link when overlay unavailable. Defaults to true. */
  fallback?: boolean;
}

`StartInlineInstallResult`

Résultat de démarrer un flux d'installation en ligne.

export interface StartInlineInstallResult {
  /** True when the inline install intent has been started. */
  started: boolean;
  /** True if a fallback deep link was used instead of inline overlay. */
  fallbackUsed?: boolean;
}

Source De Vérité

Cette page est générée à partir du plugin’s src/definitions.tsRe-faire la synchronisation lorsque les données publiques API changent en amont.

Continuer depuis Getting Started

Si vous utilisez Démarrage pour planifier le tableau de bord et les opérations API, connectez-le à Utilisation de @capgo/capacitor-android-inline-install pour la capacité native dans l'utilisation de @capgo/capacitor-android-inline-install, Vue d'ensemble de API pour les détails d'implémentation dans la Vue d'ensemble de API, Introduction pour les détails d'implémentation dans l'Introduction, Clés de API pour les détails d'implémentation dans les Clés de API, et Appareils pour les détails d'implémentation dans Appareils.