@ohos.calendarManager (Calendar Manager)

The calendarManager module provides APIs for calendar and event management, including those for creating, deleting, modifying, and querying calendars and events. A CalendarManager object is used to manage Calendar objects. A Calendar object contains the account information CalendarAccount and configuration information CalendarConfig. Calendars and events are in the one-to-many relationship. That is, a calendar can have multiple events, but an event belongs to only one calendar.

NOTE

The initial APIs of this module are supported since API version 10. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

import calendarManager from '@ohos.calendarManager';

calendarManager.getCalendarManager

getCalendarManager(context : Context): CalendarManager

Obtains a CalendarManager object based on the context.

System capability: SystemCapability.Applications.CalendarData

Model restriction: This API can be used only in the stage model.

Parameters

Return value

Example

// Obtain an mContext object.
// Obtain a calendarMgr object.
// The file is auto-generated: entry/src/main/ets/entryability/EntryAbility.ets
import AbilityConstant from '@ohos.app.ability.AbilityConstant';
import hilog from '@ohos.hilog';
import UIAbility from '@ohos.app.ability.UIAbility';
import Want from '@ohos.app.ability.Want';
import window from '@ohos.window';
import calendarManager from '@ohos.calendarManager';
import common from '@ohos.app.ability.common';
import abilityAccessCtrl, { PermissionRequestResult, Permissions } from '@ohos.abilityAccessCtrl';
import { BusinessError } from '@ohos.base';

export let calendarMgr: calendarManager.CalendarManager | null = null;
export let mContext: common.UIAbilityContext | null = null;
export default class EntryAbility extends UIAbility {
  onCreate(want: Want, launchParam: AbilityConstant.LaunchParam): void {
    hilog.info(0x0000, 'testTag', '%{public}s', 'Ability onCreate');
  }

  onDestroy(): void {
    hilog.info(0x0000, 'testTag', '%{public}s', 'Ability onDestroy');
  }

  onWindowStageCreate(windowStage: window.WindowStage): void {
    // Main window is created, set main page for this ability
    hilog.info(0x0000, 'testTag', '%{public}s', 'Ability onWindowStageCreate');

    windowStage.loadContent('pages/Index', (err, data) => {
      if (err.code) {
        hilog.error(0x0000, 'testTag', 'Failed to load the content. Cause: %{public}s', JSON.stringify(err) ?? '');
        return;
      }
      hilog.info(0x0000, 'testTag', 'Succeeded in loading the content. Data: %{public}s', JSON.stringify(data) ?? '');
    });
    mContext = this.context;
    const permissions: Permissions[] = ['ohos.permission.READ_CALENDAR', 'ohos.permission.WRITE_CALENDAR'];
    let atManager = abilityAccessCtrl.createAtManager();
    atManager.requestPermissionsFromUser(mContext, permissions).then((result: PermissionRequestResult) => {
      console.log(`get Permission success, result: ${JSON.stringify(result)}`);
      calendarMgr = calendarManager.getCalendarManager(mContext);
    }).catch((error: BusinessError) => {
      console.error(`get Permission error, error: ${JSON.stringify(error)}`);
    })
  }

  onWindowStageDestroy(): void {
    // Main window is destroyed, release UI related resources
    hilog.info(0x0000, 'testTag', '%{public}s', 'Ability onWindowStageDestroy');
  }

  onForeground(): void {
    // Ability has brought to foreground
    hilog.info(0x0000, 'testTag', '%{public}s', 'Ability onForeground');
  }

  onBackground(): void {
    // Ability has back to background
    hilog.info(0x0000, 'testTag', '%{public}s', 'Ability onBackground');
  }
}

CalendarManager

Before calling any of the following APIs, you must use getCalendarManager() to obtain a CalendarManager object.

createCalendar

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

Creates a Calendar object based on the calendar account information. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.WRITE_CALENDAR or ohos.permission.WRITE_WHOLE_CALENDAR

System capability: SystemCapability.Applications.CalendarData

Parameters

Example

import { BusinessError } from '@ohos.base';
import { calendarMgr } from '../entryability/EntryAbility';
import calendarManager from '@ohos.calendarManager';

