更新记录

1.0.0（2026-01-20）

第一版更新

平台兼容性

uni-app(4.85)

uni-app x(4.85)

miko-openinstall

OpenInstall UTS插件，用于在uniapp项目中集成OpenInstall SDK功能。

快速开始

查看 example 目录中的完整使用示例。

架构设计

插件采用分层架构设计：

• UTS层 (index.uts): 提供 uniapp 接口适配和代理转发功能
• Kotlin层 (OpenInstallManager.kt): 实现具体的 OpenInstall SDK 业务逻辑
• 配置层 (config.json): 管理依赖和构建配置

这种设计使得：

• 业务逻辑与接口适配分离
• Kotlin 代码可以进行更复杂的原生开发
• UTS 层专注于接口转发和错误处理
• 便于维护和扩展

开发文档

UTS 语法 UTS API插件 UTS uni-app兼容模式组件 UTS 标准模式组件 Hello UTS

API 接口

init(options: InitOptions)

初始化OpenInstall SDK

参数说明：

• options.success?: () => void - 初始化成功回调
• options.fail?: (res: OpenInstallFail) => void - 初始化失败回调
• options.complete?: (res: any) => void - 初始化完成回调（成功或失败都会调用）

使用示例：

import { init } from "@/uni_modules/miko-openinstall";

init({
  success: () => {
    console.log('OpenInstall初始化成功');
  },
  fail: (err) => {
    console.log('OpenInstall初始化失败', err);
  }
});

getInstall(options: GetInstallOptions)

获取安装参数，包括渠道数据和自定义数据

参数说明：

• options.success?: (res: InstallData) => void - 获取成功回调
• options.fail?: (res: OpenInstallFail) => void - 获取失败回调
• options.complete?: (res: any) => void - 获取完成回调

返回数据结构：

type InstallData = {
  channelCode: string,  // 渠道代码
  bindData: string      // 自定义数据
}

使用示例：

import { getInstall } from "@/uni_modules/miko-openinstall";

getInstall({
  success: (res) => {
    console.log('获取安装参数成功', res);
    console.log('渠道代码:', res.channelCode);
    console.log('自定义数据:', res.bindData);
  },
  fail: (err) => {
    console.log('获取安装参数失败', err);
  }
});

reportRegister(options: ReportRegisterOptions)

报告用户注册成功

参数说明：

• options.success?: () => void - 报告成功回调
• options.fail?: (res: OpenInstallFail) => void - 报告失败回调
• options.complete?: (res: any) => void - 报告完成回调

使用示例：

import { reportRegister } from "@/uni_modules/miko-openinstall";

reportRegister({
  success: () => {
    console.log('报告注册成功');
  },
  fail: (err) => {
    console.log('报告注册失败', err);
  }
});

使用注意事项

1. 初始化时机：首次启动时，确保用户同意《隐私政策》之后，再调用初始化接口
2. 主进程调用：仅在主进程的UI线程中调用初始化接口，多进程调用会导致获取参数失败
3. 前台状态：初始化调用时，尽量保证应用处于前台可触控状态下，对提升参数还原精度有很大帮助
4. 获取参数时机：不要在初始化之后立即调用getInstall，容易导致获取数据失败。在业务需要时再获取数据，保证SDK有充足的时间进行数据还原
5. 避免重试：不要在返回数据为空时，尝试使用getInstall进行重试获取数据

错误码

• 9010001 - OpenInstall初始化失败
• 9010002 - 获取安装参数失败
• 9010003 - 报告注册失败