Recurrence

The Recurrence object is used to represent the repetition rules for an appointment or a task.

Supported Platform(s)

- BlackBerry OS 5.0+
- Ripple Emulator

View Supported Platform Table

APIOS 5.0OS 6.0OS 7.0PlayBookRipple
blackberry.pim.Recurrence Y Y Y  Y
count Y Y Y  Y
dayInMonth Y Y Y  Y
dayInWeek Y Y Y  Y
dayInYear Y Y Y  Y
end Y Y Y  Y
frequency Y Y Y  Y
interval Y Y Y  Y
monthInYear Y Y Y  Y
weekInMonth Y Y Y  Y
NO_REPEAT Y Y Y  Y
DAILY Y Y Y  Y
WEEKLY Y Y Y  Y
MONTHLY Y Y Y  Y
YEARLY Y Y Y  Y
JANUARY Y Y Y  Y
FEBRUARY Y Y Y  Y
MARCH Y Y Y  Y
APRIL Y Y Y  Y
MAY Y Y Y  Y
JUNE Y Y Y  Y
JULY Y Y Y  Y
AUGUST Y Y Y  Y
SEPTEMBER Y Y Y  Y
OCTOBER Y Y Y  Y
NOVEMBER Y Y Y  Y
DECEMBER Y Y Y  Y
FIRST Y Y Y  Y
SECOND Y Y Y  Y
THIRD Y Y Y  Y
FOURTH Y Y Y  Y
FIFTH Y Y Y  Y
LAST Y Y Y  Y
SECONDLAST Y Y Y  Y
THIRDLAST Y Y Y  Y
FOURTHLAST Y Y Y  Y
FIFTHLAST Y Y Y  Y
SUNDAY Y Y Y  Y
MONDAY Y Y Y  Y
TUESDAY Y Y Y  Y
WEDNESDAY Y Y Y  Y
THURSDAY Y Y Y  Y
FRIDAY Y Y Y  Y
SATURDAY Y Y Y  Y

Configuration Document Settings

To use all of the API described for this object, you must ensure the following settings are in your configuration document:


You must declare the feature element(s) below in your configuration document:

Feature IDOS 5.0OS 6.0OS 7.0PlayBookRipple
<feature id="blackberry.pim.Recurrence" /> Y Y Y  Y

Permission Elements (PlayBook Only)
This API does not require a <permission> element to be declared in the configuration document of your BlackBerry WebWorks Application.

blackberry.pim.Recurrence

blackberry.pim.Recurrence ()

Supported Platform(s)

 - BlackBerry OS 5.0+
 - Ripple Emulator

Description

Examples of this rule could be to setup an appointment on a weekly or monthly basis. The Recurrence object is an instance object, where if a new instance is desired, it must be created using the new keyword.



Code Example(s)

<script type="text/javascript">
  // Create our Event 
  var newAppt = new blackberry.pim.Appointment();
  newAppt.location = "Your office";
  newAppt.summary = "Talk about project";
  newAppt.freeBusy = 0; // Free

  // Create Recurrence
  newAppt.recurrence = new blackberry.pim.Recurrence();
  newAppt.recurrence.frequency = blackberry.pim.Recurrence.DAILY;
  newAppt.save();
</script>

Properties:

Property Type Description Supported Platform(s)
count Number Specifies the number of times this event repeats including the first time, starting from the first time the event starts (derived from the 'start' property of the event) and continuing to the last date of the repeat (defined by the 'end' property).
 - BlackBerry OS 5.0+
 - Ripple Emulator
dayInMonth Number Specifies the day of the month an event occurs. Value can be 1-31.
 - BlackBerry OS 5.0+
 - Ripple Emulator
dayInWeek Number Specifies the days of the week an event occurs. Value can be one of the 'DAY' constants.
 - BlackBerry OS 5.0+
 - Ripple Emulator
dayInYear Number Specifies the day of the year an event occurs. Value can be 1-366.
 - BlackBerry OS 5.0+
 - Ripple Emulator
end Date Specifies the date when the event repetition would end.
 - BlackBerry OS 5.0+
 - Ripple Emulator
frequency Number Specifies the frequency of the event repetition. Value can be:
 - BlackBerry OS 5.0+
 - Ripple Emulator
interval Number Specifies the number of iterations of the frequency between occurring dates, or how often the frequency repeats.
 - BlackBerry OS 5.0+
 - Ripple Emulator
monthInYear Number Specifies the month in which an event occurs. Value can be one of the 'MONTH' constants.
 - BlackBerry OS 5.0+
 - Ripple Emulator
