2009/dap/file-system file-dir-sys.html,1.19,1.20

Update of /sources/public/2009/dap/file-system
In directory hutz:/tmp/cvs-serv32758

Modified Files:
	file-dir-sys.html 
Log Message:
Add removeRecursively for the directory interfaces, and make it clear that
copying a directory copies its contents.


Index: file-dir-sys.html
===================================================================
RCS file: /sources/public/2009/dap/file-system/file-dir-sys.html,v
retrieving revision 1.19
retrieving revision 1.20
diff -u -d -r1.19 -r1.20
--- file-dir-sys.html	16 Sep 2010 21:51:41 -0000	1.19
+++ file-dir-sys.html	28 Sep 2010 22:11:05 -0000	1.20
@@ -579,7 +579,8 @@
               Copy an entry to a different location on the file system. It is an
               error to try to copy an entry inside itself at any depth if it is
               a directory, or to copy it into its parent if a name different
-              from its current one isn't provided.
+              from its current one isn't provided.  Directory copies are always
+              recursive--that is, they copy all contents of the directory.
             </p>
             <dl class='parameters'>
               <dt>DirectoryEntry parent</dt>
@@ -755,6 +756,25 @@
               </dd>
             </dl>
           </dd>
+          <dt>void removeRecursively ()</dt>
+          <dd>
+            <p>
+              Deletes a directory and all of its contents, if any.  In the event
+              of an error [e.g. trying to delete a directory that contains a
+              file that cannot be removed], some of the contents of the
+              directory MAY be deleted.
+            </p>
+            <dl class='parameters'>
+              <dt>VoidCallback successCallback</dt>
+              <dd>
+                A callback that is called on success.
+              </dd>
+              <dt>optional ErrorCallback errorCallback</dt>
+              <dd>
+                A callback that is called when errors happen.
+              </dd>
+            </dl>
+          </dd>
         </dl>
       </section>
       
@@ -1311,6 +1331,29 @@
               element referred to by path.</dd>
             </dl>
           </dd>
+          <dt>void removeRecursively ()</dt>
+          <dd>
+            <p>
+              Deletes a directory and all of its contents, if any.  In the event
+              of an error [e.g. trying to delete a directory that contains a
+              file that cannot be removed], some of the contents of the
+              directory MAY be deleted.
+            </p>
+            <dl class='exception' title='FileException'>
+              <dt>NOT_FOUND_ERR</dt>
+              <dd>This DirectoryEntrySync refers to a resource that does not
+              exist.</dd>
+              <dt>INVALID_STATE_ERR</dt>
+              <dd>This DirectoryEntrySync is no longer valid for some reason
+              other than it having been deleted.</dd>
+              <dt>NO_MODIFICATION_ALLOWED_ERR</dt>
+              <dd>At least one of the target directory, its parent, or some of
+              its contents, is not writable.</dd>
+              <dt>SECURITY_ERR</dt>
+              <dd>The application does not have permission to access the target
+              directory, its parent, or some of its contents.</dd>
+            </dl>
+          </dd>
         </dl>
       </section>
       

Received on Tuesday, 28 September 2010 22:11:09 UTC