1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>How to manage documents? — JIO 2.0.0 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '2.0.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="JIO 2.0.0 documentation" href="index.html" />
<link rel="next" title="Revision Storages: Conflicts and Resolution" href="revision_storages.html" />
<link rel="prev" title="Downloads" href="download.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="revision_storages.html" title="Revision Storages: Conflicts and Resolution"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="download.html" title="Downloads"
accesskey="P">previous</a> |</li>
<li><a href="index.html">JIO 2.0.0 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="how-to-manage-documents">
<h1>How to manage documents?<a class="headerlink" href="#how-to-manage-documents" title="Permalink to this headline">¶</a></h1>
<p>JIO is mapped after the CouchDB API and extends them to provide unified, scalable
and high performance access via Javascript to a wide variety of different
storage backends.</p>
<p>If you are unfamiliar with <a class="reference external" href="http://couchdb.apache.org/">Apache CouchDB</a>:
it is a scalable, fault-tolerant, and schema-free document-oriented database.
It is used in large and small organizations for a variety of applications where
traditional SQL databases are not the best solution for the problem at hand.
CouchDB provides a RESTful HTTP/JSON API accessible by many programming
libraries and tools (like <a class="reference external" href="http://curl.haxx.se/">curl</a> or <a class="reference external" href="http://pouchdb.com/">Pouchdb</a>)
and has its own conflict management system.</p>
<div class="section" id="what-is-a-document">
<h2>What is a document?<a class="headerlink" href="#what-is-a-document" title="Permalink to this headline">¶</a></h2>
<p>A document is an association of metadata and attachment(s). The metadata is the
set of properties of the document and the attachments are the binaries of the content
of the document.</p>
<p>In jIO, metadata is just a dictionnary with keys and values (JSON object), and
attachments are just simple strings.</p>
<div class="highlight-javascript"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre>1
2
3
4
5
6</pre></div></td><td class="code"><div class="highlight"><pre><span class="p">{</span>
<span class="c1">// document metadata</span>
<span class="s2">"_id"</span> <span class="o">:</span> <span class="s2">"Identifier"</span><span class="p">,</span>
<span class="s2">"title"</span> <span class="o">:</span> <span class="s2">"A Title!"</span><span class="p">,</span>
<span class="s2">"creator"</span><span class="o">:</span> <span class="s2">"Mr.Author"</span>
<span class="p">}</span>
</pre></div>
</td></tr></table></div>
<p>You can also retrieve document attachment metadata in this object.</p>
<div class="highlight-javascript"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre> 1
2
3
4
5
6
7
8
9
10
11
12
13
14</pre></div></td><td class="code"><div class="highlight"><pre><span class="p">{</span>
<span class="c1">// document metadata</span>
<span class="s2">"_id"</span> <span class="o">:</span> <span class="s2">"Identifier"</span><span class="p">,</span>
<span class="s2">"title"</span> <span class="o">:</span> <span class="s2">"A Title!"</span><span class="p">,</span>
<span class="s2">"creator"</span><span class="o">:</span> <span class="s2">"Mr.Author"</span><span class="p">,</span>
<span class="s2">"_attachments"</span><span class="o">:</span> <span class="p">{</span>
<span class="c1">// attachment metadata</span>
<span class="s2">"body.html"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"length"</span><span class="o">:</span> <span class="mi">12893</span><span class="p">,</span>
<span class="s2">"digest"</span><span class="o">:</span> <span class="s2">"sha256-XXXX..."</span><span class="p">,</span>
<span class="s2">"content_type"</span><span class="o">:</span> <span class="s2">"text/html"</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
</td></tr></table></div>
<p><a class="reference internal" href="metadata.html#metadata-head"><em>Here</em></a> is a draft about metadata to use with jIO.</p>
</div>
<div class="section" id="basic-methods">
<h2>Basic Methods<a class="headerlink" href="#basic-methods" title="Permalink to this headline">¶</a></h2>
<p>Below you can find sample calls of the main jIO methods. All examples are using
revisions (as in revision storage or replicate revision storage), so you can
see how method calls should be made with either of these storages.</p>
<div class="highlight-javascript"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre> 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50</pre></div></td><td class="code"><div class="highlight"><pre><span class="c1">// Create a new jIO instance</span>
<span class="kd">var</span> <span class="nx">jio_instance</span> <span class="o">=</span> <span class="nx">jIO</span><span class="p">.</span><span class="nx">newJio</span><span class="p">(</span><span class="nx">storage</span> <span class="nx">tree</span> <span class="nx">description</span><span class="p">);</span>
<span class="c1">// create and store new document</span>
<span class="nx">jio_instance</span><span class="p">.</span><span class="nx">post</span><span class="p">({</span><span class="s2">"title"</span><span class="o">:</span> <span class="s2">"some title"</span><span class="p">}).</span>
<span class="nx">then</span><span class="p">(</span><span class="kd">function</span> <span class="p">(</span><span class="nx">response</span><span class="p">)</span> <span class="p">{</span>
<span class="c1">// console.log(response);</span>
<span class="p">});</span>
<span class="c1">// create or update an existing document</span>
<span class="nx">jio_instance</span><span class="p">.</span><span class="nx">put</span><span class="p">({</span><span class="s2">"_id"</span><span class="o">:</span> <span class="s2">"my_document"</span><span class="p">,</span> <span class="s2">"title"</span><span class="o">:</span> <span class="s2">"New Title"</span><span class="p">}).</span>
<span class="nx">then</span><span class="p">(</span><span class="kd">function</span> <span class="p">(</span><span class="nx">response</span><span class="p">)</span> <span class="p">{</span>
<span class="c1">// console.log(response);</span>
<span class="p">});</span>
<span class="c1">// add an attachment to a document</span>
<span class="nx">jio_instance</span><span class="p">.</span><span class="nx">putAttachment</span><span class="p">({</span><span class="s2">"_id"</span><span class="o">:</span> <span class="s2">"my_document"</span><span class="p">,</span> <span class="s2">"_attachment"</span><span class="o">:</span> <span class="s2">"its_attachment"</span><span class="p">,</span>
<span class="s2">"_data"</span><span class="o">:</span> <span class="s2">"abc"</span><span class="p">,</span> <span class="s2">"_mimetype"</span><span class="o">:</span> <span class="s2">"text/plain"</span><span class="p">}).</span>
<span class="nx">then</span><span class="p">(</span><span class="kd">function</span> <span class="p">(</span><span class="nx">response</span><span class="p">)</span> <span class="p">{</span>
<span class="c1">// console.log(response);</span>
<span class="p">});</span>
<span class="c1">// read a document</span>
<span class="nx">jio_instance</span><span class="p">.</span><span class="nx">get</span><span class="p">({</span><span class="s2">"_id"</span><span class="o">:</span> <span class="s2">"my_document"</span><span class="p">}).</span>
<span class="nx">then</span><span class="p">(</span><span class="kd">function</span> <span class="p">(</span><span class="nx">response</span><span class="p">)</span> <span class="p">{</span>
<span class="c1">// console.log(response);</span>
<span class="p">});</span>
<span class="c1">// read an attachment</span>
<span class="nx">jio_instance</span><span class="p">.</span><span class="nx">getAttachment</span><span class="p">({</span><span class="s2">"_id"</span><span class="o">:</span> <span class="s2">"my_document"</span><span class="p">,</span> <span class="s2">"_attachment"</span><span class="o">:</span> <span class="s2">"its_attachment"</span><span class="p">}).</span>
<span class="nx">then</span><span class="p">(</span><span class="kd">function</span> <span class="p">(</span><span class="nx">response</span><span class="p">)</span> <span class="p">{</span>
<span class="c1">// console.log(response);</span>
<span class="p">});</span>
<span class="c1">// delete a document and its attachment(s)</span>
<span class="nx">jio_instance</span><span class="p">.</span><span class="nx">remove</span><span class="p">({</span><span class="s2">"_id"</span><span class="o">:</span> <span class="s2">"my_document"</span><span class="p">}).</span>
<span class="nx">then</span><span class="p">(</span><span class="kd">function</span> <span class="p">(</span><span class="nx">response</span><span class="p">)</span> <span class="p">{</span>
<span class="c1">// console.log(response):</span>
<span class="p">});</span>
<span class="c1">// delete an attachment</span>
<span class="nx">jio_instance</span><span class="p">.</span><span class="nx">removeAttachment</span><span class="p">({</span><span class="s2">"_id"</span><span class="o">:</span> <span class="s2">"my_document"</span><span class="p">,</span> <span class="s2">"_attachment"</span><span class="o">:</span> <span class="s2">"its_attachment"</span><span class="p">}).</span>
<span class="nx">then</span><span class="p">(</span><span class="kd">function</span> <span class="p">(</span><span class="nx">response</span><span class="p">)</span> <span class="p">{</span>
<span class="c1">// console.log(response):</span>
<span class="p">});</span>
<span class="c1">// get all documents</span>
<span class="nx">jio_instance</span><span class="p">.</span><span class="nx">allDocs</span><span class="p">().</span><span class="nx">then</span><span class="p">(</span><span class="kd">function</span> <span class="p">(</span><span class="nx">response</span><span class="p">)</span> <span class="p">{</span>
<span class="c1">// console.log(response):</span>
<span class="p">});</span>
</pre></div>
</td></tr></table></div>
</div>
<div class="section" id="promises">
<h2>Promises<a class="headerlink" href="#promises" title="Permalink to this headline">¶</a></h2>
<p>Each JIO methods returns a Promise object, which allows us to get responses into
callback parameters and to chain callbacks with other returned values.</p>
<p>JIO uses a custom version of <a class="reference external" href="https://github.com/tildeio/rsvp.js">RSVP.js</a>, adding canceler and progression features.</p>
<p>You can read more about promises:</p>
<blockquote>
<div><ul class="simple">
<li><a class="reference external" href="https://github.com/tildeio/rsvp.js#rsvpjs--">github RSVP.js</a></li>
<li><a class="reference external" href="http://promisesaplus.com/">Promises/A+</a></li>
<li><a class="reference external" href="http://wiki.commonjs.org/wiki/Promises">CommonJS Promises</a></li>
</ul>
</div></blockquote>
</div>
<div class="section" id="method-options-and-callback-responses">
<h2>Method Options and Callback Responses<a class="headerlink" href="#method-options-and-callback-responses" title="Permalink to this headline">¶</a></h2>
<p>To retrieve JIO responses, you have to provide callbacks like this:</p>
<div class="highlight-javascript"><div class="highlight"><pre><span class="nx">jio_instance</span><span class="p">.</span><span class="nx">post</span><span class="p">(</span><span class="nx">metadata</span><span class="p">,</span> <span class="p">[</span><span class="nx">options</span><span class="p">]).</span>
<span class="nx">then</span><span class="p">([</span><span class="nx">responseCallback</span><span class="p">],</span> <span class="p">[</span><span class="nx">errorCallback</span><span class="p">],</span> <span class="p">[</span><span class="nx">progressionCallback</span><span class="p">]);</span>
</pre></div>
</div>
<ul class="simple">
<li>On command success, responseCallback will be called with the JIO response as first parameter.</li>
<li>On command error, errorCallback will be called with the JIO error as first parameter.</li>
<li>On command notification, progressionCallback will be called with the storage notification.</li>
</ul>
<p>Here is a list of responses returned by JIO according to methods and options:</p>
<table border="1" class="docutils">
<colgroup>
<col width="19%" />
<col width="32%" />
<col width="49%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Option</th>
<th class="head">Available for</th>
<th class="head">Response (Callback first parameter)</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>No options</td>
<td>post, put, remove</td>
<td><div class="first last highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
<span class="s2">"result"</span><span class="o">:</span> <span class="s2">"success"</span><span class="p">,</span>
<span class="s2">"method"</span><span class="o">:</span> <span class="s2">"post"</span><span class="p">,</span>
<span class="c1">// or put or remove</span>
<span class="s2">"id"</span><span class="o">:</span> <span class="s2">"my_doc_id"</span><span class="p">,</span>
<span class="s2">"status"</span><span class="o">:</span> <span class="mi">204</span><span class="p">,</span>
<span class="s2">"statusText"</span><span class="o">:</span> <span class="s2">"No Content"</span>
<span class="p">}</span>
</pre></div>
</div>
</td>
</tr>
<tr class="row-odd"><td>No options</td>
<td>putAttachment, removeAttachment</td>
<td><div class="first last highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
<span class="s2">"result"</span><span class="o">:</span> <span class="s2">"success"</span><span class="p">,</span>
<span class="s2">"method"</span><span class="o">:</span> <span class="s2">"putAttachment"</span><span class="p">,</span>
<span class="c1">// or removeAttachment</span>
<span class="s2">"id"</span><span class="o">:</span> <span class="s2">"my_doc_id"</span><span class="p">,</span>
<span class="s2">"attachment"</span><span class="o">:</span> <span class="s2">"my_attachment_id"</span><span class="p">,</span>
<span class="s2">"status"</span><span class="o">:</span> <span class="mi">204</span><span class="p">,</span>
<span class="s2">"statusText"</span><span class="o">:</span> <span class="s2">"No Content"</span>
<span class="p">}</span>
</pre></div>
</div>
</td>
</tr>
<tr class="row-even"><td>No options</td>
<td>get</td>
<td><div class="first last highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
<span class="s2">"result"</span><span class="o">:</span> <span class="s2">"success"</span><span class="p">,</span>
<span class="s2">"method"</span><span class="o">:</span> <span class="s2">"get"</span><span class="p">,</span>
<span class="s2">"id"</span><span class="o">:</span> <span class="s2">"my_doc_id"</span><span class="p">,</span>
<span class="s2">"status"</span><span class="o">:</span> <span class="mi">200</span><span class="p">,</span>
<span class="s2">"statusText"</span><span class="o">:</span> <span class="s2">"Ok"</span><span class="p">,</span>
<span class="s2">"data"</span><span class="o">:</span> <span class="p">{</span>
<span class="c1">// Here, the document metadata</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
</td>
</tr>
<tr class="row-odd"><td>No options</td>
<td>getAttachment</td>
<td><div class="first last highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
<span class="s2">"result"</span><span class="o">:</span> <span class="s2">"success"</span><span class="p">,</span>
<span class="s2">"method"</span><span class="o">:</span> <span class="s2">"getAttachment"</span><span class="p">,</span>
<span class="s2">"id"</span><span class="o">:</span> <span class="s2">"my_doc_id"</span><span class="p">,</span>
<span class="s2">"attachment"</span><span class="o">:</span> <span class="s2">"my_attachment_id"</span><span class="p">,</span>
<span class="s2">"status"</span><span class="o">:</span> <span class="mi">200</span><span class="p">,</span>
<span class="s2">"statusText"</span><span class="o">:</span> <span class="s2">"Ok"</span><span class="p">,</span>
<span class="s2">"data"</span><span class="o">:</span> <span class="nx">Blob</span> <span class="c1">// Here, the attachment content</span>
<span class="p">}</span>
</pre></div>
</div>
</td>
</tr>
<tr class="row-even"><td>No option</td>
<td>allDocs</td>
<td><div class="first last highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
<span class="s2">"result"</span><span class="o">:</span> <span class="s2">"success"</span><span class="p">,</span>
<span class="s2">"method"</span><span class="o">:</span> <span class="s2">"allDocs"</span><span class="p">,</span>
<span class="s2">"id"</span><span class="o">:</span> <span class="s2">"my_doc_id"</span><span class="p">,</span>
<span class="s2">"status"</span><span class="o">:</span> <span class="mi">200</span><span class="p">,</span>
<span class="s2">"statusText"</span><span class="o">:</span> <span class="s2">"Ok"</span><span class="p">,</span>
<span class="s2">"data"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"total_rows"</span><span class="o">:</span> <span class="mi">1</span><span class="p">,</span>
<span class="s2">"rows"</span><span class="o">:</span> <span class="p">[{</span>
<span class="s2">"id"</span><span class="o">:</span> <span class="s2">"mydoc"</span><span class="p">,</span>
<span class="s2">"key"</span><span class="o">:</span> <span class="s2">"mydoc"</span><span class="p">,</span> <span class="c1">// optional</span>
<span class="s2">"value"</span><span class="o">:</span> <span class="p">{},</span>
<span class="p">}]</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
</td>
</tr>
<tr class="row-odd"><td>include_docs: true</td>
<td>allDocs</td>
<td><div class="first last highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
<span class="s2">"result"</span><span class="o">:</span> <span class="s2">"success"</span><span class="p">,</span>
<span class="s2">"method"</span><span class="o">:</span> <span class="s2">"allDocs"</span><span class="p">,</span>
<span class="s2">"id"</span><span class="o">:</span> <span class="s2">"my_doc_id"</span><span class="p">,</span>
<span class="s2">"status"</span><span class="o">:</span> <span class="mi">200</span><span class="p">,</span>
<span class="s2">"statusText"</span><span class="o">:</span> <span class="s2">"Ok"</span><span class="p">,</span>
<span class="s2">"data"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"total_rows"</span><span class="o">:</span> <span class="mi">1</span><span class="p">,</span>
<span class="s2">"rows"</span><span class="o">:</span> <span class="p">[{</span>
<span class="s2">"id"</span><span class="o">:</span> <span class="s2">"mydoc"</span><span class="p">,</span>
<span class="s2">"key"</span><span class="o">:</span> <span class="s2">"mydoc"</span><span class="p">,</span> <span class="c1">// optional</span>
<span class="s2">"value"</span><span class="o">:</span> <span class="p">{},</span>
<span class="s2">"doc"</span><span class="o">:</span> <span class="p">{</span>
<span class="c1">// Here, "mydoc" metadata</span>
<span class="p">}</span>
<span class="p">}]</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
</td>
</tr>
</tbody>
</table>
<p>In case of error, the errorCallback first parameter will look like:</p>
<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
<span class="s2">"result"</span><span class="o">:</span> <span class="s2">"error"</span><span class="p">,</span>
<span class="s2">"method"</span><span class="o">:</span> <span class="s2">"get"</span><span class="p">,</span>
<span class="s2">"status"</span><span class="o">:</span> <span class="mi">404</span><span class="p">,</span>
<span class="s2">"statusText"</span><span class="o">:</span> <span class="s2">"Not Found"</span><span class="p">,</span>
<span class="s2">"error"</span><span class="o">:</span> <span class="s2">"not_found"</span><span class="p">,</span>
<span class="s2">"reason"</span><span class="o">:</span> <span class="s2">"document missing"</span><span class="p">,</span>
<span class="s2">"message"</span><span class="o">:</span> <span class="s2">"Unable to get the requseted document"</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="example-how-to-store-a-video-on-localstorage">
<h2>Example: How to store a video on localStorage<a class="headerlink" href="#example-how-to-store-a-video-on-localstorage" title="Permalink to this headline">¶</a></h2>
<p>The following shows how to create a new jIO in localStorage and then post a document with two attachments.</p>
<div class="highlight-javascript"><div class="highlight"><pre><span class="c1">// create a new jIO</span>
<span class="kd">var</span> <span class="nx">jio_instance</span> <span class="o">=</span> <span class="nx">jIO</span><span class="p">.</span><span class="nx">newJio</span><span class="p">({</span>
<span class="s2">"type"</span><span class="o">:</span> <span class="s2">"local"</span><span class="p">,</span>
<span class="s2">"username"</span><span class="o">:</span> <span class="s2">"usr"</span><span class="p">,</span>
<span class="s2">"application_name"</span><span class="o">:</span><span class="s2">"app"</span>
<span class="p">});</span>
<span class="c1">// post the document "metadata"</span>
<span class="nx">jio_instance</span><span class="p">.</span><span class="nx">post</span><span class="p">({</span>
<span class="s2">"title"</span> <span class="o">:</span> <span class="s2">"My Video"</span><span class="p">,</span>
<span class="s2">"type"</span> <span class="o">:</span> <span class="s2">"MovingImage"</span><span class="p">,</span>
<span class="s2">"format"</span> <span class="o">:</span> <span class="s2">"video/ogg"</span><span class="p">,</span>
<span class="s2">"description"</span> <span class="o">:</span> <span class="s2">"Images Compilation"</span>
<span class="p">},</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">response</span><span class="p">)</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">id</span><span class="p">;</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">err</span><span class="p">)</span> <span class="p">{</span>
<span class="k">return</span> <span class="nx">alert</span><span class="p">(</span><span class="s1">'Error posting the document meta'</span><span class="p">);</span>
<span class="p">}</span>
<span class="nx">id</span> <span class="o">=</span> <span class="nx">response</span><span class="p">.</span><span class="nx">id</span><span class="p">;</span>
<span class="c1">// post a thumbnail attachment</span>
<span class="nx">jio_instance</span><span class="p">.</span><span class="nx">putAttachment</span><span class="p">({</span>
<span class="s2">"_id"</span><span class="o">:</span> <span class="nx">id</span><span class="p">,</span>
<span class="s2">"_attachment"</span><span class="o">:</span> <span class="s2">"thumbnail"</span><span class="p">,</span>
<span class="s2">"_data"</span><span class="o">:</span> <span class="nx">my_image</span><span class="p">,</span>
<span class="s2">"_mimetype"</span><span class="o">:</span> <span class="s2">"image/jpeg"</span>
<span class="p">},</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">response</span><span class="p">)</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">err</span><span class="p">)</span> <span class="p">{</span>
<span class="k">return</span> <span class="nx">alert</span><span class="p">(</span><span class="s1">'Error attaching thumbnail'</span><span class="p">);</span>
<span class="p">}</span>
<span class="c1">// post video attachment</span>
<span class="nx">jio_instance</span><span class="p">.</span><span class="nx">putAttachment</span><span class="p">({</span>
<span class="s2">"_id"</span><span class="o">:</span> <span class="nx">id</span><span class="p">,</span>
<span class="s2">"_attachment"</span><span class="o">:</span> <span class="s2">"video"</span><span class="p">,</span>
<span class="s2">"_data"</span><span class="o">:</span> <span class="nx">my_video</span><span class="p">,</span>
<span class="s2">"_mimetype"</span><span class="o">:</span><span class="s2">"video/ogg"</span>
<span class="p">},</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">response</span><span class="p">)</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">err</span><span class="p">)</span> <span class="p">{</span>
<span class="k">return</span> <span class="nx">alert</span><span class="p">(</span><span class="s1">'Error attaching the video'</span><span class="p">);</span>
<span class="p">}</span>
<span class="nx">alert</span><span class="p">(</span><span class="s1">'Video Stored'</span><span class="p">);</span>
<span class="p">});</span>
<span class="p">});</span>
<span class="p">});</span>
</pre></div>
</div>
<p>localStorage contents:</p>
<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
<span class="s2">"jio/local/usr/app/12345678-1234-1234-1234-123456789012"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"_id"</span><span class="o">:</span> <span class="s2">"12345678-1234-1234-1234-123456789012"</span><span class="p">,</span>
<span class="s2">"title"</span><span class="o">:</span> <span class="s2">"My Video"</span><span class="p">,</span>
<span class="s2">"type"</span><span class="o">:</span> <span class="s2">"MovingImage"</span><span class="p">,</span>
<span class="s2">"format"</span><span class="o">:</span> <span class="s2">"video/ogg"</span><span class="p">,</span>
<span class="s2">"description"</span><span class="o">:</span> <span class="s2">"Images Compilation"</span><span class="p">,</span>
<span class="s2">"_attachments"</span><span class="o">:</span><span class="p">{</span>
<span class="s2">"thumbnail"</span><span class="o">:</span><span class="p">{</span>
<span class="s2">"digest"</span><span class="o">:</span> <span class="s2">"md5-3ue..."</span><span class="p">,</span>
<span class="s2">"content_type"</span><span class="o">:</span> <span class="s2">"image/jpeg"</span><span class="p">,</span>
<span class="s2">"length"</span><span class="o">:</span> <span class="mi">17863</span>
<span class="p">},</span>
<span class="s2">"video"</span><span class="o">:</span><span class="p">{</span>
<span class="s2">"digest"</span><span class="o">:</span> <span class="s2">"md5-0oe..."</span><span class="p">,</span>
<span class="s2">"content_type"</span><span class="o">:</span> <span class="s2">"video/ogg"</span><span class="p">,</span>
<span class="s2">"length"</span><span class="o">:</span> <span class="mi">2840824</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">},</span>
<span class="s2">"jio/local/usr/app/myVideo/thumbnail"</span><span class="o">:</span> <span class="s2">"/9j/4AAQSkZ..."</span><span class="p">,</span>
<span class="s2">"jio/local/usr/app/myVideo/video"</span><span class="o">:</span> <span class="s2">"..."</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="index.html">
<img class="logo" src="_static/jio.png" alt="Logo"/>
</a></p>
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">How to manage documents?</a><ul>
<li><a class="reference internal" href="#what-is-a-document">What is a document?</a></li>
<li><a class="reference internal" href="#basic-methods">Basic Methods</a></li>
<li><a class="reference internal" href="#promises">Promises</a></li>
<li><a class="reference internal" href="#method-options-and-callback-responses">Method Options and Callback Responses</a></li>
<li><a class="reference internal" href="#example-how-to-store-a-video-on-localstorage">Example: How to store a video on localStorage</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="download.html"
title="previous chapter">Downloads</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="revision_storages.html"
title="next chapter">Revision Storages: Conflicts and Resolution</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/manage_documents.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="revision_storages.html" title="Revision Storages: Conflicts and Resolution"
>next</a> |</li>
<li class="right" >
<a href="download.html" title="Downloads"
>previous</a> |</li>
<li><a href="index.html">JIO 2.0.0 documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2013, Nexedi.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>