Sun Java System Calendar Server 6 2005Q4 Developer's Guide

Parameters

Table 7–18 get_calprops Parameters

Parameter  

Type  

Purpose  

Required  

Default  

calid

semicolon-separated list of strings 

Semicolon-separated list of calendar identifiers from which to retrieve properties. 

The calid can be supplied in two formats: 

  • string - calendar identifier

  • mailto:rfc822addr - An email address appended to “mailto:”. The address is mapped to a user with an LDAP lookup, and then the user’s default calendar ID is used. Returns: X-SICS-EMAIL and X-NSCP-CALPROPS-RELATIVE-CALID

Current user’s calid

fmt-out

string 

The format for the returned data. 

Two format types: 

text/calendar

text/xml

text/calendar

id

unique identifier string 

The session identifier. 

N/A 

invitecount

integer (0, 1)

1 = Requests the server to return the open invitations count, that is, events where PARSTAT=needs-action. The integer count is returned in the X-Token X-S1CS-CALPROPS-INVITATION-COUNT.

if more than one calid is specified in the calid parameter, the open invitation count for each calendar is returned in the corresponding iCal or iCal XML block.

0 = Count not requested.

0

invitecount

integer (0, 1)

0 = Do not return a count of the open invitations, meaning events and todos where PARTSTAT=needs-action).

1 = Returns the count of open invitations in X-S1CS-CALPROPS-INVITATION-COUNT

If more than one calid is specified, the open invitation count for each calendar is returned in the corresponding iCal or XML block. 

0