harmony 鸿蒙@ohos.calendarManager (日程管理能力)

  • 2023-10-30
  • 浏览 (835)

@ohos.calendarManager (日程管理能力)

本模块提供日历与日程管理能力,包括日历和日程的创建、删除、修改、查询等。日历管理器CalendarManager用于管理日历Calendar。日历Calendar主要包含帐户信息CalendarAccount和配置信息CalendarConfig。日历Calendar与日程Event属于一对多关系,一个Calendar可以有多个Event,一个Event只属于一个Calendar。

说明:

本模块首批接口从API version 10开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

导入模块

import calendarManager from '@ohos.calendarManager';

calendarManager.getCalendarManager

getCalendarManager(context : Context): CalendarManager;

根据上下文获取CalendarManager对象,用于管理日历。

系统能力: SystemCapability.Applications.CalendarData

模型约束:此接口仅可在Stage模型下使用。

参数

参数名 类型 必填 说明
context Context 应用上下文Context,Stage模型的应用Context定义见Context

示例

  // 获取context
  // 以下代码中的class EntryAbility extends UIAbility,onWindowStageCreate在工程main/ets/entryability/EntryAbility.ets中,测试ohosTest/ets/testability/TestAbility.ets中有,可直接使用
  import UIAbility from '@ohos.app.ability.UIAbility';
  import common from '@ohos.app.ability.common';

  export let mContext : common.UIAbilityContext|null = null;
  class EntryAbility extends UIAbility {
    onWindowStageCreate(windowStage: window.WindowStage){
      mContext = this.context;
    }
  }
  let calendarMgr:calendarManager.CalendarManager = calendarManager.getCalendarManager(mContext as Context);

CalendarManager

下列API示例中需先通过getCalendarManager()方法获取CalendarManager对象,再通过此对象调用对应方法,进行Calendar的创建、删除、修改、查询等操作。

createCalendar

createCalendar(calendarAccount: CalendarAccount, callback: AsyncCallback<Calendar>): void

根据日历帐户信息,创建一个Calendar对象,使用callback异步回调。

需要权限: ohos.permission.WRITE_CALENDAR or ohos.permission.WRITE_WHOLE_CALENDAR

系统能力: SystemCapability.Applications.CalendarData

参数

参数名 类型 必填 说明
calendarAccount CalendarAccount 日历帐户信息。
callback AsyncCallback<Calendar> 回调函数,返回创建的Calendar对象。

示例

import { BusinessError } from '@ohos.base';

let calendar : calendarManager.Calendar|undefined = undefined;
const calendarAccount: calendarManager.CalendarAccount = {
  name: 'MyCalendar',
  type: calendarManager.CalendarType.LOCAL
};
try {
  calendarMgr.createCalendar(calendarAccount, (err: BusinessError, data: calendarManager.Calendar) => {
    if (err) {
      console.error(`Failed to create calendar: err->${JSON.stringify(err)}`);
    } else {
      console.info(`Succeeded in creating calendar data->${JSON.stringify(data)}`);
      calendar = data;
    }
  });
} catch (error) {
  console.error(`Failed to create calendar: err->${JSON.stringify(error)}`);
}

createCalendar

createCalendar(calendarAccount: CalendarAccount): Promise<Calendar>

根据日历帐户信息,创建一个Calendar对象,使用Promise异步回调。

需要权限: ohos.permission.WRITE_CALENDAR or ohos.permission.WRITE_WHOLE_CALENDAR

系统能力: SystemCapability.Applications.CalendarData

参数

参数名 类型 必填 说明
calendarAccount CalendarAccount 日历帐户信息。

返回值

类型 说明
Promise<Calendar> Promise对象,返回创建的Calendar对象。

示例

import { BusinessError } from '@ohos.base';

