InvokeRecurrenceRule

The recurrence is invoked by a timer registration. The headless target is invoked on the specified time slot with the action 'bb.action.system.TIMER_FIRED'. At a minimum, a recurrence rule is described by the following 3 parameters:

The interval is a positive integer identifying the interval of repetition for the rule. For example, interval equal to 1 means every hour for an InvokeRecurrenceRuleFrequency::Hourly rule. For a InvokeRecurrenceRuleFrequency::Daily rule an interval of 2 means every other day. Additionally, the rule can be further modified by specifying recurrences such as minutes of the hour, hours of the day, days of the month and months of the year. If minutes of the hour, hours of the day, days of the month and months of the year are missing, the missing values are derived from the corresponding values in the start date.

The frequency used to define a recurrence rules may generate recurrence instances with an invalid date (for example, February 30) or nonexistent local time (for example, 1:30 AM on a day where the local time is moved forward by an hour at 1:00 AM). These invalid recurrence instances will be skipped.

Optionally, it can have a date limit or a count limit. A date limit specifies the date at which the recurrence ends. The count limit specifies the number of times the recurrence rule will trigger the headless application.

The following sample code demonstrates how to register a daily recurrent timer that fires at 10AM and 5PM, beginning January 1st, 2014 in local time zone. Note that error handling is omitted for clarity.

    QDate sDate(2014, 1, 1);  // January 1, 2014
    QTime sTime(0, 0);  // Midnight
    InvokeDateTime startTime(sDate,sTime);
    InvokeRecurrenceRule recurrenceRule(bb::system::InvokeRecurrenceRuleFrequency::Daily, startTime);
    QSet<int> setHours;
    setHours << 10 << 17 ;
    recurrenceRule.setHoursOfDay(setHours);

    InvokeTimerRequest timerRequest;
    QString timerId = "1234-unique-id";
    if (recurrenceRule.isValid()) {
      timerRequest.set(timerId,  recurrenceRule, "com.example.RecRuleTestService");
       bb::system::InvokeReply * _reply = _invokeManager->registerTimer(timerRequest);
       if (_reply != NULL) {
           connect(_reply, SIGNAL(finished()), this, SLOT(finishedFired()));
       }
    }

If a recurrence rule defines a schedule that leads to generating time slots that are less than six minutes apart, this rule will be rejected and registration will fail.

    bb::system::InvokeReply * _reply = _invokeManager->deregisterTimer(timerId);

    if (_reply != NULL) {
       connect(_reply, SIGNAL(finished()), this, SLOT(finishedFired()));
     }