[Pkg-owncloud-commits] [owncloud-client] 123/164: doc: Added snippet about custom WebDAV properties.

[Sandro Knauß]

This is an automated email from the git hooks/post-receive script.

hefee-guest pushed a commit to branch master
in repository owncloud-client.

commit 5a6eecd694488faf4fc6981e7e4ad887e0f377bb
Author: Klaas Freitag <freitag at owncloud.com>
Date:   Wed Mar 11 10:29:58 2015 +0100

    doc: Added snippet about custom WebDAV properties.
---
 doc/architecture.rst | 67 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 67 insertions(+)

diff --git a/doc/architecture.rst b/doc/architecture.rst
index a8f279e..03ca326 100644
--- a/doc/architecture.rst
+++ b/doc/architecture.rst
@@ -204,3 +204,70 @@ journal. This function can be used to recreate the journal database.
 
 .. note:: We recommend that you use this function only when advised to do so by
    ownCloud support staff.
+
+Custom WebDAV Properties
+------------------------
+
+In the communication between client and server a couple of custom WebDAV properties
+were introduced. They are either needed for sync functionality or help have a positive
+effect on synchronization performance.
+
+This chapter describes additional xml elemeents which the server returns in response
+to a successful PROPFIND request on a file or directory. The elemnts are returned in
+the namespace oc.
+
+###Server Side  Permissions
+
+The XML element <oc:permissions> represents the permission- and sharing state of the
+item. It is a list of characters, and each of the chars has a meaning as outlined
+in the table below:
+
++------+-------------+-------------------------------------------+
+| Code | Resource    | Description                               |
+|======+=============+===========================================|
+| S | File or Folder | is shared                                 |
++---+----------------+-------------------------------------------|
+| R | File or Folder | can share (includes reshare)              |
++---+----------------+-------------------------------------------|
+| M | File or Folder | is mounted (like on DropBox, Samba, etc.) |
++---+----------------+-------------------------------------------|
+| W | File           | can write file                            |
++---+----------------+-------------------------------------------|
+| C | Folder         |can create file in folder                  |
++---+----------------+-------------------------------------------|
+| K | Folder         | can create folder (mkdir)                 |
++---+----------------+-------------------------------------------|
+| D | File or Folder |can delete file or folder                  |
++---+----------------+-------------------------------------------|
+| N | File or Folder | can rename file or folder                 |
++---+----------------+-------------------------------------------|
+| V | File or Folder | can move file or folder                   |
++---+----------------+-------------------------------------------|
+
+Example:
+```
+        <oc:permissions>RDNVCK</oc:permissions>
+```
+
+###File- or Directory Size
+
+The XML element <oc:size> represents the file- or directory size in bytes. For
+directories, the size of the whole file tree underneath the directory is accumulated.
+
+Example:
+```
+        <oc:size>2429176697</oc:size>
+```
+
+###FileID
+
+
+The XML element <oc:id> represents the so called file ID. It is a non volatile string id
+that stays constant as long as the file exists. It is not changed if the file changes or
+is renamed or moved.
+
+
+Example:
+```
+        <oc:id>00000020oc5cfy6qqizm</oc:id>
+```

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-owncloud/owncloud-client.git