WWW-www.enlightenment.org pushed a commit to branch master.

http://git.enlightenment.org/website/www-content.git/commit/?id=bd70d244ccf183938b19e3a68c81ebea57e4d78c

commit bd70d244ccf183938b19e3a68c81ebea57e4d78c
Author: Lauro Moura <lauromo...@expertisesolutions.com.br>
Date:   Thu Dec 10 20:05:01 2015 -0800

    Wiki page file changed with summary [] by Lauro Moura
---
 pages/api/javascript/ecore/file.txt | 66 +++++++++++++++++++++----------------
 1 file changed, 37 insertions(+), 29 deletions(-)

diff --git a/pages/api/javascript/ecore/file.txt 
b/pages/api/javascript/ecore/file.txt
index 4c1a5cd..880befb 100644
--- a/pages/api/javascript/ecore/file.txt
+++ b/pages/api/javascript/ecore/file.txt
@@ -2,23 +2,31 @@
 
 [[api:javascript:ecore|Back to the JS Ecore page]]
 
-WORKINPROGRESS
+**DRAFT**
 
-==== Constants ====
+The File module provides a large number of functions to work with file, 
directories and downloads.
 
+==== Constants ====
 
 === Events ===
 
-   * ''efl.Ecore.File.EVENT_NONE''
-   * ''efl.Ecore.File.EVENT_CREATED_FILE''
-   * ''efl.Ecore.File.EVENT_CREATED_DIRECTORY''
-   * ''efl.Ecore.File.EVENT_DELETED_FILE''
-   * ''efl.Ecore.File.EVENT_DELETED_DIRECTORY''
-   * ''efl.Ecore.File.EVENT_SELF''
-   * ''efl.Ecore.File.EVENT_MODIFIED''
-   * ''efl.Ecore.File.EVENT_CLOSED''
-   * ''efl.Ecore.File.PROGRESS_CONTINUE''
-   * ''efl.Ecore.File.PROCESS_ABORT''
+When monitoring a file or a directory, these constants are used:
+
+   * ''efl.Ecore.File.EVENT_NONE'' - No event.
+   * ''efl.Ecore.File.EVENT_CREATED_FILE'' - Created file event.
+   * ''efl.Ecore.File.EVENT_CREATED_DIRECTORY'' - Created directory event.
+   * ''efl.Ecore.File.EVENT_DELETED_FILE'' - Deleted file event.
+   * ''efl.Ecore.File.EVENT_DELETED_DIRECTORY'' - Deleted directory event.
+   * ''efl.Ecore.File.EVENT_SELF'' - Deleted monitored directory event.
+   * ''efl.Ecore.File.EVENT_MODIFIED'' - Modified file or directory event.
+   * ''efl.Ecore.File.EVENT_CLOSED'' - Closed file event.
+
+=== Progress ===
+
+These constants are used to handle the progress of a download action.
+
+   * ''efl.Ecore.File.PROGRESS_CONTINUE'' - Continue the download.
+   * ''efl.Ecore.File.PROCESS_ABORT'' - Abort the download.
 
 ==== Functions ====
 
@@ -27,51 +35,51 @@ WORKINPROGRESS
 Syntax
 
 <code javascript>
+efl.Ecore.File.abortAllDownloads();
 </code>
 
-Parameters
+Abort all downloads.
 
-   * parameter
+This function aborts all the downloads that have been started by 
''efl.Ecore.File.download''. It loops over the started downloads and call 
''abort()'' for each of them. To abort only one specific download operation, 
call ''abort()'' directly on the download wrapper object.
 
-Return type
-
-   * return type
-
-Lorem ipsum...
-
-=== addMonitor() ===
+=== addMonitor(path, callback) ===
 
 Syntax
 
 <code javascript>
+function mycallback(monitor, event, path) { ... }
+var monitor = efl.Ecore.File.addMonitor(path, mycallback);
 </code>
 
 Parameters
 
-   * parameter
+   * path - The path to monitor.
+   * callback - The function to call on changes.
 
 Return type
 
-   * return type
+   * object - An object wrapping the new monitor.
+   * null - If it was not possible to create the monitor.
 
-Lorem ipsum...
+This function monitors path. If path is ''null'', or is an empty string, or 
none of the notify methods (Inotify, Windows notification or polling) is 
available, or if path does not exist the function returns ''null''. Otherwise, 
it returns a newly allocated ''Monitor'' object and the monitoring begins. When 
one of the ''efl.Ecore.File.EVENT_*'' events is notified, callback is called. 
Call ''del()'' on the monitor object to stop the monitoring.
 
-=== availableDownloadProtocol() ===
+=== availableDownloadProtocol(protocol) ===
 
 Syntax
 
 <code javascript>
+var isAvailable = efl.Ecore.File.availableDownloadProtocol(protocol);
 </code>
 
 Parameters
 
-   * parameter
+   * protocol - The name of the desired protocol
 
 Return type
 
-   * return type
+   * boolean - Whether the protocol is available or not.
 
-Lorem ipsum...
+This function returns ''true'' if protocol is supported, ''false'' otherwise. 
protocol can be 'http://', 'ftp://' or 'file://'. Ecore.File must be compiled 
with CURL to handle http and ftp protocols.
 
 === canExec() ===
 
@@ -683,4 +691,4 @@ Return type
 
    * return type
 
-Lorem ipsum...
+Lorem ipsum...
\ No newline at end of file

-- 


Reply via email to