Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
2832c4e0
D
Docs
项目概览
OpenHarmony
/
Docs
大约 2 年 前同步成功
通知
161
Star
293
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
提交
2832c4e0
编写于
7月 24, 2023
作者:
Z
z00797030
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
文档链接格式修改
Signed-off-by:
N
z00797030
<
zhuchengli@huawei.com
>
上级
325e7a45
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
65 addition
and
65 deletion
+65
-65
zh-cn/application-dev/reference/apis/js-apis-calendarManager.md
...application-dev/reference/apis/js-apis-calendarManager.md
+65
-65
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-calendarManager.md
浏览文件 @
2832c4e0
...
@@ -28,8 +28,8 @@ createCalendar(calendarAccount: [CalendarAccount](#calendaraccount), callback: A
...
@@ -28,8 +28,8 @@ createCalendar(calendarAccount: [CalendarAccount](#calendaraccount), callback: A
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| --------------- | ------------------------------------- | ---- | ---------------------------------- |
| --------------- | ------------------------------------- | ---- | ---------------------------------- |
| calendarAccount |
[
CalendarAccount
](
#
CalendarA
ccount
)
| 是 | 账户信息实例。 |
| calendarAccount |
[
CalendarAccount
](
#
calendara
ccount
)
| 是 | 账户信息实例。 |
| callback | AsyncCallback
\<
[
Calendar
](
#
C
alendar
)
> | 是 | 异步回调,返回创建的Calendar对象。 |
| callback | AsyncCallback
\<
[
Calendar
](
#
c
alendar
)
> | 是 | 异步回调,返回创建的Calendar对象。 |
**错误码:**
**错误码:**
...
@@ -55,7 +55,7 @@ calendarManager.createCalendar({ name: 'MyCalendar', type: calendarManager.Calen
...
@@ -55,7 +55,7 @@ calendarManager.createCalendar({ name: 'MyCalendar', type: calendarManager.Calen
## calendarManager.createCalendar
## calendarManager.createCalendar
createCalendar(calendarAccount:
[
CalendarAccount
](
#
CalendarAccount
)
): Promise
<
[
Calendar
](
#C
alendar
)
>
createCalendar(calendarAccount:
[
CalendarAccount
](
#
calendaraccount
)
): Promise
<
[
Calendar
](
#c
alendar
)
>
创建账户,使用Promise方式实现异步调用。
创建账户,使用Promise方式实现异步调用。
...
@@ -67,13 +67,13 @@ createCalendar(calendarAccount: [CalendarAccount](#CalendarAccount)): Promise<[C
...
@@ -67,13 +67,13 @@ createCalendar(calendarAccount: [CalendarAccount](#CalendarAccount)): Promise<[C
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| --------------- | ----------------------------------- | ---- | -------------- |
| --------------- | ----------------------------------- | ---- | -------------- |
| calendarAccount |
[
CalendarAccount
](
#
CalendarA
ccount
)
| 是 | 账户信息实例。 |
| calendarAccount |
[
CalendarAccount
](
#
calendara
ccount
)
| 是 | 账户信息实例。 |
**返回值**
:
**返回值**
:
| 类型 | 说明 |
| 类型 | 说明 |
| ------------------------------ | -------------- |
| ------------------------------ | -------------- |
| Promise
<
[
Calendar
](
#
C
alendar
)
>
| 返回账户实例。 |
| Promise
<
[
Calendar
](
#
c
alendar
)
>
| 返回账户实例。 |
**错误码:**
**错误码:**
...
@@ -97,7 +97,7 @@ calendarManager.createCalendar({ name: 'MyCalendar', type: calendarManager.Calen
...
@@ -97,7 +97,7 @@ calendarManager.createCalendar({ name: 'MyCalendar', type: calendarManager.Calen
## calendarManager.deleteCalendar
## calendarManager.deleteCalendar
deleteCalendar(calendar:
[
Calendar
](
#
C
alendar
)
, callback: AsyncCallback
<void>
): void
deleteCalendar(calendar:
[
Calendar
](
#
c
alendar
)
, callback: AsyncCallback
<void>
): void
删除账户,使用回调的方式实现异步调用。
删除账户,使用回调的方式实现异步调用。
...
@@ -109,7 +109,7 @@ deleteCalendar(calendar: [Calendar](#Calendar), callback: AsyncCallback<void>):
...
@@ -109,7 +109,7 @@ deleteCalendar(calendar: [Calendar](#Calendar), callback: AsyncCallback<void>):
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------- | ---- | ---------- |
| -------- | --------------------- | ---- | ---------- |
| calendar |
[
Calendar
](
#
C
alendar
)
| 是 | 账户实例。 |
| calendar |
[
Calendar
](
#
c
alendar
)
| 是 | 账户实例。 |
| callback | AsyncCallback
<void>
| 是 | 异步回调。 |
| callback | AsyncCallback
<void>
| 是 | 异步回调。 |
**错误码:**
**错误码:**
...
@@ -137,7 +137,7 @@ calendarManager.deleteCalendar(calendar, (err, data) => {
...
@@ -137,7 +137,7 @@ calendarManager.deleteCalendar(calendar, (err, data) => {
## calendarManager.deleteCalendar
## calendarManager.deleteCalendar
deleteCalendar(calendar:
[
Calendar
](
#
C
alendar
)
): Promise
<void>
deleteCalendar(calendar:
[
Calendar
](
#
c
alendar
)
): Promise
<void>
删除账户,使用Promise方式实现异步调用。
删除账户,使用Promise方式实现异步调用。
...
@@ -149,7 +149,7 @@ deleteCalendar(calendar: [Calendar](#Calendar)): Promise<void>
...
@@ -149,7 +149,7 @@ deleteCalendar(calendar: [Calendar](#Calendar)): Promise<void>
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------- | ---- | ---------- |
| -------- | --------------------- | ---- | ---------- |
| calendar |
[
Calendar
](
#
C
alendar
)
| 是 | 账户实例。 |
| calendar |
[
Calendar
](
#
c
alendar
)
| 是 | 账户实例。 |
**返回值**
:
**返回值**
:
...
@@ -180,7 +180,7 @@ calendarManager.deleteCalendar(calendar).then((data) => {
...
@@ -180,7 +180,7 @@ calendarManager.deleteCalendar(calendar).then((data) => {
## calendarManager.getCalendar
## calendarManager.getCalendar
getCalendar(callback: AsyncCallback
<
[
Calendar
](
#
C
alendar
)
>
): void
getCalendar(callback: AsyncCallback
<
[
Calendar
](
#
c
alendar
)
>
): void
获取默认账户,使用回调的方式实现异步调用。
获取默认账户,使用回调的方式实现异步调用。
...
@@ -192,7 +192,7 @@ getCalendar(callback: AsyncCallback<[Calendar](#Calendar)>): void
...
@@ -192,7 +192,7 @@ getCalendar(callback: AsyncCallback<[Calendar](#Calendar)>): void
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------ | ---- | ------------------------------ |
| -------- | ------------------------------------ | ---- | ------------------------------ |
| callback | AsyncCallback
<
[
C
alendar
](
#Calendar
)
>
| 是 | 异步回调,返回查询的账户实例。 |
| callback | AsyncCallback
<
[
c
alendar
](
#Calendar
)
>
| 是 | 异步回调,返回查询的账户实例。 |
**错误码:**
**错误码:**
...
@@ -218,7 +218,7 @@ calendarManager.getCalendar((err, data) => {
...
@@ -218,7 +218,7 @@ calendarManager.getCalendar((err, data) => {
## calendarManager.getCalendar
## calendarManager.getCalendar
getCalendar(calendarAccount:
[
CalendarAccount
](
#
CalendarAccount
)
,callback: AsyncCallback
<
[
Calendar
](
#C
alendar
)
>
): void
getCalendar(calendarAccount:
[
CalendarAccount
](
#
calendaraccount
)
,callback: AsyncCallback
<
[
Calendar
](
#c
alendar
)
>
): void
获取指定账户,使用回调的方式实现异步调用。
获取指定账户,使用回调的方式实现异步调用。
...
@@ -230,8 +230,8 @@ getCalendar(calendarAccount: [CalendarAccount](#CalendarAccount),callback: Asy
...
@@ -230,8 +230,8 @@ getCalendar(calendarAccount: [CalendarAccount](#CalendarAccount),callback: Asy
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| --------------- | ------------------------------------ | ---- | ------------------------------ |
| --------------- | ------------------------------------ | ---- | ------------------------------ |
| calendarAccount |
[
CalendarAccount
](
#
CalendarA
ccount
)
| 是 | 账户信息实例 |
| calendarAccount |
[
CalendarAccount
](
#
calendara
ccount
)
| 是 | 账户信息实例 |
| callback | AsyncCallback
<
[
Calendar
](
#
C
alendar
)
>
| 是 | 异步回调,返回查询的账户实例。 |
| callback | AsyncCallback
<
[
Calendar
](
#
c
alendar
)
>
| 是 | 异步回调,返回查询的账户实例。 |
**错误码:**
**错误码:**
...
@@ -257,7 +257,7 @@ calendarManager.getCalendar({ name: 'MyCalendar', type: calendarManager.Calendar
...
@@ -257,7 +257,7 @@ calendarManager.getCalendar({ name: 'MyCalendar', type: calendarManager.Calendar
## calendarManager.getCalendar
## calendarManager.getCalendar
getCalendar(calendarAccount?:
[
CalendarAccount
](
#
CalendarAccount
)
): Promise
<
[
Calendar
](
#C
alendar
)
>
getCalendar(calendarAccount?:
[
CalendarAccount
](
#
calendarAccount
)
): Promise
<
[
Calendar
](
#c
alendar
)
>
获取账户,使用Promise的方式实现异步调用。
获取账户,使用Promise的方式实现异步调用。
...
@@ -269,13 +269,13 @@ getCalendar(calendarAccount?: [CalendarAccount](#CalendarAccount)): Promise<[Cal
...
@@ -269,13 +269,13 @@ getCalendar(calendarAccount?: [CalendarAccount](#CalendarAccount)): Promise<[Cal
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| --------------- | ----------------------------------- | ---- | ------------ |
| --------------- | ----------------------------------- | ---- | ------------ |
| calendarAccount |
[
CalendarAccount
](
#
CalendarA
ccount
)
| 否 | 账户信息实例 |
| calendarAccount |
[
CalendarAccount
](
#
calendara
ccount
)
| 否 | 账户信息实例 |
**返回值**
:
**返回值**
:
| 类型 | 说明 |
| 类型 | 说明 |
| ------------------------------ | -------------------- |
| ------------------------------ | -------------------- |
| Promise
<
[
Calendar
](
#
C
alendar
)
>
| 返回查询的账户实例。 |
| Promise
<
[
Calendar
](
#
c
alendar
)
>
| 返回查询的账户实例。 |
**错误码:**
**错误码:**
...
@@ -300,7 +300,7 @@ calendarManager.getCalendar().then((data) => {
...
@@ -300,7 +300,7 @@ calendarManager.getCalendar().then((data) => {
## calendarManager.getAllCalendars
## calendarManager.getAllCalendars
getAllCalendars(callback: AsyncCallback
<
[
Calendar
](
#
C
alendar
)[]
>
): void
getAllCalendars(callback: AsyncCallback
<
[
Calendar
](
#
c
alendar
)[]
>
): void
获取当前应用所有创建的账户以及默认账户,使用回调的方式实现异步调用。
获取当前应用所有创建的账户以及默认账户,使用回调的方式实现异步调用。
...
@@ -312,7 +312,7 @@ getAllCalendars(callback: AsyncCallback<[Calendar](#Calendar)[]>): void
...
@@ -312,7 +312,7 @@ getAllCalendars(callback: AsyncCallback<[Calendar](#Calendar)[]>): void
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------- | ---- | ----------------------------------- |
| -------- | -------------------------------------- | ---- | ----------------------------------- |
| callback | AsyncCallback
<
[
Calendar
](
#
C
alendar
)[]
>
| 是 | 异步回调, 返回查询的账户实例数组。 |
| callback | AsyncCallback
<
[
Calendar
](
#
c
alendar
)[]
>
| 是 | 异步回调, 返回查询的账户实例数组。 |
**错误码:**
**错误码:**
...
@@ -338,7 +338,7 @@ calendarManager.getAllCalendars((err, data) => {
...
@@ -338,7 +338,7 @@ calendarManager.getAllCalendars((err, data) => {
## calendarManager.getAllCalendars
## calendarManager.getAllCalendars
getAllCalendars(): Promise
<
[
Calendar
](
#
C
alendar
)[]
>
getAllCalendars(): Promise
<
[
Calendar
](
#
c
alendar
)[]
>
获取当前应用所有创建的账户以及默认账户,使用Promise方式实现异步调用。
获取当前应用所有创建的账户以及默认账户,使用Promise方式实现异步调用。
...
@@ -350,7 +350,7 @@ getAllCalendars(): Promise<[Calendar](#Calendar)[]>
...
@@ -350,7 +350,7 @@ getAllCalendars(): Promise<[Calendar](#Calendar)[]>
| 类型 | 说明 |
| 类型 | 说明 |
| -------------------------------- | ------------------------ |
| -------------------------------- | ------------------------ |
| Promise
<
[
Calendar
](
#
C
alendar
)[]
>
| 返回查询的账户实例数组。 |
| Promise
<
[
Calendar
](
#
c
alendar
)[]
>
| 返回查询的账户实例数组。 |
**错误码:**
**错误码:**
...
@@ -384,7 +384,7 @@ calendarManager.getAllCalendars().then((data) => {
...
@@ -384,7 +384,7 @@ calendarManager.getAllCalendars().then((data) => {
### addEvent
### addEvent
addEvent(event:
[
Event
](
#
E
vent
)
, callback: AsyncCallback
<number>
): void
addEvent(event:
[
Event
](
#
e
vent
)
, callback: AsyncCallback
<number>
): void
创建日程,使用回调的方式实现异步调用。
创建日程,使用回调的方式实现异步调用。
...
@@ -394,7 +394,7 @@ addEvent(event: [Event](#Event), callback: AsyncCallback<number>): void
...
@@ -394,7 +394,7 @@ addEvent(event: [Event](#Event), callback: AsyncCallback<number>): void
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------- | ---- | ---------------------- |
| -------- | --------------------- | ---- | ---------------------- |
| event |
[
Event
](
#
E
vent
)
| 是 | 日程具体参数实例。 |
| event |
[
Event
](
#
e
vent
)
| 是 | 日程具体参数实例。 |
| callback | AsyncCallback
<number>
| 是 | 异步回调,返回日程id。 |
| callback | AsyncCallback
<number>
| 是 | 异步回调,返回日程id。 |
**示例**
:
**示例**
:
...
@@ -420,7 +420,7 @@ calendar.addEvent(event, (err, data) => {
...
@@ -420,7 +420,7 @@ calendar.addEvent(event, (err, data) => {
### addEvent
### addEvent
addEvent(event:
[
Event
](
#
E
vent
)
): Promise
<number>
addEvent(event:
[
Event
](
#
e
vent
)
): Promise
<number>
创建日程,使用Promise方式实现异步调用。
创建日程,使用Promise方式实现异步调用。
...
@@ -430,7 +430,7 @@ addEvent(event: [Event](#Event)): Promise<number>
...
@@ -430,7 +430,7 @@ addEvent(event: [Event](#Event)): Promise<number>
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | --------------- | ---- | ------------------ |
| ------ | --------------- | ---- | ------------------ |
| event |
[
Event
](
#
E
vent
)
| 是 | 日程具体参数实例。 |
| event |
[
Event
](
#
e
vent
)
| 是 | 日程具体参数实例。 |
**返回值**
:
**返回值**
:
...
@@ -459,7 +459,7 @@ calendar.addEvent(event).then((data) => {
...
@@ -459,7 +459,7 @@ calendar.addEvent(event).then((data) => {
### addEvents
### addEvents
addEvents(events:
[
Event
](
#
E
vent
)[]
, callback: AsyncCallback
<void>
): void
addEvents(events:
[
Event
](
#
e
vent
)[]
, callback: AsyncCallback
<void>
): void
批量创建日程,使用回调的方式实现异步调用。
批量创建日程,使用回调的方式实现异步调用。
...
@@ -469,7 +469,7 @@ addEvents(events: [Event](#Event)[], callback: AsyncCallback<void>): void
...
@@ -469,7 +469,7 @@ addEvents(events: [Event](#Event)[], callback: AsyncCallback<void>): void
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------- | ---- | ---------------------- |
| -------- | ------------------- | ---- | ---------------------- |
| events |
[
Event
](
#
E
vent
)[]
| 是 | 日程具体参数实例数组。 |
| events |
[
Event
](
#
e
vent
)[]
| 是 | 日程具体参数实例数组。 |
| callback | AsyncCallback
<void>
| 是 | 异步回调。 |
| callback | AsyncCallback
<void>
| 是 | 异步回调。 |
**示例**
:
**示例**
:
...
@@ -502,7 +502,7 @@ calendar.addEvents(events, (err, data) => {
...
@@ -502,7 +502,7 @@ calendar.addEvents(events, (err, data) => {
### addEvents
### addEvents
addEvents(events:
[
Event
](
#
E
vent
)[]
): Promise
<void>
addEvents(events:
[
Event
](
#
e
vent
)[]
): Promise
<void>
批量创建日程,使用Promise方式实现异步调用。
批量创建日程,使用Promise方式实现异步调用。
...
@@ -512,7 +512,7 @@ addEvents(events: [Event](#Event)[]): Promise<void>
...
@@ -512,7 +512,7 @@ addEvents(events: [Event](#Event)[]): Promise<void>
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ----------------- | ---- | ---------------------- |
| ------ | ----------------- | ---- | ---------------------- |
| events |
[
Event
](
#
E
vent
)[]
| 是 | 日程具体参数实例数组。 |
| events |
[
Event
](
#
e
vent
)[]
| 是 | 日程具体参数实例数组。 |
**返回值**
:
**返回值**
:
...
@@ -674,7 +674,7 @@ calendar.deleteEvents([1, 2]).then(() => {
...
@@ -674,7 +674,7 @@ calendar.deleteEvents([1, 2]).then(() => {
### updateEvent
### updateEvent
updateEvent(event:
[
Event
](
#
E
vent
)
, callback: AsyncCallback
<void>
): void
updateEvent(event:
[
Event
](
#
e
vent
)
, callback: AsyncCallback
<void>
): void
更新日程,使用回调的方式实现异步调用。
更新日程,使用回调的方式实现异步调用。
...
@@ -684,7 +684,7 @@ updateEvent(event: [Event](#Event), callback: AsyncCallback<void>): void
...
@@ -684,7 +684,7 @@ updateEvent(event: [Event](#Event), callback: AsyncCallback<void>): void
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------- | ---- | ------------------ |
| -------- | ------------------- | ---- | ------------------ |
| event |
[
Event
](
#
E
vent
)
| 是 | 日程具体参数示例。 |
| event |
[
Event
](
#
e
vent
)
| 是 | 日程具体参数示例。 |
| callback | AsyncCallback
<void>
| 是 | 异步回调。 |
| callback | AsyncCallback
<void>
| 是 | 异步回调。 |
**示例**
:
**示例**
:
...
@@ -712,7 +712,7 @@ calendar.updateEvent(event, (err, data) => {
...
@@ -712,7 +712,7 @@ calendar.updateEvent(event, (err, data) => {
### updateEvent
### updateEvent
updateEvent(event:
[
Event
](
#
E
vent
)
): Promise
<void>
updateEvent(event:
[
Event
](
#
e
vent
)
): Promise
<void>
更新日程,使用Promise方式实现异步调用。
更新日程,使用Promise方式实现异步调用。
...
@@ -722,7 +722,7 @@ updateEvent(event: [Event](#Event)): Promise<void>
...
@@ -722,7 +722,7 @@ updateEvent(event: [Event](#Event)): Promise<void>
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | --------------- | ---- | ------------------ |
| ------ | --------------- | ---- | ------------------ |
| event |
[
Event
](
#
E
vent
)
| 是 | 日程具体参数示例。 |
| event |
[
Event
](
#
e
vent
)
| 是 | 日程具体参数示例。 |
**返回值**
:
**返回值**
:
...
@@ -753,7 +753,7 @@ calendar.updateEvent(event).then(() => {
...
@@ -753,7 +753,7 @@ calendar.updateEvent(event).then(() => {
### getEvents
### getEvents
getEvents(callback: AsyncCallback
<
[
Event
](
#
E
vent
)[]
>
): void
getEvents(callback: AsyncCallback
<
[
Event
](
#
e
vent
)[]
>
): void
查询账户下所有日程,使用回调的方式实现异步调用。
查询账户下所有日程,使用回调的方式实现异步调用。
...
@@ -763,7 +763,7 @@ getEvents(callback: AsyncCallback<[Event](#Event)[]>): void
...
@@ -763,7 +763,7 @@ getEvents(callback: AsyncCallback<[Event](#Event)[]>): void
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------- | ---- | -------------------------------- |
| -------- | -------------------------------- | ---- | -------------------------------- |
| callback | AsyncCallback
<
[
Event
](
#
E
vent
)[]
>
| 是 | 异步回调,返回的是日程实例数组。 |
| callback | AsyncCallback
<
[
Event
](
#
e
vent
)[]
>
| 是 | 异步回调,返回的是日程实例数组。 |
**示例**
:
**示例**
:
...
@@ -782,7 +782,7 @@ calendar.getEvents((err, data) => {
...
@@ -782,7 +782,7 @@ calendar.getEvents((err, data) => {
### getEvents
### getEvents
getEvents(eventFilter:
[
EventFilter
](
#
EventFilter
)
, eventKey: (keyof
[
Event
](
#Event
)
)
[
], callback: AsyncCallback<[Event
](
#E
vent
)[]
>):void
getEvents(eventFilter:
[
EventFilter
](
#
eventfilter
)
, eventKey: (keyof
[
Event
](
#event
)
)
[
], callback: AsyncCallback<[Event
](
#e
vent
)[]
>):void
查询账户下符合条件的日程,使用回调的方式实现异步调用。
查询账户下符合条件的日程,使用回调的方式实现异步调用。
...
@@ -792,9 +792,9 @@ getEvents(eventFilter: [EventFilter](#EventFilter), eventKey: (keyof [Event](#Ev
...
@@ -792,9 +792,9 @@ getEvents(eventFilter: [EventFilter](#EventFilter), eventKey: (keyof [Event](#Ev
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | -------------------------------- | ---- | -------------------------------- |
| ----------- | -------------------------------- | ---- | -------------------------------- |
| eventFilter |
[
EventFilter
](
#
EventF
ilter
)
| 是 | 查询条件 |
| eventFilter |
[
EventFilter
](
#
eventf
ilter
)
| 是 | 查询条件 |
| eventKey | (keyof
[
Event
](
#
E
vent
)
)[] | 是 | 查询结果集 |
| eventKey | (keyof
[
Event
](
#
e
vent
)
)[] | 是 | 查询结果集 |
| callback | AsyncCallback
<
[
Event
](
#
E
vent
)[]
>
| 是 | 异步回调,返回的是日程实例数组。 |
| callback | AsyncCallback
<
[
Event
](
#
e
vent
)[]
>
| 是 | 异步回调,返回的是日程实例数组。 |
**示例**
:
**示例**
:
...
@@ -815,7 +815,7 @@ calendar.getEvents(filter, columns, (err, data) => {
...
@@ -815,7 +815,7 @@ calendar.getEvents(filter, columns, (err, data) => {
### getEvents
### getEvents
getEvents(eventFilter?:
[
EventFilter
](
#
EventFilter
)
, eventKey?: (keyof
[
Event
](
#Event
)
)
[
]): Promise<[Event
](
#E
vent
)[]
>
getEvents(eventFilter?:
[
EventFilter
](
#
eventfilter
)
, eventKey?: (keyof
[
Event
](
#event
)
)
[
]): Promise<[Event
](
#e
vent
)[]
>
查询账户下符合条件的日程,使用Promise方式实现异步调用。
查询账户下符合条件的日程,使用Promise方式实现异步调用。
...
@@ -825,14 +825,14 @@ getEvents(eventFilter?: [EventFilter](#EventFilter), eventKey?: (keyof [Event](#
...
@@ -825,14 +825,14 @@ getEvents(eventFilter?: [EventFilter](#EventFilter), eventKey?: (keyof [Event](#
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | --------------------------- | ---- | ---------- |
| ----------- | --------------------------- | ---- | ---------- |
| eventFilter |
[
EventFilter
](
#
EventF
ilter
)
| 否 | 查询条件 |
| eventFilter |
[
EventFilter
](
#
eventf
ilter
)
| 否 | 查询条件 |
| eventKey | (keyof
[
Event
](
#
E
vent
)
)[] | 否 | 查询结果集 |
| eventKey | (keyof
[
Event
](
#
e
vent
)
)[] | 否 | 查询结果集 |
**返回值**
:
**返回值**
:
| 类型 | 说明 |
| 类型 | 说明 |
| -------------------------- | ------------------ |
| -------------------------- | ------------------ |
| Promise
<
[
Event
](
#
E
vent
)[]
>
| 返回日程实例数组。 |
| Promise
<
[
Event
](
#
e
vent
)[]
>
| 返回日程实例数组。 |
**示例**
:
**示例**
:
...
@@ -850,7 +850,7 @@ calendar.getEvents(filter).then((data) => {
...
@@ -850,7 +850,7 @@ calendar.getEvents(filter).then((data) => {
### getConfig
### getConfig
getConfig():
[
CalendarConfig
](
#
CalendarC
onfig
)
getConfig():
[
CalendarConfig
](
#
calendarc
onfig
)
获取账户具体参数。
获取账户具体参数。
...
@@ -860,7 +860,7 @@ getConfig(): [CalendarConfig](#CalendarConfig)
...
@@ -860,7 +860,7 @@ getConfig(): [CalendarConfig](#CalendarConfig)
| 类型 | 说明 |
| 类型 | 说明 |
| --------------------------------- | ------------------ |
| --------------------------------- | ------------------ |
|
[
CalendarConfig
](
#
CalendarC
onfig
)
| 返回账户参数实例。 |
|
[
CalendarConfig
](
#
calendarc
onfig
)
| 返回账户参数实例。 |
**示例**
:
**示例**
:
...
@@ -874,7 +874,7 @@ console.log("get config success");
...
@@ -874,7 +874,7 @@ console.log("get config success");
### setConfig
### setConfig
setConfig(config:
[
CalendarConfig
](
#
CalendarC
onfig
)
, callback: AsyncCallback
<void>
): void
setConfig(config:
[
CalendarConfig
](
#
calendarc
onfig
)
, callback: AsyncCallback
<void>
): void
设置账户参数,使用回调的方式实现异步调用。
设置账户参数,使用回调的方式实现异步调用。
...
@@ -884,7 +884,7 @@ setConfig(config: [CalendarConfig](#CalendarConfig), callback: AsyncCallback<voi
...
@@ -884,7 +884,7 @@ setConfig(config: [CalendarConfig](#CalendarConfig), callback: AsyncCallback<voi
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------- | ---- | ---------------- |
| -------- | --------------------------------- | ---- | ---------------- |
| config |
[
CalendarConfig
](
#
CalendarC
onfig
)
| 是 | 账户具体参数实例 |
| config |
[
CalendarConfig
](
#
calendarc
onfig
)
| 是 | 账户具体参数实例 |
| callback | AsyncCallback
<void>
| 是 | 异步回调。 |
| callback | AsyncCallback
<void>
| 是 | 异步回调。 |
**示例**
:
**示例**
:
...
@@ -907,7 +907,7 @@ calendar.setConfig(config, (err, data) => {
...
@@ -907,7 +907,7 @@ calendar.setConfig(config, (err, data) => {
### setConfig
### setConfig
setConfig(config:
[
CalendarConfig
](
#
CalendarC
onfig
)
): Promise
<void>
setConfig(config:
[
CalendarConfig
](
#
calendarc
onfig
)
): Promise
<void>
设置账户参数,使用Promise方式实现异步调用。
设置账户参数,使用Promise方式实现异步调用。
...
@@ -917,7 +917,7 @@ setConfig(config: [CalendarConfig](#CalendarConfig)): Promise<void>
...
@@ -917,7 +917,7 @@ setConfig(config: [CalendarConfig](#CalendarConfig)): Promise<void>
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | --------------------------------- | ---- | ---------------- |
| ------ | --------------------------------- | ---- | ---------------- |
| config |
[
CalendarConfig
](
#
CalendarC
onfig
)
| 是 | 账户具体参数实例 |
| config |
[
CalendarConfig
](
#
calendarc
onfig
)
| 是 | 账户具体参数实例 |
**返回值**
:
**返回值**
:
...
@@ -943,7 +943,7 @@ calendar.setConfig(config).then(() => {
...
@@ -943,7 +943,7 @@ calendar.setConfig(config).then(() => {
### getAccount
### getAccount
getAccount():
[
CalendarAccount
](
#
CalendarA
ccount
)
getAccount():
[
CalendarAccount
](
#
calendara
ccount
)
获取账户信息。
获取账户信息。
...
@@ -953,7 +953,7 @@ getAccount(): [CalendarAccount](#CalendarAccount)
...
@@ -953,7 +953,7 @@ getAccount(): [CalendarAccount](#CalendarAccount)
| 类型 | 说明 |
| 类型 | 说明 |
| ----------------------------------- | ------------------ |
| ----------------------------------- | ------------------ |
|
[
CalendarAccount
](
#
CalendarA
ccount
)
| 返回账户信息实例。 |
|
[
CalendarAccount
](
#
calendara
ccount
)
| 返回账户信息实例。 |
**示例**
:
**示例**
:
...
@@ -974,7 +974,7 @@ console.log("get account success");
...
@@ -974,7 +974,7 @@ console.log("get account success");
| 名称 | 类型 | 只读 | 必填 | 说明 |
| 名称 | 类型 | 只读 | 必填 | 说明 |
| ----------- | ----------------------------- | ---- | ---- | -------------- |
| ----------- | ----------------------------- | ---- | ---- | -------------- |
| name | string | 是 | 是 | 账户名称 |
| name | string | 是 | 是 | 账户名称 |
| type |
[
CalendarType
](
#
CalendarT
ype
)
| 否 | 是 | 账户类型 |
| type |
[
CalendarType
](
#
calendart
ype
)
| 否 | 是 | 账户类型 |
| displayName | string | 否 | 否 | 账户的显示名称 |
| displayName | string | 否 | 否 | 账户的显示名称 |
## CalendarConfig
## CalendarConfig
...
@@ -997,18 +997,18 @@ console.log("get account success");
...
@@ -997,18 +997,18 @@ console.log("get account success");
| 名称 | 类型 | 只读 | 必填 | 说明 |
| 名称 | 类型 | 只读 | 必填 | 说明 |
| -------------- | --------------------------------- | ---- | ---- | -------------- |
| -------------- | --------------------------------- | ---- | ---- | -------------- |
| id | number | 是 | 否 | 日程id |
| id | number | 是 | 否 | 日程id |
| type |
[
EventType
](
#
EventT
ype
)
| 否 | 是 | 日程类型 |
| type |
[
EventType
](
#
eventt
ype
)
| 否 | 是 | 日程类型 |
| title | string | 否 | 否 | 日程标题 |
| title | string | 否 | 否 | 日程标题 |
| location |
[
Location
](
#
L
ocation
)
| 否 | 否 | 日程地点 |
| location |
[
Location
](
#
l
ocation
)
| 否 | 否 | 日程地点 |
| startTimer | number | 否 | 是 | 日程开始时间 |
| startTimer | number | 否 | 是 | 日程开始时间 |
| endTimer | number | 否 | 是 | 日程结束时间 |
| endTimer | number | 否 | 是 | 日程结束时间 |
| isAllDay | boolean | 否 | 否 | 是否为全天日程 |
| isAllDay | boolean | 否 | 否 | 是否为全天日程 |
| attendee |
[
Attendee
](
#
A
ttendee
)[]
| 否 | 否 | 日程参与者 |
| attendee |
[
Attendee
](
#
a
ttendee
)[]
| 否 | 否 | 日程参与者 |
| timeZone | string | 否 | 否 | 日程时区 |
| timeZone | string | 否 | 否 | 日程时区 |
| reminderTime | number[] | 否 | 否 | 日程提醒时间 |
| reminderTime | number[] | 否 | 否 | 日程提醒时间 |
| recurrenceRule |
[
RecurrenceRule
](
#
RecurrenceR
ule
)
| 否 | 否 | 日程重复规则 |
| recurrenceRule |
[
RecurrenceRule
](
#
recurrencer
ule
)
| 否 | 否 | 日程重复规则 |
| description | string | 否 | 否 | 日程描述 |
| description | string | 否 | 否 | 日程描述 |
| service |
[
EventService
](
#
EventS
ervice
)
| 否 | 否 | 日程服务 |
| service |
[
EventService
](
#
events
ervice
)
| 否 | 否 | 日程服务 |
## CalendarType
## CalendarType
...
@@ -1040,7 +1040,7 @@ console.log("get account success");
...
@@ -1040,7 +1040,7 @@ console.log("get account success");
### filterById
### filterById
filterById(ids: number
[
]): [EventFilter
](
#
EventF
ilter
)
filterById(ids: number
[
]): [EventFilter
](
#
eventf
ilter
)
根据日程id进行过滤
根据日程id进行过滤
...
@@ -1056,7 +1056,7 @@ filterById(ids: number[]): [EventFilter](#EventFilter)
...
@@ -1056,7 +1056,7 @@ filterById(ids: number[]): [EventFilter](#EventFilter)
| 类型 | 说明 |
| 类型 | 说明 |
| --------------------------- | ---------------------- |
| --------------------------- | ---------------------- |
|
[
EventFilter
](
#
EventF
ilter
)
| 返回日程过滤实例对象。 |
|
[
EventFilter
](
#
eventf
ilter
)
| 返回日程过滤实例对象。 |
**示例**
:
**示例**
:
...
@@ -1074,7 +1074,7 @@ calendar.getEvents(filter).then((data) => {
...
@@ -1074,7 +1074,7 @@ calendar.getEvents(filter).then((data) => {
### filterByTime
### filterByTime
filterByTime(start: number, end: number):
[
EventFilter
](
#
EventF
ilter
)
filterByTime(start: number, end: number):
[
EventFilter
](
#
eventf
ilter
)
根据日程时间进行过滤
根据日程时间进行过滤
...
@@ -1091,7 +1091,7 @@ filterByTime(start: number, end: number): [EventFilter](#EventFilter)
...
@@ -1091,7 +1091,7 @@ filterByTime(start: number, end: number): [EventFilter](#EventFilter)
| 类型 | 说明 |
| 类型 | 说明 |
| --------------------------- | ---------------------- |
| --------------------------- | ---------------------- |
|
[
EventFilter
](
#
EventF
ilter
)
| 返回日程过滤实例对象。 |
|
[
EventFilter
](
#
eventf
ilter
)
| 返回日程过滤实例对象。 |
**示例**
:
**示例**
:
...
@@ -1109,7 +1109,7 @@ calendar.getEvents(filter).then((data) => {
...
@@ -1109,7 +1109,7 @@ calendar.getEvents(filter).then((data) => {
### filterByTitle
### filterByTitle
filterByTitle(title: string):
[
EventFilter
](
#
EventF
ilter
)
filterByTitle(title: string):
[
EventFilter
](
#
eventf
ilter
)
根据日程时间进行过滤
根据日程时间进行过滤
...
@@ -1125,7 +1125,7 @@ filterByTitle(title: string): [EventFilter](#EventFilter)
...
@@ -1125,7 +1125,7 @@ filterByTitle(title: string): [EventFilter](#EventFilter)
| 类型 | 说明 |
| 类型 | 说明 |
| --------------------------- | ---------------------- |
| --------------------------- | ---------------------- |
|
[
EventFilter
](
#
EventF
ilter
)
| 返回日程过滤实例对象。 |
|
[
EventFilter
](
#
eventf
ilter
)
| 返回日程过滤实例对象。 |
**示例**
:
**示例**
:
...
@@ -1160,7 +1160,7 @@ calendar.getEvents(filter).then(() => {
...
@@ -1160,7 +1160,7 @@ calendar.getEvents(filter).then(() => {
| 名称 | 类型 | 只读 | 必填 | 说明 |
| 名称 | 类型 | 只读 | 必填 | 说明 |
| ------------------- | ------------------------------------------- | ---- | ---- | ---------------- |
| ------------------- | ------------------------------------------- | ---- | ---- | ---------------- |
| recurrenceFrequency |
[
RecurrenceFrequency
](
#
RecurrenceF
requency
)
| 否 | 否 | 日程重复规则类型 |
| recurrenceFrequency |
[
RecurrenceFrequency
](
#
recurrencef
requency
)
| 否 | 否 | 日程重复规则类型 |
| expire | number | 否 | 否 | 日程过期时间 |
| expire | number | 否 | 否 | 日程过期时间 |
## RecurrenceFrequency
## RecurrenceFrequency
...
@@ -1195,7 +1195,7 @@ calendar.getEvents(filter).then(() => {
...
@@ -1195,7 +1195,7 @@ calendar.getEvents(filter).then(() => {
| 名称 | 类型 | 只读 | 必填 | 说明 |
| 名称 | 类型 | 只读 | 必填 | 说明 |
| ----------- | --------------------------- | ---- | ---- | ---------- |
| ----------- | --------------------------- | ---- | ---- | ---------- |
| type |
[
ServiceType
](
#
ServiceT
ype
)
| 否 | 是 | 服务类型 |
| type |
[
ServiceType
](
#
servicet
ype
)
| 否 | 是 | 服务类型 |
| uri | string | 否 | 是 | 服务的uri |
| uri | string | 否 | 是 | 服务的uri |
| description | string | 否 | 否 | 服务的描述 |
| description | string | 否 | 否 | 服务的描述 |
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录