calendarMemo

remindersAuth removeEvent getAllEvent

概述

calendarMemo 使用系统日历提供的接口，向系统日历中添加，删除，更新事件（比如：生日，开会，旅行等）， 当系统时间满足条件时，会触发相应的事件并提醒用户

remindersAuth

判断是否有访问提醒事项的权限

remindersAuth(callback(ret, err))

ret：

• 类型：JSON 对象
• 内部字段：

示例代码

privacy.remindersAuth(function(ret, err) {
    if (ret.status) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS 系统

可提供的 1.0.0 及更高版本

addEvent

添加事件

addEvent({params}, callback(ret))

params

• 类型：字符串
• 描述：事件的标题

description：

• 类型：字符串
• 描述：事件的描述

location：

• 类型：字符串
• 描述：（可选）地点

startTime：

• 类型：字符串
• 描述：开始时间
• 格式：2016-10-01 13:20:30

endTime:

• 类型：字符串
• 描述：结束时间
• 格式：2016-10-01 13:20:30

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    eventId: id             //字符类型；创建成功后返回的事件类型

示例代码

    var calendarMemo = api.require('calendarMemo');
    calendarMemo.addEvent({
        title: '标题',
        description: '描述',
        startTime: '2016-10-01 13:00:00',
        endTime: '2016-10-01 14:00:00'
    }, function(ret) {});

iOS系统，Android系统

可提供的1.0.0及更高版本

removeEvent

删除事件

removeEvent(callback(ret))

params

• 类型：字符串
• 描述：待删除事件的id

callback(ret)

• 类型：JSON 对象
• 内部字段：

{
    status: true             // 布尔类型；是否删除成功
}

示例代码

updateEvent

更新事件

params

eventId:

• 类型：字符串
• 描述：待更新事件的id

title：

• 类型：字符串
• 描述：事件的标题

description：

• 类型：字符串
• 描述：事件的描述

location：

• 类型：字符串
• 描述：（可选）地点

startTime：

• 类型：字符串
• 描述：开始时间
• 格式：2016-10-1 13:20:30

endTime:

• 类型：字符串
• 描述：结束时间
• 格式：2016-10-1 13:20:30

callback(ret)

• 类型：JSON 对象
• 内部字段：

{
    status: true             // 布尔类型；是否更新成功
}

    var calendarMemo = api.require('calendarMemo');
    calendarMemo.updateEvent({
        eventId:'',
        title:'标题1',
        startTime:'2016-10-01 13:00:00',
        endTime  :'2016-10-01 14:00:00'
    }, function(ret){
        if(ret.status){
            alert(JSON.stringify(ret));
        }
    });

getAllEvent

获取所有的事件

params

startTime:

• 类型：JSON 对象
• 描述：（可选项）搜索的起始时间
• 内部字段：

finishTime:

• 类型：JSON 对象
• 描述：（可选项）搜索的起始时间
• 内部字段：

    years:'2019' , //字符串类型；终止年份 ；默认：2018
    month:'12' , //字符串类型；终止月份 ；默认：01
    day:'01'   //字符串类型；终止日 ；默认：01
}

callback(ret)

• 类型：JSON 对象
• 内部字段：

{
    result:[
        {    
            eventId:'',
            title:'',
            description:'',
            startTime:'',
            endTime:'',
            location:''
        }
    ]
}

示例代码

    var calendarMemo = api.require('calendarMemo');
    calendarMemo.getAllEvent({
        startTime:{
            years: 2018,
           month: 09,
           day:02
        },
        finishTime:{
            years: 2019,
           month: 12,
           day:01
        }
    },function(ret) {
        if (ret) {
            alert(JSON.stringify(ret));
        }
    });

getEventById

通过id获取事件

params

eventId:

• 类型：字符串
• 描述：待更新事件的id

callback(ret)

• 类型：JSON 对象
• 内部字段：

    var calendarMemo = api.require('calendarMemo');
    calendarMemo.getEventById({
        eventId: ''
    }, function(ret) {
        if (ret) {
            alert(JSON.stringify(ret));
        }