let calendar: calendarManager.Calendar | undefined = undefined;
const calendarAccount: calendarManager.CalendarAccount = {
  name: 'CreateMyCalendarByCallBack',
  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 the 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>

Creates a Calendar object based on the calendar account information. This API uses a promise to return the result.

Required permissions: ohos.permission.WRITE_CALENDAR or ohos.permission.WRITE_WHOLE_CALENDAR

System capability: SystemCapability.Applications.CalendarData

Parameters

Return value

Example

import { BusinessError } from '@ohos.base';
import { calendarMgr } from '../entryability/EntryAbility';
import calendarManager from '@ohos.calendarManager';

let calendar : calendarManager.Calendar | undefined = undefined;
const calendarAccount: calendarManager.CalendarAccount = {
  name: 'CreateMyCalendarByPromise',
  type: calendarManager.CalendarType.LOCAL,
  displayName : 'MyApplication'
};
calendarMgr?.createCalendar(calendarAccount).then((data: calendarManager.Calendar) => {
  console.info(`Succeeded in creating the 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

Deletes a specified Calendar object. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.WRITE_CALENDAR or ohos.permission.WRITE_WHOLE_CALENDAR

System capability: SystemCapability.Applications.CalendarData

Parameters

Example

import { BusinessError } from '@ohos.base';
import { calendarMgr } from '../entryability/EntryAbility';
import calendarManager from '@ohos.calendarManager';

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

deleteCalendar

deleteCalendar(calendar: Calendar): Promise<void>

Deletes a specified Calendar object. This API uses a promise to return the result.

Required permissions: ohos.permission.WRITE_CALENDAR or ohos.permission.WRITE_WHOLE_CALENDAR

System capability: SystemCapability.Applications.CalendarData

Parameters

Return value

Example

import { BusinessError } from '@ohos.base';
import { calendarMgr } from '../entryability/EntryAbility';
import calendarManager from '@ohos.calendarManager';

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

getCalendar

getCalendar(callback: AsyncCallback<Calendar>): void

Obtains the default Calendar object, which is created when the data storage runs for the first time. This API uses an asynchronous callback to return the result. You can call this API instead of createCalendar() to use the default calendar for a new event.

Required permissions: ohos.permission.READ_CALENDAR or ohos.permission.READ_WHOLE_CALENDAR

System capability: SystemCapability.Applications.CalendarData

Parameters

Example

import { BusinessError } from '@ohos.base';
import { calendarMgr } from '../entryability/EntryAbility';
import calendarManager from '@ohos.calendarManager';

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

getCalendar

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

Obtains a specified Calendar object. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.READ_CALENDAR or ohos.permission.READ_WHOLE_CALENDAR

System capability: SystemCapability.Applications.CalendarData

Parameters

Example

import { BusinessError } from '@ohos.base';
import { calendarMgr } from '../entryability/EntryAbility';
import calendarManager from '@ohos.calendarManager';

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

getCalendar

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

Obtains the default Calendar object or a specified Calendar object. This API uses a promise to return the result.

Required permissions: ohos.permission.READ_CALENDAR or ohos.permission.READ_WHOLE_CALENDAR

System capability: SystemCapability.Applications.CalendarData

Parameters

Return value

Example

import { BusinessError } from '@ohos.base';
import { calendarMgr } from '../entryability/EntryAbility';
import calendarManager from '@ohos.calendarManager';

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

getAllCalendars

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

Obtains the created and default Calendar objects of the current application. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.READ_CALENDAR or ohos.permission.READ_WHOLE_CALENDAR

System capability: SystemCapability.Applications.CalendarData

Parameters

Example

import { BusinessError } from '@ohos.base';
import { calendarMgr } from '../entryability/EntryAbility';
import calendarManager from '@ohos.calendarManager';

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, data -> ${JSON.stringify(data)}`);
    data.forEach((calendar) => {
      const account = calendar.getAccount();
      console.info(`account -> ${JSON.stringify(account)}`);
    })
  }
});

getAllCalendars

getAllCalendars(): Promise<Calendar[]>

Obtains the created and default Calendar objects of the current application. This API uses a promise to return the result.

Required permissions: ohos.permission.READ_CALENDAR or ohos.permission.WRITE_WHOLE_CALENDAR

System capability: SystemCapability.Applications.CalendarData

Return value

Example

import { BusinessError } from '@ohos.base';
import { calendarMgr } from '../entryability/EntryAbility';
import calendarManager from '@ohos.calendarManager';

