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
APIBB5.0BB6.0BB7.0PB1.0PB2.0BB10Ripple
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 IDBB5.0BB6.0BB7.0PB1.0PB2.0BB10Ripple
<feature id="blackberry.pim.Recurrence" /> Y Y Y      Y

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


Properties

Number count
Number dayInMonth
Number dayInWeek
Number dayInYear
Date end
Number frequency
Number interval
Number monthInYear
Number weekInMonth

Constants

Number NO_REPEAT
Number DAILY
Number WEEKLY
Number MONTHLY
Number YEARLY
Number JANUARY
Number FEBRUARY
Number MARCH
Number APRIL
Number MAY
Number JUNE
Number JULY
Number AUGUST
Number SEPTEMBER
Number OCTOBER
Number NOVEMBER
Number DECEMBER
Number FIRST
Number SECOND
Number THIRD
Number FOURTH
Number FIFTH
Number LAST
Number SECONDLAST
Number THIRDLAST
Number FOURTHLAST
Number FIFTHLAST
Number SUNDAY
Number MONDAY
Number TUESDAY
Number WEDNESDAY
Number THURSDAY
Number FRIDAY
Number SATURDAY

Constructors

blackberry.pim.Recurrence ()

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.


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator


Code Example:
<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

Number count


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).


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

Number dayInMonth


Specifies the day of the month an event occurs. Value can be 1-31.


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

Number dayInWeek


Specifies the days of the week an event occurs. Value can be one of the 'DAY' constants.


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

Number dayInYear


Specifies the day of the year an event occurs. Value can be 1-366.


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

Date end


Specifies the date when the event repetition would end.


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

Number frequency


Specifies the frequency of the event repetition. Value can be:


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

Number interval


Specifies the number of iterations of the frequency between occurring dates, or how often the frequency repeats.


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

Number monthInYear


Specifies the month in which an event occurs. Value can be one of the 'MONTH' constants.


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

Number weekInMonth


Specifies which week in a month a particular event occurs. Value can be one of the 'WEEK' constants.


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

Constants

static Number NO_REPEAT


Indicates no recurrence


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

static Number DAILY


Indicates repetition daily


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

static Number WEEKLY


Indicates repetition weekly


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

static Number MONTHLY


Indicates repetition monthly


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

static Number YEARLY


Indicates repetition yearly


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

static Number JANUARY


Constant representing the month of January


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

static Number FEBRUARY


Constant representing the month of February


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

static Number MARCH


Constant representing the month of March


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

static Number APRIL


Constant representing the month of April


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

static Number MAY


Constant representing the month of May


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

static Number JUNE


Constant representing the month of June


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

static Number JULY


Constant representing the month of July


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

static Number AUGUST


Constant representing the month of August


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

static Number SEPTEMBER


Constant representing the month of September


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

static Number OCTOBER


Constant representing the month of October


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

static Number NOVEMBER


Constant representing the month of November


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

static Number DECEMBER


Constant representing the month of December


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

static Number FIRST


Constant for the FIRST day of the week used with weekInMonth


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

static Number SECOND


Constant for the SECOND day of the week used with weekInMonth


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

static Number THIRD


Constant for the THIRD day of the week used with weekInMonth


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

static Number FOURTH


Constant for the FOURTH day of the week used with weekInMonth


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

static Number FIFTH


Constant for the FIFTH day of the week used with weekInMonth


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

static Number LAST


Constant for the LAST day of the week used with weekInMonth


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

static Number SECONDLAST


Constant for the SECONDLAST day of the week used with weekInMonth


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

static Number THIRDLAST


Constant for the THIRDLAST day of the week used with weekInMonth


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

static Number FOURTHLAST


Constant for the FOURTHLAST day of the week used with weekInMonth


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

static Number FIFTHLAST


Constant for the FIFTHLAST day of the week used with weekInMonth


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

static Number SUNDAY


Constant for SUNDAY used with dayInWeek


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

static Number MONDAY


Constant for MONDAY used with dayInWeek


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

static Number TUESDAY


Constant for TUESDAY used with dayInWeek


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

static Number WEDNESDAY


Constant for WEDNESDAY used with dayInWeek


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

static Number THURSDAY


Constant for THURSDAY used with dayInWeek


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

static Number FRIDAY


Constant for FRIDAY used with dayInWeek


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

static Number SATURDAY


Constant for SATURDAY used with dayInWeek


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

Documentation generated by JsDoc Toolkit 2.4.0 on Mon Feb 11 2013 14:51:10 GMT-0500 (EST)