Appointment Mappings
- 3 minutes to read
Mapping | Data Type | Required? | Description |
|---|---|---|---|
Boolean | No | Maps to the Appointment.AllDay property. | |
Object (any type) | Yes (see description) | Maps to the PersistentObject.Id property. Appointment identity. Should be unique. This mapping is required in the following situations:
If your application relies on Appointment.Id, you should provide methods for assigning the ID and updating the underlying data source with the actual ID value, as described in the PersistentObject.Id article. Consider using the AppointmentStorage.CommitIdToDataSource and the AppointmentStorage.AutoRetrieveId properties in different identifier generation scenarios. | |
String | No | Maps to the Appointment.Description property. | |
DateTime | Yes | Maps to the Appointment.End property. Do not map the same data field to both “Start” and “End” properties. | |
Object (any type) | No | Maps to the Appointment.LabelKey property. The Label identifier. | |
String | No | Maps to the Appointment.Location property. | |
DateTime | No | Maps to the Appointment.OriginalOccurrenceStart property. Used in scenarios which handle the FetchAppointments event for recurring appointments. | |
DateTime | No | Maps to the Appointment.OriginalOccurrenceEnd property. Used in scenarios which handle the FetchAppointments event for recurring appointments. | |
Integer | Yes (for Gantt View only) | Maps to the Appointment.PercentComplete property. Used for the Gantt View only. | |
Object (any type) | Yes (if you use Resources) | Maps to the Appointment.ResourceId property. Required for identifying a resource for the appointment. Should be the same type as the ID Resource mapping. | |
String | Yes (if you use Resources) | Maps to the Appointment.ResourceIds property. Required for associating multiple resources with appointments, when the SchedulerControl.ResourceSharing property is set to true. The data is composed of tags and attributes that specify the ID type and the ID value of associated resources. Starting from version 15.2 resource identifiers are of Object type so they are serialized using Base64 encoding. Set the SchedulerCompatibility.Base64XmlObjectSerialization property to false to store them as integers. | |
String | Yes (for recurring appointments) | Maps to the Appointment.RecurrenceInfo property. The data is a list of attributes with values. If the appointment is the first in the chain, the data contains a unique pattern identifier, and parameters that describe the recurrence pattern. If the appointment is not the first member in a chain, the data contains a pattern identifier and the index in the chain. | |
String | No | Used to create a reminder specified by the Appointment.Reminder property. The data is a list of attributes with values. The attribute values are specified for the ReminderBase.AlertTime value and the ReminderBase.TimeBeforeStart value. | |
DateTime | Yes | Maps to the Appointment.Start property. Do not map the same data field to both “Start” and “End” properties. | |
Object (any type) | No | Maps to the Appointment.StatusKey property. The Status identifier. | |
String | No | Maps to the Appointment.Subject property. | |
String | No | Maps to the Appointment.TimeZoneId property. Used to store the original time zone for the appointment. | |
Integer | Yes (if the RecurrenceInfo mapping is set and the recurrence is enabled) | Maps to the Appointment.Type property. Contains integer values that correspond to the AppointmentType enumeration. |