notification
向用户发出震动、声音提示、灯光闪烁、状态栏消息等通知,以及闹钟功能。状态栏消息点击后,页面可以通过监听 noticeclicked 事件得到内容。
注:当应用在前台弹出通知提示时,iOS上面通知将在显示几秒后消失,不会在通知栏保留。
notification({params}, callback(ret, err))
params
vibrate:
类型:数组
默认值:[500,500]
描述:(可选项)伴随节奏的震动,时间数组,时间单位为毫秒,iOS上面震动时间为固定值
sound:
类型:字符串
默认值:default
描述:(可选项)提示音,默认为系统提示音。android为系统默认,不可定制;当实现闹钟功能时,iOS只支持widget://路径协议
light:
类型:布尔型
默认值:false
描述:(可选项)设备提示灯是否闪烁
notify:
类型:JSON 对象
默认值:无
描述:(可选项)弹出通知到状态栏
内部字段:
{
title:'' //标题,Android中默认值为应用名称,支持Android和iOS 8.2以上系统
content:'' //内容,默认值为'有新消息'
extra:'' //附加信息,页面可以监听noticeclicked事件得到点击的通知的附加信息
updateCurrent: false //是否覆盖更新已有的通知,取值范围true|false。只Android有效
}
alarm:
类型:JSON 对象
默认值:无
描述:(可选项)如果本次通知设置了闹铃,那么该通知将在设定的闹铃时间弹出
内部字段:
{
hour: //小时,数字类型,取值范围(0-23),默认值为当前系统时
minutes: //分钟,数字类型,取值范围(0-59),默认值为当前系统分
daysOfWeek: //通知循环时间,以周为单位,数组类型,如[1,2,3,4,5,6,7]代表周日、周一、周二、周三、周四、周五、周六。若不传则不循环,只在当天或隔天的指定时间通知一次
time: //闹铃目标时间,数字类型,1970年至今的毫秒数,只在设定的时间执行一次,若设置了time,那么hour、minutes、daysOfWeek将被忽略
}
callback(ret, err)
如果 notification 时传入了 notify,那么将收到 callback,返回本次状态栏通知的 id,该 id 可用于取消状态栏通知。
ret:
类型:JSON 对象
内部字段:
{
id:1 //弹出到状态栏通知的id,可用于取消通知
}
示例代码
api.notification({
notify: {
content: '闹钟'
},
alarm: {
hour: 7,
minutes: 30,
daysOfWeek: [2, 3, 4, 5, 6]
}
}, function(ret, err) {
var id = ret.id;
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本