Oracle® Calendar Application Developer's Guide 10g Release 1 (10.1.2) Part Number B25489-01 |
|
|
View PDF |
This chapter documents all the flags, capabilities, and type definitions of Oracle Calendar SDK.
The following flags are defined in the ctapi.h header file.
Table 5-1 Defines
Define Declaration | Description |
---|---|
CSDK_FLAG_CONTINUE_ON_ERROR |
Can be passed to CSDK_Fetch*ByUID or CSDK_Delete*ByUID calls to request that, if possible, we continue the operations even if we encountered an error. Furthermore we return partial data if applicable (CSDK_Fetch*ByUID). Example, if we do a CSDK_Fetch*ByUID with multiple UID, and there is a UID that is not found. Instead of the function returning a STATUS CODE and no data (default behavior), we would return STATUS CODE CSDK_STAT_OK (error would only be reported in RequestResult) and the partial data found for the valid UID's. |
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" timezone. The current user's preferred timezone as set on the Oracle Calendar server is considered the "local" timezone. |
CSDK_FLAG_FETCH_RESOURCES_WITHOUT_ADDRESSES |
Can be passed to CSDK_FetchEvent* calls to request that resources without email addresses not be exported using invalid email addresses. |
CSDK_FLAG_FETCH_USERS_WITHOUT_ADDRESSES |
Can be passed to CSDK_FetchEvent* calls to request that users without email addresses not be exported using invalid email addresses. |
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_NONE |
Used to select the default behavior (same as CAPI_FLAG_NONE). |
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 (CAPI_FLAG_STORE_CREATE) a new object (task/contact) on the server if none exists with the given UID, or to completely replace (CAPI_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_Store* 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. |
The following capabilities are defined in the ctapi.h header file.
Table 5-2 Calendar SDK Capabilities
Define Declaration | Description |
---|---|
CAPI_CAPAB_ABOUT_BOX |
Returns information about CAPI. |
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 which CAPI can handle ("20371129"). |
CAPI_CAPAB_MINREFRESHRATE |
Returns the minimum idle refresh rate for SDK clients. |
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 which CAPI does not process. ("VJOURNAL,VFREEBUSY") |
CAPI_CAPAB_UNSUPPORTED_ICAL_PROP |
Returns a comma delimited list of iCal properties which CAPI does not process. ("GEO,COMMENT"). A server connection must exist to read this capability. |
CAPI_CAPAB_VERSION |
Same as CAPI_CAPAB_CAPI_VERSION. |
The Oracle Calendar SDK has the following type definitions defined:
Table 5-3 Typedefs
Typedef Declaration | Description |
---|---|
typedef int(* CAPICallback)(void *in_userData, char *io_data, size_t in_dataSize, size_t *out_datSize) |
|
typedef long CAPICapabilityID |
|
typedef unsigned long CAPIFlag |
|
typedef void* CAPIHandle |
|
typedef void* CAPISession |
|
typedef unsigned long CAPIStatus |
|
typedef void* CAPIStream |
|
typedef char const* const* CAPIUIDSet |
|
typedef struct CSDKCondition { const char * prop; CSDKOperator op; const char * value; } CSDKCondition |
|
typedef int CSDKOperator |
|
typedef void* CSDKQuery |
|
typedef struct ScapiAbstractRequestResult* CSDKRequestResult |