当前仓库属于关闭状态,部分功能使用受限,详情请查阅 仓库状态说明
46 Star 179 Fork 4.8K

OpenHarmony/interface_sdk-js
关闭

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
文件
克隆/下载
@ohos.calendarManager.d.ts 43.65 KB
一键复制 编辑 原始数据 按行查看 历史
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589
/*
* Copyright (c) 2022-2023 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file
* @kit CalendarKit
*/
import { AsyncCallback } from './@ohos.base';
import type Context from './application/Context';
/**
* This provides calendar data access abilities.
* @namespace calendarManager
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* This provides calendar data access abilities.
* @namespace calendarManager
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
declare namespace calendarManager {
/**
* Returns an instance of CalendarManager
*
* @param { Context } context - Hap context information
* @returns { CalendarManager } Instance of CalendarManager
* @syscap SystemCapability.Applications.CalendarData
* @StageModelOnly
* @since 10
*/
/**
* Returns an instance of CalendarManager
*
* @param { Context } context - Hap context information
* @returns { CalendarManager } Instance of CalendarManager
* @syscap SystemCapability.Applications.CalendarData
* @StageModelOnly
* @atomicservice
* @since 11
*/
function getCalendarManager(context: Context) : CalendarManager;
/**
* Defines the CalendarManager class and provides functions to access the calendar data.
*
* @typedef CalendarManager
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Defines the CalendarManager class and provides functions to access the calendar data.
*
* @typedef CalendarManager
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
export interface CalendarManager {
/**
* Create calendar instance.
* @permission ohos.permission.WRITE_CALENDAR or ohos.permission.WRITE_WHOLE_CALENDAR
* @param { CalendarAccount } calendarAccount - calendar account to create calendar
* @returns { Promise<Calendar> } the promise with calendar corresponding to account
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
* @throws { BusinessError } 801 - Capability not supported.
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
createCalendar(calendarAccount: CalendarAccount): Promise<Calendar>;
/**
* Create calendar instance.
*
* @permission ohos.permission.WRITE_CALENDAR or ohos.permission.WRITE_WHOLE_CALENDAR
* @param { CalendarAccount } calendarAccount - calendar account to create calendar
* @param { AsyncCallback<Calendar> } callback - the callback of createCalendar
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
* @throws { BusinessError } 801 - Capability not supported.
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
createCalendar(calendarAccount: CalendarAccount, callback: AsyncCallback<Calendar>): void;
/**
* Delete calendar instance.
*
* @permission ohos.permission.WRITE_CALENDAR or ohos.permission.WRITE_WHOLE_CALENDAR
* @param { Calendar } calendar - calendar to be deleted
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
* @throws { BusinessError } 801 - Capability not supported.
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
deleteCalendar(calendar: Calendar): Promise<void>;
/**
* Delete calendar instance.
*
* @permission ohos.permission.WRITE_CALENDAR or ohos.permission.WRITE_WHOLE_CALENDAR
* @param { Calendar } calendar - calendar to be deleted
* @param { AsyncCallback<void> } callback - the callback of deleteCalendar
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
* @throws { BusinessError } 801 - Capability not supported.
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
deleteCalendar(calendar: Calendar, callback: AsyncCallback<void>): void;
/**
* Get calendar instance from database.
*
* @permission ohos.permission.READ_CALENDAR or ohos.permission.READ_WHOLE_CALENDAR
* @param { CalendarAccount } [calendarAccount] - specify calendar account to retrieve
* @returns { Promise<Calendar> } the promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: Incorrect parameter types.
* @throws { BusinessError } 801 - Capability not supported.
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Get calendar instance from database.
*
* @permission ohos.permission.READ_CALENDAR or ohos.permission.READ_WHOLE_CALENDAR
* @param { CalendarAccount } [calendarAccount] - specify calendar account to retrieve
* @returns { Promise<Calendar> } the promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: Incorrect parameter types.
* @throws { BusinessError } 801 - Capability not supported.
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
getCalendar(calendarAccount?: CalendarAccount): Promise<Calendar>;
/**
* Get calendar instance from database by specified account.
*
* @permission ohos.permission.READ_CALENDAR or ohos.permission.READ_WHOLE_CALENDAR
* @param { CalendarAccount } calendarAccount - specify calendar account to retrieve
* @param { AsyncCallback<Calendar> } callback - the callback of getCalendar
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
* @throws { BusinessError } 801 - Capability not supported.
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Get calendar instance from database by specified account.
*
* @permission ohos.permission.READ_CALENDAR or ohos.permission.READ_WHOLE_CALENDAR
* @param { CalendarAccount } calendarAccount - specify calendar account to retrieve
* @param { AsyncCallback<Calendar> } callback - the callback of getCalendar
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
* @throws { BusinessError } 801 - Capability not supported.
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
getCalendar(calendarAccount: CalendarAccount, callback: AsyncCallback<Calendar>): void;
/**
* Get default calendar instance from database.
*
* @permission ohos.permission.READ_CALENDAR or ohos.permission.READ_WHOLE_CALENDAR
* @param { AsyncCallback<Calendar> } callback - the callback of getCalendar with default calendar instance
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
* @throws { BusinessError } 801 - Capability not supported.
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Get default calendar instance from database.
*
* @permission ohos.permission.READ_CALENDAR or ohos.permission.READ_WHOLE_CALENDAR
* @param { AsyncCallback<Calendar> } callback - the callback of getCalendar with default calendar instance
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
* @throws { BusinessError } 801 - Capability not supported.
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
getCalendar(callback: AsyncCallback<Calendar>): void;
/**
* Get all calendar instance.
*
* @permission ohos.permission.READ_CALENDAR or ohos.permission.READ_WHOLE_CALENDAR
* @returns { Promise<Calendar[]> } the promise returned by the function.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: Incorrect parameter types.
* @throws { BusinessError } 801 - Capability not supported.
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
getAllCalendars(): Promise<Calendar[]>;
/**
* Get all calendar instance.
*
* @permission ohos.permission.READ_CALENDAR or ohos.permission.READ_WHOLE_CALENDAR
* @param {AsyncCallback<Calendar[]>} callback - the callback of getAllCalendars
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
* @throws { BusinessError } 801 - Capability not supported.
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
getAllCalendars(callback: AsyncCallback<Calendar[]>): void;
/**
* Create a single event,invoking this interface will open the event creation page.
*
* @param { Event } event - Indicates the information about a single event.
* @returns { Promise<number> } the promise with event id.
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 12
*/
editEvent(event: Event): Promise<number>;
}
/**
* Describes a calendar instance.
* @typedef Calendar
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Describes a calendar instance.
* @typedef Calendar
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
export interface Calendar {
/**
* Id of the calendar
* @type { number }
* @readonly
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Id of the calendar
* @type { number }
* @readonly
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
readonly id: number
/**
* Add a single event.
* @param { Event } event - Indicates the information about a single event.
* @returns { Promise<number> } The event ID.
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Add a single event.
* @param { Event } event - Indicates the information about a single event.
* @returns { Promise<number> } The event ID.
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
addEvent(event: Event): Promise<number>;
/**
* Add a single event.
* @param { Event } event - a single event to add.
* @param { AsyncCallback<number> } callback - callback of addEvent.
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Add a single event.
* @param { Event } event - a single event to add.
* @param { AsyncCallback<number> } callback - callback of addEvent.
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
addEvent(event: Event, callback: AsyncCallback<number>): void;
/**
* Add multiple events.
* @param { Event[] } events - multiple events to add.
* @returns { Promise<void> } The promise returned by function.
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
addEvents(events: Event[]): Promise<void>;
/**
* Add multiple events.
* @param { Event[] } events - Indicates the information about multiple events.
* @param { AsyncCallback<void> } callback - The callback of addEvents
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
addEvents(events: Event[], callback: AsyncCallback<void>): void;
/**
* Delete a single event.
* @param { number } id - Indicates the ID of an event.
* @returns { Promise<void> } The promise returned by function.
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
deleteEvent(id: number): Promise<void>;
/**
* Delete a single event.
* @param { number } id - Indicates the ID of an event.
* @param {AsyncCallback<void>} callback - The callback of deleteEvent.
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Delete a single event.
* @param { number } id - Indicates the ID of an event.
* @param {AsyncCallback<void>} callback - The callback of deleteEvent.
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 19
*/
deleteEvent(id: number, callback: AsyncCallback<void>): void;
/**
* Delete multiple events.
* @param { number[] } ids - The id array of multiple events.
* @returns { Promise<void> } The promise returned by function.
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
deleteEvents(ids: number[]): Promise<void>;
/**
* Delete multiple events.
* @param { number[] } ids - Indicates the IDs of multiple events.
* @param {AsyncCallback<void>} callback - The callback of deleteEvents.
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Delete multiple events.
* @param { number[] } ids - Indicates the IDs of multiple events.
* @param {AsyncCallback<void>} callback - The callback of deleteEvents.
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 19
*/
deleteEvents(ids: number[], callback: AsyncCallback<void>): void;
/**
* Update a single event.
* @param { Event } event - Indicates the information about a single event.
* @returns { Promise<void> } The promise returned by function.
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
updateEvent(event: Event): Promise<void>;
/**
* Update a single event.
* @param { Event } event - Indicates the information about a single event.
* @param { AsyncCallback<void> } callback - The callback of updateEvent.
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
updateEvent(event: Event, callback: AsyncCallback<void>): void;
/**
* Query events based on filter conditions.
* @param { EventFilter } [eventFilter] - Indicates the filtering conditions of events.
* @param { (keyof Event)[] } [eventKey] - Expected column to be returned.
* @returns { Promise<Event[]> } Information about events that match the filter conditions.
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
getEvents(eventFilter?: EventFilter, eventKey?: (keyof Event)[]): Promise<Event[]>;
/**
* Query events based on filter conditions.
* @param { EventFilter } eventFilter - Indicates the filtering conditions of events.
* @param { (keyof Event)[] } eventKey - Expected column to be returned.
* @param { AsyncCallback<Event[]> } callback - The callback of getEvents.
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
getEvents(eventFilter: EventFilter, eventKey: (keyof Event)[], callback: AsyncCallback<Event[]>):void;
/**
* Query all events with all column from current calendar instance.
* @param { AsyncCallback<Event[]> } callback - The callback of getEvents with all events.
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
getEvents(callback: AsyncCallback<Event[]>):void;
/**
* Get calendar configure.
* @returns { CalendarConfig } configure of current calendar.
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
getConfig(): CalendarConfig;
/**
* Set calendar configure.
* @param { CalendarConfig } config - calendar config to set
* @returns { Promise<void> } The promise returned by function.
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
setConfig(config: CalendarConfig): Promise<void>;
/**
* Set calendar configure.
* @param { CalendarConfig } config - calendar config to set
* @param { AsyncCallback<void> } callback - callback of setConfig
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
setConfig(config: CalendarConfig, callback: AsyncCallback<void>): void;
/**
* Get calendar account.
* @returns { CalendarAccount } calendar account of current calendar.
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
getAccount(): CalendarAccount;
/**
* Query event instances based on the conditions.
* @param { number } start - start time of query range
* @param { number } end - end time of query range
* @param { number[] } [ids] - Indicates the IDs of multiple events
* @param { (keyof Event)[] } [eventKey] - Expected column to be returned
* @returns { Promise<Event[]> } Information about events that match the condition
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 18
*/
queryEventInstances(start: number, end: number, ids?: number[], eventKey?: (keyof Event)[]): Promise<Event[]>;
}
/**
* Describes a calendar account.
* @typedef CalendarAccount
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Describes a calendar account.
* @typedef CalendarAccount
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
interface CalendarAccount {
/**
* Name of the calendar
* @type { string }
* @readonly
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Name of the calendar
* @type { string }
* @readonly
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
readonly name: string;
/**
* Type of the calendar
* @type { CalendarType }
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Type of the calendar
* @type { CalendarType }
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
type: CalendarType;
/**
* DisplayName of the calendar
* @type { ?string }
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* DisplayName of the calendar
* @type { ?string }
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
displayName?: string
}
/**
* Describes a calendar configuration.
* @typedef CalendarConfig
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
interface CalendarConfig {
/**
* Whether the calendar provides a reminder
* @type { ?boolean }
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
enableReminder?: boolean;
/**
* Color of the calendar
* @type { ?(number | string) }
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
color?: number | string;
}
/**
* Describes an event information.
* @typedef Event
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Describes an event information.
* @typedef Event
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
interface Event {
/**
* Id of the event
* @type { ?number }
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Id of the event
* @type { ?number }
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
id?: number;
/**
* Type of the event
* @type { EventType }
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Type of the event
* @type { EventType }
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
type: EventType;
/**
* Title of the event
* @type { ?string }
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Title of the event
* @type { ?string }
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
title?: string;
/**
* Location of the event
* @type { ?Location }
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Location of the event
* @type { ?Location }
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
location?: Location;
/**
* start time of the event
* @type { number }
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* start time of the event
* @type { number }
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
startTime: number;
/**
* end time of the event
* @type { number }
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* end time of the event
* @type { number }
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
endTime: number;
/**
* Whether the event is allDay
* @type { ?boolean }
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Whether the event is allDay
* @type { ?boolean }
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
isAllDay?: boolean;
/**
* Attendees of the event
* @type { ?Attendee[] }
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Attendees of the event
* @type { ?Attendee[] }
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
attendee?: Attendee[];
/**
* TimeZone of the event
* @type { ?string }
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* TimeZone of the event
* @type { ?string }
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
timeZone?: string;
/**
* Reminder time of the event
* @type { ?number[] }
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Reminder time of the event
* @type { ?number[] }
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
reminderTime?: number[];
/**
* RecurrenceRule of the event
* @type { ?RecurrenceRule }
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* RecurrenceRule of the event
* @type { ?RecurrenceRule }
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
recurrenceRule?: RecurrenceRule;
/**
* Description of the event
* @type { ?string }
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Description of the event
* @type { ?string }
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
description?: string;
/**
* Service of the event
* @type { ?EventService }
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Service of the event
* @type { ?EventService }
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
service?: EventService;
/**
* Unique identifier of the event
* @type { ?string }
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 12
*/
identifier?: string;
/**
* Whether the event is lunar.
* @type { ?boolean }
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 12
*/
isLunar?: boolean;
/**
* Start time of the event instance.
* @type { ?number }
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 18
*/
instanceStartTime?: number;
/**
* End time of the event instance.
* @type { ?number }
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 18
*/
instanceEndTime?: number;
}
/**
* Enum for all calendar type.
* @enum { string }
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Enum for all calendar type.
* @enum { string }
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
enum CalendarType {
/**
* Local calendar
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Local calendar
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
LOCAL = 'local',
/**
* Email calendar
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Email calendar
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
EMAIL = 'email',
/**
* Birthday calendar
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Birthday calendar
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
BIRTHDAY = 'birthday',
/**
* CalDAV calendar
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* CalDAV calendar
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
CALDAV = 'caldav',
/**
* Subscribed calendar
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Subscribed calendar
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
SUBSCRIBED = 'subscribed'
}
/**
* Location of an event.
* @typedef Location
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Location of an event.
* @typedef Location
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
interface Location {
/**
* Location of the event
* @type { ?string }
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Location of the event
* @type { ?string }
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
location?: string;
/**
* Longitude of the location
* @type { ?number }
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Longitude of the location
* @type { ?number }
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
longitude?: number;
/**
* Latitude of the location
* @type { ?number }
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Latitude of the location
* @type { ?number }
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
latitude?: number;
}
/**
* Provides the abilities to retrive event filter.
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
class EventFilter {
/**
* Filter events by event id.
* @param {number[]} ids id array to retrieve
* @returns { EventFilter } Returns the EventFilter with ids.
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
static filterById(ids: number[]): EventFilter;
/**
* Filter events by event start time and end time.
* @param { number } start - start time of query range
* @param { number } end - end time of query range
* @returns { EventFilter } Returns the EventFilter with time range.
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
static filterByTime(start: number, end: number): EventFilter;
/**
* Filter events by event title.
* @param { string } title - event title to query
* @returns {EventFilter } Returns the EventFilter with title.
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
static filterByTitle(title: string): EventFilter;
}
/**
* Enum for supported events type.
* @enum { number }
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Enum for supported events type.
* @enum { number }
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
enum EventType {
/**
* normal event.
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* normal event.
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
NORMAL = 0,
/**
* important event.
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* important event.
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
IMPORTANT = 1,
}
/**
* Defines the recurrence rule of event
* @typedef RecurrenceRule
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Defines the recurrence rule of event
* @typedef RecurrenceRule
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
export interface RecurrenceRule {
/**
* RecurrenceFrequency of recurrence event.
* @type { RecurrenceFrequency }
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* RecurrenceFrequency of recurrence event.
* @type { RecurrenceFrequency }
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
recurrenceFrequency: RecurrenceFrequency;
/**
* Expiration time of recurrence event.
* @type { ?number }
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Expiration time of recurrence event.
* @type { ?number }
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
expire?: number;
/**
* Repetition count of recurrence event.
* @type { ?number }
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 12
*/
count?: number;
/**
* Repeat interval of recurrence event.
* @type { ?number }
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 12
*/
interval?: number;
/**
* Excluded dates of recurrence event.
* @type { ?number[] }
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 12
*/
excludedDates?: number[];
/**
* The days of the week associated with the recurrence event.
* @type { ?number[] }
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 12
*/
daysOfWeek?: number[];
/**
* The days of the month associated with the recurrence event.
* @type { ?number[] }
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 12
*/
daysOfMonth?: number[];
/**
* The days of the year associated with the recurrence event.
* @type { ?number[] }
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 12
*/
daysOfYear?: number[];
/**
* The weeks of the month associated with the recurrence event.
* @type { ?number[] }
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 12
*/
weeksOfMonth?: number[];
/**
* The weeks of the year associated with the recurrence event.
* @type { ?number[] }
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 12
*/
weeksOfYear?: number[];
/**
* The months of the year associated with the recurrence event.
* @type { ?number[] }
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 12
*/
monthsOfYear?: number[];
}
/**
* Enum for the recurrence type by different period
* @enum { number }
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Enum for the recurrence type by different period
* @enum { number }
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
export enum RecurrenceFrequency {
/**
* The event repeats every year.
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* The event repeats every year.
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
YEARLY = 0,
/**
* The event repeats every month.
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* The event repeats every month.
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
MONTHLY = 1,
/**
* The event repeats every week.
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* The event repeats every week.
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
WEEKLY = 2,
/**
* The event repeats every day.
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* The event repeats every day.
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
DAILY = 3,
}
/**
* Defines the attendee information
* @typedef Attendee
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Defines the attendee information
* @typedef Attendee
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
export interface Attendee {
/**
* Name of the Attendee.
* @type { string }
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Name of the Attendee.
* @type { string }
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
name: string;
/**
* Email of the Attendee.
* @type { string }
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Email of the Attendee.
* @type { string }
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
email: string;
/**
* Role of the Attendee.
* @type { ?AttendeeRole }
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 12
*/
role?: AttendeeRole;
/**
* Type of the Attendee.
* @type { ?AttendeeType }
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 18
*/
type?: AttendeeType;
/**
* Status of the Attendee.
* @type { ?AttendeeStatus }
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 18
*/
status?: AttendeeStatus;
}
/**
* Enum for the attendee role
* @enum { string }
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 12
*/
export enum AttendeeRole {
/**
* The organizer of a meeting.
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 12
*/
ORGANIZER = 'organizer',
/**
* The participant of a meeting.
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 12
*/
PARTICIPANT = 'participant'
}
/**
* Enum for the attendee type
* @enum { number }
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 18
*/
export enum AttendeeType {
/**
* A mailbox user who is a required attendee to the meeting.
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 18
*/
REQUIRED = 1,
/**
* A mailbox user who is an optional attendee to the meeting.
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 18
*/
OPTIONAL = 2,
/**
* A resource such as a TV or projector that is scheduled for use in the meeting.
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 18
*/
RESOURCE = 3
}
/**
* Enum for the attendee states
* @enum { number }
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 18
*/
export enum AttendeeStatus {
/**
* The acceptance status of the participant is unknown.
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 18
*/
UNKNOWN = 0,
/**
* The acceptance status of the participant is tentative.
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 18
*/
TENTATIVE = 1,
/**
* The acceptance status of the participant is accepted.
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 18
*/
ACCEPTED = 2,
/**
* The acceptance status of the participant is declined.
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 18
*/
DECLINED = 3,
/**
* The acceptance status of the participant is unresponsive.
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 18
*/
UNRESPONSIVE = 4,
}
/**
* Defines event service information
* @typedef EventService
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Defines event service information
* @typedef EventService
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
export interface EventService {
/**
* Type of the EventService.
* @type { ServiceType }
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Type of the EventService.
* @type { ServiceType }
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
type: ServiceType;
/**
* Uri of the EventService.
* @type { string }
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Uri of the EventService.
* @type { string }
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
uri: string;
/**
* Description of the EventService.
* @type { ?string }
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Description of the EventService.
* @type { ?string }
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
description?: string;
}
/**
* Defines event service type
* @enum { string }
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Defines event service type
* @enum { string }
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
export enum ServiceType {
/**
* Meeting event.
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Meeting event.
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
MEETING = 'Meeting',
/**
* Watch drama event.
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Watch drama event.
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
WATCHING = 'Watching',
/**
* Repayment event.
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Repayment event.
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
REPAYMENT = 'Repayment',
/**
* Live event.
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Live event.
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
LIVE = 'Live',
/**
* Shopping event.
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Shopping event.
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
SHOPPING = 'Shopping',
/**
* trip event.
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* trip event.
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
TRIP = 'Trip',
/**
* Class event.
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Class event.
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
CLASS = 'Class',
/**
* Sports game event.
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Sports game event.
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
SPORTS_EVENTS = 'SportsEvents',
/**
* Sports exercise event.
* @syscap SystemCapability.Applications.CalendarData
* @since 10
*/
/**
* Sports exercise event.
* @syscap SystemCapability.Applications.CalendarData
* @atomicservice
* @since 11
*/
SPORTS_EXERCISE = 'SportsExercise',
}
}
export default calendarManager;
Loading...
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/openharmony/interface_sdk-js.git
git@gitee.com:openharmony/interface_sdk-js.git
openharmony
interface_sdk-js
interface_sdk-js
master

搜索帮助