[CalendarServer-changes] [10567] CalendarServer/branches/users/glyph/unshare-when-access-revoked

[source_changes at macosforge.org]

Revision: 10567
          http://trac.calendarserver.org//changeset/10567
Author:   glyph at apple.com
Date:     2013-01-28 19:28:45 -0800 (Mon, 28 Jan 2013)
Log Message:
-----------
More documentation.

Modified Paths:
--------------
    CalendarServer/branches/users/glyph/unshare-when-access-revoked/twistedcaldav/directory/wiki.py

Property Changed:
----------------
    CalendarServer/branches/users/glyph/unshare-when-access-revoked/

Modified: CalendarServer/branches/users/glyph/unshare-when-access-revoked/twistedcaldav/directory/wiki.py
===================================================================
--- CalendarServer/branches/users/glyph/unshare-when-access-revoked/twistedcaldav/directory/wiki.py	2013-01-29 03:28:44 UTC (rev 10566)
+++ CalendarServer/branches/users/glyph/unshare-when-access-revoked/twistedcaldav/directory/wiki.py	2013-01-29 03:28:45 UTC (rev 10567)
@@ -131,6 +131,42 @@
     Ask the wiki server we're paired with what level of access the userID has
     for the given wikiID.  Possible values are "read", "write", and "admin"
     (which we treat as "write").
+
+    @param userID: the GUID (UUID) of the user's directory record.
+    @type userID: L{bytes} (UTF-8)
+
+    @param wikiID: the short name of the wiki principal's synthetic directory
+        record.  (See L{WikiDirectoryService}).
+    @type wikiID: L{bytes} (UTF-8)
+
+    @return: A string indicating the level of access that the given user has to
+        the given wiki.  Possible values are:
+
+        1. C{b"no-access"} for read-only access
+
+        2. C{b"no-access"} for read/write access
+
+        3. C{b"no-access"} for administrative access (which, for calendaring
+           purposes, should be equialent to read/write)
+
+        4. C{b"no-access"} for a user who is not allowed to see the wiki at
+           all.
+
+    @rtype: L{bytes}
+
+    @raise: L{HTTPError} indicating that there is a problem requesting
+        permission information.  This may be raised with a few different status
+        codes, each indicating a different problem:
+
+        1. L{responsecode.FORBIDDEN}: The user represented by C{userID} did not
+           exist.
+
+        2. L{responsecode.NOT_FOUND}: The wiki represented by C{wikiID} did not
+           exist.
+
+        3. L{responsecode.SERVICE_UNAVAILABLE}: The service that we are
+           checking permissions with is currently offline or responding with an
+           unknown fault.
     """
     wikiConfig = config.Authentication.Wiki
     if method is None:
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.macosforge.org/pipermail/calendarserver-changes/attachments/20130128/c405b473/attachment-0001.html>