开始使用

复制一个带有安装步骤和完整 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-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.

安装

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

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

然后使用以下提示：

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

如果您更喜欢手动设置，请通过运行以下命令安装插件并遵循以下平台特定的说明：

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

导入

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

API概述

`startInlineInstall`

使用 Google Play overlay 开始内联安装流程。

注意：只有符合条件的应用才能使用内联安装。请参阅： 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');
  }
}

类型参考

`StartInlineInstallOptions`

复制到剪贴板

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`

开始内联安装结果

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;
}

数据源

本页面由插件生成 src/definitions.ts当公共API发生更改时，请重新同步

继续从开始

如果您正在使用开始规划仪表板和API操作时，请将其连接到使用@capgo/capacitor-android-inline-install 在使用@capgo/capacitor-android-inline-install时，native能力 API概述为API概述的实现细节，简介为简介的实现细节， API密钥为API密钥的实现细节，和设备为设备的实现细节。