Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(2095)

Unified Diff: chrome/common/extensions/docs/templates/intros/fileSystemProvider.html

Issue 356463002: [fsp] Add documentation for the File System Provider API. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: Addressed comments. Created 6 years, 6 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
Index: chrome/common/extensions/docs/templates/intros/fileSystemProvider.html
diff --git a/chrome/common/extensions/docs/templates/intros/fileSystemProvider.html b/chrome/common/extensions/docs/templates/intros/fileSystemProvider.html
new file mode 100644
index 0000000000000000000000000000000000000000..c8992836bbca0f0e56923f2f1937ad7960f20715
--- /dev/null
+++ b/chrome/common/extensions/docs/templates/intros/fileSystemProvider.html
@@ -0,0 +1,54 @@
+<h2 id="manifest">Manifest</h2>
+<p>You must declare the "fileSystemProvider" permission
+in the <a href="manifest">extension manifest</a>
+to use the File System Provider API.
+For example:</p>
+<pre data-filename="manifest.json">
+{
+ "name": "My extension",
+ ...
+ <b>"permissions": [
+ "fileSystemProvider"
+ ]</b>,
+ ...
+}
+</pre>
+
+<h2 id="overview">Overview</h2>
+<p>
+File System Provider API allows to write extensions providing support for
not at google - send to devlin 2014/06/25 14:03:30 s/to write extensions providing support for/extens
mtomasz 2014/06/26 02:19:43 Done.
+virtual file systems, which are available in the file manager on Chrome OS.
+Use cases include decompressing archives and accessing files in a cloud
+service other than Drive.
+</p>
+
+<h2 id="archives">File handlers</h2>
+<p>
+Provided file systems can either provide file system contents from an external
+source (such as a remote server), or using a local file (such as an archive) as
+its input.
+</p>
+<p>
+In the second case, the providing extension should have a
+<a href="manifest/file_handlers">file_handlers</a> manifest entry in order
+to be launched when the file is selected in the file manager.
+When the extension is executed with a file to be handled, it has to mount a
+file system and start serving contents from the provided file.
+</p>
+
+<h2 id="archives">Life cycle</h2>
+<p>
+Provided file systems once mounted are remembered by Chrome and remounted
+automatically after reboot or restart. Hence, once a file system is
+<a href="method-mount">mounted</a> by a providing extension, it will stay until
+either the extension is unloaded, or the extension calls the
+<a href="#method-unmount"> unmount</a> method.
+</p>
+<p>
+In case of acting as a file handler, the handled file may need to be stored
+to access it after either a reboot, or suspending and resuming an event page
+of the providing extension. In such case
+<a href="fileSystem#method-retainEntry">chrome.fileSystem.retainEntry</a> and
+<a href="fileSystem#method-restoreEntry">chrome.fileSystem.restoreEntry</a>
+should be used.
+</p>

Powered by Google App Engine
This is Rietveld 408576698