Blame view

sources/3rdparty/Sabre/CalDAV/IShareableCalendar.php 1.53 KB
03e52840d   Kload   Init
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
  <?php
  
  /**
   * This interface represents a Calendar that can be shared with other users.
   *
   * @package Sabre
   * @subpackage CalDAV
   * @copyright Copyright (C) 2007-2013 Rooftop Solutions. All rights reserved.
   * @author Evert Pot (http://www.rooftopsolutions.nl/)
   * @license http://code.google.com/p/sabredav/wiki/License Modified BSD License
   */
  interface Sabre_CalDAV_IShareableCalendar extends Sabre_CalDAV_ICalendar {
  
      /**
       * Updates the list of shares.
       *
       * The first array is a list of people that are to be added to the
       * calendar.
       *
       * Every element in the add array has the following properties:
       *   * href - A url. Usually a mailto: address
       *   * commonName - Usually a first and last name, or false
       *   * summary - A description of the share, can also be false
       *   * readOnly - A boolean value
       *
       * Every element in the remove array is just the address string.
       *
       * @param array $add
       * @param array $remove
       * @return void
       */
      function updateShares(array $add, array $remove);
  
      /**
       * Returns the list of people whom this calendar is shared with.
       *
       * Every element in this array should have the following properties:
       *   * href - Often a mailto: address
       *   * commonName - Optional, for example a first + last name
       *   * status - See the Sabre_CalDAV_SharingPlugin::STATUS_ constants.
       *   * readOnly - boolean
       *   * summary - Optional, a description for the share
       *
       * @return array
       */
      function getShares();
  
  }