calendarMgr?.getAllCalendars().then((data: calendarManager.Calendar[]) => {
  console.info(`Succeeded in getting all calendars, data -> ${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

In the following API examples, you need to use createCalendar() or getCalendar() to obtain a Calendar object before calling related APIs.

Attributes

System capability: SystemCapability.Applications.CalendarData

addEvent

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

Creates an event, with no event ID specified in Event. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Applications.CalendarData

Parameters

Example

import { BusinessError } from '@ohos.base';
import { calendarMgr } from '../entryability/EntryAbility';
import calendarManager from '@ohos.calendarManager';

let calendar : calendarManager.Calendar | undefined = undefined;
const date = new Date();
const event: calendarManager.Event = {
  type: calendarManager.EventType.NORMAL,
  startTime: date.getTime(),
  endTime: date.getTime() + 60 * 60 * 1000
};
calendarMgr?.getCalendar().then((data: calendarManager.Calendar) => {
  console.info(`Succeeded in getting the calendar, data -> ${JSON.stringify(data)}`);
  calendar = data;
  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 the event, id -> ${data}`);
    }
  });
}).catch((err: BusinessError) => {
  console.error(`Failed to get the calendar, err -> ${JSON.stringify(err)}`);
});

addEvent

addEvent(event: Event): Promise<number>

Creates an event, with no event ID specified in Event. This API uses a promise to return the result.

System capability: SystemCapability.Applications.CalendarData

Parameters

Return value

Example

import { BusinessError } from '@ohos.base';
import { calendarMgr } from '../entryability/EntryAbility';
import calendarManager from '@ohos.calendarManager';

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

addEvents

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

Creates a batch of events, with no event ID specified in Event. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Applications.CalendarData

Parameters

Example

import { BusinessError } from '@ohos.base';
import { calendarMgr } from '../entryability/EntryAbility';
import calendarManager from '@ohos.calendarManager';

let calendar : calendarManager.Calendar | undefined = undefined;
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
  }
];
calendarMgr?.getCalendar((err: BusinessError, data:calendarManager.Calendar) => {
  if (err) {
    console.error(`Failed to get the calendar, err -> ${JSON.stringify(err)}`);
  } else {
    console.info(`Succeeded in getting the calendar, data -> ${JSON.stringify(data)}`);
    calendar = data;
    calendar.addEvents(events, (err: BusinessError) => {
      if (err) {
        console.error(`Failed to add events, err -> ${JSON.stringify(err)}`);
      } else {
        console.info("Succeeded in adding the events");
      }
    });
  }
});

addEvents

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

Creates a batch of events, with no event ID specified in Event. This API uses a promise to return the result.

System capability: SystemCapability.Applications.CalendarData

Parameters

Return value

Example

import { BusinessError } from '@ohos.base';
import { calendarMgr } from '../entryability/EntryAbility';
import calendarManager from '@ohos.calendarManager';

let calendar : calendarManager.Calendar | undefined = undefined;
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
  }
];
calendarMgr?.getCalendar((err: BusinessError, data:calendarManager.Calendar) => {
  if (err) {
    console.error(`Failed to get the calendar: err -> ${JSON.stringify(err)}`);
  } else {
    console.info(`Succeeded in getting the calendar, data -> ${JSON.stringify(data)}`);
    calendar = data;
    calendar.addEvents(events).then(() => {
      console.info("Succeeded in adding the events");
    }).catch((err: BusinessError) => {
      console.error(`Failed to add event, err -> ${JSON.stringify(err)}`);
    });
  }
});

deleteEvent

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

Deletes an event with the specified ID. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Applications.CalendarData

Parameters

Example

import { BusinessError } from '@ohos.base';
import { calendarMgr } from '../entryability/EntryAbility';
import calendarManager from '@ohos.calendarManager';

let calendar : calendarManager.Calendar | undefined = undefined;
let id: number = 0;
const date = new Date();
const event: calendarManager.Event = {
  type: calendarManager.EventType.NORMAL,
  startTime: date.getTime(),
  endTime: date.getTime() + 60 * 60 * 1000
};
calendarMgr?.getCalendar(async (err: BusinessError, data:calendarManager.Calendar) => {
  if (err) {
    console.error(`Failed to get the calendar, err -> ${JSON.stringify(err)}`);
  } else {
    console.info(`Succeeded in getting the calendar, data -> ${JSON.stringify(data)}`);
    calendar = data;
    await calendar.addEvent(event).then((data: number) => {
      console.info(`Succeeded in adding the event, id -> ${data}`);
      id = data;
    }).catch((err: BusinessError) => {
      console.error(`Failed to add event, err -> ${JSON.stringify(err)}`);
    });
    calendar.deleteEvent(id, (err: BusinessError) => {
      if (err) {
        console.error(`Failed to delete event, err -> ${JSON.stringify(err)}`);
      } else {
        console.info(`Succeeded to delete event, err -> ${JSON.stringify(err)}`);
      }
    });
  }
});

