Criteria for deleting calendar information

The criteria object specifies which calendar or calendar entries to delete. For entries, if no calendar is specified, the delete operation is performed on the default calendar.

The criteria object has two main properties: Type and Data. These are described in the following table. Properties enclosed in brackets are optional.

Table: Criteria object properties

Property

Description

Type

Value

criteria.Type

Specifies the type of calendar information to delete.

string

Possible values:

  • "Calendar"

  • "CalendarEntry"

criteria.Data

Specifies the calendar information to delete.

If deleting a calendar, specify only Data.CalendarName.

If deleting calendar entries, specify at least one of the following:

  • Data.IdList or Data.LocalIdList

  • Data.StartRange

  • Data.EndRange

  • Data.DeleteAll

object

Object with the properties specified below

criteria.Data.CalendarName

If Type is "Calendar", this is a mandatory property that specifies the calendar to delete. No other criteria are required.

If Type is "CalendarEntry", this is an optional property that specifies the calendar from which to delete the entries. If this property is not specified, the default calendar is used.

string

<DriveLetter>:<FileName>

For example: "C:Calendar"

[criteria.Data.IdList]

Specifies the ids of the entries to delete. If an entry has child entries, both the parent and child entries are deleted. Invalid values are ignored.

Specify either Data.IdList or Data.LocalIdList or neither, but not both.

The first id is specified in Data.IdList[0].

array of strings

  

[criteria.Data.LocalIdList]

Specifies the LocalIds of the entries to delete. If an entry is a child entry, only it is deleted. Invalid values ignored.

Specify either Data.IdList or Data.LocalIdList or neither, but not both.

The first LocalId is specified in Data.LocalIdList[0].

array of strings

  

[criteria.Data.StartRange]

If StartRange is specified, all entries that occur on or after this date are deleted.

If both StartRange and EndRange are specified, all entries that occur within these dates are deleted.

date object

  

[criteria.Data.EndRange]

If EndRange is specified, all entries that occur on or before this date are deleted.

If both StartRange and EndRange are specified, all entries that occur within these dates are deleted.

date object

  

[criteria.Data.DeleteAll]

If DeleteAll is set to true, all entries are deleted from the calendar.

boolean

Possible values:

  • true

  • false
© Nokia 2009.