let calendar : calendarManager.Calendar|undefined = undefined;
const calendarAccount: calendarManager.CalendarAccount = {
  name: 'MyCalendar',
  type: calendarManager.CalendarType.LOCAL,
  displayName : 'MyApplication'
};
calendarMgr.createCalendar(calendarAccount).then((data: calendarManager.Calendar) => {
  console.info(`Succeeded in creating calendar data->${JSON.stringify(data)}`);
  calendar = data;
}).catch((error : BusinessError) => {
  console.error(`Failed to create calendar: err->${JSON.stringify(error)}`);
});

deleteCalendar

deleteCalendar(calendar: Calendar, callback: AsyncCallback<void>): void

删除指定Calendar对象,使用callback异步回调。

需要权限: ohos.permission.WRITE_CALENDAR or ohos.permission.WRITE_WHOLE_CALENDAR

系统能力: SystemCapability.Applications.CalendarData

参数

参数名 类型 必填 说明
calendar Calendar Calendar对象。
callback AsyncCallback<void> 回调函数。

示例

import { BusinessError } from '@ohos.base';

const calendarAccount: calendarManager.CalendarAccount = {
  name: 'MyCalendar',
  type: calendarManager.CalendarType.LOCAL
};
calendarMgr.getCalendar(calendarAccount, (err: BusinessError, data: calendarManager.Calendar) => {
  if (err) {
    console.error(`Failed to get calendar: err->${JSON.stringify(err)}`);
  } else {
    console.info("Succeeded in getting calendar");
    calendarMgr.deleteCalendar(data, (err: BusinessError) => {
      if (err) {
        console.error(`Failed to delete calendar: err->${JSON.stringify(err)}`);
      } else {
        console.info("Succeeded in deleting calendar");
      }
    });
  }
});

deleteCalendar

deleteCalendar(calendar: Calendar): Promise<void>

删除指定Calendar对象,使用Promise异步回调。

需要权限: ohos.permission.WRITE_CALENDAR or ohos.permission.WRITE_WHOLE_CALENDAR

系统能力: SystemCapability.Applications.CalendarData

参数

参数名 类型 必填 说明
calendar Calendar Calendar对象。

返回值

类型 说明
Promise<void> 无返回结果的Promise对象。

示例

import { BusinessError } from '@ohos.base';

const calendarAccount: calendarManager.CalendarAccount = {
  name: 'MyCalendar',
  type: calendarManager.CalendarType.LOCAL
};
calendarMgr.getCalendar(calendarAccount).then((data: calendarManager.Calendar) => {
  console.info("Succeeded in getting calendar");
  calendarMgr.deleteCalendar(data).then(() => {
    console.info("Succeeded in deleting calendar");
  }).catch((err: BusinessError) => {
    console.error(`Failed to delete calendar: err->${JSON.stringify(err)}`);
  });
}).catch((err: BusinessError) => {
  console.error(`Failed to get calendar: err->${JSON.stringify(err)}`);
});

getCalendar

getCalendar(callback: AsyncCallback<Calendar>): void

获取默认Calendar对象,默认Calendar是日历存储首次运行时创建的,若创建Event时不关注其Calendar归属,则无须通过createCalendar()创建Calendar,直接使用默认Calendar,使用callback异步回调。

需要权限:ohos.permission.READ_CALENDAR or ohos.permission.READ_WHOLE_CALENDAR

系统能力: SystemCapability.Applications.CalendarData

参数

参数名 类型 必填 说明
callback AsyncCallback<Calendar> 回调函数,返回查询到的Calendar对象。

示例

import { BusinessError } from '@ohos.base';

let calendar : calendarManager.Calendar|undefined = undefined;
calendarMgr.getCalendar((err: BusinessError, data:calendarManager.Calendar) => {
  if (err) {
    console.error(`Failed to get calendar: err->${JSON.stringify(err)}`);
  } else {
    console.info(`Succeeded in getting calendar data->${JSON.stringify(data)}`);
    calendar = data;
  }
});

getCalendar

getCalendar(calendarAccount: CalendarAccount, callback: AsyncCallback<Calendar>): void

