更新记录

2.8.0(2023-04-04)

更新极光sdk到v4.8.1,优化了插件兼容性

2.6.8(2022-11-14)

开放所有API接口


平台兼容性

Android Android CPU类型 iOS
适用版本区间:4.4 - 12.0 armeabi-v7a:未测试,arm64-v8a:未测试,x86:未测试 适用版本区间:9 - 16

原生插件通用使用流程:

  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原生插件配置”->”云端插件“列表中删除该插件重新选择


JG-JPush

温馨提示:可下载demo示例工程或加作者咨询

QQ: 835588741/1660584265 微信: 15921627041

注意

需要同时引入luanqing-push-plugin和luanqing-core-plugin插件(免费),两者缺一不可。

点击前往luanqing-core-plugin插件

    const JPush = uni.requireNativePlugin("luanqing-push-plugin");

    详情查看demo

所有原生功能的方法列表

名称 说明 参数 是否必须
initJPushService 初始化SDK
setLoggerEnable 设置log是否开启 boolean
stopPush 停止推送
resumePush 恢复推送
isPushStopped 查询是否推送服务停止 (res)=>{}回调函数
setPushTime 设置推送时间(详见下方) Object
setSilenceTime 设置静默时间(详见下方) Object
setChannel 设置渠道(详见下方) Object
getRegistrationID 获取设备注册的极光推送id,后台可根据此id个推 (res)=>{}回调函数
setLatestNotificationNumber 设置最近通知的保留条数。仅对通知有效,意为: 如有新的通知到达,之前列表里最老的那条会被移除。默认保留5条 Number
updateTags 更新标签,会覆盖(详见下方) Object
addTags 新增标签(详见下方) Object
deleteTags 删除标签(详见下方) Object
cleanTags 清除所有标签(详见下方) Object
queryTag 查询某个标签(详见下方) Object
getAllTags 获取所有标签(详见下方) Object
setAlias 设置别名(详见下方) Object
deleteAlias 删除别名(详见下方) Object
queryAlias 查询别名(详见下方) Object
setMobileNumber 调用此 API 设置手机号码,用于短信补充功能。该接口会控制调用频率,频率为 10s 之内最多 3 次(详见下方) Object
onKillProcess 杀死进程
addLocalNotification 添加本地通知(详见下方) Object
removeLocalNotification 移除本地通知(详见下方) Object
clearAllNotifications 清除所有通知
clearLocalNotifications 清楚所有本地通知
clearNotificationById 通过id清除通知 Object
setMobileNumber 获取所有标签(详见下方) Object
setMobileNumber 获取所有标签(详见下方) Object
requestPermission 请求推送权限
setBadge 设置应用角标数值 Number
setGeofenceInterval 设置地理围栏监控周期,最小3分钟,最大1天(默认15分钟),当距离地理围栏边界小于1000米周期自动调整为3分钟。设置成功后一直使用设置周期,不会进行调整。 Object
setMaxGeofenceNumber 设置最多允许保存的地理围栏数量,超过最大限制后,如果继续创建先删除最早创建的地理围栏 Object
deleteGeofence 删除指定 id 的地理围栏 Object
setPowerSaveMode 设置是否开启省电模式,默认关闭 Boolean
isNotificationEnabled 检查当前应用的通知开关是否开启 (res)=>{}回调函数
openSettingsForNotification 跳转手机的应用通知设置页,可由用户操作开启通知开关 (res)=>{}回调函数
addConnectEventListener 连接事件监听 (res)=>{}回调函数
addNotificationListener 通知事件监听 (res)=>{}回调函数
addCustomMessageListener 自定义事件监听 (res)=>{}回调函数
addInMessageListener 应用内消息事件监听 (res)=>{}回调函数
addLocalNotificationListener 本地通知事件监听 (res)=>{}回调函数
addMobileNumberListener 手机号设置事件监听 (res)=>{}回调函数
addCommandListener 命令事件监听 (res)=>{}回调函数
addTagAliasListener 标签/别名事件监听 (res)=>{}回调函数

########### 方法详细说明--------------------------------------------------------------