deleteEvent

deleteEvent(id: number): Promise<void>

Deletes an event with the specified ID. This API uses a promise to return the result.

System capability: SystemCapability.Applications.CalendarData

Parameters

Return value

Example

import { BusinessError } from '@ohos.base';
import { calendarMgr } from '../entryability/EntryAbility';
import calendarManager from '@ohos.calendarManager';

let calendar : calendarManager.Calendar | undefined = undefined;
let id: number = 0;
const date = new Date();
const event: calendarManager.Event = {
  type: calendarManager.EventType.NORMAL,
  startTime: date.getTime(),
  endTime: date.getTime() + 60 * 60 * 1000
};
calendarMgr?.getCalendar(async (err: BusinessError, data:calendarManager.Calendar) => {
  if (err) {
    console.error(`Failed to get the calendar: err->${JSON.stringify(err)}`);
  } else {
    console.info(`Succeeded in getting the calendar data->${JSON.stringify(data)}`);
    calendar = data;
    await calendar.addEvent(event).then((data: number) => {
      console.info(`Succeeded in adding the event, id -> ${data}`);
      id = data;
    }).catch((err: BusinessError) => {
      console.error(`Failed to add event, err -> ${JSON.stringify(err)}`);
    });
    calendar.deleteEvent(id).then(() => {
      console.info("Succeeded to delete event");
    }).catch((err: BusinessError) => {
      console.error("Failed to delete event");
    });
  }
});

deleteEvents

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

Deletes a batch of events with the specified IDs. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Applications.CalendarData

Parameters

Example

import { BusinessError } from '@ohos.base';
import { calendarMgr } from '../entryability/EntryAbility';
import calendarManager from '@ohos.calendarManager';

let calendar : calendarManager.Calendar | undefined = undefined;
let id1: number = 0;
let id2: number = 0;
const date = new Date();
const event1: calendarManager.Event = {
  type: calendarManager.EventType.NORMAL,
  startTime: date.getTime(),
  endTime: date.getTime() + 60 * 60 * 1000
};
const event2: calendarManager.Event = {
  type: calendarManager.EventType.IMPORTANT,
  startTime: date.getTime(),
  endTime: date.getTime() + 60 * 60 * 1000
};
calendarMgr?.getCalendar(async (err: BusinessError, data:calendarManager.Calendar) => {
  if (err) {
    console.error(`Failed to get the calendar, err -> ${JSON.stringify(err)}`);
  } else {
    console.info(`Succeeded in getting the calendar, data -> ${JSON.stringify(data)}`);
    calendar = data;
    await calendar.addEvent(event1).then((data: number) => {
      console.info(`Succeeded in adding the event, id -> ${data}`);
      id1 = data;
    }).catch((err: BusinessError) => {
      console.error(`Failed to add event, err -> ${JSON.stringify(err)}`);
    });
    await calendar.addEvent(event2).then((data: number) => {
      console.info(`Succeeded in adding the event, id -> ${data}`);
      id2 = data;
    }).catch((err: BusinessError) => {
      console.error(`Failed to add event, err -> ${JSON.stringify(err)}`);
    });
    calendar.deleteEvents([id1, id2], (err: BusinessError) => {
      if (err) {
        console.error("Failed to delete events");
      } else {
        console.info("Succeeded to delete events");
      }
    });
  }
});

deleteEvents

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

Deletes a batch of events with the specified IDs. This API uses a promise to return the result.

System capability: SystemCapability.Applications.CalendarData

Parameters

Return value

Example

import { BusinessError } from '@ohos.base';
import { calendarMgr } from '../entryability/EntryAbility';
import calendarManager from '@ohos.calendarManager';