获取指定Calendar对象,使用callback异步回调。

需要权限: ohos.permission.READ_CALENDAR or ohos.permission.READ_WHOLE_CALENDAR

系统能力: SystemCapability.Applications.CalendarData

参数

参数名 类型 必填 说明
calendarAccount CalendarAccount 日历帐户信息。
callback AsyncCallback<Calendar> 回调函数,返回查询到的Calendar对象。

示例

import { BusinessError } from '@ohos.base';

let calendar : calendarManager.Calendar|undefined = undefined;
const calendarAccount: calendarManager.CalendarAccount = {
  name: 'MyCalendar',
  type: calendarManager.CalendarType.LOCAL
};
calendarMgr.getCalendar(calendarAccount, (err: BusinessError, data: calendarManager.Calendar) => {
  if (err) {
    console.error(`Failed to get calendar: err->${JSON.stringify(err)}`);
  } else {
    console.info(`Succeeded in getting calendar data->${JSON.stringify(data)}`);
    calendar = data;
  }
});

getCalendar

getCalendar(calendarAccount?: CalendarAccount): Promise<Calendar>

获取默认Calendar对象或者指定Calendar对象,使用Promise异步回调。

需要权限: ohos.permission.READ_CALENDAR or ohos.permission.READ_WHOLE_CALENDAR

系统能力: SystemCapability.Applications.CalendarData

参数

参数名 类型 必填 说明
calendarAccount CalendarAccount 日历帐户信息,用来获取指定Calendar对象,不填时,表示获取默认Calendar对象。

返回值

类型 说明
Promise<Calendar> Promise对象,返回查询到的Calendar对象。

示例

import { BusinessError } from '@ohos.base';

let calendar : calendarManager.Calendar|undefined = undefined;
calendarMgr.getCalendar().then((data: calendarManager.Calendar) => {
  console.info(`Succeeded in getting calendar data->${JSON.stringify(data)}`);
  calendar = data;
}).catch((err: BusinessError) => {
  console.error(`Failed to get calendar: err->${JSON.stringify(err)}`);
});

getAllCalendars

getAllCalendars(callback: AsyncCallback<Calendar[]>): void

获取当前应用所有创建的Calendar对象以及默认Calendar对象,使用callback异步回调。

需要权限:ohos.permission.READ_CALENDAR or ohos.permission.READ_WHOLE_CALENDAR

系统能力: SystemCapability.Applications.CalendarData

参数

参数名 类型 必填 说明
callback AsyncCallback<Calendar[]> 回调函数, 返回查询到的Calendar对象数组。

示例

import { BusinessError } from '@ohos.base';

calendarMgr.getAllCalendars((err: BusinessError, data: calendarManager.Calendar[]) => {
  if (err) {
    console.error(`Failed to get all calendars: err->${JSON.stringify(err)}`);
  } else {
    console.info(`Succeeded in getting all calendars->${JSON.stringify(data)}`);
    data.forEach((calendar) => {
      const account = calendar.getAccount();
      console.info(`account->${JSON.stringify(account)}`);
    })
  }
});

getAllCalendars

getAllCalendars(): Promise<Calendar[]>

获取当前应用所有创建的Calendar对象以及默认Calendar对象,使用Promise异步回调。

需要权限: ohos.permission.READ_CALENDAR or ohos.permission.WRITE_WHOLE_CALENDAR

系统能力: SystemCapability.Applications.CalendarData

返回值

类型 说明
Promise<Calendar[]> Promise对象,返回查询到的Calendar对象数组。

示例

import { BusinessError } from '@ohos.base';

calendarMgr.getAllCalendars().then((data: calendarManager.Calendar[]) => {
  console.info(`Succeeded in getting all calendars->${JSON.stringify(data)}`);
  data.forEach((calendar) => {
    const account = calendar.getAccount();
    console.info(`account->${JSON.stringify(account)}`);
  })
}).catch((err: BusinessError) => {
  console.error(`Failed to get all calendars: err->${JSON.stringify(err)}`);
});

