Command: set_calprops

Purpose

Set the calendar properties of a calendar.

Parameters

Description

This command is an update command, that is, it only changes the values of the parameters you specify. It is not necessary to supply all parameters in the command, only the ones you want to change. Calendar properties are special states of a calendar, which includes the calendar's name, read and write permission values (acl parameter), the list of owners, and the list of categories.

Use set_calprops to do the following:

• Change the name of the calendar.

• Change owner of calendar.

• Change category of calendar.

• Change read permission of calendar’s event.

• Change write permission of calendar’s event.

• Change description of calendar.

• Change character set of calendar.

• Change language of calendar.

• Change email contact of this calendar.

• Change the time zone-identifier of the calendar.

• Allow or disallow double booking for this calendar.

Single Calendar Example

Here is a sample URL that sets calendar properties: (The calid parameter is required.)

http://calendarserver?set_calprops.wcap
                     ?id=dfasdfzd3ds
                     &calid=jdoe
                     &categories=business;meeting
                     &name=John%39s%32Calendar

Multiple Calendars Example

To set properties of several calendars at one time, set the multiple parameter to the number of calendars to be set, then pass a cal parameter for each calendar. The cal parameter contains an encoded string with the complete property parameter list for the identified calendar. In this string, replace all special characters with a percent character (%), followed by the hexadecimal ASCII code for the special character. ASCII hex codes for common special characters are as follows:

For example, the following URL modifies three calendars with ID's xxxx, yyyy, and zzzz, setting the descriptions to X-Calendar, Y-Calendar, and Z-Calendar, respectively:

http://calendarserver?id=fasdfzd3ds
                     &multiple=3
                     &cal=calid%3Dxxxx%26description%3DX-Calendar
                     &cal=calid%3Dyyyy%26description%3DY-Calendar
                     &cal=calid%3Dzzzz%26description%3DZ-Calendar

This is the equivalent of the following three URL's:

http://calendarserver?id=fasdfzd3ds&calid=xxxx&desc=X-Calendar
http://calendarserver?id=fasdfzd3ds&calid=yyyy&desc=Y-Calendar
http://calendarserver?id=fasdfzd3ds&calid=zzzz&desc=Z-Calendar

In the example, notice that since the multiple parameter is set to 3, there are three instances of the cal parameter. The value of each cal parameter is an encoded list of parameters and their values. The server decodes each cal parameter and set the properties appropriately.

Access Control Entries

See Access Control Information, in the Common Topics section at the front of this chapter. Note that due to limitations of the user interface, it is advisable to limit the number of individuals listed in the ACE's to a maximum of 75 per calendar.

Double Booking

If the ics.conf parameter user.allow.doublebook is set to “yes”, then:

• Allowed — Double booking is allowed if the user’s doublebookingcalendar property is set to 1).

• Disallowed — Double booking is disallowed if the calendar doublebooking property is set to 0. The command returns error 40 STORE_FAILED_DOUBLE_BOOKED.

However, if the user.allow.doublebook parameter is set to “no”, then double booking is disallowed, no matter what the calendar property is set to.

Freebusy Access

See Free-busy Calendars, in the Common Topics section at the front of this chapter.

Choosing a Different Language or Character Set

See Changing Language or Character Set, in the Common Topics section at the front of this chapter.