更新记录

1.0.0(2024-04-19)


平台兼容性

Android Android CPU类型 iOS
适用版本区间:6.0 - 14.0 armeabi-v7a:支持,arm64-v8a:支持,x86:支持 ×

原生插件通用使用流程:

  1. 购买插件,选择该插件绑定的项目。
  2. 在HBuilderX里找到项目,在manifest的app原生插件配置中勾选模块,如需要填写参数则参考插件作者的文档添加。
  3. 根据插件作者的提供的文档开发代码,在代码中引用插件,调用插件功能。
  4. 打包自定义基座,选择插件,得到自定义基座,然后运行时选择自定义基座,进行log输出测试。
  5. 开发完毕后正式云打包

付费原生插件目前不支持离线打包。
Android 离线打包原生插件另见文档 https://nativesupport.dcloud.net.cn/NativePlugin/offline_package/android
iOS 离线打包原生插件另见文档 https://nativesupport.dcloud.net.cn/NativePlugin/offline_package/ios

注意事项:使用HBuilderX2.7.14以下版本,如果同一插件且同一appid下购买并绑定了多个包名,提交云打包界面提示包名绑定不一致时,需要在HBuilderX项目中manifest.json->“App原生插件配置”->”云端插件“列表中删除该插件重新选择


概述

本插件是一个为 uni-app 框架提供的原生插件,用于实现设备唤醒、保活、后台运行、通知权限检查等功能。通过该插件,可解决定位、推送、websocket、定时任务、蓝牙、聊天等保活问题。

演示程序

扫码下载示例APP

引入插件

  • 在 uni-app 项目中引入插件,在需要使用插件的文件中添加以下代码:

    const linAlive = uni.requireNativePlugin("Lin-Alive");

API 文档

Lin-Alive 插件提供了以下 API:

1. startAliveService(options, callback)

开启保活服务。

  • 参数

    • options(Object):保活服务配置选项。
      • title(String):前台通知标题。
      • description(String):前台通知描述。
      • hideFromTaskList(Boolean):是否在后台任务列表中隐藏。
      • sendStatusWhenScreenOn(Boolean):不息屏是否定时发送服务状态。
      • sendStatusScreenOnTime(Number):不息屏发送服务状态时间间隔(单位:秒)。
      • enableWakeLock(Boolean):是否开启锁屏唤醒功能。
      • wakeLockScreenTime(Number):锁屏唤醒时间(单位:分钟)。
    • callback(Function):响应回调函数,返回结果包含 code(状态码)和 msg(提示信息)。
  • 示例

    linAlive.startAliveService({
      title: "保持位置信息",
      description: "持续获取位置信息以记录轨迹等信息。",
      hideFromTaskList: false,
      sendStatusWhenScreenOn: true,
      sendStatusScreenOnTime: 10,
      enableWakeLock: true,
      wakeLockScreenTime: 1
    }, res => {
      console.log(res);
    });

2. stopAliveService(callback)

停止保活服务。

  • 参数

    • callback(Function):响应回调函数,返回结果包含 code(状态码)和 msg(提示信息)。
  • 示例

    linAlive.stopAliveService(res => {
      console.log(res);
    });

3. runInBackground(callback)

使应用进入后台运行。

  • 参数

    • callback(Function):响应回调函数,返回结果包含 code(状态码)和 msg(提示信息)。
  • 示例

    linAlive.runInBackground(res => {
      console.log(res);
    });

4. checkNotificationPermission(callback)

检查通知权限是否开启。

  • 参数

    • callback(Function):响应回调函数,返回结果包含 code(状态码)和 msg(提示信息)。
  • 示例

    linAlive.checkNotificationPermission(res => {
      console.log(res);
    });

5. openNotificationSettings(callback)

打开通知设置页面。

  • 参数

    • callback(Function):响应回调函数,返回结果包含 code(状态码)和 msg(提示信息)。
  • 示例

    linAlive.openNotificationSettings(res => {
      console.log(res);
    });

6. requestOverlayPermission(callback)

请求悬浮窗权限。

  • 参数

    • callback(Function):响应回调函数,返回结果包含 code(状态码)和 msg(提示信息)。
  • 示例

    linAlive.requestOverlayPermission(res => {
      console.log(res);
    });

7. openOverlaySettings(callback)

打开悬浮窗设置页面。

  • 参数

    • callback(Function):响应回调函数,返回结果包含 code(状态码)和 msg(提示信息)。
  • 示例

    linAlive.openOverlaySettings(res => {
      console.log(res);
    });

8. ignoreBatteryOptimization(callback)

忽略电池优化。

  • 参数

    • callback(Function):响应回调函数,返回结果包含 code(状态码)和 msg(提示信息)。
  • 示例

    linAlive.ignoreBatteryOptimization(res => {
      console.log(res);
    });

9. openBatteryOptimizationSettings(callback)

打开电池优化应用设置页面。

  • 参数

    • callback(Function):响应回调函数,返回结果包含 code(状态码)和 msg(提示信息)。
  • 示例

    linAlive.openBatteryOptimizationSettings(res => {
      console.log(res);
    });

10. setAutoStart(callback)

设置自启动。

  • 参数

    • callback(Function):响应回调函数,返回结果包含 code(状态码)和 msg(提示信息)。
  • 示例

    linAlive.setAutoStart(res => {
      console.log(res);
    });

    11. setTaskVisibility(isShow, callback)

设置自启动。

  • 参数

    • isShow (Boolean)是否在后台任务列表中隐藏
    • callback(Function):响应回调函数,返回结果包含 code(状态码)和 msg(提示信息)。
  • 示例

    linAlive.setTaskVisibility(false, res => {
      console.log(res);
    });
    // 或者
    linAlive.setTaskVisibility(false);

错误码说明

Lin-Alive 插件返回的错误码(code)及其含义如下:

  • 0:操作成功。
  • -1:操作失败或出现异常。

联系方式

如果在使用过程中遇到问题,可以通过一下联系方式与我们联系或者在下方评论区留言。

  • 技术支持邮箱:mail@lincq.cn

致谢

感谢您选择 Lin-Alive 插件,我们将持续优化和更新插件,为您提供更好的服务。如果您有任何建议或反馈,请随时联系我们。

隐私、权限声明

1. 本插件需要申请的系统权限列表:

android.permission.FOREGROUND_SERVICE android.permission.GET_TASKS android.permission.RECEIVE_BOOT_COMPLETED android.permission.REORDER_TASKS android.permission.SYSTEM_ALERT_WINDOW android.permission.SYSTEM_OVERLAY_WINDOW android.permission.REQUEST_IGNORE_BATTERY_OPTIMIZATIONS android.permission.WAKE_LOCK

2. 本插件采集的数据、发送的服务器地址、以及数据用途说明:

3. 本插件是否包含广告,如包含需详细说明广告表达方式、展示频率:

使用中有什么不明白的地方,就向插件作者提问吧~ 我要提问