Calendar

下列API示例中需先通过createCalendar()getCalendar()中任一方法获取Calendar对象,再通过此对象调用对应方法,对该Calendar下的日程进行创建、删除、修改、查询等操作。

属性

系统能力:SystemCapability.Applications.CalendarData

名称 类型 只读 必填 说明
id number 帐户id。

addEvent

addEvent(event: Event, callback: AsyncCallback<number>): void

创建日程,入参Event不填日程id,使用callback异步回调。

系统能力: SystemCapability.Applications.CalendarData

参数

参数名 类型 必填 说明
event Event Event对象。
callback AsyncCallback<number> 回调函数,返回日程id。

示例

import { BusinessError } from '@ohos.base';

const date = new Date();
const event: calendarManager.Event = {
  type: calendarManager.EventType.NORMAL,
  startTime: date.getTime(),
  endTime: date.getTime() + 60 * 60 * 1000
};
calendar.addEvent(event, (err: BusinessError, data: number): void => {
  if (err) {
    console.error(`Failed to addEvent: err->${JSON.stringify(err)}`);
  } else {
    console.info(`Succeeded in adding event id:${data}`);
  }
});

addEvent

addEvent(event: Event): Promise<number>

创建日程,入参Event不填日程id,使用Promise异步回调。

系统能力: SystemCapability.Applications.CalendarData

参数

参数名 类型 必填 说明
event Event Event对象。

返回值

类型 说明
Promise<number> Promise对象,返回日程的id。

示例

import { BusinessError } from '@ohos.base';

const date = new Date();
const event: calendarManager.Event = {
  type: calendarManager.EventType.NORMAL,
  startTime: date.getTime(),
  endTime: date.getTime() + 60 * 60 * 1000
};
calendar.addEvent(event).then((data: number) => {
  console.info(`Succeeded in adding event id:${data}`);
}).catch((err: BusinessError) => {
  console.error(`Failed to addEvent: err->${JSON.stringify(err)}`);
});

addEvents

addEvents(events: Event[], callback: AsyncCallback<void>): void

批量创建日程,入参Event不填日程id,使用callback异步回调。

系统能力: SystemCapability.Applications.CalendarData

参数

参数名 类型 必填 说明
events Event[] Event对象数组。
callback AsyncCallback<void> 回调函数。

示例

import { BusinessError } from '@ohos.base';

const date = new Date();
const events: calendarManager.Event[] = [
  {
    type: calendarManager.EventType.NORMAL,
    startTime: date.getTime(),
    endTime: date.getTime() + 60 * 60 * 1000
  },
  {
    type: calendarManager.EventType.NORMAL,
    startTime: date.getTime(),
    endTime: date.getTime() + 60 * 60 * 1000
  }
];
calendar.addEvents(events, (err: BusinessError) => {
  if (err) {
    console.error(`Failed to addEvent: err->${JSON.stringify(err)}`);
  } else {
    console.info("Succeeded in adding events");
  }
});

addEvents

addEvents(events: Event[]): Promise<void>

批量创建日程,入参Event不填日程id,使用Promise异步回调。

系统能力: SystemCapability.Applications.CalendarData

参数

参数名 类型 必填 说明
events Event[] Event对象数组。

返回值

类型 说明
Promise<void> 无返回结果的Promise对象。

示例

import { BusinessError } from '@ohos.base';

const date = new Date();
const events: calendarManager.Event[] = [
  {
    type: calendarManager.EventType.NORMAL,
    startTime: date.getTime(),
    endTime: date.getTime() + 60 * 60 * 1000
  },
  {
    type: calendarManager.EventType.NORMAL,
    startTime: date.getTime(),
    endTime: date.getTime() + 60 * 60 * 1000
  }
];
calendar.addEvents(events).then(() => {
  console.info("Succeeded in adding events");
}).catch((err: BusinessError) => {
  console.error(`Failed to addEvent: err->${JSON.stringify(err)}`);
});

