5
Calendar SDK Flags and Capabilities

CSDK Flags

CSDK_FLAG_NONE

Used to select the default behavior.

CAPI_FLAG_STORE_DELPROPS

Used with CAPI_Store* functions to specify that the supplied properties are to be cleared or deleted on the server.

CAPI_FLAG_STORE_MODPROPS

Used with CAPI_Store* functions to specify that the supplied properties are to be modified on the server without changing other properties (where possible).

CSDK_FLAG_FETCH_AGENDA_ATTENDEE_ONLY

Used with CSDK_FetchEvent* calls to filter out ATTENDEE properties for all attendees other than the agenda being viewed.

CSDK_FLAG_FETCH_COMBINED

Used with CSDK_FetchEvent* calls to return all events in a single VCALENDAR rather than one VCALENDAR per agenda.

This is faster and produces smaller output.

CSDK_FLAG_FETCH_DO_NOT_EXPAND_RRULE

Can be passed to CSDK_FetchEvent* calls to request that recurrence rules not be expanded.

This flag is set by default with CSDK_FetchEventsByUID and can be overridden by using CSDK_FLAG_FETCH_EXPAND_RRULE.

CSDK_FLAG_FETCH_EXCLUDE_ACCEPTED

Used with CSDK_FetchEvent* calls to exclude events the caller has accepted.

CSDK_FLAG_FETCH_EXCLUDE_APPOINTMENTS

Used with CAPI_FetchEvent* and CSDK_FetchEvent* calls to exclude regular meetings (appointments).

CSDK_FLAG_FETCH_EXCLUDE_DAILYNOTES

Used with CAPI_FetchEvent* and CSDK_FetchEvent* calls to exclude daily notes.

CSDK_FLAG_FETCH_EXCLUDE_DAYEVENTS

Used with CAPI_FetchEvent* and CSDK_FetchEvent* calls to exclude day events.

CSDK_FLAG_FETCH_EXCLUDE_DECLINED

Used with CSDK_FetchEvent* calls to exclude events the caller has declined.

CSDK_FLAG_FETCH_EXCLUDE_HOLIDAYS

Used with CAPI_FetchEvent* and CSDK_FetchEvent* calls to exclude holidays.

CSDK_FLAG_FETCH_EXCLUDE_NOTOWNER

Used with CSDK_FetchEvent* calls to exclude events which are not owned by the caller.

CSDK_FLAG_FETCH_EXCLUDE_UNCONFIRMED

Used with CSDK_FetchEvent* calls to exclude events the caller has not confirmed.

CSDK_FLAG_FETCH_EXPAND_RRULE

Can be passed to CSDK_FetchEvent* calls to request that recurrence rules be expanded.

This flag is set by default with CSDK_FetchEventsByRange and CSDK_FetchEventsByAlarmRange and can be overridden by using CSDK_FLAG_FETCH_DO_NOT_EXPAND_RRULE.

CSDK_FLAG_FETCH_LOCALTIMES

Used with CSDK_FetchEvent* and CSDK_FetchTask* calls to request that times be returned in the local time zone.

The current user's preferred time zone as set on the calendar server will be used as the local time zone

CAPI_FLAG_FETCH_NO_FIELDHOLDERS

Used with CAPI_FetchEventsBy* to avoid reading some event properties from the server.

There are significant performance gains when using this flag, but X- properties and user-assigned UIDs will not be returned.

CSDK_FLAG_FETCH_VCARD_VERSION_2_1

Used with CSDK_FetchContacts* calls to request version 2.1 vCards.

CSDK_FLAG_FETCH_VCARD_VERSION_3_0

Used with CSDK_FetchContacts* calls to request version 3.0 vCards (default).

CSDK_FLAG_STORE_CREATE

Used with CSDK_Store* calls to create a new object on the server.

If an object already exists with the same UID, an error will be returned

CSDK_FLAG_STORE_IMPORT

Used with CSDK_Store* calls to create (CSDK_FLAG_STORE_CREATE) a new object (task/contact) on the server if none exists with the given UID, or to completely replace (CSDK_FLAG_STORE_REPLACE) an existing object.

CSDK_FLAG_STORE_INVITE_SELF

Used with CSDK_StoreEvents to invite the current user without requiring an ATTENDEE property.

CSDK_FLAG_STORE_MODIFY

Used with CSDK_Store* calls to add, or modify the given properties to an existing object on the server.

CSDK_FLAG_STORE_REMOVE

Used with CSDK_StoreContacts and CSDK_StoreTasks* calls to remove the given properties from an existing object on the server.

The UID property must be specified in the input, but will not itself be removed from the server. This mode will not completely delete an object on the server - use CSDK_Delete* instead.

CSDK_FLAG_STORE_REPLACE

Used with CSDK_Store* functions to specify that the object (event/task/contact) on the server should be completely replaced by the given object.

CSDK_FLAG_STORE_REPLY

Used with CSDK_StoreEvents to reply (set ATTENDEE and VALARM) to events organized by other people.

CSDK_FLAG_STREAM_NOT_MIME

Used with CSDK_Store* and CSDK_Fetch* calls to specify that the stream should not be MIME encapsulated.

Capabilities

Typedefs

typedef long CAPICapabilityID

CAPI_CAPAB_AUTH

Returns the authentication mechanisms supported by the server

E.g.: cs-standard,gssapi:kerberos5,sasl:KERBEROS_V4. A server connection must exist to read this capability.

CAPI_CAPAB_CAPI_VERSION

Returns the SDK version as a string.

E.g.: 9.0.4

CAPI_CAPAB_COMP

Returns the compression mechanisms supported by the server

E.g.: cs-simple,none. A server connection must exist to read this capability.

CAPI_CAPAB_ENCR

Returns the encryption mechanisms supported by the server

E.g.: cs-light,none. A server connection must exist to read this capability.

CAPI_CAPAB_MAXDATE

Returns the largest date that the SDK can handle (20371129).

CAPI_CAPAB_SERVER_VERSION

Returns the server version as a string.

E.g.: 6.0. A server connection must exist to read this capability.

CAPI_CAPAB_UNSUPPORTED_ICAL_COMP

Returns a comma delimited list of iCal components that the SDK does not process.

E.g.: VJOURNAL,VFREEBUSY

CAPI_CAPAB_UNSUPPORTED_ICAL_PROP

Returns a comma delimited list of iCal properties that the SDK does not process.

E.g.: GEO,COMMENT. A server connection must exist to read this capability.

CAPI_CAPAB_VERSION

Same as CAPI_CAPAB_CAPI_VERSION.