let calendar : calendarManager.Calendar | undefined = undefined;
let id1: number = 0;
let id2: number = 0;
const date = new Date();
const event1: calendarManager.Event = {
  type: calendarManager.EventType.NORMAL,
  startTime: date.getTime(),
  endTime: date.getTime() + 60 * 60 * 1000
};
const event2: calendarManager.Event = {
  type: calendarManager.EventType.IMPORTANT,
  startTime: date.getTime(),
  endTime: date.getTime() + 60 * 60 * 1000
};
calendarMgr?.getCalendar(async (err: BusinessError, data:calendarManager.Calendar) => {
  if (err) {
    console.error(`Failed to get the calendar, err -> ${JSON.stringify(err)}`);
  } else {
    console.info(`Succeeded in getting the calendar, data -> ${JSON.stringify(data)}`);
    calendar = data;
    await calendar.addEvent(event1).then((data: number) => {
      console.info(`Succeeded in adding the event, id -> ${data}`);
      id1 = data;
    }).catch((err: BusinessError) => {
      console.error(`Failed to add event, err -> ${JSON.stringify(err)}`);
    });
    await calendar.addEvent(event2).then((data: number) => {
      console.info(`Succeeded in adding the event, id -> ${data}`);
      id2 = data;
    }).catch((err: BusinessError) => {
      console.error(`Failed to add event, err -> ${JSON.stringify(err)}`);
    });
    calendar.deleteEvents([id1, id2]).then(() => {
      console.info("Succeeded to delete events");
    }).catch((err: BusinessError) => {
      console.error("Failed to delete events");
    });
  }
});

updateEvent

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

Updates an event. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Applications.CalendarData

Parameters

Example

import { BusinessError } from '@ohos.base';
import { calendarMgr } from '../entryability/EntryAbility';
import calendarManager from '@ohos.calendarManager';

let calendar : calendarManager.Calendar | undefined = undefined;
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
};
calendarMgr?.getCalendar(async (err: BusinessError, data:calendarManager.Calendar) => {
  if (err) {
    console.error(`Failed to get the calendar, err -> ${JSON.stringify(err)}`);
  } else {
    console.info(`Succeeded in getting the calendar, data -> ${JSON.stringify(data)}`);
    calendar = data;
    await calendar.addEvent(oriEvent).then((data: number) => {
      console.info(`Succeeded in adding the event, id -> ${data}`);
      oriEvent.id = data;
      oriEvent.title = 'newUpdate';
    }).catch((err: BusinessError) => {
      console.error(`Failed to add event, err -> ${JSON.stringify(err)}`);
    });
    calendar.updateEvent(oriEvent, (err: BusinessError) => {
      if (err) {
        console.error(`Failed to update event, err -> ${JSON.stringify(err)}`);
      } else {
        console.info("Succeeded in updating the event");
      }
    });
  }
});

updateEvent

updateEvent(event: Event): Promise<void>

Updates an event. This API uses a promise to return the result.

System capability: SystemCapability.Applications.CalendarData

Parameters

Return value

Example

import { BusinessError } from '@ohos.base';
import { calendarMgr } from '../entryability/EntryAbility';
import calendarManager from '@ohos.calendarManager';

let calendar : calendarManager.Calendar | undefined = undefined;
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
};
calendarMgr?.getCalendar(async (err: BusinessError, data:calendarManager.Calendar) => {
  if (err) {
    console.error(`Failed to get the calendar, err -> ${JSON.stringify(err)}`);
  } else {
    console.info(`Succeeded in getting the calendar, data -> ${JSON.stringify(data)}`);
    calendar = data;
    await calendar.addEvent(oriEvent).then((data: number) => {
      console.info(`Succeeded in adding the event, id -> ${data}`);
      oriEvent.id = data;
      oriEvent.title = 'newUpdate';
    }).catch((err: BusinessError) => {
      console.error(`Failed to add event, err -> ${JSON.stringify(err)}`);
    });
    calendar.updateEvent(oriEvent).then(() => {
      console.info(`Succeeded in updating the event`);
    }).catch((err: BusinessError) => {
      console.error(`Failed to update event, err -> ${JSON.stringify(err)}`);
    });
  }
});

getEvents

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

Obtains all events in a calendar. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Applications.CalendarData

Parameters

Example

import { BusinessError } from '@ohos.base';
import { calendarMgr } from '../entryability/EntryAbility';
import calendarManager from '@ohos.calendarManager';

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

getEvents

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

Obtains all events in a calendar that match the filter criteria. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Applications.CalendarData

Parameters

Example

import { BusinessError } from '@ohos.base';
import { calendarMgr } from '../entryability/EntryAbility';
import calendarManager from '@ohos.calendarManager';