weekInMonth Number Specifies which week in a month a particular event occurs. Value can be one of the 'WEEK' constants.
 - BlackBerry OS 5.0+
 - Ripple Emulator

Constants:

Property Type Description Supported Platform(s)
NO_REPEAT Number Indicates no recurrence
 - BlackBerry OS 5.0+
 - Ripple Emulator
DAILY Number Indicates repetition daily
 - BlackBerry OS 5.0+
 - Ripple Emulator
WEEKLY Number Indicates repetition weekly
 - BlackBerry OS 5.0+
 - Ripple Emulator
MONTHLY Number Indicates repetition monthly
 - BlackBerry OS 5.0+
 - Ripple Emulator
YEARLY Number Indicates repetition yearly
 - BlackBerry OS 5.0+
 - Ripple Emulator
JANUARY Number Constant representing the month of January
 - BlackBerry OS 5.0+
 - Ripple Emulator
FEBRUARY Number Constant representing the month of February
 - BlackBerry OS 5.0+
 - Ripple Emulator
MARCH Number Constant representing the month of March
 - BlackBerry OS 5.0+
 - Ripple Emulator
APRIL Number Constant representing the month of April
 - BlackBerry OS 5.0+
 - Ripple Emulator
MAY Number Constant representing the month of May
 - BlackBerry OS 5.0+
 - Ripple Emulator
JUNE Number Constant representing the month of June
 - BlackBerry OS 5.0+
 - Ripple Emulator
JULY Number Constant representing the month of July
 - BlackBerry OS 5.0+
 - Ripple Emulator
AUGUST Number Constant representing the month of August
 - BlackBerry OS 5.0+
 - Ripple Emulator
SEPTEMBER Number Constant representing the month of September
 - BlackBerry OS 5.0+
 - Ripple Emulator
OCTOBER Number Constant representing the month of October
 - BlackBerry OS 5.0+
 - Ripple Emulator
NOVEMBER Number Constant representing the month of November
 - BlackBerry OS 5.0+
 - Ripple Emulator
DECEMBER Number Constant representing the month of December
 - BlackBerry OS 5.0+
 - Ripple Emulator
FIRST Number Constant for the FIRST day of the week used with weekInMonth
 - BlackBerry OS 5.0+
 - Ripple Emulator
SECOND Number Constant for the SECOND day of the week used with weekInMonth
 - BlackBerry OS 5.0+
 - Ripple Emulator
THIRD Number Constant for the THIRD day of the week used with weekInMonth
 - BlackBerry OS 5.0+
 - Ripple Emulator
FOURTH Number Constant for the FOURTH day of the week used with weekInMonth
 - BlackBerry OS 5.0+
 - Ripple Emulator
FIFTH Number Constant for the FIFTH day of the week used with weekInMonth
 - BlackBerry OS 5.0+
 - Ripple Emulator
LAST Number Constant for the LAST day of the week used with weekInMonth
 - BlackBerry OS 5.0+
 - Ripple Emulator
SECONDLAST Number Constant for the SECONDLAST day of the week used with weekInMonth
 - BlackBerry OS 5.0+
 - Ripple Emulator
THIRDLAST Number Constant for the THIRDLAST day of the week used with weekInMonth
 - BlackBerry OS 5.0+
 - Ripple Emulator
FOURTHLAST Number Constant for the FOURTHLAST day of the week used with weekInMonth
 - BlackBerry OS 5.0+
 - Ripple Emulator
FIFTHLAST Number Constant for the FIFTHLAST day of the week used with weekInMonth
 - BlackBerry OS 5.0+
 - Ripple Emulator
SUNDAY Number Constant for SUNDAY used with dayInWeek
 - BlackBerry OS 5.0+
 - Ripple Emulator
MONDAY Number Constant for MONDAY used with dayInWeek
 - BlackBerry OS 5.0+
 - Ripple Emulator
TUESDAY Number Constant for TUESDAY used with dayInWeek
 - BlackBerry OS 5.0+
 - Ripple Emulator
WEDNESDAY Number Constant for WEDNESDAY used with dayInWeek
 - BlackBerry OS 5.0+
 - Ripple Emulator
THURSDAY Number Constant for THURSDAY used with dayInWeek
 - BlackBerry OS 5.0+
 - Ripple Emulator
FRIDAY Number Constant for FRIDAY used with dayInWeek
 - BlackBerry OS 5.0+
 - Ripple Emulator
SATURDAY Number Constant for SATURDAY used with dayInWeek
 - BlackBerry OS 5.0+
 - Ripple Emulator
Documentation generated by JsDoc Toolkit 2.4.0 on Sun Dec 30 2012 13:31:19 GMT-0500 (EST)