入门指南

安装

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. 当 upstream 的公共 API 变更时，请重新同步。