SDK API
最近更新:2024-10-08
展开全部
SDK API
设置调试模式 API(setDebug)
功能说明
- 请在 AbilityStage(#onCreate) 里面调用
- 请在 init 之前调用
- 可选接口
接口定义
/**
* debug log 设置,默认false
*
* @param debug true 为 debug,false 为非 debug
*/
setDebug(debug: boolean)
/**
* debug log 设置,默认false
*
* @param debug true 为 debug,false 为非 debug
*/
setDebug(debug: boolean)
此代码块在浮窗中显示
代码示例
JPushInterface.setDebug(true)//启用 debug
JPushInterface.setDebug(true)//启用 debug
此代码块在浮窗中显示
参数说明
- debug 为 true 则会打印 debug 级别的日志,false 则只会打印 warning 级别以上的日志
配置极光 Appkey(setAppKey)
功能说明
- 请在 AbilityStage(#onCreate) 里面调用
- 请在 init 之前调用
- 必须调用的接口
接口定义
/**
* 设置appkey
*
* @param appKey 为平台的appkey
*/
setAppKey(appKey: string)
/**
* 设置appkey
*
* @param appKey 为平台的appkey
*/
setAppKey(appKey: string)
此代码块在浮窗中显示
代码示例
JPushInterface.setAppKey("你的appKey")
JPushInterface.setAppKey("你的appKey")
此代码块在浮窗中显示
参数说明
- appKey 需要从极光控制台获取。
配置下载渠道(setChannel)
功能说明
动态配置 channel(程序包下载渠道)
- channel 指明应用程序包的下载渠道,为方便分渠道统计,具体值由你自行定义,如华为应用市场等。
- JPush HarmonyOS SDK v1.1.0 以上版本支持。
- 请在 AbilityStage(#onCreate) 里面调用
- 请在 init 之前调用
- 必须调用的接口
接口定义
/**
* 配置渠道
*
* @param channel 渠道名称
*/
setChannel(channel: string)
/**
* 配置渠道
*
* @param channel 渠道名称
*/
setChannel(channel: string)
此代码块在浮窗中显示
代码示例
JPushInterface.setChannel("渠道名称")
JPushInterface.setChannel("渠道名称")
此代码块在浮窗中显示
参数说明
- channel 用户业务自定义。
开启推送业务功能 API(init)
功能说明
极光推送服务,调用了本 API 后,开启JPush 推送服务,将会开始收集上报SDK业务功能所必要的用户个人信息。
- 启动时调用
接口定义
/**
* 开启推送业务功能
* @param context 上下文
*/
init(context: common.UIAbilityContext | common.AbilityStageContext)
/**
* 开启推送业务功能
* @param context 上下文
*/
init(context: common.UIAbilityContext | common.AbilityStageContext)
此代码块在浮窗中显示
代码示例
JPushInterface.init(this.context)
JPushInterface.init(this.context)
此代码块在浮窗中显示
参数说明
- context 在AbilityStage中传 common.UIAbilityContext ,在UIAbility中传 common.AbilityStageContext
接口使用说明
- 开发者如果主动调用了 init 方法,会开启JPush推送服务。
- 考虑 APP 上线合规,开发者必须在APP用户同意了隐私政策,并且开发者确定为App用户开始提供推送服务后,再调用启用推送业务功能接口使用极光服务。
- 关于 APP 隐私政策建议和说明,具体可以参考 如何草拟合规的隐私政策。
获取 RegistrationID(getRegistrationId)
功能说明
- 请先init,否则调用无效
接口定义
/**
* 反回注册的rid
*
*/
getRegistrationId(): string
/**
* 反回注册的rid
*
*/
getRegistrationId(): string
此代码块在浮窗中显示
代码示例
let rid = JPushInterface.getRegistrationId()
let rid = JPushInterface.getRegistrationId()
此代码块在浮窗中显示
参数说明
- 无
设置回调接口(setCallBackMsg)
功能说明
这个接口是用来接收sdk数据的。如:注册结果,登陆结果,通知点击结果,设置标签别名操作结果等的回调。 接收类需要实现CallBackMsg接口,CallBackMsg功能可看代码例子。
- 请在 AbilityStage(#onCreate) 里面调用
- 请在 init 之前调用
- 必须调用的接口
接口定义
/**
* 监听回调事件和数据
*
* @param callBackMsg
*/
setCallBackMsg(callBackMsg: CallBackMsg)
/**
* 监听回调事件和数据
*
* @param callBackMsg
*/
setCallBackMsg(callBackMsg: CallBackMsg)
此代码块在浮窗中显示
代码示例
class MyCallBackMsg extends CallBackMsg {
context: common.ApplicationContext
constructor(co: common.ApplicationContext) {
super();
this.context = co
}
/**
* 注册成功后回调rid
* @param registrationId 注册成功后回调rid
*/
onRegister(registrationId: string): void {
hilog.info(0x0000, 'testTag', '%{public}s', 'onRegister registrationId:' + registrationId);
this.context.eventHub.emit('jPush_event', "registrationId:" + registrationId);
}
/**
* 长连接登陆 回调
* @param isConnected true:成功,false:失败
*/
onConnected(isConnected: boolean): void {
hilog.info(0x0000, 'testTag', '%{public}s', 'onConnected isConnected:' + isConnected);
this.context.eventHub.emit('jPush_event', "isConnected:" + isConnected);
}
/**
* 操作 tag 接口回调
* @param jTagMessage
* export class JTagMessage {
* sequence?: number //对应操作id,全局不要重复
* code?: number //0成功,JTagMessage.CODE_TIME_OUT超时
* op?: string
* tags?: string[] //对应数据
* curr?: number //数据当前页数,页数从1开始
* total?: number //数据总页数
* msg?: string
* validated?:boolean //checkTagBindState 查询tag是否存在
* }
*/
onTagOperatorResult(jTagMessage: JTagMessage): void {
hilog.info(0x0000, 'testTag', '%{public}s', 'onTagOperatorResult JTagMessage:' + JSON.stringify(jTagMessage));
this.context.eventHub.emit('jPush_event', "onTagOperatorResult:" + JSON.stringify(jTagMessage));
}
/**
* 操作 Alias 接口回调
* @param jAliasMessage
* export class JAliasMessage {
* sequence?: number //对应操作id,全局不要重复
* code?: number //0成功,JAliasMessage.CODE_TIME_OUT超时
* op?: string
* alias?: string //对应数据
* curr?: number
* total?: number
* msg?: string
* }
*/
onAliasOperatorResult(jAliasMessage: JAliasMessage): void {
hilog.info(0x0000, 'testTag', '%{public}s', 'onAliasOperatorResult jAliasMessage:' + JSON.stringify(jAliasMessage));
this.context.eventHub.emit('jPush_event', "onAliasOperatorResult:" + JSON.stringify(jAliasMessage));
}
/**
* 通知点击事件回调
* @param jMessage
*
* export class JMessage {
* msgId?: string //通知id
* title?: string //通知标题
* content?: string//通知内容
* extras?: Record<string, Object>//自定义数据
* }
*/
onClickMessage(jMessage: JMessage) {
hilog.info(0x0000, 'testTag', '%{public}s', 'onClickMessage jMessage:' + JSON.stringify(jMessage));
this.context.eventHub.emit('jPush_event', "onClickMessage:" + JSON.stringify(jMessage));
}
/**
* 自定义信息通知回调
* 回调一:冷启动调用sdk初始化后回调之前还没有回调的信息
* 回调二:app存活时会直接回调信息
* 想要有自定义信息回调,还需查看集成指南的自定义信息集成配置方式
* @param jCustomMessage
*
* export class JCustomMessage {
* msgId?: string //通知id
* title?: string //通知标题
* content?: string //通知内容
* contentType?: string //通知内容类型
* extras?: Record<string, Object> //通知自定义键值对
* ttl?: number //后台下发的信息过期时间,单位秒
* stime?: number //后台下发时间,毫秒
* }
*/
onCustomMessage(jCustomMessage: JCustomMessage) {
hilog.info(0x0000, TAG, '%{public}s', 'onCustomMessage jCustomMessage:' + JSON.stringify(jCustomMessage));
this.context.eventHub.emit('jPush_event', "onCustomMessage:" + JSON.stringify(jCustomMessage));
}
/**
* 通知扩展消息回调
* @param jMessageExtra
*
* export class JMessageExtra {
* msgId?: string //通知id
* title?: string //通知标题
* content?: string//通知内容
* extras?: Record<string, Object>//自定义数据
* extraData?: string//通知扩展消息的自定义数据
* }
*/
onJMessageExtra(jme: JMessageExtra) {
hilog.info(0x0000, TAG, '%{public}s', 'onJMessageExtra jme:' + JSON.stringify(jme));
this.context.eventHub.emit('jPush_event', "onJMessageExtra:" + JSON.stringify(jme));
}
/**
* VoIP呼叫消息回调
* export class JMessageVoIP {
* msgId?: string //通知id
* extraData?: string //VoIP自定义数据
}
* @param jmVoIP
*/
onJMessageVoIP(jmVoIP: JMessageVoIP) {
hilog.info(0x0000, TAG, '%{public}s', 'JMessageVoIP jmVoIP:' + JSON.stringify(jmVoIP));
this.context.eventHub.emit('jPush_event', "JMessageVoIP:" + JSON.stringify(jmVoIP));
}
/**
* export class JCmdMessage {
* public static CMD_PUSH_STOP = 2007 //通知停止 设置回调
* public static CMD_PUSH_RESUME = 2006 // 通知恢复 设置回调
* cmd?: number //操作类型
* errorCode?: number //状态码
* msg?: string //内容
* extra?: Record<string, Object>
* }
* @param cmdMessage
*/
onCommandResult(cmdMessage: JCmdMessage) {
hilog.info(0x0000, TAG, '%{public}s', 'onCommandResult cmdMessage:' + JSON.stringify(cmdMessage));
this.context.eventHub.emit('jPush_event', "onCommandResult:" + JSON.stringify(cmdMessage));
}
}
JPushInterface.setCallBackMsg(new MyCallBackMsg(this.context))
class MyCallBackMsg extends CallBackMsg {
context: common.ApplicationContext
constructor(co: common.ApplicationContext) {
super();
this.context = co
}
/**
* 注册成功后回调rid
* @param registrationId 注册成功后回调rid
*/
onRegister(registrationId: string): void {
hilog.info(0x0000, 'testTag', '%{public}s', 'onRegister registrationId:' + registrationId);
this.context.eventHub.emit('jPush_event', "registrationId:" + registrationId);
}
/**
* 长连接登陆 回调
* @param isConnected true:成功,false:失败
*/
onConnected(isConnected: boolean): void {
hilog.info(0x0000, 'testTag', '%{public}s', 'onConnected isConnected:' + isConnected);
this.context.eventHub.emit('jPush_event', "isConnected:" + isConnected);
}
/**
* 操作 tag 接口回调
* @param jTagMessage
* export class JTagMessage {
* sequence?: number //对应操作id,全局不要重复
* code?: number //0成功,JTagMessage.CODE_TIME_OUT超时
* op?: string
* tags?: string[] //对应数据
* curr?: number //数据当前页数,页数从1开始
* total?: number //数据总页数
* msg?: string
* validated?:boolean //checkTagBindState 查询tag是否存在
* }
*/
onTagOperatorResult(jTagMessage: JTagMessage): void {
hilog.info(0x0000, 'testTag', '%{public}s', 'onTagOperatorResult JTagMessage:' + JSON.stringify(jTagMessage));
this.context.eventHub.emit('jPush_event', "onTagOperatorResult:" + JSON.stringify(jTagMessage));
}
/**
* 操作 Alias 接口回调
* @param jAliasMessage
* export class JAliasMessage {
* sequence?: number //对应操作id,全局不要重复
* code?: number //0成功,JAliasMessage.CODE_TIME_OUT超时
* op?: string
* alias?: string //对应数据
* curr?: number
* total?: number
* msg?: string
* }
*/
onAliasOperatorResult(jAliasMessage: JAliasMessage): void {
hilog.info(0x0000, 'testTag', '%{public}s', 'onAliasOperatorResult jAliasMessage:' + JSON.stringify(jAliasMessage));
this.context.eventHub.emit('jPush_event', "onAliasOperatorResult:" + JSON.stringify(jAliasMessage));
}
/**
* 通知点击事件回调
* @param jMessage
*
* export class JMessage {
* msgId?: string //通知id
* title?: string //通知标题
* content?: string//通知内容
* extras?: Record<string, Object>//自定义数据
* }
*/
onClickMessage(jMessage: JMessage) {
hilog.info(0x0000, 'testTag', '%{public}s', 'onClickMessage jMessage:' + JSON.stringify(jMessage));
this.context.eventHub.emit('jPush_event', "onClickMessage:" + JSON.stringify(jMessage));
}
/**
* 自定义信息通知回调
* 回调一:冷启动调用sdk初始化后回调之前还没有回调的信息
* 回调二:app存活时会直接回调信息
* 想要有自定义信息回调,还需查看集成指南的自定义信息集成配置方式
* @param jCustomMessage
*
* export class JCustomMessage {
* msgId?: string //通知id
* title?: string //通知标题
* content?: string //通知内容
* contentType?: string //通知内容类型
* extras?: Record<string, Object> //通知自定义键值对
* ttl?: number //后台下发的信息过期时间,单位秒
* stime?: number //后台下发时间,毫秒
* }
*/
onCustomMessage(jCustomMessage: JCustomMessage) {
hilog.info(0x0000, TAG, '%{public}s', 'onCustomMessage jCustomMessage:' + JSON.stringify(jCustomMessage));
this.context.eventHub.emit('jPush_event', "onCustomMessage:" + JSON.stringify(jCustomMessage));
}
/**
* 通知扩展消息回调
* @param jMessageExtra
*
* export class JMessageExtra {
* msgId?: string //通知id
* title?: string //通知标题
* content?: string//通知内容
* extras?: Record<string, Object>//自定义数据
* extraData?: string//通知扩展消息的自定义数据
* }
*/
onJMessageExtra(jme: JMessageExtra) {
hilog.info(0x0000, TAG, '%{public}s', 'onJMessageExtra jme:' + JSON.stringify(jme));
this.context.eventHub.emit('jPush_event', "onJMessageExtra:" + JSON.stringify(jme));
}
/**
* VoIP呼叫消息回调
* export class JMessageVoIP {
* msgId?: string //通知id
* extraData?: string //VoIP自定义数据
}
* @param jmVoIP
*/
onJMessageVoIP(jmVoIP: JMessageVoIP) {
hilog.info(0x0000, TAG, '%{public}s', 'JMessageVoIP jmVoIP:' + JSON.stringify(jmVoIP));
this.context.eventHub.emit('jPush_event', "JMessageVoIP:" + JSON.stringify(jmVoIP));
}
/**
* export class JCmdMessage {
* public static CMD_PUSH_STOP = 2007 //通知停止 设置回调
* public static CMD_PUSH_RESUME = 2006 // 通知恢复 设置回调
* cmd?: number //操作类型
* errorCode?: number //状态码
* msg?: string //内容
* extra?: Record<string, Object>
* }
* @param cmdMessage
*/
onCommandResult(cmdMessage: JCmdMessage) {
hilog.info(0x0000, TAG, '%{public}s', 'onCommandResult cmdMessage:' + JSON.stringify(cmdMessage));
this.context.eventHub.emit('jPush_event', "onCommandResult:" + JSON.stringify(cmdMessage));
}
}
JPushInterface.setCallBackMsg(new MyCallBackMsg(this.context))
此代码块在浮窗中显示
参数说明
- callBackMsg: 接收sdk数据回调的类,需继承CallBackMsg接口
回调方法明细
注册结果回调(onRegister)
注册结果回调
接口定义
/**
* 注册结果回调
*
* @param registrationId rid
*/
onRegister(registrationId: string)
/**
* 注册结果回调
*
* @param registrationId rid
*/
onRegister(registrationId: string)
此代码块在浮窗中显示
长连接状态回调(isConnected)
接口定义
/**
* 长连接是否连接成功
*
* 在开启推送业务功能后会进行长连接,连接成功/失败均会回调此方法
*
* @param isConnected 长连接是否连接成功,true为成功;false为失败
*/
onConnected(isConnected: boolean)
/**
* 长连接是否连接成功
*
* 在开启推送业务功能后会进行长连接,连接成功/失败均会回调此方法
*
* @param isConnected 长连接是否连接成功,true为成功;false为失败
*/
onConnected(isConnected: boolean)
此代码块在浮窗中显示
通知点击事件回调(onClickMessage)
接口定义
/**
* 通知点击事件回调
export class JMessage {
msgId?: string //通知id
title?: string //通知标题
content?: string //通知内容
extras?: Record<string, Object> //自定义数据
}
*
* @param jMessage
*/
onClickMessage(jMessage: JMessage)
/**
* 通知点击事件回调
export class JMessage {
msgId?: string //通知id
title?: string //通知标题
content?: string //通知内容
extras?: Record<string, Object> //自定义数据
}
*
* @param jMessage
*/
onClickMessage(jMessage: JMessage)
此代码块在浮窗中显示
交互事件回调(onCommandResult)
接口定义
/**
* 交互事件回调
* @param cmdMessage
* export class JCmdMessage {
* public static CMD_PUSH_STOP = 2007 //通知停止 设置回调
* public static CMD_PUSH_RESUME = 2006 // 通知恢复 设置回调
*
* cmd?: number //操作事件,2007通知停止,2006恢复通知
* errorCode?: number //0表示成功,其他为错误
* msg?: string //内容信息
* extra?: Record<string, Object>
* }
*/
onCommandResult(cmdMessage: JCmdMessage);
/**
* 交互事件回调
* @param cmdMessage
* export class JCmdMessage {
* public static CMD_PUSH_STOP = 2007 //通知停止 设置回调
* public static CMD_PUSH_RESUME = 2006 // 通知恢复 设置回调
*
* cmd?: number //操作事件,2007通知停止,2006恢复通知
* errorCode?: number //0表示成功,其他为错误
* msg?: string //内容信息
* extra?: Record<string, Object>
* }
*/
onCommandResult(cmdMessage: JCmdMessage);
此代码块在浮窗中显示
cmd | errorCode | msg | DESCRIPTION |
---|---|---|---|
0 | 失败 code | 失败信息 | 注册失败 |
2006 | 0 | success | onResume 设置回调 |
2007 | 0 | success | onStop 设置回调 |
后台自定义信息回调(onCustomMessage)
接口定义
/**
* 自定义信息通知回调
* 回调一:冷启动调用sdk初始化后回调之前还没有回调的信息
* 回调二:app存活时会直接回调信息
* 想要有自定义信息回调,还需查看集成指南的自定义信息集成配置方式
* @param jCustomMessage
*
* export class JCustomMessage {
* msgId?: string //通知id
* title?: string //通知标题
* content?: string //通知内容
* contentType?: string //通知内容类型
* extras?: Record<string, Object> //通知自定义键值对
* ttl?: number //后台下发的信息过期时间,单位秒
* stime?: number //后台下发时间,毫秒
* }
*/
onCustomMessage(jCustomMessage: JCustomMessage);
/**
* 自定义信息通知回调
* 回调一:冷启动调用sdk初始化后回调之前还没有回调的信息
* 回调二:app存活时会直接回调信息
* 想要有自定义信息回调,还需查看集成指南的自定义信息集成配置方式
* @param jCustomMessage
*
* export class JCustomMessage {
* msgId?: string //通知id
* title?: string //通知标题
* content?: string //通知内容
* contentType?: string //通知内容类型
* extras?: Record<string, Object> //通知自定义键值对
* ttl?: number //后台下发的信息过期时间,单位秒
* stime?: number //后台下发时间,毫秒
* }
*/
onCustomMessage(jCustomMessage: JCustomMessage);
此代码块在浮窗中显示
通知扩展消息回调(onJMessageExtra)
接口定义
/**
* 通知扩展消息回调
* @param jMessageExtra
*
* export class JMessageExtra {
* msgId?: string //通知id
* title?: string //通知标题
* content?: string//通知内容
* extras?: Record<string, Object>//自定义数据
* extraData?: string//通知扩展消息的自定义数据
* }
*/
onJMessageExtra(jme: JMessageExtra);
/**
* 通知扩展消息回调
* @param jMessageExtra
*
* export class JMessageExtra {
* msgId?: string //通知id
* title?: string //通知标题
* content?: string//通知内容
* extras?: Record<string, Object>//自定义数据
* extraData?: string//通知扩展消息的自定义数据
* }
*/
onJMessageExtra(jme: JMessageExtra);
此代码块在浮窗中显示
VoIP呼叫消息回调(onJMessageVoIP)
接口定义
/**
* VoIP呼叫消息回调
* export class JMessageVoIP {
* msgId?: string //通知id
* extraData?: string //VoIP自定义数据
}
* @param jmVoIP
*/
onJMessageVoIP(jmVoIP: JMessageVoIP);
/**
* VoIP呼叫消息回调
* export class JMessageVoIP {
* msgId?: string //通知id
* extraData?: string //VoIP自定义数据
}
* @param jmVoIP
*/
onJMessageVoIP(jmVoIP: JMessageVoIP);
此代码块在浮窗中显示
操作 tag 接口回调(onTagOperatorResult)
接口定义
/**
* 操作 tag 接口回调
export class JTagMessage {
sequence?: number //对应操作id,全局不要重复
code?: number //0成功,JTagMessage.CODE_TIME_OUT超时
op?: string
tags?: string[] //对应数据
curr?: number //数据当前页数,页数从1开始
total?: number //数据总页数
msg?: string
}
*
* @param jTagMessage
*/
onTagOperatorResult(jTagMessage: JTagMessage)
/**
* 操作 tag 接口回调
export class JTagMessage {
sequence?: number //对应操作id,全局不要重复
code?: number //0成功,JTagMessage.CODE_TIME_OUT超时
op?: string
tags?: string[] //对应数据
curr?: number //数据当前页数,页数从1开始
total?: number //数据总页数
msg?: string
}
*
* @param jTagMessage
*/
onTagOperatorResult(jTagMessage: JTagMessage)
此代码块在浮窗中显示
操作 Alias 接口回调(onAliasOperatorResult)
接口定义
/**
* 操作 Alias 接口回调
export class JAliasMessage {
sequence?: number //对应操作id,全局不要重复
code?: number //0成功,JAliasMessage.CODE_TIME_OUT超时
op?: string
alias?: string //对应数据
curr?: number
total?: number
msg?: string
}
*
* @param jAliasMessage
*/
onAliasOperatorResult(jAliasMessage: JAliasMessage)
/**
* 操作 Alias 接口回调
export class JAliasMessage {
sequence?: number //对应操作id,全局不要重复
code?: number //0成功,JAliasMessage.CODE_TIME_OUT超时
op?: string
alias?: string //对应数据
curr?: number
total?: number
msg?: string
}
*
* @param jAliasMessage
*/
onAliasOperatorResult(jAliasMessage: JAliasMessage)
此代码块在浮窗中显示
通知跳转数据接收(setClickWant)
功能说明
为了能接收到通知点击后回调的对应数据 在通知跳转页面UIAbility的onCreate、onNewWant中调用:传入want 然后会通过上面设置的回调接口CallBackMsg类中的onClickMessage方法回调
- 请先setAppKey,否则调用无效
接口定义
/**
* 在通知跳转页面UIAbility的onCreate、onNewWant中调用:传入want,通过上面的onClickMessage接口回调自定义数据
*
* @param want
*/
setClickWant(want: Want): Promise<JMessage | undefined>
/**
* 在通知跳转页面UIAbility的onCreate、onNewWant中调用:传入want,通过上面的onClickMessage接口回调自定义数据
*
* @param want
*/
setClickWant(want: Want): Promise<JMessage | undefined>
此代码块在浮窗中显示
代码示例
onCreate(want: Want, launchParam: AbilityConstant.LaunchParam): void {
this.setClickWant(want)
}
onNewWant(want: Want, launchParam: AbilityConstant.LaunchParam): void {
super.onNewWant(want,launchParam)
this.setClickWant(want)
}
private async setClickWant(want: Want) {
let j:JMessage|undefined = await JPushInterface.setClickWant(want);
hilog.info(0x0000, TAG, '%{public}s', 'setClickWant: '+JSON.stringify(j));
}
onCreate(want: Want, launchParam: AbilityConstant.LaunchParam): void {
this.setClickWant(want)
}
onNewWant(want: Want, launchParam: AbilityConstant.LaunchParam): void {
super.onNewWant(want,launchParam)
this.setClickWant(want)
}
private async setClickWant(want: Want) {
let j:JMessage|undefined = await JPushInterface.setClickWant(want);
hilog.info(0x0000, TAG, '%{public}s', 'setClickWant: '+JSON.stringify(j));
}
此代码块在浮窗中显示
参数说明
want:为UIAbility中的want
return
- 反回数据,JMessage表示正确处理并反回了数据对象,undefined表示没有数据或不是极光的数据或异常出错
停止通知(stopPush)
功能说明
- 请先init,否则调用无效
- 结果在onCommandResult(cmdMessage: JCmdMessage)回调
接口定义
/**
* 停止通知
*
*/
stopPush()
/**
* 停止通知
*
*/
stopPush()
此代码块在浮窗中显示
代码示例
JPushInterface.stopPush()
JPushInterface.stopPush()
此代码块在浮窗中显示
参数说明
- 无
恢复通知(resumePush)
功能说明
- 请先init,否则调用无效
- 结果在onCommandResult(cmdMessage: JCmdMessage)回调
接口定义
/**
* 恢复通知
*
*/
resumePush()
/**
* 恢复通知
*
*/
resumePush()
此代码块在浮窗中显示
代码示例
JPushInterface.resumePush()
JPushInterface.resumePush()
此代码块在浮窗中显示
参数说明
- 无
通知状态查询(isPushStopped)
功能说明
- 请先init,否则调用无效
接口定义
/**
* 通知状态查询
*
*/
isPushStopped(): boolean | undefined
/**
* 通知状态查询
*
*/
isPushStopped(): boolean | undefined
此代码块在浮窗中显示
代码示例
let isPushStopped = JPushInterface.isPushStopped()
let isPushStopped = JPushInterface.isPushStopped()
此代码块在浮窗中显示
参数说明
- 反回值:true停止,false正常,undefined没有初始化等异常情况
标签与别名-api
新增标签(addTags)
功能说明
- 请先init,否则调用无效
- 如果环境没有问题,onTagOperatorResult会回调结果
接口定义
/**
* 增加指定tag,累加逻辑,之前设置的标签依然存在
*
* @param sequence 用户自定义的操作序列号,同操作结果一起返回,用来标识一次操作的唯一性
* @param tags 标签数组,每个tag命名长度限制为40字节,最多支持设置1000个tag,且单次操作总长度不得超过5000字节
*/
addTags(sequence: number, tags: string[])
/**
* 增加指定tag,累加逻辑,之前设置的标签依然存在
*
* @param sequence 用户自定义的操作序列号,同操作结果一起返回,用来标识一次操作的唯一性
* @param tags 标签数组,每个tag命名长度限制为40字节,最多支持设置1000个tag,且单次操作总长度不得超过5000字节
*/
addTags(sequence: number, tags: string[])
此代码块在浮窗中显示
代码示例
JPushInterface.addTags(this.sequence++, ["ccc", "ddddd"])
JPushInterface.addTags(this.sequence++, ["ccc", "ddddd"])
此代码块在浮窗中显示
参数说明
- sequence
- 用户自定义的操作序列号,同操作结果一起返回,用来标识一次操作的唯一性。
- tags
- 每次调用至少新增一个 tag。
- 有效的标签组成:字母(区分大小写)、数字、下划线、汉字、特殊字符 @!#$&*+=.|。
- 限制:每个 tag 命名长度限制为 40 字节,最多支持设置 1000 个 tag,且单次操作总长度不得超过 5000 字节。(判断长度需采用 UTF-8 编码) 单个设备最多支持设置 1000 个 tag。App 全局 tag 数量无限制。
删除标签(deleteTags)
功能说明
- 请先init,否则调用无效
- 如果环境没有问题,onTagOperatorResult会回调结果
接口定义
/**
* 删除指定tag,删除逻辑,会删除指定的标签
*
* @param sequence 用户自定义的操作序列号,同操作结果一起返回,用来标识一次操作的唯一性
* @param tags 标签数组,每个tag命名长度限制为40字节,最多支持设置1000个tag,且单次操作总长度不得超过5000字节
*/
deleteTags(sequence: number, tags: string[])
/**
* 删除指定tag,删除逻辑,会删除指定的标签
*
* @param sequence 用户自定义的操作序列号,同操作结果一起返回,用来标识一次操作的唯一性
* @param tags 标签数组,每个tag命名长度限制为40字节,最多支持设置1000个tag,且单次操作总长度不得超过5000字节
*/
deleteTags(sequence: number, tags: string[])
此代码块在浮窗中显示
代码示例
JPushInterface.deleteTags(this.sequence++, ["ccc"])
JPushInterface.deleteTags(this.sequence++, ["ccc"])
此代码块在浮窗中显示
参数说明
- sequence
- 用户自定义的操作序列号,同操作结果一起返回,用来标识一次操作的唯一性。
- tags
- 每次调用至少删除一个 tag。
- 有效的标签组成:字母(区分大小写)、数字、下划线、汉字、特殊字符 @!#$&*+=.|。
- 限制:每个 tag 命名长度限制为 40 字节,最多支持设置 1000 个 tag,且单次操作总长度不得超过 5000 字节。(判断长度需采用 UTF-8 编码) 单个设备最多支持设置 1000 个 tag。App 全局 tag 数量无限制。
设置标签(setTags)
功能说明
- 请先init,否则调用无效
- 如果环境没有问题,onTagOperatorResult会回调结果
接口定义
/**
* 更新指定tag,覆盖逻辑,之前添加的tag会清空
*
* @param sequence 用户自定义的操作序列号,同操作结果一起返回,用来标识一次操作的唯一性
* @param tags 标签数组,每个tag命名长度限制为40字节,最多支持设置1000个tag,且单次操作总长度不得超过5000字节
*/
setTags(sequence: number, tags: string[])
/**
* 更新指定tag,覆盖逻辑,之前添加的tag会清空
*
* @param sequence 用户自定义的操作序列号,同操作结果一起返回,用来标识一次操作的唯一性
* @param tags 标签数组,每个tag命名长度限制为40字节,最多支持设置1000个tag,且单次操作总长度不得超过5000字节
*/
setTags(sequence: number, tags: string[])
此代码块在浮窗中显示
代码示例
JPushInterface.setTags(this.sequence++, ["xxx", "yyy"])
JPushInterface.setTags(this.sequence++, ["xxx", "yyy"])
此代码块在浮窗中显示
参数说明
- sequence
- 用户自定义的操作序列号,同操作结果一起返回,用来标识一次操作的唯一性。
- tags
- 每次调用至少新增一个 tag。
- 有效的标签组成:字母(区分大小写)、数字、下划线、汉字、特殊字符 @!#$&*+=.|。
- 限制:每个 tag 命名长度限制为 40 字节,最多支持设置 1000 个 tag,且单次操作总长度不得超过 5000 字节。(判断长度需采用 UTF-8 编码) 单个设备最多支持设置 1000 个 tag。App 全局 tag 数量无限制。
查询指定标签的绑定状态(checkTagBindState)
功能说明
- 请先init,否则调用无效
- 如果环境没有问题,onTagOperatorResult会回调结果
接口定义
/**
* 查询指定tag
*
* @param sequence 用户自定义的操作序列号,同操作结果一起返回,用来标识一次操作的唯一性
* @param tag 标签,每个tag命名长度限制为40字节
*/
checkTagBindState(sequence: number, tag: string)
/**
* 查询指定tag
*
* @param sequence 用户自定义的操作序列号,同操作结果一起返回,用来标识一次操作的唯一性
* @param tag 标签,每个tag命名长度限制为40字节
*/
checkTagBindState(sequence: number, tag: string)
此代码块在浮窗中显示
代码示例
JPushInterface.checkTagBindState(this.sequence++, "ccc")
JPushInterface.checkTagBindState(this.sequence++, "ccc")
此代码块在浮窗中显示
参数说明
- sequence
- 用户自定义的操作序列号,同操作结果一起返回,用来标识一次操作的唯一性。
- tags
- 被查询的 tag
清除所有标签(cleanTags)
功能说明
- 请先init,否则调用无效
- 如果环境没有问题,onTagOperatorResult会回调结果
接口定义
/**
* 删除所有tag,清空逻辑,会删除所有的标签
*
* @param sequence 用户自定义的操作序列号,同操作结果一起返回,用来标识一次操作的唯一性
*/
cleanTags(sequence: number)
/**
* 删除所有tag,清空逻辑,会删除所有的标签
*
* @param sequence 用户自定义的操作序列号,同操作结果一起返回,用来标识一次操作的唯一性
*/
cleanTags(sequence: number)
此代码块在浮窗中显示
代码示例
JPushInterface.cleanTags(this.sequence++)
JPushInterface.cleanTags(this.sequence++)
此代码块在浮窗中显示
参数说明
- sequence
- 用户自定义的操作序列号,同操作结果一起返回,用来标识一次操作的唯一性。
查询所有标签(getTags)
功能说明
- 请先init,否则调用无效
- 如果环境没有问题,onTagMessage会回调结果
接口定义
/**
* 查询所有tag,获取逻辑,会获取所有标签
*
* @param sequence 用户自定义的操作序列号,同操作结果一起返回,用来标识一次操作的唯一性
* @param curr 获取当前的页数,开始页数值为1
*/
getTags(sequence: number, curr: number)
/**
* 查询所有tag,获取逻辑,会获取所有标签
*
* @param sequence 用户自定义的操作序列号,同操作结果一起返回,用来标识一次操作的唯一性
* @param curr 获取当前的页数,开始页数值为1
*/
getTags(sequence: number, curr: number)
此代码块在浮窗中显示
代码示例
JPushInterface.getTags(this.sequence++, 1)
JPushInterface.getTags(this.sequence++, 1)
此代码块在浮窗中显示
参数说明
- sequence
- 用户自定义的操作序列号,同操作结果一起返回,用来标识一次操作的唯一性。
设置别名(setAlias)
功能说明
- 请先init,否则调用无效
- 如果环境没有问题,onAliasOperatorResult会回调结果
接口定义
/**
* 设置alias
*
* 同一个应用程序内,对不同的用户,建议取不同的别名。这样,尽可能根据别名来唯一确定用户
*
* 不限定一个别名只能指定一个用户
*
* @param sequence 用户自定义的操作序列号,同操作结果一起返回,用来标识一次操作的唯一性
* @param alias 有效的别名组成:字母(区分大小写)、数字、下划线、汉字、特殊字符@!#$&*+=.|。限制:alias命名长度限制为 40 字节(判断长度需采用 UTF-8 编码)
*
*/
setAlias(sequence: number, alias: string)
/**
* 设置alias
*
* 同一个应用程序内,对不同的用户,建议取不同的别名。这样,尽可能根据别名来唯一确定用户
*
* 不限定一个别名只能指定一个用户
*
* @param sequence 用户自定义的操作序列号,同操作结果一起返回,用来标识一次操作的唯一性
* @param alias 有效的别名组成:字母(区分大小写)、数字、下划线、汉字、特殊字符@!#$&*+=.|。限制:alias命名长度限制为 40 字节(判断长度需采用 UTF-8 编码)
*
*/
setAlias(sequence: number, alias: string)
此代码块在浮窗中显示
代码示例
JPushInterface.setAlias(this.sequence++, "gggdd")
JPushInterface.setAlias(this.sequence++, "gggdd")
此代码块在浮窗中显示
参数说明
- sequence
- 用户自定义的操作序列号,同操作结果一起返回,用来标识一次操作的唯一性,推荐每次都用不同的数字序号。
- alias
- 每次调用设置有效的别名,覆盖之前的设置。
- 有效的别名组成:字母(区分大小写)、数字、下划线、汉字、特殊字符 @!#$&*+=.|。
- 限制:alias 命名长度限制为 40 字节。(判断长度需采用 UTF-8 编码)
查询别名(getAlias)
功能说明
- 请先init,否则调用无效
- 如果环境没有问题,onAliasOperatorResult会回调结果
接口定义
/**
* 获取alias
*
* 同一个应用程序内,对不同的用户,建议取不同的别名。这样,尽可能根据别名来唯一确定用户
*
* 不限定一个别名只能指定一个用户
*
* @param sequence 用户自定义的操作序列号,同操作结果一起返回,用来标识一次操作的唯一性
*/
getAlias(sequence: number)
/**
* 获取alias
*
* 同一个应用程序内,对不同的用户,建议取不同的别名。这样,尽可能根据别名来唯一确定用户
*
* 不限定一个别名只能指定一个用户
*
* @param sequence 用户自定义的操作序列号,同操作结果一起返回,用来标识一次操作的唯一性
*/
getAlias(sequence: number)
此代码块在浮窗中显示
代码示例
JPushInterface.getAlias(this.sequence++)
JPushInterface.getAlias(this.sequence++)
此代码块在浮窗中显示
参数说明
- sequence
- 用户自定义的操作序列号,同操作结果一起返回,用来标识一次操作的唯一性,推荐每次都用不同的数字序号。
删除别名(deleteAlias)
功能说明
- 请先init,否则调用无效
- 如果环境没有问题,onAliasOperatorResult会回调结果
接口定义
/**
* 清除alias
*
* 同一个应用程序内,对不同的用户,建议取不同的别名。这样,尽可能根据别名来唯一确定用户
*
* 不限定一个别名只能指定一个用户
*
* @param sequence 用户自定义的操作序列号,同操作结果一起返回,用来标识一次操作的唯一性
*/
deleteAlias(sequence: number)
/**
* 清除alias
*
* 同一个应用程序内,对不同的用户,建议取不同的别名。这样,尽可能根据别名来唯一确定用户
*
* 不限定一个别名只能指定一个用户
*
* @param sequence 用户自定义的操作序列号,同操作结果一起返回,用来标识一次操作的唯一性
*/
deleteAlias(sequence: number)
此代码块在浮窗中显示
代码示例
JPushInterface.deleteAlias(this.sequence++)
JPushInterface.deleteAlias(this.sequence++)
此代码块在浮窗中显示
参数说明
- sequence
- 用户自定义的操作序列号,同操作结果一起返回,用来标识一次操作的唯一性,推荐每次都用不同的数字序号。
设置手机号(setMobileNumber)
功能说明
- 请先init,否则调用无效
接口定义
/**
* 设置手机号
*
* @param sequence 用户自定义的操作序列号,同操作结果一起返回,用来标识一次操作的唯一性,推荐每次都用不同的数字序号。
* @param mobileNumber 手机号
*/
setMobileNumber(sequence: number, mobileNumber: string)
/**
* 设置手机号
*
* @param sequence 用户自定义的操作序列号,同操作结果一起返回,用来标识一次操作的唯一性,推荐每次都用不同的数字序号。
* @param mobileNumber 手机号
*/
setMobileNumber(sequence: number, mobileNumber: string)
此代码块在浮窗中显示
代码示例
JPushInterface.setMobileNumber(this.sequence++,"155xxxxxxxx)
JPushInterface.setMobileNumber(this.sequence++,"155xxxxxxxx)
此代码块在浮窗中显示
参数说明
- sequence
- 用户自定义的操作序列号,同操作结果一起返回,用来标识一次操作的唯一性,推荐每次都用不同的数字序号。
- mobileNumber
- 手机号
设置角标(setBadgeNumber)
- 手机号
功能说明
- 请先init,否则调用无效
接口定义
/**
* 设置角标
*
* @param badgeNumber 角标值
*/
setBadgeNumber(badgeNumber: number)
/**
* 设置角标
*
* @param badgeNumber 角标值
*/
setBadgeNumber(badgeNumber: number)
此代码块在浮窗中显示
代码示例
JPushInterface.setBadgeNumber(0)
JPushInterface.setBadgeNumber(0)
此代码块在浮窗中显示
参数说明
- badgeNumber
- 角标值
自定义信息接收(customMessageBackgroundData)
功能说明
- 请查看集成指南文档中:配置自定义信息
接口定义
/**
* 自定义消息集成使用
* 后台自定义信息接收
* @param data BACKGROUND消息
*/
customMessageBackgroundData(data: pushCommon.PushPayload): Promise<boolean>
/**
* 自定义消息集成使用
* 后台自定义信息接收
* @param data BACKGROUND消息
*/
customMessageBackgroundData(data: pushCommon.PushPayload): Promise<boolean>
此代码块在浮窗中显示
代码示例
import { UIAbility } from '@kit.AbilityKit';
import { JPushInterface } from '@jg/push';
import { pushCommon, pushService } from '@kit.PushKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
const TAG: string = 'JPUSH-JLog-PushMessageAbility'
export default class PushMessageAbility extends UIAbility {
onCreate(): void {
try { // receiveMessage中的参数固定为BACKGROUND-------后台自定义信息接收
pushService.receiveMessage('BACKGROUND', this, async (data: pushCommon.PushPayload) => {
let jg = await JPushInterface.customMessageBackgroundData(data)
if (jg) { //如果是true为已经处理
return
}
});
} catch (e) {
hilog.info(0x0000, TAG, '%{public}s', 'BACKGROUND fail:'+JSON.stringify(e));
}
}
import { UIAbility } from '@kit.AbilityKit';
import { JPushInterface } from '@jg/push';
import { pushCommon, pushService } from '@kit.PushKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
const TAG: string = 'JPUSH-JLog-PushMessageAbility'
export default class PushMessageAbility extends UIAbility {
onCreate(): void {
try { // receiveMessage中的参数固定为BACKGROUND-------后台自定义信息接收
pushService.receiveMessage('BACKGROUND', this, async (data: pushCommon.PushPayload) => {
let jg = await JPushInterface.customMessageBackgroundData(data)
if (jg) { //如果是true为已经处理
return
}
});
} catch (e) {
hilog.info(0x0000, TAG, '%{public}s', 'BACKGROUND fail:'+JSON.stringify(e));
}
}
此代码块在浮窗中显示
参数说明
- data
- receiveMessage中的参数固定为BACKGROUND数据,即后台数据
- return
- 反回数据,true表示正确处理了,false表示不是极光的数据或异常出错
VoIP呼叫消息接收(voIPMessageBackgroundData)
功能说明
- 请查看集成指南文档中:配置VoIP呼叫消息
接口定义
/**
* VoIP呼叫消息集成使用
* VoIP呼叫消息接收
* @param data VoIP消息
*/
voIPMessageBackgroundData(data: pushCommon.PushPayload): Promise<boolean>
/**
* VoIP呼叫消息集成使用
* VoIP呼叫消息接收
* @param data VoIP消息
*/
voIPMessageBackgroundData(data: pushCommon.PushPayload): Promise<boolean>
此代码块在浮窗中显示
代码示例
import { UIAbility } from '@kit.AbilityKit';
import { JPushInterface } from '@jg/push';
import { pushCommon, pushService } from '@kit.PushKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
const TAG: string = 'JPUSH-JLog-PushMessageAbility'
export default class PushMessageAbility extends UIAbility {
onCreate(): void {
try {
pushService.receiveMessage('VoIP', this, async (data) => {
let jg = await JPushInterface.voIPMessageBackgroundData(data)
if (jg) { //如果是true为已经处理
return
}
});
} catch (e) {
hilog.info(0x0000, TAG, '%{public}s', 'VoIP fail:'+JSON.stringify(e));
}
}
}
import { UIAbility } from '@kit.AbilityKit';
import { JPushInterface } from '@jg/push';
import { pushCommon, pushService } from '@kit.PushKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
const TAG: string = 'JPUSH-JLog-PushMessageAbility'
export default class PushMessageAbility extends UIAbility {
onCreate(): void {
try {
pushService.receiveMessage('VoIP', this, async (data) => {
let jg = await JPushInterface.voIPMessageBackgroundData(data)
if (jg) { //如果是true为已经处理
return
}
});
} catch (e) {
hilog.info(0x0000, TAG, '%{public}s', 'VoIP fail:'+JSON.stringify(e));
}
}
}
此代码块在浮窗中显示
参数说明
- data
- receiveMessage中的参数固定为VoIP数据,即通VoIP呼叫消息
- return
- 反回数据,true表示正确处理了,false表示不是极光的数据或异常出错
通知扩展消息接收--进程存活时(extraMessageBackgroundData)
功能说明
- 请查看集成指南文档中:配置通知扩展消息
接口定义
/**
* 通知扩展消息集成使用
* 通知扩展消息接收
* @param data IM消息
*/
extraMessageBackgroundData(data: pushCommon.PushPayload): Promise<boolean>
/**
* 通知扩展消息集成使用
* 通知扩展消息接收
* @param data IM消息
*/
extraMessageBackgroundData(data: pushCommon.PushPayload): Promise<boolean>
此代码块在浮窗中显示
代码示例
import { UIAbility } from '@kit.AbilityKit';
import { JPushInterface } from '@jg/push';
import { pushCommon, pushService } from '@kit.PushKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
const TAG: string = 'JPUSH-JLog-PushMessageAbility'
export default class PushMessageAbility extends UIAbility {
onCreate(): void {
try { // receiveMessage中的参数固定为IM-------拓展通知接收
pushService.receiveMessage('IM', this, async (data) => {
let jg = await JPushInterface.extraMessageBackgroundData(data)
if (jg) { //如果是true为已经处理
return
}
});
} catch (e) {
hilog.info(0x0000, TAG, '%{public}s', 'IM fail:'+JSON.stringify(e));
}
}
import { UIAbility } from '@kit.AbilityKit';
import { JPushInterface } from '@jg/push';
import { pushCommon, pushService } from '@kit.PushKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
const TAG: string = 'JPUSH-JLog-PushMessageAbility'
export default class PushMessageAbility extends UIAbility {
onCreate(): void {
try { // receiveMessage中的参数固定为IM-------拓展通知接收
pushService.receiveMessage('IM', this, async (data) => {
let jg = await JPushInterface.extraMessageBackgroundData(data)
if (jg) { //如果是true为已经处理
return
}
});
} catch (e) {
hilog.info(0x0000, TAG, '%{public}s', 'IM fail:'+JSON.stringify(e));
}
}
此代码块在浮窗中显示
参数说明
- data
- receiveMessage中的参数固定为IM数据,即通知扩展消息
- return
- 反回数据,true表示正确处理了,false表示不是极光的数据或异常出错
通知扩展消息接收--进程不存在(receiveExtraDataMessage)
功能说明
- 请查看集成指南文档中:配置通知扩展消息
接口定义
/**
* 通知扩展消息集成使用
* 通知扩展消息接收
* @param rNEAbility 对应RemoteNotificationExtensionAbility
* @param data onReceiveMessage数据
*/
receiveExtraDataMessage(rNEAbility: RemoteNotificationExtensionAbility, remoteNotificationInfo: pushCommon.RemoteNotificationInfo): Promise<JMessageExtra | undefined>
/**
* 通知扩展消息集成使用
* 通知扩展消息接收
* @param rNEAbility 对应RemoteNotificationExtensionAbility
* @param data onReceiveMessage数据
*/
receiveExtraDataMessage(rNEAbility: RemoteNotificationExtensionAbility, remoteNotificationInfo: pushCommon.RemoteNotificationInfo): Promise<JMessageExtra | undefined>
此代码块在浮窗中显示
代码示例
import { pushCommon, RemoteNotificationExtensionAbility } from '@kit.PushKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { JPushInterface } from '@jg/push';
const TAG: string = 'JPUSH-JLog-RemoteNotificationExtAbility'
export default class RemoteNotificationExtAbility extends RemoteNotificationExtensionAbility {
async onReceiveMessage(remoteNotificationInfo: pushCommon.RemoteNotificationInfo): Promise<pushCommon.RemoteNotificationContent> {
hilog.info(0x0000, TAG, 'onReceiveMessage, remoteNotificationInfo: %{public}s',
JSON.stringify(remoteNotificationInfo));
let jMessageExtra = await JPushInterface.receiveExtraDataMessage(this, remoteNotificationInfo);
hilog.info(0x0000, TAG, 'onReceiveMessage jMessageExtra:' + JSON.stringify(jMessageExtra));
// Return the replaced message content.
return {}//如果要修改通知可以反回有数据通知
}
onDestroy(): void {
hilog.info(0x0000, TAG, 'RemoteNotificationExtAbility onDestroy.');
}
}
import { pushCommon, RemoteNotificationExtensionAbility } from '@kit.PushKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { JPushInterface } from '@jg/push';
const TAG: string = 'JPUSH-JLog-RemoteNotificationExtAbility'
export default class RemoteNotificationExtAbility extends RemoteNotificationExtensionAbility {
async onReceiveMessage(remoteNotificationInfo: pushCommon.RemoteNotificationInfo): Promise<pushCommon.RemoteNotificationContent> {
hilog.info(0x0000, TAG, 'onReceiveMessage, remoteNotificationInfo: %{public}s',
JSON.stringify(remoteNotificationInfo));
let jMessageExtra = await JPushInterface.receiveExtraDataMessage(this, remoteNotificationInfo);
hilog.info(0x0000, TAG, 'onReceiveMessage jMessageExtra:' + JSON.stringify(jMessageExtra));
// Return the replaced message content.
return {}//如果要修改通知可以反回有数据通知
}
onDestroy(): void {
hilog.info(0x0000, TAG, 'RemoteNotificationExtAbility onDestroy.');
}
}
此代码块在浮窗中显示
参数说明
- rNEAbility
- 对应RemoteNotificationExtensionAbility
- data
- onReceiveMessage回调的参数数据,即通知扩展消息
- return
- 反回数据,JMessageExtra表示正确处理并反回了数据对象,undefined表示不是极光的数据或异常出错
扩展业务相关设置
wifi列表采集开关(setListWifi)
功能说明
- 请先setAppKey,否则调用无效
接口定义
/**
* @param applicationContext 上下文
* @param enable 默认为true,false-不允许采集
*
*/
setListWifi(applicationContext: common.ApplicationContext, enable: boolean)
/**
* @param applicationContext 上下文
* @param enable 默认为true,false-不允许采集
*
*/
setListWifi(applicationContext: common.ApplicationContext, enable: boolean)
此代码块在浮窗中显示
代码示例
JCollectControl.setListWifi(this.context.getApplicationContext(), false)
JCollectControl.setListWifi(this.context.getApplicationContext(), false)
此代码块在浮窗中显示
参数说明
- applicationContext
- 上下文
- enable
- 默认为true,false-不允许采集
GPS采集开关(setGPS)
- 默认为true,false-不允许采集
功能说明
- 请先setAppKey,否则调用无效
接口定义
/**
* @param applicationContext 上下文
* @param enable 默认为true,false-不允许采集
*
*/
setGPS(applicationContext: common.ApplicationContext, enable: boolean)
/**
* @param applicationContext 上下文
* @param enable 默认为true,false-不允许采集
*
*/
setGPS(applicationContext: common.ApplicationContext, enable: boolean)
此代码块在浮窗中显示
代码示例
JCollectControl.setGPS(this.context.getApplicationContext(), false)
JCollectControl.setGPS(this.context.getApplicationContext(), false)
此代码块在浮窗中显示
参数说明
- applicationContext
- 上下文
- enable
- 默认为true,false-不允许采集
文档内容是否对您有帮助?