let calendar : calendarManager.Calendar | undefined = undefined;
let id1: number = 0;
let id2: number = 0;
const date = new Date();
const event1: calendarManager.Event = {
  type: calendarManager.EventType.NORMAL,
  startTime: date.getTime(),
  endTime: date.getTime() + 60 * 60 * 1000
};
const event2: calendarManager.Event = {
  type: calendarManager.EventType.IMPORTANT,
  startTime: date.getTime(),
  endTime: date.getTime() + 60 * 60 * 1000
};
calendarMgr?.getCalendar(async (err: BusinessError, data:calendarManager.Calendar) => {
  if (err) {
    console.error(`Failed to get the calendar, err -> ${JSON.stringify(err)}`);
  } else {
    console.info(`Succeeded in getting the calendar, data -> ${JSON.stringify(data)}`);
    calendar = data;
    await calendar.addEvent(event1).then((data: number) => {
      console.info(`Succeeded in adding the event, id -> ${data}`);
    }).catch((err: BusinessError) => {
      console.error(`Failed to add event, err -> ${JSON.stringify(err)}`);
    });
    await calendar.addEvent(event2).then((data: number) => {
      console.info(`Succeeded in adding the event, id -> ${data}`);
    }).catch((err: BusinessError) => {
      console.error(`Failed to add event, err -> ${JSON.stringify(err)}`);
    });
    const filter = calendarManager.EventFilter.filterById([id1, id2]);
    calendar.getEvents(filter, ['title', 'type', 'startTime', 'endTime'], (err: BusinessError, data: calendarManager.Event[]) => {
      if (err) {
        console.error(`Failed to get the events, err -> ${JSON.stringify(err)}`);
      } else {
        console.info(`Succeeded in getting events, data -> ${JSON.stringify(data)}`);
      }
    });
  }
});

getEvents

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

Obtains all events in a calendar that match the filter criteria. This API uses a promise to return the result.

System capability: SystemCapability.Applications.CalendarData

Parameters

Return value

Example

import { BusinessError } from '@ohos.base';
import { calendarMgr } from '../entryability/EntryAbility';
import calendarManager from '@ohos.calendarManager';

let calendar : calendarManager.Calendar | undefined = undefined;
const date = new Date();
const event: calendarManager.Event = {
  title: 'MyEvent',
  type: calendarManager.EventType.IMPORTANT,
  startTime: date.getTime(),
  endTime: date.getTime() + 60 * 60 * 1000
};
calendarMgr?.getCalendar(async (err: BusinessError, data:calendarManager.Calendar) => {
  if (err) {
    console.error(`Failed to get the calendar, err -> ${JSON.stringify(err)}`);
  } else {
    console.info(`Succeeded in getting the calendar, data -> ${JSON.stringify(data)}`);
    calendar = data;
    await calendar.addEvent(event).then((data: number) => {
      console.info(`Succeeded in adding the event, id -> ${data}`);
    }).catch((err: BusinessError) => {
      console.error(`Failed to add event, err -> ${JSON.stringify(err)}`);
    });
    const filter = calendarManager.EventFilter.filterByTitle('MyEvent');
    calendar.getEvents(filter).then((data: calendarManager.Event[]) => {
      console.info(`Succeeded in getting events, data -> ${JSON.stringify(data)}`);
    }).catch((err: BusinessError) => {
      console.error(`Failed to get the events, err -> ${JSON.stringify(err)}`);
    });
  }
});

getConfig

getConfig(): CalendarConfig

Obtains the calendar configuration information.

System capability: SystemCapability.Applications.CalendarData

Return value

Example

