Reminder Object

clone

Creates a copy of the activity.

compare

Compares the activity with the specificed activity.

Parameters

activity

The activity that will be compared.

Remarks

Returns true if the activities are the same, otherwise it returns false.

createRecurrence

Creates a recurrence object.

Remarks

Calling this method does not automatically attach the recurrence to the activity. In order to attach the recurrence you will need to call the setRecurrence method on the Activity.

getAllDayEvent

Returns a boolean value that determines if the Activity is an AllDayEvent.

getDataKey

Returns the dataKey for the Activity.

getDescription

Returns the description for the Activity.

getDuration

Returns the duration for the Activity in minutes.

getEnableReminder

Returns a boolean value that determines if the Activity has reminders enabled.

getImportance

Returns a value from 0 - 2 based on the Importance level for the Activity.

Remarks

0 - Low

1 - Normal

2 - High

getIsOccurrence

Returns true if the activity is an occurrence.

getIsVariance

Returns true if the activity is a variance.

getLocation

Returns the location for the Activity.

getRecurrence

Returns the recurrence object attached to the activity, or null if there is no recurrence object.

getRecurrenceKey

Returns the recurrence key.

getReminderInterval

Returns the ReminderInterval for the Activity in ticks.

getRootActivityKey

Returns the key of the rootActivity. This only applies to activities that are occurrences.

getShowTimeAs

Returns a value from 0 - 3.

Remarks

0 - Free

1 - Tentative

2 - OutofOffice

3 - Busy

getSnoozeInterval

Returns the SnoozeInterval for the Activity in ticks.

getStartDateTime

Returns a date object that represents the StartDateTime for the Activity.

getStatus

Returns the status for the Activity.

Remarks

0 - Normal

3 - Expired

getSubject

Returns the subject for the Activity.

getVarianceKey

Returns the variance key if there is one.

setAllDayEvent

Sets the AllDayEvent field of the Activity.

Parameters

allDayEvent

A boolean value that determines if the Activity is an All Day Event.

setDescription

Sets the description field of the Activity.

Parameters

description

A string value to set the description of the Activity.

setDuration

Sets the duration field of the Activity.

Parameters

duration

An integer value that represents the duration of the Activity in minutes.

setEnableReminder

Sets the EnableReminder field of the Activity.

Parameters

enableReminder

A boolean value that determines if the Activity has reminders enabled.

setImportance

Sets the Importance of the Activity.

Parameters

importance

An integer value ranging from 0 - 2 that determines the importance of the Activity.

0 - Low

1 - Normal

2 - High

setIsVariance

Marks the occurrence as a variance.

setLocation

Sets the location field of the Activity.

Parameters

location

A string value to set the location of the Activity.

setRecurrence

Sets the recurrence object on the activity.

Parameters

recurrence

The recurrence object to be set on the activity. If the passed in recurrence is null, then the recurrence object will be removed from the activity.

setReminderInterval

Sets the ReminderInterval field of the Activity.

Parameters

ReminderInterval

An integer value to set the reminder interval of the Activity in ticks.

setShowTimeAs

Sets the ShowTimeAs field of the Activity.

Parameters

showTimeAs

An integer value ranging from 0 - 3 that determines how the Activity should be displayed.

0 - Free

1 - Tentative

2 - OutofOffice

3 - Busy

setSnoozeInterval

Sets the SnoozeInterval field of the Activity.

Parameters

snoozeInterval

An integer value to set the snooze interval of the Activity in ticks.

setStartDateTime

Sets the StartDateTime field of the Activity.

Parameters

startDateTime

A date object to set the startdatetime of the Activity.

setSubject

Sets the subject field of the Activity.

Parameters

subject

A string value to set the subject of the Activity.