imip-agent

Change of docs/wiki/Preferences

1039:a12150034cbd
docs/wiki/Preferences
     1.1 --- a/docs/wiki/Preferences	Sun Feb 07 23:35:20 2016 +0100
     1.2 +++ b/docs/wiki/Preferences	Mon Feb 08 00:14:53 2016 +0100
     1.3 @@ -110,6 +110,24 @@
     1.4            .. all event details
     1.5  }}}
     1.6  
     1.7 +=== confirmation_function ===
     1.8 +
     1.9 + Default:: (none)
    1.10 + Alternatives:: (see below)
    1.11 +
    1.12 +Indicates the confirmation functions used by [[../Resources|resources]] to be
    1.13 +invoked when an event is scheduled. Such functions support certain scheduling
    1.14 +functions that require a record of scheduling activity.
    1.15 +
    1.16 +The `imiptools.handlers.scheduling` module contains the built-in confirmation
    1.17 +functions which include the following:
    1.18 +
    1.19 +{{{#!table
    1.20 +`add_to_quota`         || add the details of an event to quota records
    1.21 +}}}
    1.22 +
    1.23 +See also `retraction_function` and `scheduling_function`.
    1.24 +
    1.25  === event_refreshing ===
    1.26  
    1.27   Default:: `never`
    1.28 @@ -267,6 +285,24 @@
    1.29  minute values that correspond to permitted values in this participant's own
    1.30  time zone.
    1.31  
    1.32 +=== retraction_function ===
    1.33 +
    1.34 + Default:: (none)
    1.35 + Alternatives:: (see below)
    1.36 +
    1.37 +Indicates the retraction functions used by [[../Resources|resources]] to be
    1.38 +invoked when an event is cancelled. Such functions support certain scheduling
    1.39 +functions that require a record of scheduling activity.
    1.40 +
    1.41 +The `imiptools.handlers.scheduling` module contains the built-in retraction
    1.42 +functions which include the following:
    1.43 +
    1.44 +{{{#!table
    1.45 +`remove_from_quota`    || remove the details of an event from quota records
    1.46 +}}}
    1.47 +
    1.48 +See also `confirmation_function` and `scheduling_function`.
    1.49 +
    1.50  === scheduling_function ===
    1.51  
    1.52   Default:: `schedule_in_freebusy`
    1.53 @@ -277,7 +313,7 @@
    1.54  scheduling request appearing on a separate line, optionally accompanied by
    1.55  arguments controlling the behaviour of the function.
    1.56  
    1.57 -The imiptools.handlers.scheduling module contains the built-in scheduling
    1.58 +The `imiptools.handlers.scheduling` module contains the built-in scheduling
    1.59  functions which include the following:
    1.60  
    1.61  {{{#!table
    1.62 @@ -286,6 +322,10 @@
    1.63                         .. the invitation according to the indicated rules
    1.64                         .. (described in the [[../Resources|resources guide]])
    1.65  ==
    1.66 +`check_quota`          || accept an invitation only if the organiser does not
    1.67 +                       .. exceed their quota allowance for bookings
    1.68 +                       .. (described in the [[../Resources|resources guide]])
    1.69 +==
    1.70  `same_domain_only`     || accept an invitation only if the organiser employs an
    1.71                         .. address in the same domain as the resource
    1.72  ==
    1.73 @@ -309,3 +349,5 @@
    1.74  
    1.75  The scheduling mechanism can be extended by implementing additional scheduling
    1.76  functions or by extending the handler framework directly.
    1.77 +
    1.78 +See also `confirmation_function` and `retraction_function`.