notification

向用戶發(fā)出震動(dòng)、聲音提示、燈光閃爍、手機(jī)狀態(tài)欄通知等提示行為，支持鬧鐘功能。如果是狀態(tài)欄通知，當(dāng)用戶點(diǎn)擊該通知，頁面可以通過監(jiān)聽 noticeclicked 事件獲取該通知相關(guān)內(nèi)容。

注：當(dāng)應(yīng)用在前臺(tái)彈出通知提示時(shí)，iOS平臺(tái)的通知將在顯示幾秒后消失，不會(huì)在通知欄保留。

notification({params}, callback(ret, err))

params

vibrate：

• 類型：數(shù)組
• 默認(rèn)值：[100, 500, 100, 500]
• 描述：（可選項(xiàng)）伴隨節(jié)奏的震動(dòng)，時(shí)間數(shù)組，單位：毫秒。iOS平臺(tái)震動(dòng)時(shí)間為固定值；Android平臺(tái)節(jié)奏為【等待-震動(dòng)-等待-震動(dòng)..】，例如[100, 500, 100, 500]表現(xiàn)效果為：等待100毫秒-震動(dòng)500毫秒-等待100毫秒-震動(dòng)500毫秒

sound：

• 類型：字符串
• 默認(rèn)值：default
• 描述：（可選項(xiàng)）提示音，默認(rèn)為系統(tǒng)設(shè)置的提示音。Android支持傳入widget協(xié)議音頻文件，例如：widget://res/horse.mp3；當(dāng)實(shí)現(xiàn)鬧鐘功能時(shí)，iOS只支持widget://路徑協(xié)議

light：

• 類型：布爾型
• 默認(rèn)值：false
• 描述：（可選項(xiàng)）設(shè)備提示燈是否閃爍

notify：

• 類型：JSON 對(duì)象
• 默認(rèn)值：無
• 描述：（可選項(xiàng)）彈出通知到狀態(tài)欄。彈出時(shí)是否震動(dòng)或響鈴，可通過設(shè)置vibrate，sound等字段配合實(shí)現(xiàn)。
• 內(nèi)部字段：

{
    title:''                //標(biāo)題，Android中默認(rèn)值為應(yīng)用名稱，支持Android和iOS 8.2以上系統(tǒng)
    content:''              //內(nèi)容，默認(rèn)值為'有新消息'
    extra:''                //附加信息，頁面可以監(jiān)聽noticeclicked事件得到點(diǎn)擊的通知的附加信息
    updateCurrent: false    //是否覆蓋更新已有的通知，取值范圍true|false。只Android有效
}

alarm：

• 類型：JSON 對(duì)象
• 默認(rèn)值：無
• 描述：（可選項(xiàng)）設(shè)置鬧鈴。與notify配合使用，即如果設(shè)置了鬧鈴，那么對(duì)應(yīng)的notify將在設(shè)定的鬧鈴時(shí)間觸發(fā)
• 內(nèi)部字段：

{
    hour:           //小時(shí)，數(shù)字類型，取值范圍（0-23），默認(rèn)值為當(dāng)前系統(tǒng)時(shí)
    minutes:        //分鐘，數(shù)字類型，取值范圍（0-59），默認(rèn)值為當(dāng)前系統(tǒng)分
    daysOfWeek:     //通知循環(huán)時(shí)間，以周為單位，數(shù)組類型，取值范圍[1,2,3,4,5,6,7]，表示周日、周一、周二、周三、周四、周五、周六。若不傳則不循環(huán)，只在當(dāng)天或隔天的指定時(shí)間通知一次
    time:           //鬧鈴目標(biāo)時(shí)間，數(shù)字類型，1970年至今的毫秒數(shù)，只在設(shè)定的時(shí)間執(zhí)行一次，若設(shè)置了time，那么hour、minutes、daysOfWeek將被忽略
    openApp:        //當(dāng)鬧鈴觸發(fā)時(shí)是否打開當(dāng)前應(yīng)用，如果打開，則不彈出狀態(tài)欄通知，bool類型，默認(rèn)值為false。僅支持Android平臺(tái)。
}

callback(ret, err)

如果 notification 時(shí)傳入了 notify或者alarm，那么將收到 callback，返回本次狀態(tài)欄通知的 id或者鬧鈴 id，該 id 可用于取消狀態(tài)欄通知或者鬧鈴。

ret：

• 類型：JSON 對(duì)象
• 內(nèi)部字段：

{
    id:1        //彈出到狀態(tài)欄通知的id或者設(shè)置的鬧鈴id，可用于取消通知或者鬧鈴
}

示例代碼

//僅震動(dòng)
api.notification({
    vibrate:[100, 500, 200, 500, 300, 500, 400, 500]
});


//僅提示音
api.notification({
    sound:'default'
});


//提示音+震動(dòng)
api.notification();


//彈出狀態(tài)欄通知
api.notification({
    notify: {
    title: '通知標(biāo)題',
        content: '通知內(nèi)容'
    }
});


//鬧鈴
api.notification({
    notify: {
        content: '鬧鐘'
    },
    //每周一、二、三、四、五的7點(diǎn)30分鬧鈴
    alarm: {
        hour: 7,
        minutes: 30,
        daysOfWeek: [2, 3, 4, 5, 6]
    }
}, function(ret, err) {
    var id = ret.id;
});

可用性

iOS系統(tǒng)，Android系統(tǒng)

可提供的1.0.0及更高版本