planNotify

立即使用

open close planRemind cancleRemind setFinishPlanListener cancleFinishPlanListener

概述

planNotify 封装了自定义通知。

配置

targetSdkVersion需要设置到26或以上。targetSdkVersion设置

使用此模块之前需先配置 config.xml 文件，方法如下

  • 配置示例:
  1. <feature name="planNotify">
  2.    <param  name="androidChannelId" value="11"/>
  3.    <param  name="androidChannel" value="appchannel"/>
  4.    <param  name="androidChannelDes" value="notification description"/>
  6.     </feature>

  • 字段描述:

    androidChannelId：安卓8.0推送渠道配置，渠道id。后台通过此渠道id推送

    androidChannel：安卓8.0推送渠道配置，渠道名称。

    androidChannelDes：安卓8.0推送渠道配置，渠道描述。

open

打开自定义通知

open({params},callback(ret))

params

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. status:,                       //布尔类型；是否打开成功
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. msg:,                       //字符串类型；错误信息
  3. }

click

点击事件，点击会重新打开主页面并传递参数，参数通过api.addEventListener({name:’appintent’}接口监听

planNotifyClick：

  • 类型：字符串类型
  • 描述：点击自定义通知item打开页面携带参数
  • 有效值： ‘api_plannotify_route’/点击行程传递参数 ‘api_plannotify_list’/点击清单传递参数 ‘api_plannotify_note’/点击笔记传递参数 ‘api_plannotify_date’/点击日历传递参数

示例代码

  1. var planNotify = api.require('planNotify');
  2. planNotify.open({
  4. }, function(ret, err) {
  5. alert(JSON.stringify(ret));
  6. });

可用性

Android系统

可提供的1.0.0及更高版本

close

关闭自定义通知

close({params},callback(ret))

params

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. status:,                       //布尔类型；是否关闭成功
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. msg:,                       //字符串类型；错误信息
  3. }

示例代码

  1. var planNotify = api.require('planNotify');
  2. planNotify.close({
  4. }, function(ret, err) {
  5. alert(JSON.stringify(ret));
  6. });

可用性

Android系统

可提供的1.0.0及更高版本

planRemind

计划提醒通知

planRemind({params},callback(ret))

params

notifyId：

  • 类型：数字类型
  • 描述：通知id，可根据此id关闭通知。id相同仅显示最后一个通知，id不同分别展示

localId：

  • 类型：字符串类型
  • 描述：本地行程id

tripId：

  • 类型：字符串类型
  • 描述：行程id

title：

  • 类型：字符串类型
  • 描述：计划title

content：

  • 类型：字符串类型
  • 描述：计划内容

extra：

  • 类型：字符串类型
  • 描述：（可选项）附加内容

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. status:,                       //布尔类型；是否成功
  3. notifyId:,                 //数字类型；通知id
  4. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. msg:,                       //字符串类型；错误信息
  3. }

click

点击事件，点击会重新打开主页面并传递以下参数，参数通过api.addEventListener({name:’appintent’}接口监听

localId：

  • 类型：字符串类型
  • 描述：本地行程id

tripId：

  • 类型：字符串类型
  • 描述：行程id

示例代码

  1. var planNotify = api.require('planNotify');
  2. planNotify.planRemind({
  3. notifyId:10,
  4.     localId:'',
  5.     tripId:'',
  6.     title:'',
  7.     content:'',
  8. }, function(ret, err) {
  9. alert(JSON.stringify(ret));
  10. });

可用性

Android系统

可提供的1.0.0及更高版本

cancleRemind

取消提醒

cancleRemind({params},callback(ret))

params

notifyId

  • 类型：数字类型
  • 描述：通知id，planRemind 接口中返回notifyId

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. status:,                       //布尔类型；是否关闭成功
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. msg:,                       //字符串类型；错误信息
  3. }

示例代码

  1. var planNotify = api.require('planNotify');
  2. planNotify.cancleRemind({
  3.     notifyId:,
  4. }, function(ret, err) {
  5. alert(JSON.stringify(ret));
  6. });

可用性

Android系统

可提供的1.0.0及更高版本

setFinishPlanListener

设置计划提醒通知中【将此事项标记已完成】点击监听

setFinishPlanListener({params},callback(ret))

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. status:,                       //布尔类型；监听设置成功
  3. localId:'',                   //字符串类型；planRemind接口中传入的本地行程id
  4. tripId:'',                    //字符串类型；planRemind接口中传入的行程id
  5. extra:'',                   //字符串类型；planRemind接口中传入的附加字段
  6. notifyId:'',            //字符串累心；点击的通知id
  7. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. msg:,                       //字符串类型；错误信息
  3. }

示例代码

  1. var planNotify = api.require('planNotify');
  2. planNotify.setFinishPlanListener({
  3. }, function(ret, err) {
  4. alert(JSON.stringify(ret));
  5. });

可用性

Android系统

可提供的1.0.0及更高版本

cancleFinishPlanListener

取消计划提醒通知中【将此事项标记已完成】点击监听

cancleFinishPlanListener({params},callback(ret))

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. status:,                       //布尔类型；是否取消成功
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. msg:,                       //字符串类型；错误信息
  3. }

示例代码

  1. var planNotify = api.require('planNotify');
  2. planNotify.cancleFinishPlanListener({
  3. }, function(ret, err) {
  4. alert(JSON.stringify(ret));
  5. });

可用性

Android系统

可提供的1.0.0及更高版本