Author: scottbw
Date: Mon Aug 22 10:16:29 2011
New Revision: 1160187
URL: http://svn.apache.org/viewvc?rev=1160187&view=rev
Log:
Added API doc for Flatpack
Modified:
incubator/wookie/site/trunk/content/wookie/docs/api.mdtext
Modified: incubator/wookie/site/trunk/content/wookie/docs/api.mdtext
URL:
http://svn.apache.org/viewvc/incubator/wookie/site/trunk/content/wookie/docs/api.mdtext?rev=1160187&r1=1160186&r2=1160187&view=diff
==============================================================================
--- incubator/wookie/site/trunk/content/wookie/docs/api.mdtext (original)
+++ incubator/wookie/site/trunk/content/wookie/docs/api.mdtext Mon Aug 22
10:16:29 2011
@@ -228,6 +228,33 @@ A property consists of a <em>propertynam
</tr>
</tbody></table>
+
+#Flatpack
+
+The Flatpack API contains methods for exporting a Widget Instance as a new
Widget package (.wgt file) that can be downloaded by a client.
+
+This can be used, for example, for a plugin to support users exporting the
widget (including any preferences they have set) for side-loading onto a mobile
device or running in a desktop environment like Opera Widgets.
+
+**Note** this is new functionality only available in latest builds, and has a
number of limitations (for example, Widgets using features like Wave won't
export properly).
+<table border="1"><tbody>
+<tr>
+<th >Request</th>
+<th >Description</th>
+</tr>
+<tr>
+<td >GET {wookie}/flatpack</td>
+<td >Not supported.</td>
+</tr>
+<tr>
+<td >GET {wookie}/flatpack/{package_id}.wgt</td>
+<td >Downloads the specified widget package.</td>
+</tr>
+<tr>
+<td >POST {wookie}/flatpack {params: <em>instance_params</em></td>
+<td >creates a new W3C Widget package (.wgt) with an opaque file name for the
specified widget instance, and returns the download URL. </td>
+</tr>
+</tbody></table>
+
#Administration Functions
The following sections describe the API invoked by admin clients for managing
the Wookie server, e.g. for managing whitelist entries or widget access
policies.