deleteEvent

deleteEvent(id: number, callback: AsyncCallback<void>): void

删除指定id的日程,使用callback异步回调。

系统能力: SystemCapability.Applications.CalendarData

参数

参数名 类型 必填 说明
id number 日程id。
callback AsyncCallback<void> 回调函数。

示例

import { BusinessError } from '@ohos.base';

calendar.deleteEvent(1, (err: BusinessError) => {
  if (err) {
    console.error("Failed to delete event");
  } else {
    console.info("Succeeded in deleting event");
  }
});

deleteEvent

deleteEvent(id: number): Promise<void>

删除指定id的日程,使用Promise异步回调。

系统能力: SystemCapability.Applications.CalendarData

参数

参数名 类型 必填 说明
id number 日程id。

返回值

类型 说明
Promise<void> 无返回结果的Promise对象。

示例

import { BusinessError } from '@ohos.base';

calendar.deleteEvent(1).then(() => {
  console.info("Succeeded in deleting event");
}).catch((err: BusinessError) => {
  console.error("Failed to delete event");
});

deleteEvents

deleteEvents(ids: number[], callback: AsyncCallback<void>): void

根据日程id,批量删除日程,使用callback异步回调。

系统能力: SystemCapability.Applications.CalendarData

参数

参数名 类型 必填 说明
ids number[] 日程id数组。
callback AsyncCallback<void> 回调函数。

示例

import { BusinessError } from '@ohos.base';

calendar.deleteEvents([1, 2], (err: BusinessError) => {
  if (err) {
    console.error("Failed to delete events");
  } else {
    console.info("Succeeded in deleting events");
  }
});

deleteEvents

deleteEvents(ids: number[]): Promise<void>

根据日程id,批量删除日程,使用Promise异步回调。

系统能力: SystemCapability.Applications.CalendarData

参数

参数名 类型 必填 说明
ids number[] 日程id数组。

返回值

类型 说明
Promise<void> 无返回结果的Promise对象。

示例

import { BusinessError } from '@ohos.base';

calendar.deleteEvents([1, 2]).then(() => {
  console.info("Succeeded in deleting events");
}).catch((err: BusinessError) => {
  console.error("Failed to delete events");
});

updateEvent

updateEvent(event: Event, callback: AsyncCallback<void>): void

更新日程,使用callback异步回调。

系统能力: SystemCapability.Applications.CalendarData

参数

参数名 类型 必填 说明
event Event Event对象。
callback AsyncCallback<void> 回调函数。

示例

import { BusinessError } from '@ohos.base';

const date = new Date();
const oriEvent: calendarManager.Event = {
  title: 'update',
  type: calendarManager.EventType.NORMAL,
  description: 'updateEventTest',
  startTime: date.getTime(),
  endTime: date.getTime() + 60 * 60 * 1000
};
calendar.addEvent(oriEvent, (err: BusinessError, data: number): void => {
  if (err) {
    console.error(`Failed to addEvent: err->${JSON.stringify(err)}`);
  } else {
    console.info(`Succeeded in adding event id:${data}`);
    oriEvent.id = data; // must set id
    oriEvent.title = 'newUpdate';
    calendar.updateEvent(oriEvent, (err: BusinessError) => {
      if (err) {
        console.error(`Failed to updateEvent: err->${JSON.stringify(err)}`);
      } else {
        console.info("Succeeded in updating event");
      }
    });
  }
});

updateEvent

updateEvent(event: Event): Promise<void>

更新日程,使用Promise异步回调。

系统能力: SystemCapability.Applications.CalendarData

参数

参数名 类型 必填 说明
event Event Event对象。

返回值

类型 说明
Promise<void> 无返回结果的Promise对象。

示例

import { BusinessError } from '@ohos.base';