setPushTime(Object) 设置允许推送时间
参数 类型 说明
pushTimeDays JsonArray 0 表示星期天,1 表示星期一,以此类推,数组size>6 或 size<0 无效
pushTimeStartHour Number 允许推送的开始时间(24 小时制:范围 0 - 23)
pushTimeEndHour Number 允许推送的结束时间(24 小时制:范围 0 - 23)
setSilenceTime(Object) 设置静默推送时间(此时段不推送)
参数 类型 说明
silenceTimeStartHour Number 静音时段的开始时间 - 小时 ( 24 小时制,范围:0~23 )
silenceTimeStartMinute Number 静音时段的开始时间 - 分钟(范围:0~59 )
silenceTimeEndHour Number 静音时段的结束时间 - 小时 ( 24 小时制,范围:0~23 )
silenceTimeEndMinute Number 静音时段的结束时间 - 分钟(范围:0~59 )
setChannel(Object) 设置渠道
参数 类型 说明
chanel String 渠道名
标签 updateTags(Object)更新 / addTags(Object)新增 / deleteTags(Object)删除
参数 类型 说明
tags JsonArray 标签名数组,每次调用至少设置一个 tag,覆盖之前的设置,不是新增。单个tag显示40字符内(字母(区分大小写)、数字、下划线、汉字、特殊字符 @!#$&*+=.
sequence Number 用户自定义的操作序列号,同操作结果一起返回,用来标识一次操作的唯一性。
cleanTags(Object) 清除设备上所有标签
参数 类型 说明
sequence Number 用户自定义的操作序列号,同操作结果一起返回,用来标识一次操作的唯一性。
queryTag(Object) 查询某个标签
参数 类型 说明
tags String 标签名,查询次标签
sequence Number 用户自定义的操作序列号,同操作结果一起返回,用来标识一次操作的唯一性。
getAllTags(Object) 获取所有标签
参数 类型 说明
sequence Number 用户自定义的操作序列号,同操作结果一起返回,用来标识一次操作的唯一性。
setAlias(Object) 设置别名
参数 类型 说明
alias String 别名字符串
sequence Number 用户自定义的操作序列号,同操作结果一起返回,用来标识一次操作的唯一性。
deleteAlias(Object) 删除别名
参数 类型 说明
sequence Number 用户自定义的操作序列号,同操作结果一起返回,用来标识一次操作的唯一性。
queryAlias(Object) 查询别名
参数 类型 说明
sequence Number 用户自定义的操作序列号,同操作结果一起返回,用来标识一次操作的唯一性。
setMobileNumber(Object) 设置手机号
参数 类型 说明
mobileNumber String 手机号,调用此 API 设置手机号码,用于 短信补充功能。该接口会控制调用频率,频率为 10s 之内最多 3 次
sequence Number 用户自定义的操作序列号,同操作结果一起返回,用来标识一次操作的唯一性。
addLocalNotification(Object) 添加本地通知
参数 类型 说明
messageID String 消息Id,自定义,必传,不传不生效
title String 通知标题
content String 通知内容
extras Object 额外携带的数据,非必传
removeLocalNotification(Object) 移除本地通知
参数 类型 说明
messageID String 要移除的消息Id,自定义,必传,不传不生效
clearNotificationById(Object) 通过id移除通知
参数 类型 说明
notificationId String 要移除的通知Id,自定义,必传,不传不生效
setGeofenceInterval(Number) 设置地理围栏监控周期
参数 类型 说明
value Number 必填,监控周期,单位是毫秒。
setMaxGeofenceNumber(Number) 设置最多允许保存的地理围栏数量
参数 类型 说明
value Number 必填,地理围栏数量
deleteGeofence(String) 设置地理围栏监控周期
参数 类型 说明
value String 必填,要删除的地理围栏id

隐私、权限声明

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

Android "${applicationId}.permission.JPUSH_MESSAGE", "android.permission.INTERNET", "android.permission.ACCESS_NETWORK_STATE", "android.permission.POST_NOTIFICATIONS", "com.hihonor.android.launcher.permission.CHANGE_BADGE" "com.vivo.notification.permission.BADGE_ICON" "com.huawei.android.launcher.permission.CHANGE_BADGE", "android.permission.VIBRATE", "android.permission.ACCESS_COARSE_LOCATION", "android.permission.ACCESS_FINE_LOCATION", "android.permission.ACCESS_BACKGROUND_LOCATION", "android.permission.READ_PHONE_STATE", "android.permission.QUERY_ALL_PACKAGES", "android.permission.GET_TASKS", "android.permission.ACCESS_WIFI_STATE", "android.permission.WRITE_EXTERNAL_STORAGE", "android.permission.READ_EXTERNAL_STORAGE", "${applicationId}.permission.MIPUSH_RECEIVE", "com.coloros.mcs.permission.RECIEVE_MCS_MESSAGE", "com.heytap.mcs.permission.RECIEVE_MCS_MESSAGE"

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

插件使用的安卓、iOS SDK会采集数据,详情可参考:https://www.jiguang.cn/license/privacy

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

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