Calendar
Last updated: 2024-11-21 18:48:11
addPhoneCalendar
This API is used via wx.addPhoneCalendar(Object object)
Feature Description: Adds events into the system calendar.
Parameter and Description: Object.
Attribute | Type | Default value | Required | Description |
title | string | - | Yes | Calendar Event Title |
startTime | number | - | Yes | Unix timestamp of the start time |
allDay | boolean | - | No | Whether it is an all-day event, which defaults to "false". |
description | string | - | No | Event Description |
location | string | - | No | Event Location |
endTime | string | - | No | Unix timestamp of the end time |
alarm | boolean | - | No | Whether to send a reminder, which defaults to "true". |
alarmOffset | number | - | No | Reminder lead time, in seconds. The default value is 0, indicating a reminder at the start of the event. |
success | function | - | No | Callback Function of Successful Interface Call |
fail | function | - | No | Callback Function of Failing Interface Call |
complete | function | - | No | Callback function executed upon the completion of the interface invocation (both successful and unsuccessful invocations) |
addPhoneRepeatCalendar
This API is used via wx.addPhoneRepeatCalendar(Object object)
Feature Description: Adds recurring events into the system calendar.
Parameter and Description: Object.
Attribute | Type | Default value | Required | Description |
title | string | - | Yes | Calendar Event Title |
startTime | number | - | Yes | Unix timestamp of the start time (number of seconds elapsed since January 1, 1970) |
allDay | boolean | - | No | Whether it is an all-day event, which defaults to "false". |
description | string | - | No | Event Description |
location | string | - | No | Event Location |
endTime | string | - | No | Unix timestamp of the end time |
alarm | boolean | - | No | Whether to send a reminder, which defaults to "true". |
alarmOffset | number | - | No | Reminder lead time, in seconds. The default value is 0, indicating a reminder at the start of the event. |
repeatInterval | string | - | No | Repetition cycle, defaulting to 'month' for monthly repetition |
repeatEndTime | number | - | No | Unix timestamp for the end of the repetition cycle. If left blank, it implies indefinite repetition. |
success | function | - | No | Callback Function of Successful Interface Call |
fail | function | - | No | Callback Function of Failing Interface Call |
complete | function | - | No | Callback function executed upon the completion of the interface invocation (both successful and unsuccessful invocations) |
repeatInterval
Valid Values | Description |
day | Recurring day by day |
week | Recurring week by week |
month | Recurring month by month. Under this mode, the date should not exceed the 28th day. |
year | Recurring year by year |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No
Feedback