const filter = calendarManager.EventFilter.filterByTitle('update');
calendar.getEvents(filter).then((events : calendarManager.Event[]) => {
  console.info(`Succeeded in getEvents`);
  if (events.length < 1) {
    return;
  }
  let newEvent = events[0];
  newEvent.title = 'newUpdate';
  calendar.updateEvent(newEvent).then(() => {
    console.info(`Succeeded in updateEvent`);
  }).catch((err: BusinessError) => {
    console.error(`Failed to updateEvent err->${JSON.stringify(err)}`);
  });
}).catch((err: BusinessError) => {
  console.error(`Failed to getEvents err->${JSON.stringify(err)}`);
});

getEvents

getEvents(callback: AsyncCallback<Event[]>): void

查询Calendar下所有Event,使用callback异步回调。

系统能力: SystemCapability.Applications.CalendarData

参数

参数名 类型 必填 说明
callback AsyncCallback<Event[]> 回调函数,返回的是Event对象数组。

示例

import { BusinessError } from '@ohos.base';

calendar.getEvents((err: BusinessError, data: calendarManager.Event[]) => {
  if (err) {
    console.error("Failed to get events");
  } else {
    console.info("Succeeded in getting events");
  }
});

getEvents

getEvents(eventFilter: EventFilter, eventKey: (keyof Event)[], callback: AsyncCallback<Event[]>):void

获取Calendar下符合查询条件的Event,使用callback异步回调。

系统能力: SystemCapability.Applications.CalendarData

参数

参数名 类型 必填 说明
eventFilter EventFilter 查询条件。
eventKey (keyof Event)[] 查询字段。
callback AsyncCallback<Event[]> 回调函数,返回的是Event对象数组。

示例

import { BusinessError } from '@ohos.base';

const filter = calendarManager.EventFilter.filterById([1, 2]);
calendar.getEvents(filter, ['title', 'type', 'startTime', 'endTime'], (err: BusinessError, data: calendarManager.Event[]) => {
  if (err) {
    console.error("Failed to get events");
  } else {
    console.info("Succeeded in getting events");
  }
});

getEvents

getEvents(eventFilter?: EventFilter, eventKey?: (keyof Event)[]): Promise<Event[]>

获取Calendar下符合查询条件的Event,使用Promise异步回调。

系统能力: SystemCapability.Applications.CalendarData

参数

参数名 类型 必填 说明
eventFilter EventFilter 查询条件。
eventKey (keyof Event)[] 查询字段。

返回值

类型 说明
Promise<Event[]> Promise对象,返回日程配置信息数组。

示例

import { BusinessError } from '@ohos.base';

const filter = calendarManager.EventFilter.filterByTitle('MyEvent');
calendar.getEvents(filter).then((data: calendarManager.Event[]) => {
  console.info("Succeeded in getting events");
}).catch((err: BusinessError) => {
  console.error("Failed to get events");
});

getConfig

getConfig(): CalendarConfig

获取日历配置信息。

系统能力: SystemCapability.Applications.CalendarData

返回值

类型 说明
CalendarConfig 日历配置信息。

示例

const config = calendar.getConfig();
console.info("get config success");

setConfig

setConfig(config: CalendarConfig, callback: AsyncCallback<void>): void

设置日历配置信息,使用callback异步回调。

系统能力: SystemCapability.Applications.CalendarData

参数

参数名 类型 必填 说明
config CalendarConfig 日历配置信息。
callback AsyncCallback<void> 回调函数。

示例

import { BusinessError } from '@ohos.base';

const config: calendarManager.CalendarConfig = {
  enableReminder: true
};
calendar.setConfig(config, (err: BusinessError) => {
  if (err) {
    console.error("Failed to set config");
  } else {
    console.info("Succeeded in setting config");
  }
});

setConfig

setConfig(config: CalendarConfig): Promise<void>

设置日历配置信息,使用Promise异步回调。

系统能力: SystemCapability.Applications.CalendarData