import { calendarMgr } from '../entryability/EntryAbility';
import calendarManager from '@ohos.calendarManager';
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 the calendar, err -> ${JSON.stringify(err)}`);
  } else {
    console.info(`Succeeded in getting the calendar, data -> ${JSON.stringify(data)}`);
    calendar = data;
    const config = calendar.getConfig();
    console.info("get config success");
  }
});

setConfig

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

Sets the calendar configuration information. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Applications.CalendarData

Parameters

Example

import { BusinessError } from '@ohos.base';
import { calendarMgr } from '../entryability/EntryAbility';
import calendarManager from '@ohos.calendarManager';

let calendar : calendarManager.Calendar | undefined = undefined;
const config: calendarManager.CalendarConfig = {
  enableReminder: true,
  color: '#aabbcc'
};
calendarMgr?.getCalendar((err: BusinessError, data:calendarManager.Calendar) => {
  if (err) {
    console.error(`Failed to get the calendar, err -> ${JSON.stringify(err)}`);
  } else {
    console.info(`Succeeded in getting the calendar, data -> ${JSON.stringify(data)}`);
    calendar = data;
    calendar.setConfig(config, (err: BusinessError) => {
      if (err) {
        console.error(`Failed to set config, err -> ${JSON.stringify(err)}`);
      } else {
        console.info(`Succeeded in setting config, config -> ${JSON.stringify(config)}`);
      }
    });
  }
});

setConfig

setConfig(config: CalendarConfig): Promise<void>

Sets the calendar configuration information. This API uses a promise to return the result.

System capability: SystemCapability.Applications.CalendarData

Parameters

Return value

Example

import { BusinessError } from '@ohos.base';
import { calendarMgr } from '../entryability/EntryAbility';
import calendarManager from '@ohos.calendarManager';

let calendar : calendarManager.Calendar | undefined = undefined;
const config: calendarManager.CalendarConfig = {
  enableReminder: true,
  color: '#aabbcc'
};
calendarMgr?.getCalendar((err: BusinessError, data:calendarManager.Calendar) => {
  if (err) {
    console.error(`Failed to get the calendar, err -> ${JSON.stringify(err)}`);
  } else {
    console.info(`Succeeded in getting the calendar, data -> ${JSON.stringify(data)}`);
    calendar = data;
    calendar.setConfig(config).then(() => {
      console.info(`Succeeded in setting config, data->${JSON.stringify(config)}`);
    }).catch((err: BusinessError) => {
      console.error(`Failed to set config, err->${JSON.stringify(err)}`);
    });
  }
});

getAccount

getAccount(): CalendarAccount

Obtains the calendar account information.

System capability: SystemCapability.Applications.CalendarData

Return value

Example

import { calendarMgr } from '../entryability/EntryAbility';
import calendarManager from '@ohos.calendarManager';
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 the calendar, err -> ${JSON.stringify(err)}`);
  } else {
    console.info(`Succeeded in getting the calendar, data -> ${JSON.stringify(data)}`);
    calendar = data;
    const account = calendar.getAccount();
    console.info(`get account success, account -> ${JSON.stringify(account)}`);
  }
});

CalendarAccount

Describes the calendar account information.

System capability: SystemCapability.Applications.CalendarData

CalendarConfig

Describes the calendar configuration information.

System capability: SystemCapability.Applications.CalendarData

Event

Describes an Event object, including the event title, start time, and end time.

System capability: SystemCapability.Applications.CalendarData

CalendarType

Enumerates the account types.

System capability: SystemCapability.Applications.CalendarData

Location

Describes the event location.

System capability: SystemCapability.Applications.CalendarData

EventFilter

Implements an event filter.

You can use filterById(), filterByTime(), or filterByTitle() to obtain an event filter, and then pass the filter in getEvents() for filtering.

filterById

static filterById(ids: number[]): EventFilter

Defines an event ID based filter.

System capability: SystemCapability.Applications.CalendarData

Parameters

Return value

Example

import { BusinessError } from '@ohos.base';
import { calendarMgr } from '../entryability/EntryAbility';
import calendarManager from '@ohos.calendarManager';

let calendar : calendarManager.Calendar | undefined = undefined;
let id1: number = 0;
let id2: number = 0;
const date = new Date();
const event1: calendarManager.Event = {
  type: calendarManager.EventType.NORMAL,
  startTime: date.getTime(),
  endTime: date.getTime() + 60 * 60 * 1000
};
const event2: calendarManager.Event = {
  type: calendarManager.EventType.IMPORTANT,
  startTime: date.getTime(),
  endTime: date.getTime() + 60 * 60 * 1000
};
calendarMgr?.getCalendar(async (err: BusinessError, data:calendarManager.Calendar) => {
  if (err) {
    console.error(`Failed to get the calendar, err -> ${JSON.stringify(err)}`);
  } else {
    console.info(`Succeeded in getting the calendar, data -> ${JSON.stringify(data)}`);
    calendar = data;
    await calendar.addEvent(event1).then((data: number) => {
      console.info(`Succeeded in adding the event, id -> ${data}`);
      id1 = data;
    }).catch((err: BusinessError) => {
      console.error(`Failed to add event, err -> ${JSON.stringify(err)}`);
    });
    await calendar.addEvent(event2).then((data: number) => {
      console.info(`Succeeded in adding the event, id -> ${data}`);
      id2 = data;
    }).catch((err: BusinessError) => {
      console.error(`Failed to add event, err -> ${JSON.stringify(err)}`);
    });
    const filter = calendarManager.EventFilter.filterById([id1, id2]);
    calendar.getEvents(filter).then((data: calendarManager.Event[]) => {
      console.info(`Succeeded in filtering by id, data -> ${JSON.stringify(data)}`);
    }).catch((err: BusinessError) => {
      console.error(`Failed to filter by id, err -> ${JSON.stringify(err)}`);
    });
  }
});

