jpush
简介
接入雷霆平台api - 极光推送服务端接口
文档：https://leiting.feishu.cn/wiki/ZvRVwPo6fi46TIkgEIzce9D8nOc
组件接口
类
JpushAndroidNotification
极光安卓通知栏专属参数
成员变量
| 变量名 | 类型 | 初始值 | 须初始化 | 描述 |
|---|---|---|---|---|
| sound | string | nil | 可选 | 铃声 - N 填写android工程中/res/raw/路径下铃声文件名称，无需文件名后缀。如果传了channelId则该字段不生效 |
| clickAction | string | nil | 可选 | 点击通知后续动作 - N android支持以下三种类型: 1.（默认）应用首页(固定为此地址): intent:#Intent;action=android.intent.action.MAIN;end 2. 跳转到目标页: intent:#Intent;action=action路径;component=包名/Activity全名;end （OPPO 和 FCM 通道必须传 "action 路径", 其他厂商必须传 "Activity 全名", 否则将出现对应厂商无法跳转问题） 3. 跳转到 deeplink 地址: scheme://test?key1=val1&key2=val2 |
| displayForeground | bool | nil | 可选 | app在前台，是否展示，默认不展示。true展示 1. 不展示，不弹通知，客户端收不到通知 2. 展示，直接弹通知，客户端可以收到通知 |
| builderId | string | nil | 可选 | 安卓样式id，设置通知栏布局样式等 - N |
| channelId | string | nil | 可选 | channelId，需要android8.0以上，支持自定义铃声、震动、呼吸灯等 - N |
| style | int | nil | 可选 | 样式类型 1：bigText 2：Inbox 3：bigPicture - N |
| bigText | string | nil | 可选 | 大文本，当 style = 1 时可用，长度 ≤ 128 - N |
| inbox | map | nil | 可选 | 文本条目。当 style = 2 时可用， json 的每个 key 对应的 value 会被当作文本条目逐条展示 - N |
| bigPicture | string | nil | 可选 | 大图片，当 style = 3 时可用，支持.jpg和.png。填写图片url，或者本地图片填sdcard的相对路径 - N |
| largeIcon | string | nil | 可选 | 大图标，不超过300k，填写图片url，或者本地图片填sdcard的相对路径 - N |
| smallIcon | string | nil | 可选 | 小图标，不超过300k，填写图片url，或者本地图片填sdcard的相对路径 - N |
| showBeginTime | string | nil | 可选 | 仅极光通道支持，且app需要保持在线状态。定时展示开始时间（yyyy-MM-dd HH:mm:ss），此属性不填写，SDK 默认立即展示 - N |
| priority | string | nil | 可选 | 优先级，默认0，范围-2~2 - N |
| category | string | nil | 可选 | 消息分类，android完全依赖rom厂商对category的处理策略 - N |
成员方法
| 函数原型 | 函数作用 |
|---|
JpushIosNotification
极光iOS通知栏专属参数
成员变量
| 变量名 | 类型 | 初始值 | 须初始化 | 描述 |
|---|---|---|---|---|
| subTitle | string | nil | 可选 | 子标题 - N |
| sound | string | nil | 可选 | 铃声，JPush官方SDK会默认填充声音字段 - N |
| category | string | nil | 可选 | 消息分类，iOS8 开始支持，设置APNs payload中的"category"字段值 - N |
| contentAvailable | bool | nil | 可选 | 静默推送，默认false - N |
| interruptionLevel | string | nil | 可选 | iOS15的通知级别，取值只能是active,critical,passive,time-sensitive中的一个 - N 详情参考：https://developer.apple.com/documentation/usernotifications/unnotificationinterruptionlevel |
成员方法
| 函数原型 | 函数作用 |
|---|
JpushHmosNotification
极光鸿蒙通知栏专属参数
成员变量
| 变量名 | 类型 | 初始值 | 须初始化 | 描述 |
|---|---|---|---|---|
| largeIcon | string | nil | 可选 | 大图标，图标大小不超过 30 k，图片长*宽<12800像素。- N必须传url，使用HTTPS协议，取值样例：https://example.com/image.png |
| clickAction | string | nil | 可选 | 点击通知后续动作。- N 鸿蒙支持以下三种类型: 1.（默认）应用首页(固定为此地址): action.system.home 2. 跳转到 action 地址: com.test.action 3. 跳转到 deeplink 地址: scheme://test?key1=val1&key2=val2 |
成员方法
| 函数原型 | 函数作用 |
|---|
LtJpushAliasRequest
继承自 LtRequest
极光别名推送请求
成员变量
| 变量名 | 类型 | 初始值 | 须初始化 | 描述 |
|---|---|---|---|---|
| alias | array | nil | 可选 | 别名数组，1~1000个。- Y 平台默认会使用userId进行绑定，推送时传userId即可 |
| channelNo | string | nil | 可选 | 渠道编号 - Y |
| packageName | string | nil | 可选 | 包名 - Y |
| game | string | nil | 可选 | 游戏标识 - Y |
| msgType | int | nil | 可选 | 消息类型 - Y 1：通知栏消息 2：自定义消息 3：自定义转通知栏消息（仅android支持，鸿蒙和iOS不支持） |
| title | string | nil | 可选 | 通知标题，长度限制见上图 - Y 支持个性化文案，需要提前配置用户属性 |
| content | string | nil | 可选 | 通知内容，长度限制见上图 - Y 支持个性化文案，需要提前配置用户属性 |
| pushDuration | int | nil | 可选 | 定速推送，单位分钟；- N 最大值为1400；最多同时存在20条定速推送 |
| category | string | nil | 可选 | 消费分类 - N 不传代表非订阅消息，厂商会限制发送条数（走运营消息） subscribe：订阅消息（走系统消息，需要找商务申请厂商消息分类配置） chat：聊天消息（走系统消息，需要找商务申请厂商消息分类配置） |
| extras | map | nil | 可选 | 拓展字段，需要使用方自行定义key-value（都是string类型），客户端收到key-value后自行处理 - N iOS实现点击跳转、图标展示都需要通过该字段实现 极光-iOS通知点击跳转 极光-iOS图标设置 |
| androidNotification | JpushAndroidNotification | nil | 可选 | 安卓通知栏专属参数 - N |
| iosNotification | JpushIosNotification | nil | 可选 | iOS通知栏专属参数 - N |
| hmosNotification | JpushHmosNotification | nil | 可选 | 鸿蒙通知栏专属参数 - N |
| zone | string | nil | 可选 | 区组名 - N |
成员方法
| 函数原型 | 函数作用 |
|---|---|
| string gen_sign_text(string key) | 生成待签名文本 |
| string get_url(string host) | 获取请求地址 |
| void set_android_notification(map notification) | 设置安卓通知栏专属参数 |
| void set_ios_notification(map notification) | 设置iOS通知栏专属参数 |
| void set_hmos_notification(map notification) | 设置鸿蒙通知栏专属参数 |
LtJpushChannelRequest
继承自 LtRequest
极光渠道群推请求
成员变量
| 变量名 | 类型 | 初始值 | 须初始化 | 描述 |
|---|---|---|---|---|
| channelNo | string | nil | 可选 | 渠道编号 - Y |
| packageName | string | nil | 可选 | 包名 - Y |
| game | string | nil | 可选 | 游戏标识 - Y |
| msgType | int | nil | 可选 | 消息类型 - Y 1：通知栏消息 2：自定义消息 3：自定义转通知栏消息（仅android支持，鸿蒙和iOS不支持） |
| title | string | nil | 可选 | 通知标题，长度限制见上图 - Y 支持个性化文案，需要提前配置用户属性 |
| content | string | nil | 可选 | 通知内容，长度限制见上图 - Y 支持个性化文案，需要提前配置用户属性 |
| pushDuration | int | nil | 可选 | 定速推送，单位分钟；- N 最大值为1400；最多同时存在20条定速推送 |
| category | string | nil | 可选 | 消费分类 - N 不传代表非订阅消息，厂商会限制发送条数（走运营消息） subscribe：订阅消息（走系统消息，需要找商务申请厂商消息分类配置） chat：聊天消息（走系统消息，需要找商务申请厂商消息分类配置） |
| extras | map | nil | 可选 | 拓展字段，需要使用方自行定义key-value（都是string类型），客户端收到key-value后自行处理 - N |
| androidNotification | JpushAndroidNotification | nil | 可选 | 安卓通知栏专属参数 - N |
| iosNotification | JpushIosNotification | nil | 可选 | iOS通知栏专属参数 - N |
| hmosNotification | JpushHmosNotification | nil | 可选 | 鸿蒙通知栏专属参数 - N |
成员方法
| 函数原型 | 函数作用 |
|---|---|
| string gen_sign_text(string key) | 生成待签名文本 |
| string get_url(string host) | 生成请求地址 |
| void set_android_notification(map notification) | 设置安卓通知栏专属参数 |
| void set_ios_notification(map notification) | 设置iOS通知栏专属参数 |
| void set_hmos_notification(map notification) | 设置鸿蒙通知栏专属参数 |
LtJpushAllRequest
继承自 LtRequest
极光游戏群推请求
成员变量
| 变量名 | 类型 | 初始值 | 须初始化 | 描述 |
|---|---|---|---|---|
| game | string | nil | 可选 | 游戏标识 - Y |
| msgType | int | nil | 可选 | 消息类型 - Y 1：通知栏消息 2：自定义消息 3：自定义转通知栏消息（仅android支持，鸿蒙和iOS不支持） |
| title | string | nil | 可选 | 通知标题，长度限制见上图 - Y 支持个性化文案，需要提前配置用户属性 |
| content | string | nil | 可选 | 通知内容，长度限制见上图 - Y 支持个性化文案，需要提前配置用户属性 |
| pushDuration | int | nil | 可选 | 定速推送，单位分钟；- N 最大值为1400；最多同时存在20条定速推送 |
| extras | map | nil | 可选 | 拓展字段，需要使用方自行定义key-value（都是string类型），客户端收到key-value后自行处理 - N |
| androidNotification | JpushAndroidNotification | nil | 可选 | 安卓通知栏专属参数 - N |
| iosNotification | JpushIosNotification | nil | 可选 | iOS通知栏专属参数 - N |
| hmosNotification | JpushHmosNotification | nil | 可选 | 鸿蒙通知栏专属参数 - N |
成员方法
| 函数原型 | 函数作用 |
|---|---|
| string gen_sign_text(string key) | 生成待签名文本 |
| string get_url(string host) | 生成请求地址 |
| void set_android_notification(map notification) | 设置安卓通知栏专属参数 |
| void set_ios_notification(map notification) | 设置iOS通知栏专属参数 |
| void set_hmos_notification(map notification) | 设置鸿蒙通知栏专属参数 |
LtJpushRegistrationIdRequest
继承自 LtRequest
极光唯一id推送请求(不推荐)
成员变量
| 变量名 | 类型 | 初始值 | 须初始化 | 描述 |
|---|---|---|---|---|
| registrationId | array | nil | 可选 | registrationId数组，1~1000个 - Y |
| channelNo | string | nil | 可选 | 渠道编号 - Y |
| game | string | nil | 可选 | 游戏标识 - Y |
| msgType | int | nil | 可选 | 消息类型 - Y 1：通知栏消息 2：自定义消息 3：自定义转通知栏消息（仅android支持，鸿蒙和iOS不支持） |
| title | string | nil | 可选 | 通知标题，长度限制见上图 - Y 支持个性化文案，需要提前配置用户属性 |
| content | string | nil | 可选 | 通知内容，长度限制见上图 - Y 支持个性化文案，需要提前配置用户属性 |
| packageName | string | nil | 可选 | 包名 - Y |
| pushDuration | int | nil | 可选 | 定速推送，单位分钟；- N 最大值为1400；最多同时存在20条定速推送 |
| category | string | nil | 可选 | 消费分类 - N 不传代表非订阅消息，厂商会限制发送条数（走运营消息） subscribe：订阅消息（走系统消息，需要找商务申请厂商消息分类配置） chat：聊天消息（走系统消息，需要找商务申请厂商消息分类配置） |
| extras | map | nil | 可选 | 拓展字段，需要使用方自行定义key-value（都是string类型），客户端收到key-value后自行处理 - N |
| androidNotification | JpushAndroidNotification | nil | 可选 | 安卓通知栏专属参数 - N |
| iosNotification | JpushIosNotification | nil | 可选 | iOS通知栏专属参数 - N |
| hmosNotification | JpushHmosNotification | nil | 可选 | 鸿蒙通知栏专属参数 - N |
成员方法
| 函数原型 | 函数作用 |
|---|---|
| string gen_sign_text(string key) | 生成待签名文本 |
| string get_url(string host) | 生成请求地址 |
| void set_android_notification(map notification) | 设置安卓通知栏专属参数 |
| void set_ios_notification(map notification) | 设置iOS通知栏专属参数 |
| void set_hmos_notification(map notification) | 设置鸿蒙通知栏专属参数 |