参数

参数名 类型 必填 说明
config CalendarConfig 日历配置信息。

返回值

类型 说明
Promise<void> 无返回结果的Promise对象。

示例

import { BusinessError } from '@ohos.base';

const config: calendarManager.CalendarConfig = {
  enableReminder: true
};
calendar.setConfig(config).then(() => {
  console.info("Succeeded in setting config");
}).catch((err: BusinessError) => {
  console.error("Failed to set config");
});

getAccount

getAccount(): CalendarAccount

获取日历账户信息。

系统能力: SystemCapability.Applications.CalendarData

返回值

类型 说明
CalendarAccount 日历帐户信息。

示例

const account = calendar.getAccount();
console.info("get account success");

CalendarAccount

日历帐户信息。

系统能力:SystemCapability.Applications.CalendarData

名称 类型 只读 必填 说明
name string 帐户名称。
type CalendarType 帐户类型。
displayName string 帐户的显示名称。不填时,默认为空字符串。

CalendarConfig

日历配置信息。

系统能力:SystemCapability.Applications.CalendarData

名称 类型 只读 必填 说明
enableReminder boolean 是否打开Calendar下所有Event提醒能力。当取值为true时,该Calendar下所有Event具备提醒能力;当取值为false时,不具备提醒能力,默认具备提醒能力。
color ResourceColor 设置Calendar颜色。不填时,默认值为’#0A59F7’。

Event

日程对象,包含日程标题、开始时间、结束时间等信息。

系统能力:SystemCapability.Applications.CalendarData

名称 类型 只读 必填 说明
id number 日程id。当调用addEvent()addEvents()创建日程时,不填写此参数。
type EventType 日程类型。
title string 日程标题。不填时,默认为空字符串。
location Location 日程地点。不填时,默认为null。
startTime number 日程开始时间。
endTime number 日程结束时间。
isAllDay boolean 是否为全天日程。当取值为true时,说明为全天日程;当取值为false时,说明不是全天日程,默认为非全天日程。
attendee Attendee[] 日程参与者。不填时,默认为null。
timeZone string 日程时区。不填时,默认为当前所在时区,当需要创建与当前不一样的时区时,可填入对应的时区。可通过getTimeZone()获取当前系统时区。
reminderTime number[] 日程提醒时间。不填时,默认为不提醒。
recurrenceRule RecurrenceRule 日程重复规则。不填时,默认为不重复。
description string 日程描述。不填时,默认为空字符串。
service EventService 日程服务。不填时,默认没有一键服务。

CalendarType

帐户类型枚举。

系统能力:SystemCapability.Applications.CalendarData

名称 说明
LOCAL ‘local’ 本地帐户。
EMAIL ‘email’ 邮箱帐户。
BIRTHDAY ‘birthday’ 生日帐户。
CALDAV ‘caldav’ 支持CalDAV协议帐户。
SUBSCRIBED ‘subscribed’ 订阅帐户。

Location

日程地点。

系统能力:SystemCapability.Applications.CalendarData

名称 类型 只读 必填 说明
location string 地点位置。默认为空字符串。
longitude number 地点经度。默认为0。
latitude number 地点纬度。默认为0。

EventFilter

日程过滤器,查询日程时进行筛选过滤,获取符合条件的日程。

通过filterById()filterByTime()filterByTitle()任一方法获取日程过滤器,传入getEvents()过滤。

filterById

static filterById(ids: number[]): EventFilter

根据日程id过滤日程。

系统能力: SystemCapability.Applications.CalendarData

参数

参数名 类型 必填 说明
ids number[] 日程id数组。

返回值

类型 说明
EventFilter 返回日程过滤器对象。

示例

import { BusinessError } from '@ohos.base';

const filter = calendarManager.EventFilter.filterById([1, 2]);
calendar.getEvents(filter).then((data: calendarManager.Event[]) => {
  console.info("Succeeded in filtering by id");
}).catch((err: BusinessError) => {
  console.error("Failed to filter by id");
});

