calendarMemo

来自于:官方立即使用

概述

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

remindersAuth

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

remindersAuth(callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true,    //布尔型;是否有访问该功能权限;true(有权限)||false (无权限)
    details: ''      //字符串类型;权限详情,取值范围如下:
                     //notDetermined: 用户从未选择过权限
                     //restricted:无法访问手机提醒,该状态用户无法改变
                     //denied:户拒绝该应用访问手机提醒,或是访问手机提醒服务总开关处于关闭状态
                     //authorized:用户允许该程序可以访问手机提醒
}

示例代码

var privacy = api.require('calendarMemo');
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

title:

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

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

eventId:

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

callback(ret)

  • 类型:JSON 对象
  • 内部字段:
{
    status: true             // 布尔类型;是否删除成功
}

示例代码

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

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',
        description:'描述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

获取所有的事件

callback(ret)

  • 类型:JSON 对象
  • 内部字段:
{
    result:[
        {    
            eventId:'',
            title:'',
            description:'',
            startTime:'',
            endTime:'',
            location:''
        }
    ]
}

示例代码

    var calendarMemo = api.require('calendarMemo');
    calendarMemo.getAllEvent(function(ret) {
        if (ret) {
            alert(JSON.stringify(ret));
        }
    });

getEventById

通过id获取事件

params

eventId:

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

callback(ret)

  • 类型:JSON 对象
  • 内部字段:
{
    event:{    

            eventId:'',     // 字符串; 事件ID
            title:'',       // 字符串; 事件的标题
            description:'', // 字符串; 事件的描述
            startTime:'',   // 字符串; 事件的开始时间
            endTime:'',     // 字符串; 事件的结束时间
            location:''     // 字符串; 事件的位置

        }
}

示例代码

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