filterByTime

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

Defines an event time based filter.

System capability: SystemCapability.Applications.CalendarData

Parameters

Return value

Example

import { BusinessError } from '@ohos.base';
import { calendarMgr } from '../entryability/EntryAbility';
import calendarManager from '@ohos.calendarManager';

let calendar : calendarManager.Calendar | undefined = undefined;
const event1: calendarManager.Event = {
  type: calendarManager.EventType.NORMAL,
  startTime: 1686931200000,
  endTime: 1687017600000
};
const event2: calendarManager.Event = {
  type: calendarManager.EventType.IMPORTANT,
  startTime: 1686931200000,
  endTime: 1687017600000
};
calendarMgr?.getCalendar(async (err: BusinessError, data:calendarManager.Calendar) => {
  if (err) {
    console.error(`Failed to get the calendar, err -> ${JSON.stringify(err)}`);
  } else {
    console.info(`Succeeded in getting the calendar, data -> ${JSON.stringify(data)}`);
    calendar = data;
    await calendar.addEvent(event1).then((data: number) => {
      console.info(`Succeeded in adding the event, id -> ${data}`);
    }).catch((err: BusinessError) => {
      console.error(`Failed to add event, err -> ${JSON.stringify(err)}`);
    });
    await calendar.addEvent(event2).then((data: number) => {
      console.info(`Succeeded in adding the event, id -> ${data}`);
    }).catch((err: BusinessError) => {
      console.error(`Failed to add event, err -> ${JSON.stringify(err)}`);
    });
    const filter = calendarManager.EventFilter.filterByTime(1686931200000, 1687017600000);
    calendar.getEvents(filter).then((data: calendarManager.Event[]) => {
      console.info(`Succeeded in filtering by time, data -> ${JSON.stringify(data)}`);
    }).catch((err: BusinessError) => {
      console.error(`Failed to filter by time, err -> ${JSON.stringify(err)}`);
    });
  }
});

filterByTitle

static filterByTitle(title: string): EventFilter

Defines an event title based filter.

System capability: SystemCapability.Applications.CalendarData

Parameters

Return value

Example

import { BusinessError } from '@ohos.base';
import { calendarMgr } from '../entryability/EntryAbility';
import calendarManager from '@ohos.calendarManager';

let calendar : calendarManager.Calendar | undefined = undefined;
const event: calendarManager.Event = {
  title: 'MyEvent',
  type: calendarManager.EventType.NORMAL,
  startTime: 1686931200000,
  endTime: 1687017600000
};
calendarMgr?.getCalendar(async (err: BusinessError, data:calendarManager.Calendar) => {
  if (err) {
    console.error(`Failed to get the calendar, err -> ${JSON.stringify(err)}`);
  } else {
    console.info(`Succeeded in getting the calendar, data -> ${JSON.stringify(data)}`);
    calendar = data;
    await calendar.addEvent(event).then((data: number) => {
      console.info(`Succeeded in adding the event, id -> ${data}`);
    }).catch((err: BusinessError) => {
      console.error(`Failed to add event, err -> ${JSON.stringify(err)}`);
    });
    const filter = calendarManager.EventFilter.filterByTitle('MyEvent');
    calendar.getEvents(filter).then((data: calendarManager.Event[]) => {
      console.info(`Succeeded in filtering by title, data -> ${JSON.stringify(data)}`);
    }).catch((err: BusinessError) => {
      console.error(`Failed to filter by title, err -> ${JSON.stringify(err)}`);
    });
  }
});

EventType

Enumerates event types.

System capability: SystemCapability.Applications.CalendarData

RecurrenceRule

Describes the event recurrence rule.

System capability: SystemCapability.Applications.CalendarData

RecurrenceFrequency

Enumerates the types of the event recurrence rule.

System capability: SystemCapability.Applications.CalendarData

Attendee

Describes the event attendee.

System capability: SystemCapability.Applications.CalendarData

EventService

Describes the event service.

System capability: SystemCapability.Applications.CalendarData

ServiceType

Enumerates the event service types.

System capability: SystemCapability.Applications.CalendarData