filterByTime

static filterByTime(start: number, end: number): EventFilter

根据日程时间过滤日程。

系统能力: SystemCapability.Applications.CalendarData

参数

参数名 类型 必填 说明
start number 开始时间。
end number 结束时间。

返回值

类型 说明
EventFilter 返回日程过滤器对象。

示例

import { BusinessError } from '@ohos.base';

const filter = calendarManager.EventFilter.filterByTime(1686931200000, 1687017600000);
calendar.getEvents(filter).then((data: calendarManager.Event[]) => {
  console.info("Succeeded in filtering by time");
}).catch((err: BusinessError) => {
  console.error("Failed to filter by time");
});

filterByTitle

static filterByTitle(title: string): EventFilter

根据日程标题过滤日程。

系统能力: SystemCapability.Applications.CalendarData

参数

参数名 类型 必填 说明
title string 日程标题。

返回值

类型 说明
EventFilter 返回日程过滤器对象。

示例

import { BusinessError } from '@ohos.base';

const filter = calendarManager.EventFilter.filterByTitle('MyEvent');
calendar.getEvents(filter).then((data: calendarManager.Event[]) => {
  console.info("Succeeded in filtering by title");
}).catch((err: BusinessError) => {
  console.error("Failed to filter by title");
});

EventType

日程类型枚举。

系统能力:SystemCapability.Applications.CalendarData

名称 说明
NORMAL 0 普通日程。
IMPORTANT 1 重要日程。支持倒计时。

RecurrenceRule

日程重复规则。

系统能力:SystemCapability.Applications.CalendarData

名称 类型 只读 必填 说明
recurrenceFrequency RecurrenceFrequency 日程重复规则类型。
expire number 重复周期截止日。不填时,默认为0。

RecurrenceFrequency

日程重复规则类型枚举。

系统能力:SystemCapability.Applications.CalendarData

名称 说明
YEARLY 0 每年重复。
MONTHLY 1 每月重复。
WEEKLY 2 每周重复。
DAILY 3 每天重复。

Attendee

日程参与者。

系统能力:SystemCapability.Applications.CalendarData

名称 类型 只读 必填 说明
name string 参与者的姓名。
email string 参与者的邮箱。

EventService

日程服务。

系统能力:SystemCapability.Applications.CalendarData

名称 类型 只读 必填 说明
type ServiceType 服务类型。
uri string 服务的uri。可以跳转到三方应用相应界面。
description string 服务辅助描述。不填时,默认为空字符串。

ServiceType

日程服务类型枚举。

系统能力:SystemCapability.Applications.CalendarData

名称 说明
MEETING ‘Meeting’ 一键入会。
WATCHING ‘Watching’ 一键追剧。
REPAYMENT ‘Repayment’ 一键还款。
LIVE ‘Live’ 一键直播。
SHOPPING ‘Shopping’ 一键购物。
TRIP ‘Trip’ 一键查看。
CLASS ‘Class’ 一键上课。
SPORTS_EVENTS ‘SportsEvents’ 一键看赛事。
SPORTS_EXERCISE ‘SportsExercise’ 一键运动。

你可能感兴趣的鸿蒙文章

harmony 鸿蒙接口

harmony 鸿蒙系统公共事件定义(待停用)

harmony 鸿蒙系统公共事件定义

harmony 鸿蒙开发说明

harmony 鸿蒙企业设备管理概述(仅对系统应用开放)

harmony 鸿蒙BundleStatusCallback

harmony 鸿蒙@ohos.bundle.innerBundleManager (innerBundleManager模块)

harmony 鸿蒙@ohos.distributedBundle (分布式包管理)

harmony 鸿蒙@ohos.bundle (Bundle模块)

harmony 鸿蒙@ohos.enterprise.EnterpriseAdminExtensionAbility (企业设备管理扩展能力)

0  赞