Updated documentation and changelog

DecaTec · Dec 5, 2016 · 88c912f · 88c912f
1 parent 40fb5a3
commit 88c912f
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 1 deletion.
diff --git a/NetFx/Documentation/DecaTec.WebDav.NetFx.Documentation/Content/Welcome.aml b/NetFx/Documentation/DecaTec.WebDav.NetFx.Documentation/Content/Welcome.aml
@@ -94,6 +94,21 @@ foreach (var item in items)
 }
           ]]>
         </code>
+        <para>
+          By default, WebDavSession uses a so called allprop when listing the contents of a folder. The WebDAV server should return all known properties. Which properties are returned
+          depends on the WebDAV server. If not all of the expected properties are returned or you only need a subset of all known properties, you can specify another PropFind type when calling ListAsync:
+        </para>
+        <code language="c#">
+          <![CDATA[
+var propFind = PropFind.CreatePropFindWithEmptyProperties(PropNameConstants.IsHidden, PropNameConstants.DisplayName, PropNameConstants.Name, PropNameConstants.GetContentType, PropNameConstants.CreationDate, PropNameConstants.ResourceType, PropNameConstants.GetLastModified, PropNameConstants.GetContentLength);
+var items = await webDavSession.ListAsync(@"MyFolder/", propFind);
+
+foreach (var item in items)
+{
+    // Handle the response (list of WebDavSessionListItems); only the properties specified with propFind should be returned by the server.
+}
+          ]]>
+        </code>
 
         <para>
           <legacyBold>WebDavClient</legacyBold>

diff --git a/Uwp/Documentation/DecaTec.WebDav.Uwp.Documentation/Content/VersionHistory/v0.5.2.0.aml b/Uwp/Documentation/DecaTec.WebDav.Uwp.Documentation/Content/VersionHistory/v0.5.2.0.aml
@@ -18,7 +18,13 @@
 
           <listItem>
             <para>
-              New overloads for WebDavSession.ListAsync where a PropFind can be specified.
+              New overloads for WebDavSession.ListAsync where a PropFind can be specified (e.g. PropFind.CreatePropFindWithEmptyPropertiesAll()).
+            </para>
+          </listItem>
+
+          <listItem>
+            <para>
+              Updated and improved documentation.
             </para>
           </listItem>
 

diff --git a/Uwp/Documentation/DecaTec.WebDav.Uwp.Documentation/Content/Welcome.aml b/Uwp/Documentation/DecaTec.WebDav.Uwp.Documentation/Content/Welcome.aml
@@ -118,6 +118,21 @@ foreach (var item in items)
 }
           ]]>
         </code>
+        <para>
+          By default, WebDavSession uses a so called allprop when listing the contents of a folder. The WebDAV server should return all known properties. Which properties are returned
+          depends on the WebDAV server. If not all of the expected properties are returned or you only need a subset of all known properties, you can specify another PropFind type when calling ListAsync:
+        </para>
+        <code language="c#">
+          <![CDATA[
+var propFind = PropFind.CreatePropFindWithEmptyProperties(PropNameConstants.IsHidden, PropNameConstants.DisplayName, PropNameConstants.Name, PropNameConstants.GetContentType, PropNameConstants.CreationDate, PropNameConstants.ResourceType, PropNameConstants.GetLastModified, PropNameConstants.GetContentLength);
+var items = await webDavSession.ListAsync(@"MyFolder/", propFind);
+
+foreach (var item in items)
+{
+    // Handle the response (list of WebDavSessionListItems); only the properties specified with propFind should be returned by the server.
+}
+          ]]>
+        </code>
 
         <para>
           <legacyBold>WebDavClient</legacyBold>