box-api 0.1.9 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/Gemfile.lock +1 -1
- data/box-api.gemspec +1 -1
- data/doc/Box.html +5 -5
- data/doc/Box/Account.html +430 -188
- data/doc/Box/Api.html +731 -428
- data/doc/Box/Api/AccountExceeded.html +3 -3
- data/doc/Box/Api/EmailInvalid.html +6 -6
- data/doc/Box/Api/EmailTaken.html +3 -3
- data/doc/Box/Api/ErrorStatus.html +3 -3
- data/doc/Box/Api/Exception.html +3 -3
- data/doc/Box/Api/Generic.html +3 -3
- data/doc/Box/Api/InvalidFolder.html +6 -6
- data/doc/Box/Api/InvalidInput.html +3 -3
- data/doc/Box/Api/InvalidName.html +3 -3
- data/doc/Box/Api/NameTaken.html +3 -3
- data/doc/Box/Api/NoAccess.html +3 -3
- data/doc/Box/Api/NoParent.html +3 -3
- data/doc/Box/Api/NotAuthorized.html +3 -3
- data/doc/Box/Api/Restricted.html +6 -6
- data/doc/Box/Api/SizeExceeded.html +3 -3
- data/doc/Box/Api/Unknown.html +3 -3
- data/doc/Box/Api/UnknownResponse.html +6 -6
- data/doc/Box/Api/UploadFailed.html +6 -6
- data/doc/Box/Comment.html +560 -0
- data/doc/Box/File.html +318 -53
- data/doc/Box/Folder.html +298 -136
- data/doc/Box/Item.html +398 -348
- data/doc/_index.html +22 -7
- data/doc/class_list.html +1 -1
- data/doc/css/full_list.css +2 -0
- data/doc/css/style.css +2 -0
- data/doc/file.README.html +3 -3
- data/doc/frames.html +1 -1
- data/doc/index.html +3 -3
- data/doc/js/full_list.js +23 -6
- data/doc/method_list.html +233 -89
- data/doc/top-level-namespace.html +3 -3
- data/examples/files.rb +3 -5
- data/examples/login.rb +14 -18
- data/lib/box/account.rb +57 -16
- data/lib/box/api.rb +34 -1
- data/lib/box/api/exceptions.rb +3 -0
- data/lib/box/comment.rb +50 -0
- data/lib/box/file.rb +31 -0
- data/lib/box/folder.rb +57 -1
- data/lib/box/item.rb +20 -4
- data/spec/account_spec.rb +4 -0
- data/spec/file_spec.rb +37 -0
- data/spec/folder_spec.rb +78 -0
- data/spec/helper/account.rb +1 -1
- metadata +55 -61
data/doc/Box/Item.html
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
<title>
|
|
7
7
|
Class: Box::Item
|
|
8
8
|
|
|
9
|
-
— Documentation by YARD 0.7.
|
|
9
|
+
— Documentation by YARD 0.7.3
|
|
10
10
|
|
|
11
11
|
</title>
|
|
12
12
|
|
|
@@ -94,18 +94,18 @@
|
|
|
94
94
|
|
|
95
95
|
<h2>Overview</h2><div class="docstring">
|
|
96
96
|
<div class="discussion">
|
|
97
|
-
|
|
98
|
-
Represents a folder or file stored on Box. Any attributes or actions
|
|
97
|
+
|
|
98
|
+
<p>Represents a folder or file stored on Box. Any attributes or actions
|
|
99
99
|
typical to a Box item can be accessed through this class. The <span class='object_link'><a href="" title="Box::Item (class)">Item</a></span> class
|
|
100
100
|
contains only methods shared by <span class='object_link'><a href="Folder.html" title="Box::Folder (class)">Folder</a></span> and <span class='object_link'><a href="File.html" title="Box::File (class)">File</a></span>, and should not be
|
|
101
|
-
instanciated directly
|
|
102
|
-
</p>
|
|
101
|
+
instanciated directly.</p>
|
|
103
102
|
|
|
104
103
|
|
|
105
104
|
</div>
|
|
106
105
|
</div>
|
|
107
106
|
<div class="tags">
|
|
108
107
|
|
|
108
|
+
|
|
109
109
|
</div><div id="subclasses">
|
|
110
110
|
<h2>Direct Known Subclasses</h2>
|
|
111
111
|
<p class="children"><span class='object_link'><a href="File.html" title="Box::File (class)">File</a></span>, <span class='object_link'><a href="Folder.html" title="Box::Folder (class)">Folder</a></span></p>
|
|
@@ -134,9 +134,8 @@ instanciated directly.
|
|
|
134
134
|
|
|
135
135
|
|
|
136
136
|
|
|
137
|
-
<span class="summary_desc"><div class='inline'
|
|
138
|
-
The <span class='object_link'><a href="Api.html" title="Box::Api (class)">Api</a></span> used by this item
|
|
139
|
-
</p>
|
|
137
|
+
<span class="summary_desc"><div class='inline'>
|
|
138
|
+
<p>The <span class='object_link'><a href="Api.html" title="Box::Api (class)">Api</a></span> used by this item.</p>
|
|
140
139
|
</div></span>
|
|
141
140
|
|
|
142
141
|
</li>
|
|
@@ -161,9 +160,8 @@ The <span class='object_link'><a href="Api.html" title="Box::Api (class)">Api</a
|
|
|
161
160
|
|
|
162
161
|
|
|
163
162
|
|
|
164
|
-
<span class="summary_desc"><div class='inline'
|
|
165
|
-
The hash of info for this item
|
|
166
|
-
</p>
|
|
163
|
+
<span class="summary_desc"><div class='inline'>
|
|
164
|
+
<p>The hash of info for this item.</p>
|
|
167
165
|
</div></span>
|
|
168
166
|
|
|
169
167
|
</li>
|
|
@@ -188,9 +186,8 @@ The hash of info for this item.
|
|
|
188
186
|
|
|
189
187
|
|
|
190
188
|
|
|
191
|
-
<span class="summary_desc"><div class='inline'
|
|
192
|
-
The parent of this item
|
|
193
|
-
</p>
|
|
189
|
+
<span class="summary_desc"><div class='inline'>
|
|
190
|
+
<p>The parent of this item.</p>
|
|
194
191
|
</div></span>
|
|
195
192
|
|
|
196
193
|
</li>
|
|
@@ -225,9 +222,8 @@ The parent of this item.
|
|
|
225
222
|
|
|
226
223
|
|
|
227
224
|
|
|
228
|
-
<span class="summary_desc"><div class='inline'
|
|
229
|
-
The string representation of this item
|
|
230
|
-
</p>
|
|
225
|
+
<span class="summary_desc"><div class='inline'>
|
|
226
|
+
<p>The string representation of this item.</p>
|
|
231
227
|
</div></span>
|
|
232
228
|
|
|
233
229
|
</li>
|
|
@@ -249,9 +245,8 @@ The string representation of this item.
|
|
|
249
245
|
|
|
250
246
|
|
|
251
247
|
|
|
252
|
-
<span class="summary_desc"><div class='inline'
|
|
253
|
-
The plural string representation of this item
|
|
254
|
-
</p>
|
|
248
|
+
<span class="summary_desc"><div class='inline'>
|
|
249
|
+
<p>The plural string representation of this item.</p>
|
|
255
250
|
</div></span>
|
|
256
251
|
|
|
257
252
|
</li>
|
|
@@ -282,9 +277,8 @@ The plural string representation of this item.
|
|
|
282
277
|
|
|
283
278
|
|
|
284
279
|
|
|
285
|
-
<span class="summary_desc"><div class='inline'
|
|
286
|
-
Copy this item to the destination folder
|
|
287
|
-
</p>
|
|
280
|
+
<span class="summary_desc"><div class='inline'>
|
|
281
|
+
<p>Copy this item to the destination folder.</p>
|
|
288
282
|
</div></span>
|
|
289
283
|
|
|
290
284
|
</li>
|
|
@@ -306,9 +300,8 @@ Copy this item to the destination folder.
|
|
|
306
300
|
|
|
307
301
|
|
|
308
302
|
|
|
309
|
-
<span class="summary_desc"><div class='inline'
|
|
310
|
-
Delete this item and all sub-items
|
|
311
|
-
</p>
|
|
303
|
+
<span class="summary_desc"><div class='inline'>
|
|
304
|
+
<p>Delete this item and all sub-items.</p>
|
|
312
305
|
</div></span>
|
|
313
306
|
|
|
314
307
|
</li>
|
|
@@ -317,7 +310,7 @@ Delete this item and all sub-items.
|
|
|
317
310
|
<li class="public ">
|
|
318
311
|
<span class="summary_signature">
|
|
319
312
|
|
|
320
|
-
<a href="#
|
|
313
|
+
<a href="#force_cached_info-instance_method" title="#force_cached_info (instance method)">- (Object) <strong>force_cached_info</strong> </a>
|
|
321
314
|
|
|
322
315
|
|
|
323
316
|
|
|
@@ -330,9 +323,8 @@ Delete this item and all sub-items.
|
|
|
330
323
|
|
|
331
324
|
|
|
332
325
|
|
|
333
|
-
<span class="summary_desc"><div class='inline'
|
|
334
|
-
|
|
335
|
-
</p>
|
|
326
|
+
<span class="summary_desc"><div class='inline'>
|
|
327
|
+
<p>Consider the item cached.</p>
|
|
336
328
|
</div></span>
|
|
337
329
|
|
|
338
330
|
</li>
|
|
@@ -341,7 +333,7 @@ Set the description of this item.
|
|
|
341
333
|
<li class="public ">
|
|
342
334
|
<span class="summary_signature">
|
|
343
335
|
|
|
344
|
-
<a href="#
|
|
336
|
+
<a href="#id-instance_method" title="#id (instance method)">- (String) <strong>id</strong> </a>
|
|
345
337
|
|
|
346
338
|
|
|
347
339
|
|
|
@@ -354,9 +346,8 @@ Set the description of this item.
|
|
|
354
346
|
|
|
355
347
|
|
|
356
348
|
|
|
357
|
-
<span class="summary_desc"><div class='inline'
|
|
358
|
-
|
|
359
|
-
</p>
|
|
349
|
+
<span class="summary_desc"><div class='inline'>
|
|
350
|
+
<p>The id of this item.</p>
|
|
360
351
|
</div></span>
|
|
361
352
|
|
|
362
353
|
</li>
|
|
@@ -365,7 +356,7 @@ Consider the item cached.
|
|
|
365
356
|
<li class="public ">
|
|
366
357
|
<span class="summary_signature">
|
|
367
358
|
|
|
368
|
-
<a href="#
|
|
359
|
+
<a href="#info-instance_method" title="#info (instance method)">- (Item) <strong>info</strong>(refresh = false) </a>
|
|
369
360
|
|
|
370
361
|
|
|
371
362
|
|
|
@@ -378,9 +369,8 @@ Consider the item cached.
|
|
|
378
369
|
|
|
379
370
|
|
|
380
371
|
|
|
381
|
-
<span class="summary_desc"><div class='inline'
|
|
382
|
-
|
|
383
|
-
</p>
|
|
372
|
+
<span class="summary_desc"><div class='inline'>
|
|
373
|
+
<p>Get the info for this item.</p>
|
|
384
374
|
</div></span>
|
|
385
375
|
|
|
386
376
|
</li>
|
|
@@ -389,12 +379,14 @@ The id of this item.
|
|
|
389
379
|
<li class="public ">
|
|
390
380
|
<span class="summary_signature">
|
|
391
381
|
|
|
392
|
-
<a href="#
|
|
382
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">- (Item) <strong>initialize</strong>(api, parent, info) </a>
|
|
393
383
|
|
|
394
384
|
|
|
395
385
|
|
|
396
386
|
</span>
|
|
397
387
|
|
|
388
|
+
<span class="note title constructor">constructor</span>
|
|
389
|
+
|
|
398
390
|
|
|
399
391
|
|
|
400
392
|
|
|
@@ -402,9 +394,8 @@ The id of this item.
|
|
|
402
394
|
|
|
403
395
|
|
|
404
396
|
|
|
405
|
-
<span class="summary_desc"><div class='inline'
|
|
406
|
-
|
|
407
|
-
</p>
|
|
397
|
+
<span class="summary_desc"><div class='inline'>
|
|
398
|
+
<p>Create a new item representing either a file or folder.</p>
|
|
408
399
|
</div></span>
|
|
409
400
|
|
|
410
401
|
</li>
|
|
@@ -413,24 +404,44 @@ Get the info for this item.
|
|
|
413
404
|
<li class="public ">
|
|
414
405
|
<span class="summary_signature">
|
|
415
406
|
|
|
416
|
-
<a href="#
|
|
407
|
+
<a href="#method_missing-instance_method" title="#method_missing (instance method)">- (Object) <strong>method_missing</strong>(sym, *args, &block) </a>
|
|
417
408
|
|
|
418
409
|
|
|
419
410
|
|
|
420
411
|
</span>
|
|
421
412
|
|
|
422
|
-
<span class="note title constructor">constructor</span>
|
|
423
413
|
|
|
424
414
|
|
|
425
415
|
|
|
426
416
|
|
|
427
417
|
|
|
418
|
+
|
|
419
|
+
|
|
420
|
+
<span class="summary_desc"><div class='inline'>
|
|
421
|
+
<p>Provides an easy way to access this item's info.</p>
|
|
422
|
+
</div></span>
|
|
428
423
|
|
|
424
|
+
</li>
|
|
429
425
|
|
|
426
|
+
|
|
427
|
+
<li class="public ">
|
|
428
|
+
<span class="summary_signature">
|
|
429
|
+
|
|
430
|
+
<a href="#move-instance_method" title="#move (instance method)">- (Item) <strong>move</strong>(destination) </a>
|
|
431
|
+
|
|
432
|
+
|
|
433
|
+
|
|
434
|
+
</span>
|
|
430
435
|
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
|
|
443
|
+
<span class="summary_desc"><div class='inline'>
|
|
444
|
+
<p>Move this item to the destination folder.</p>
|
|
434
445
|
</div></span>
|
|
435
446
|
|
|
436
447
|
</li>
|
|
@@ -439,7 +450,7 @@ Create a new item representing either a file or folder.
|
|
|
439
450
|
<li class="public ">
|
|
440
451
|
<span class="summary_signature">
|
|
441
452
|
|
|
442
|
-
<a href="#
|
|
453
|
+
<a href="#path-instance_method" title="#path (instance method)">- (String) <strong>path</strong> </a>
|
|
443
454
|
|
|
444
455
|
|
|
445
456
|
|
|
@@ -452,9 +463,8 @@ Create a new item representing either a file or folder.
|
|
|
452
463
|
|
|
453
464
|
|
|
454
465
|
|
|
455
|
-
<span class="summary_desc"><div class='inline'
|
|
456
|
-
|
|
457
|
-
</p>
|
|
466
|
+
<span class="summary_desc"><div class='inline'>
|
|
467
|
+
<p>The path of this item.</p>
|
|
458
468
|
</div></span>
|
|
459
469
|
|
|
460
470
|
</li>
|
|
@@ -463,7 +473,7 @@ Provides an easy way to access this item’s info.
|
|
|
463
473
|
<li class="public ">
|
|
464
474
|
<span class="summary_signature">
|
|
465
475
|
|
|
466
|
-
<a href="#
|
|
476
|
+
<a href="#rename-instance_method" title="#rename (instance method)">- (Item) <strong>rename</strong>(new_name) </a>
|
|
467
477
|
|
|
468
478
|
|
|
469
479
|
|
|
@@ -476,9 +486,8 @@ Provides an easy way to access this item’s info.
|
|
|
476
486
|
|
|
477
487
|
|
|
478
488
|
|
|
479
|
-
<span class="summary_desc"><div class='inline'
|
|
480
|
-
|
|
481
|
-
</p>
|
|
489
|
+
<span class="summary_desc"><div class='inline'>
|
|
490
|
+
<p>Rename this item.</p>
|
|
482
491
|
</div></span>
|
|
483
492
|
|
|
484
493
|
</li>
|
|
@@ -487,7 +496,7 @@ Move this item to the destination folder.
|
|
|
487
496
|
<li class="public ">
|
|
488
497
|
<span class="summary_signature">
|
|
489
498
|
|
|
490
|
-
<a href="#
|
|
499
|
+
<a href="#respond_to%3F-instance_method" title="#respond_to? (instance method)">- (Boolean) <strong>respond_to?</strong>(sym) </a>
|
|
491
500
|
|
|
492
501
|
|
|
493
502
|
|
|
@@ -500,9 +509,8 @@ Move this item to the destination folder.
|
|
|
500
509
|
|
|
501
510
|
|
|
502
511
|
|
|
503
|
-
<span class="summary_desc"><div class='inline'
|
|
504
|
-
|
|
505
|
-
</p>
|
|
512
|
+
<span class="summary_desc"><div class='inline'>
|
|
513
|
+
<p>Handles some cases in method_missing, but won't always be accurate.</p>
|
|
506
514
|
</div></span>
|
|
507
515
|
|
|
508
516
|
</li>
|
|
@@ -511,7 +519,7 @@ The path of this item.
|
|
|
511
519
|
<li class="public ">
|
|
512
520
|
<span class="summary_signature">
|
|
513
521
|
|
|
514
|
-
<a href="#
|
|
522
|
+
<a href="#set_description-instance_method" title="#set_description (instance method)">- (Item) <strong>set_description</strong>(message) </a>
|
|
515
523
|
|
|
516
524
|
|
|
517
525
|
|
|
@@ -524,9 +532,8 @@ The path of this item.
|
|
|
524
532
|
|
|
525
533
|
|
|
526
534
|
|
|
527
|
-
<span class="summary_desc"><div class='inline'
|
|
528
|
-
|
|
529
|
-
</p>
|
|
535
|
+
<span class="summary_desc"><div class='inline'>
|
|
536
|
+
<p>Set the description of this item.</p>
|
|
530
537
|
</div></span>
|
|
531
538
|
|
|
532
539
|
</li>
|
|
@@ -548,9 +555,8 @@ Rename this item.
|
|
|
548
555
|
|
|
549
556
|
|
|
550
557
|
|
|
551
|
-
<span class="summary_desc"><div class='inline'
|
|
552
|
-
The string representation of this item
|
|
553
|
-
</p>
|
|
558
|
+
<span class="summary_desc"><div class='inline'>
|
|
559
|
+
<p>The string representation of this item.</p>
|
|
554
560
|
</div></span>
|
|
555
561
|
|
|
556
562
|
</li>
|
|
@@ -572,9 +578,8 @@ The string representation of this item.
|
|
|
572
578
|
|
|
573
579
|
|
|
574
580
|
|
|
575
|
-
<span class="summary_desc"><div class='inline'
|
|
576
|
-
The plural string representation of this item
|
|
577
|
-
</p>
|
|
581
|
+
<span class="summary_desc"><div class='inline'>
|
|
582
|
+
<p>The plural string representation of this item.</p>
|
|
578
583
|
</div></span>
|
|
579
584
|
|
|
580
585
|
</li>
|
|
@@ -595,9 +600,8 @@ The plural string representation of this item.
|
|
|
595
600
|
|
|
596
601
|
</p><div class="docstring">
|
|
597
602
|
<div class="discussion">
|
|
598
|
-
|
|
599
|
-
Create a new item representing either a file or folder
|
|
600
|
-
</p>
|
|
603
|
+
|
|
604
|
+
<p>Create a new item representing either a file or folder.</p>
|
|
601
605
|
|
|
602
606
|
|
|
603
607
|
</div>
|
|
@@ -616,9 +620,8 @@ Create a new item representing either a file or folder.
|
|
|
616
620
|
|
|
617
621
|
|
|
618
622
|
—
|
|
619
|
-
<div class='inline'
|
|
620
|
-
The <span class='object_link'><a href="Api.html" title="Box::Api (class)">Api</a></span> instance used to generate requests
|
|
621
|
-
</p>
|
|
623
|
+
<div class='inline'>
|
|
624
|
+
<p>The <span class='object_link'><a href="Api.html" title="Box::Api (class)">Api</a></span> instance used to generate requests.</p>
|
|
622
625
|
</div>
|
|
623
626
|
|
|
624
627
|
</li>
|
|
@@ -633,9 +636,8 @@ The <span class='object_link'><a href="Api.html" title="Box::Api (class)">Api</a
|
|
|
633
636
|
|
|
634
637
|
|
|
635
638
|
—
|
|
636
|
-
<div class='inline'
|
|
637
|
-
The <span class='object_link'><a href="Folder.html" title="Box::Folder (class)">Folder</a></span> parent of this item
|
|
638
|
-
</p>
|
|
639
|
+
<div class='inline'>
|
|
640
|
+
<p>The <span class='object_link'><a href="Folder.html" title="Box::Folder (class)">Folder</a></span> parent of this item.</p>
|
|
639
641
|
</div>
|
|
640
642
|
|
|
641
643
|
</li>
|
|
@@ -650,31 +652,31 @@ The <span class='object_link'><a href="Folder.html" title="Box::Folder (class)">
|
|
|
650
652
|
|
|
651
653
|
|
|
652
654
|
—
|
|
653
|
-
<div class='inline'
|
|
654
|
-
The hash of initial info for this item
|
|
655
|
-
</p>
|
|
655
|
+
<div class='inline'>
|
|
656
|
+
<p>The hash of initial info for this item.</p>
|
|
656
657
|
</div>
|
|
657
658
|
|
|
658
659
|
</li>
|
|
659
660
|
|
|
660
661
|
</ul>
|
|
661
662
|
|
|
663
|
+
|
|
662
664
|
</div><table class="source_code">
|
|
663
665
|
<tr>
|
|
664
666
|
<td>
|
|
665
667
|
<pre class="lines">
|
|
666
668
|
|
|
667
669
|
|
|
668
|
-
22
|
|
669
|
-
23
|
|
670
670
|
24
|
|
671
671
|
25
|
|
672
672
|
26
|
|
673
673
|
27
|
|
674
|
-
28
|
|
674
|
+
28
|
|
675
|
+
29
|
|
676
|
+
30</pre>
|
|
675
677
|
</td>
|
|
676
678
|
<td>
|
|
677
|
-
<pre class="code"><span class="info file"># File 'lib/box/item.rb', line
|
|
679
|
+
<pre class="code"><span class="info file"># File 'lib/box/item.rb', line 24</span>
|
|
678
680
|
|
|
679
681
|
<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id api'>api</span><span class='comma'>,</span> <span class='id parent'>parent</span><span class='comma'>,</span> <span class='id info'>info</span><span class='rparen'>)</span>
|
|
680
682
|
<span class='ivar'>@api</span> <span class='op'>=</span> <span class='id api'>api</span>
|
|
@@ -705,9 +707,8 @@ The hash of initial info for this item.
|
|
|
705
707
|
|
|
706
708
|
</p><div class="docstring">
|
|
707
709
|
<div class="discussion">
|
|
708
|
-
|
|
709
|
-
Provides an easy way to access this item
|
|
710
|
-
</p>
|
|
710
|
+
|
|
711
|
+
<p>Provides an easy way to access this item's info.</p>
|
|
711
712
|
|
|
712
713
|
|
|
713
714
|
</div>
|
|
@@ -722,14 +723,13 @@ Provides an easy way to access this item’s info.
|
|
|
722
723
|
|
|
723
724
|
</div>
|
|
724
725
|
|
|
726
|
+
|
|
725
727
|
</div><table class="source_code">
|
|
726
728
|
<tr>
|
|
727
729
|
<td>
|
|
728
730
|
<pre class="lines">
|
|
729
731
|
|
|
730
732
|
|
|
731
|
-
137
|
|
732
|
-
138
|
|
733
733
|
139
|
|
734
734
|
140
|
|
735
735
|
141
|
|
@@ -745,21 +745,41 @@ Provides an easy way to access this item’s info.
|
|
|
745
745
|
151
|
|
746
746
|
152
|
|
747
747
|
153
|
|
748
|
-
154
|
|
748
|
+
154
|
|
749
|
+
155
|
|
750
|
+
156
|
|
751
|
+
157
|
|
752
|
+
158
|
|
753
|
+
159
|
|
754
|
+
160
|
|
755
|
+
161
|
|
756
|
+
162
|
|
757
|
+
163
|
|
758
|
+
164
|
|
759
|
+
165</pre>
|
|
749
760
|
</td>
|
|
750
761
|
<td>
|
|
751
|
-
<pre class="code"><span class="info file"># File 'lib/box/item.rb', line
|
|
762
|
+
<pre class="code"><span class="info file"># File 'lib/box/item.rb', line 139</span>
|
|
752
763
|
|
|
753
764
|
<span class='kw'>def</span> <span class='id method_missing'>method_missing</span><span class='lparen'>(</span><span class='id sym'>sym</span><span class='comma'>,</span> <span class='op'>*</span><span class='id args'>args</span><span class='comma'>,</span> <span class='op'>&</span><span class='id block'>block</span><span class='rparen'>)</span>
|
|
754
765
|
<span class='comment'># TODO: Why not symbols?
|
|
755
766
|
</span> <span class='comment'># convert to a string
|
|
756
767
|
</span> <span class='id str'>str</span> <span class='op'>=</span> <span class='id sym'>sym</span><span class='period'>.</span><span class='id to_s'>to_s</span>
|
|
757
768
|
|
|
769
|
+
<span class='comment'># determine whether to refresh the cache
|
|
770
|
+
</span> <span class='id refresh'>refresh</span> <span class='op'>=</span> <span class='id args'>args</span> <span class='op'>?</span> <span class='id args'>args</span><span class='period'>.</span><span class='id first'>first</span> <span class='op'>:</span> <span class='kw'>false</span>
|
|
771
|
+
|
|
758
772
|
<span class='comment'># return the value if it already exists
|
|
759
|
-
</span> <span class='kw'>return</span> <span class='ivar'>@data</span><span class='lbracket'>[</span><span class='id str'>str</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='ivar'>@data</span><span class='period'>.</span><span class='id key?'>key?</span><span class='lparen'>(</span><span class='id str'>str</span><span class='rparen'>)</span>
|
|
773
|
+
</span> <span class='kw'>return</span> <span class='ivar'>@data</span><span class='lbracket'>[</span><span class='id str'>str</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='kw'>not</span> <span class='id refresh'>refresh</span> <span class='kw'>and</span> <span class='ivar'>@data</span><span class='period'>.</span><span class='id key?'>key?</span><span class='lparen'>(</span><span class='id str'>str</span><span class='rparen'>)</span>
|
|
760
774
|
|
|
761
775
|
<span class='comment'># value didn't exist, so try to update the info
|
|
762
|
-
</span> <span class='
|
|
776
|
+
</span> <span class='comment'># TODO: Figure out a good way to work with multiple sources.
|
|
777
|
+
</span> <span class='kw'>case</span> <span class='id str'>str</span>
|
|
778
|
+
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>comments</span><span class='tstring_end'>'</span></span>
|
|
779
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id get_comments'>get_comments</span>
|
|
780
|
+
<span class='kw'>when</span>
|
|
781
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id info'>info</span><span class='lparen'>(</span><span class='id refresh'>refresh</span><span class='rparen'>)</span>
|
|
782
|
+
<span class='kw'>end</span>
|
|
763
783
|
|
|
764
784
|
<span class='comment'># try returning the value again
|
|
765
785
|
</span> <span class='kw'>return</span> <span class='ivar'>@data</span><span class='lbracket'>[</span><span class='id str'>str</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='ivar'>@data</span><span class='period'>.</span><span class='id key?'>key?</span><span class='lparen'>(</span><span class='id str'>str</span><span class='rparen'>)</span>
|
|
@@ -790,15 +810,15 @@ Provides an easy way to access this item’s info.
|
|
|
790
810
|
|
|
791
811
|
</p><div class="docstring">
|
|
792
812
|
<div class="discussion">
|
|
793
|
-
|
|
794
|
-
The <span class='object_link'><a href="Api.html" title="Box::Api (class)">Api</a></span> used by this item
|
|
795
|
-
</p>
|
|
813
|
+
|
|
814
|
+
<p>The <span class='object_link'><a href="Api.html" title="Box::Api (class)">Api</a></span> used by this item.</p>
|
|
796
815
|
|
|
797
816
|
|
|
798
817
|
</div>
|
|
799
818
|
</div>
|
|
800
819
|
<div class="tags">
|
|
801
|
-
|
|
820
|
+
|
|
821
|
+
<h3>Returns:</h3>
|
|
802
822
|
<ul class="return">
|
|
803
823
|
|
|
804
824
|
<li>
|
|
@@ -809,9 +829,8 @@ The <span class='object_link'><a href="Api.html" title="Box::Api (class)">Api</a
|
|
|
809
829
|
|
|
810
830
|
|
|
811
831
|
—
|
|
812
|
-
<div class='inline'
|
|
813
|
-
The <span class='object_link'><a href="Api.html" title="Box::Api (class)">Api</a></span> used by this item
|
|
814
|
-
</p>
|
|
832
|
+
<div class='inline'>
|
|
833
|
+
<p>The <span class='object_link'><a href="Api.html" title="Box::Api (class)">Api</a></span> used by this item.</p>
|
|
815
834
|
</div>
|
|
816
835
|
|
|
817
836
|
</li>
|
|
@@ -824,12 +843,12 @@ The <span class='object_link'><a href="Api.html" title="Box::Api (class)">Api</a
|
|
|
824
843
|
<pre class="lines">
|
|
825
844
|
|
|
826
845
|
|
|
827
|
-
|
|
828
|
-
|
|
829
|
-
|
|
846
|
+
14
|
|
847
|
+
15
|
|
848
|
+
16</pre>
|
|
830
849
|
</td>
|
|
831
850
|
<td>
|
|
832
|
-
<pre class="code"><span class="info file"># File 'lib/box/item.rb', line
|
|
851
|
+
<pre class="code"><span class="info file"># File 'lib/box/item.rb', line 14</span>
|
|
833
852
|
|
|
834
853
|
<span class='kw'>def</span> <span class='id api'>api</span>
|
|
835
854
|
<span class='ivar'>@api</span>
|
|
@@ -851,15 +870,15 @@ The <span class='object_link'><a href="Api.html" title="Box::Api (class)">Api</a
|
|
|
851
870
|
|
|
852
871
|
</p><div class="docstring">
|
|
853
872
|
<div class="discussion">
|
|
854
|
-
|
|
855
|
-
The hash of info for this item
|
|
856
|
-
</p>
|
|
873
|
+
|
|
874
|
+
<p>The hash of info for this item.</p>
|
|
857
875
|
|
|
858
876
|
|
|
859
877
|
</div>
|
|
860
878
|
</div>
|
|
861
879
|
<div class="tags">
|
|
862
|
-
|
|
880
|
+
|
|
881
|
+
<h3>Returns:</h3>
|
|
863
882
|
<ul class="return">
|
|
864
883
|
|
|
865
884
|
<li>
|
|
@@ -870,9 +889,8 @@ The hash of info for this item.
|
|
|
870
889
|
|
|
871
890
|
|
|
872
891
|
—
|
|
873
|
-
<div class='inline'
|
|
874
|
-
The hash of info for this item
|
|
875
|
-
</p>
|
|
892
|
+
<div class='inline'>
|
|
893
|
+
<p>The hash of info for this item.</p>
|
|
876
894
|
</div>
|
|
877
895
|
|
|
878
896
|
</li>
|
|
@@ -885,12 +903,12 @@ The hash of info for this item.
|
|
|
885
903
|
<pre class="lines">
|
|
886
904
|
|
|
887
905
|
|
|
888
|
-
|
|
889
|
-
|
|
890
|
-
|
|
906
|
+
11
|
|
907
|
+
12
|
|
908
|
+
13</pre>
|
|
891
909
|
</td>
|
|
892
910
|
<td>
|
|
893
|
-
<pre class="code"><span class="info file"># File 'lib/box/item.rb', line
|
|
911
|
+
<pre class="code"><span class="info file"># File 'lib/box/item.rb', line 11</span>
|
|
894
912
|
|
|
895
913
|
<span class='kw'>def</span> <span class='id data'>data</span>
|
|
896
914
|
<span class='ivar'>@data</span>
|
|
@@ -912,15 +930,15 @@ The hash of info for this item.
|
|
|
912
930
|
|
|
913
931
|
</p><div class="docstring">
|
|
914
932
|
<div class="discussion">
|
|
915
|
-
|
|
916
|
-
The parent of this item
|
|
917
|
-
</p>
|
|
933
|
+
|
|
934
|
+
<p>The parent of this item.</p>
|
|
918
935
|
|
|
919
936
|
|
|
920
937
|
</div>
|
|
921
938
|
</div>
|
|
922
939
|
<div class="tags">
|
|
923
|
-
|
|
940
|
+
|
|
941
|
+
<h3>Returns:</h3>
|
|
924
942
|
<ul class="return">
|
|
925
943
|
|
|
926
944
|
<li>
|
|
@@ -931,9 +949,8 @@ The parent of this item.
|
|
|
931
949
|
|
|
932
950
|
|
|
933
951
|
—
|
|
934
|
-
<div class='inline'
|
|
935
|
-
The parent of this item
|
|
936
|
-
</p>
|
|
952
|
+
<div class='inline'>
|
|
953
|
+
<p>The parent of this item.</p>
|
|
937
954
|
</div>
|
|
938
955
|
|
|
939
956
|
</li>
|
|
@@ -946,12 +963,12 @@ The parent of this item.
|
|
|
946
963
|
<pre class="lines">
|
|
947
964
|
|
|
948
965
|
|
|
949
|
-
|
|
950
|
-
|
|
951
|
-
|
|
966
|
+
17
|
|
967
|
+
18
|
|
968
|
+
19</pre>
|
|
952
969
|
</td>
|
|
953
970
|
<td>
|
|
954
|
-
<pre class="code"><span class="info file"># File 'lib/box/item.rb', line
|
|
971
|
+
<pre class="code"><span class="info file"># File 'lib/box/item.rb', line 17</span>
|
|
955
972
|
|
|
956
973
|
<span class='kw'>def</span> <span class='id parent'>parent</span>
|
|
957
974
|
<span class='ivar'>@parent</span>
|
|
@@ -977,15 +994,15 @@ The parent of this item.
|
|
|
977
994
|
|
|
978
995
|
</p><div class="docstring">
|
|
979
996
|
<div class="discussion">
|
|
980
|
-
|
|
981
|
-
The string representation of this item
|
|
982
|
-
</p>
|
|
997
|
+
|
|
998
|
+
<p>The string representation of this item.</p>
|
|
983
999
|
|
|
984
1000
|
|
|
985
1001
|
</div>
|
|
986
1002
|
</div>
|
|
987
1003
|
<div class="tags">
|
|
988
|
-
|
|
1004
|
+
|
|
1005
|
+
<h3>Returns:</h3>
|
|
989
1006
|
<ul class="return">
|
|
990
1007
|
|
|
991
1008
|
<li>
|
|
@@ -996,9 +1013,8 @@ The string representation of this item.
|
|
|
996
1013
|
|
|
997
1014
|
|
|
998
1015
|
—
|
|
999
|
-
<div class='inline'
|
|
1000
|
-
The string representation of this item
|
|
1001
|
-
</p>
|
|
1016
|
+
<div class='inline'>
|
|
1017
|
+
<p>The string representation of this item.</p>
|
|
1002
1018
|
</div>
|
|
1003
1019
|
|
|
1004
1020
|
</li>
|
|
@@ -1011,10 +1027,10 @@ The string representation of this item.
|
|
|
1011
1027
|
<pre class="lines">
|
|
1012
1028
|
|
|
1013
1029
|
|
|
1014
|
-
|
|
1030
|
+
33</pre>
|
|
1015
1031
|
</td>
|
|
1016
1032
|
<td>
|
|
1017
|
-
<pre class="code"><span class="info file"># File 'lib/box/item.rb', line
|
|
1033
|
+
<pre class="code"><span class="info file"># File 'lib/box/item.rb', line 33</span>
|
|
1018
1034
|
|
|
1019
1035
|
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id type'>type</span><span class='semicolon'>;</span> <span class='id raise'>raise</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Overwrite this method</span><span class='tstring_end'>"</span></span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
|
|
1020
1036
|
</td>
|
|
@@ -1031,15 +1047,15 @@ The string representation of this item.
|
|
|
1031
1047
|
|
|
1032
1048
|
</p><div class="docstring">
|
|
1033
1049
|
<div class="discussion">
|
|
1034
|
-
|
|
1035
|
-
The plural string representation of this item
|
|
1036
|
-
</p>
|
|
1050
|
+
|
|
1051
|
+
<p>The plural string representation of this item.</p>
|
|
1037
1052
|
|
|
1038
1053
|
|
|
1039
1054
|
</div>
|
|
1040
1055
|
</div>
|
|
1041
1056
|
<div class="tags">
|
|
1042
|
-
|
|
1057
|
+
|
|
1058
|
+
<h3>Returns:</h3>
|
|
1043
1059
|
<ul class="return">
|
|
1044
1060
|
|
|
1045
1061
|
<li>
|
|
@@ -1050,9 +1066,8 @@ The plural string representation of this item.
|
|
|
1050
1066
|
|
|
1051
1067
|
|
|
1052
1068
|
—
|
|
1053
|
-
<div class='inline'
|
|
1054
|
-
The plural string representation of this item
|
|
1055
|
-
</p>
|
|
1069
|
+
<div class='inline'>
|
|
1070
|
+
<p>The plural string representation of this item.</p>
|
|
1056
1071
|
</div>
|
|
1057
1072
|
|
|
1058
1073
|
</li>
|
|
@@ -1065,10 +1080,10 @@ The plural string representation of this item.
|
|
|
1065
1080
|
<pre class="lines">
|
|
1066
1081
|
|
|
1067
1082
|
|
|
1068
|
-
|
|
1083
|
+
36</pre>
|
|
1069
1084
|
</td>
|
|
1070
1085
|
<td>
|
|
1071
|
-
<pre class="code"><span class="info file"># File 'lib/box/item.rb', line
|
|
1086
|
+
<pre class="code"><span class="info file"># File 'lib/box/item.rb', line 36</span>
|
|
1072
1087
|
|
|
1073
1088
|
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id types'>types</span><span class='semicolon'>;</span> <span class='id type'>type</span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>s</span><span class='tstring_end'>'</span></span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
|
|
1074
1089
|
</td>
|
|
@@ -1094,15 +1109,13 @@ The plural string representation of this item.
|
|
|
1094
1109
|
|
|
1095
1110
|
<div class="note notetag">
|
|
1096
1111
|
<strong>Note:</strong>
|
|
1097
|
-
<div class='inline'
|
|
1098
|
-
Copying folders is not currently supported
|
|
1099
|
-
</p>
|
|
1112
|
+
<div class='inline'>
|
|
1113
|
+
<p>Copying folders is not currently supported.</p>
|
|
1100
1114
|
</div>
|
|
1101
1115
|
</div>
|
|
1102
1116
|
|
|
1103
|
-
|
|
1104
|
-
Copy this item to the destination folder
|
|
1105
|
-
</p>
|
|
1117
|
+
|
|
1118
|
+
<p>Copy this item to the destination folder.</p>
|
|
1106
1119
|
|
|
1107
1120
|
|
|
1108
1121
|
</div>
|
|
@@ -1121,14 +1134,14 @@ Copy this item to the destination folder.
|
|
|
1121
1134
|
|
|
1122
1135
|
|
|
1123
1136
|
—
|
|
1124
|
-
<div class='inline'
|
|
1125
|
-
The parent folder to copy the item to
|
|
1126
|
-
</p>
|
|
1137
|
+
<div class='inline'>
|
|
1138
|
+
<p>The parent folder to copy the item to.</p>
|
|
1127
1139
|
</div>
|
|
1128
1140
|
|
|
1129
1141
|
</li>
|
|
1130
1142
|
|
|
1131
1143
|
</ul>
|
|
1144
|
+
|
|
1132
1145
|
<h3>Returns:</h3>
|
|
1133
1146
|
<ul class="return">
|
|
1134
1147
|
|
|
@@ -1140,9 +1153,8 @@ The parent folder to copy the item to.
|
|
|
1140
1153
|
|
|
1141
1154
|
|
|
1142
1155
|
—
|
|
1143
|
-
<div class='inline'
|
|
1144
|
-
The new copy of this item
|
|
1145
|
-
</p>
|
|
1156
|
+
<div class='inline'>
|
|
1157
|
+
<p>The new copy of this item.</p>
|
|
1146
1158
|
</div>
|
|
1147
1159
|
|
|
1148
1160
|
</li>
|
|
@@ -1155,16 +1167,16 @@ The new copy of this item.
|
|
|
1155
1167
|
<pre class="lines">
|
|
1156
1168
|
|
|
1157
1169
|
|
|
1158
|
-
85
|
|
1159
|
-
86
|
|
1160
1170
|
87
|
|
1161
1171
|
88
|
|
1162
1172
|
89
|
|
1163
1173
|
90
|
|
1164
|
-
91
|
|
1174
|
+
91
|
|
1175
|
+
92
|
|
1176
|
+
93</pre>
|
|
1165
1177
|
</td>
|
|
1166
1178
|
<td>
|
|
1167
|
-
<pre class="code"><span class="info file"># File 'lib/box/item.rb', line
|
|
1179
|
+
<pre class="code"><span class="info file"># File 'lib/box/item.rb', line 87</span>
|
|
1168
1180
|
|
|
1169
1181
|
<span class='kw'>def</span> <span class='id copy'>copy</span><span class='lparen'>(</span><span class='id destination'>destination</span><span class='rparen'>)</span>
|
|
1170
1182
|
<span class='ivar'>@api</span><span class='period'>.</span><span class='id copy'>copy</span><span class='lparen'>(</span><span class='id type'>type</span><span class='comma'>,</span> <span class='id id'>id</span><span class='comma'>,</span> <span class='id destination'>destination</span><span class='period'>.</span><span class='id id'>id</span><span class='rparen'>)</span>
|
|
@@ -1187,18 +1199,17 @@ The new copy of this item.
|
|
|
1187
1199
|
|
|
1188
1200
|
</p><div class="docstring">
|
|
1189
1201
|
<div class="discussion">
|
|
1190
|
-
|
|
1191
|
-
Delete this item and all sub-items
|
|
1192
|
-
|
|
1193
|
-
<p>
|
|
1194
|
-
TODO: Return nil instead
|
|
1195
|
-
</p>
|
|
1202
|
+
|
|
1203
|
+
<p>Delete this item and all sub-items.</p>
|
|
1204
|
+
|
|
1205
|
+
<p>TODO: Return nil instead</p>
|
|
1196
1206
|
|
|
1197
1207
|
|
|
1198
1208
|
</div>
|
|
1199
1209
|
</div>
|
|
1200
1210
|
<div class="tags">
|
|
1201
|
-
|
|
1211
|
+
|
|
1212
|
+
<h3>Returns:</h3>
|
|
1202
1213
|
<ul class="return">
|
|
1203
1214
|
|
|
1204
1215
|
<li>
|
|
@@ -1209,9 +1220,8 @@ TODO: Return nil instead
|
|
|
1209
1220
|
|
|
1210
1221
|
|
|
1211
1222
|
—
|
|
1212
|
-
<div class='inline'
|
|
1213
|
-
self
|
|
1214
|
-
</p>
|
|
1223
|
+
<div class='inline'>
|
|
1224
|
+
<p>self</p>
|
|
1215
1225
|
</div>
|
|
1216
1226
|
|
|
1217
1227
|
</li>
|
|
@@ -1224,17 +1234,17 @@ self
|
|
|
1224
1234
|
<pre class="lines">
|
|
1225
1235
|
|
|
1226
1236
|
|
|
1227
|
-
109
|
|
1228
|
-
110
|
|
1229
1237
|
111
|
|
1230
1238
|
112
|
|
1231
1239
|
113
|
|
1232
1240
|
114
|
|
1233
1241
|
115
|
|
1234
|
-
116
|
|
1242
|
+
116
|
|
1243
|
+
117
|
|
1244
|
+
118</pre>
|
|
1235
1245
|
</td>
|
|
1236
1246
|
<td>
|
|
1237
|
-
<pre class="code"><span class="info file"># File 'lib/box/item.rb', line
|
|
1247
|
+
<pre class="code"><span class="info file"># File 'lib/box/item.rb', line 111</span>
|
|
1238
1248
|
|
|
1239
1249
|
<span class='kw'>def</span> <span class='id delete'>delete</span>
|
|
1240
1250
|
<span class='ivar'>@api</span><span class='period'>.</span><span class='id delete'>delete</span><span class='lparen'>(</span><span class='id type'>type</span><span class='comma'>,</span> <span class='id id'>id</span><span class='rparen'>)</span>
|
|
@@ -1247,89 +1257,6 @@ self
|
|
|
1247
1257
|
</td>
|
|
1248
1258
|
</tr>
|
|
1249
1259
|
</table>
|
|
1250
|
-
</div>
|
|
1251
|
-
|
|
1252
|
-
<div class="method_details ">
|
|
1253
|
-
<p class="signature " id="description-instance_method">
|
|
1254
|
-
|
|
1255
|
-
- (<tt><span class='object_link'><a href="" title="Box::Item (class)">Item</a></span></tt>) <strong>description</strong>(message)
|
|
1256
|
-
|
|
1257
|
-
|
|
1258
|
-
|
|
1259
|
-
</p><div class="docstring">
|
|
1260
|
-
<div class="discussion">
|
|
1261
|
-
<p>
|
|
1262
|
-
Set the description of this item.
|
|
1263
|
-
</p>
|
|
1264
|
-
|
|
1265
|
-
|
|
1266
|
-
</div>
|
|
1267
|
-
</div>
|
|
1268
|
-
<div class="tags">
|
|
1269
|
-
<h3>Parameters:</h3>
|
|
1270
|
-
<ul class="param">
|
|
1271
|
-
|
|
1272
|
-
<li>
|
|
1273
|
-
|
|
1274
|
-
<span class='name'>message</span>
|
|
1275
|
-
|
|
1276
|
-
|
|
1277
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
1278
|
-
|
|
1279
|
-
|
|
1280
|
-
|
|
1281
|
-
—
|
|
1282
|
-
<div class='inline'><p>
|
|
1283
|
-
The description message to use.
|
|
1284
|
-
</p>
|
|
1285
|
-
</div>
|
|
1286
|
-
|
|
1287
|
-
</li>
|
|
1288
|
-
|
|
1289
|
-
</ul>
|
|
1290
|
-
<h3>Returns:</h3>
|
|
1291
|
-
<ul class="return">
|
|
1292
|
-
|
|
1293
|
-
<li>
|
|
1294
|
-
|
|
1295
|
-
|
|
1296
|
-
<span class='type'>(<tt><span class='object_link'><a href="" title="Box::Item (class)">Item</a></span></tt>)</span>
|
|
1297
|
-
|
|
1298
|
-
|
|
1299
|
-
|
|
1300
|
-
—
|
|
1301
|
-
<div class='inline'><p>
|
|
1302
|
-
self
|
|
1303
|
-
</p>
|
|
1304
|
-
</div>
|
|
1305
|
-
|
|
1306
|
-
</li>
|
|
1307
|
-
|
|
1308
|
-
</ul>
|
|
1309
|
-
|
|
1310
|
-
</div><table class="source_code">
|
|
1311
|
-
<tr>
|
|
1312
|
-
<td>
|
|
1313
|
-
<pre class="lines">
|
|
1314
|
-
|
|
1315
|
-
|
|
1316
|
-
122
|
|
1317
|
-
123
|
|
1318
|
-
124
|
|
1319
|
-
125
|
|
1320
|
-
126</pre>
|
|
1321
|
-
</td>
|
|
1322
|
-
<td>
|
|
1323
|
-
<pre class="code"><span class="info file"># File 'lib/box/item.rb', line 122</span>
|
|
1324
|
-
|
|
1325
|
-
<span class='kw'>def</span> <span class='id description'>description</span><span class='lparen'>(</span><span class='id message'>message</span><span class='rparen'>)</span>
|
|
1326
|
-
<span class='ivar'>@api</span><span class='period'>.</span><span class='id set_description'>set_description</span><span class='lparen'>(</span><span class='id type'>type</span><span class='comma'>,</span> <span class='id id'>id</span><span class='comma'>,</span> <span class='id message'>message</span><span class='rparen'>)</span>
|
|
1327
|
-
|
|
1328
|
-
<span class='kw'>self</span>
|
|
1329
|
-
<span class='kw'>end</span></pre>
|
|
1330
|
-
</td>
|
|
1331
|
-
</tr>
|
|
1332
|
-
</table>
|
|
1333
1260
|
</div>
|
|
1334
1261
|
|
|
1335
1262
|
<div class="method_details ">
|
|
@@ -1341,28 +1268,28 @@ self
|
|
|
1341
1268
|
|
|
1342
1269
|
</p><div class="docstring">
|
|
1343
1270
|
<div class="discussion">
|
|
1344
|
-
|
|
1345
|
-
Consider the item cached. This prevents an additional api when we know the
|
|
1346
|
-
item is fully fetched
|
|
1347
|
-
</p>
|
|
1271
|
+
|
|
1272
|
+
<p>Consider the item cached. This prevents an additional api when we know the
|
|
1273
|
+
item is fully fetched.</p>
|
|
1348
1274
|
|
|
1349
1275
|
|
|
1350
1276
|
</div>
|
|
1351
1277
|
</div>
|
|
1352
1278
|
<div class="tags">
|
|
1353
1279
|
|
|
1280
|
+
|
|
1354
1281
|
</div><table class="source_code">
|
|
1355
1282
|
<tr>
|
|
1356
1283
|
<td>
|
|
1357
1284
|
<pre class="lines">
|
|
1358
1285
|
|
|
1359
1286
|
|
|
1360
|
-
|
|
1361
|
-
|
|
1362
|
-
|
|
1287
|
+
174
|
|
1288
|
+
175
|
|
1289
|
+
176</pre>
|
|
1363
1290
|
</td>
|
|
1364
1291
|
<td>
|
|
1365
|
-
<pre class="code"><span class="info file"># File 'lib/box/item.rb', line
|
|
1292
|
+
<pre class="code"><span class="info file"># File 'lib/box/item.rb', line 174</span>
|
|
1366
1293
|
|
|
1367
1294
|
<span class='kw'>def</span> <span class='id force_cached_info'>force_cached_info</span>
|
|
1368
1295
|
<span class='ivar'>@cached_info</span> <span class='op'>=</span> <span class='kw'>true</span>
|
|
@@ -1381,15 +1308,15 @@ item is fully fetched.
|
|
|
1381
1308
|
|
|
1382
1309
|
</p><div class="docstring">
|
|
1383
1310
|
<div class="discussion">
|
|
1384
|
-
|
|
1385
|
-
The id of this item
|
|
1386
|
-
</p>
|
|
1311
|
+
|
|
1312
|
+
<p>The id of this item.</p>
|
|
1387
1313
|
|
|
1388
1314
|
|
|
1389
1315
|
</div>
|
|
1390
1316
|
</div>
|
|
1391
1317
|
<div class="tags">
|
|
1392
|
-
|
|
1318
|
+
|
|
1319
|
+
<h3>Returns:</h3>
|
|
1393
1320
|
<ul class="return">
|
|
1394
1321
|
|
|
1395
1322
|
<li>
|
|
@@ -1400,9 +1327,8 @@ The id of this item.
|
|
|
1400
1327
|
|
|
1401
1328
|
|
|
1402
1329
|
—
|
|
1403
|
-
<div class='inline'
|
|
1404
|
-
The id of this item
|
|
1405
|
-
</p>
|
|
1330
|
+
<div class='inline'>
|
|
1331
|
+
<p>The id of this item.</p>
|
|
1406
1332
|
</div>
|
|
1407
1333
|
|
|
1408
1334
|
</li>
|
|
@@ -1415,13 +1341,13 @@ The id of this item.
|
|
|
1415
1341
|
<pre class="lines">
|
|
1416
1342
|
|
|
1417
1343
|
|
|
1418
|
-
45
|
|
1419
|
-
46
|
|
1420
1344
|
47
|
|
1421
|
-
48
|
|
1345
|
+
48
|
|
1346
|
+
49
|
|
1347
|
+
50</pre>
|
|
1422
1348
|
</td>
|
|
1423
1349
|
<td>
|
|
1424
|
-
<pre class="code"><span class="info file"># File 'lib/box/item.rb', line
|
|
1350
|
+
<pre class="code"><span class="info file"># File 'lib/box/item.rb', line 47</span>
|
|
1425
1351
|
|
|
1426
1352
|
<span class='kw'>def</span> <span class='id id'>id</span>
|
|
1427
1353
|
<span class='comment'># overloads Object#id
|
|
@@ -1441,10 +1367,9 @@ The id of this item.
|
|
|
1441
1367
|
|
|
1442
1368
|
</p><div class="docstring">
|
|
1443
1369
|
<div class="discussion">
|
|
1444
|
-
|
|
1445
|
-
Get the info for this item. Uses a cached copy if avaliable, or else it is
|
|
1446
|
-
fetched from the api
|
|
1447
|
-
</p>
|
|
1370
|
+
|
|
1371
|
+
<p>Get the info for this item. Uses a cached copy if avaliable, or else it is
|
|
1372
|
+
fetched from the api.</p>
|
|
1448
1373
|
|
|
1449
1374
|
|
|
1450
1375
|
</div>
|
|
@@ -1465,14 +1390,14 @@ fetched from the api.
|
|
|
1465
1390
|
|
|
1466
1391
|
|
|
1467
1392
|
—
|
|
1468
|
-
<div class='inline'
|
|
1469
|
-
Does not use the cached copy if true
|
|
1470
|
-
</p>
|
|
1393
|
+
<div class='inline'>
|
|
1394
|
+
<p>Does not use the cached copy if true.</p>
|
|
1471
1395
|
</div>
|
|
1472
1396
|
|
|
1473
1397
|
</li>
|
|
1474
1398
|
|
|
1475
1399
|
</ul>
|
|
1400
|
+
|
|
1476
1401
|
<h3>Returns:</h3>
|
|
1477
1402
|
<ul class="return">
|
|
1478
1403
|
|
|
@@ -1484,9 +1409,8 @@ Does not use the cached copy if true.
|
|
|
1484
1409
|
|
|
1485
1410
|
|
|
1486
1411
|
—
|
|
1487
|
-
<div class='inline'
|
|
1488
|
-
self
|
|
1489
|
-
</p>
|
|
1412
|
+
<div class='inline'>
|
|
1413
|
+
<p>self</p>
|
|
1490
1414
|
</div>
|
|
1491
1415
|
|
|
1492
1416
|
</li>
|
|
@@ -1499,17 +1423,17 @@ self
|
|
|
1499
1423
|
<pre class="lines">
|
|
1500
1424
|
|
|
1501
1425
|
|
|
1502
|
-
55
|
|
1503
|
-
56
|
|
1504
1426
|
57
|
|
1505
1427
|
58
|
|
1506
1428
|
59
|
|
1507
1429
|
60
|
|
1508
1430
|
61
|
|
1509
|
-
62
|
|
1431
|
+
62
|
|
1432
|
+
63
|
|
1433
|
+
64</pre>
|
|
1510
1434
|
</td>
|
|
1511
1435
|
<td>
|
|
1512
|
-
<pre class="code"><span class="info file"># File 'lib/box/item.rb', line
|
|
1436
|
+
<pre class="code"><span class="info file"># File 'lib/box/item.rb', line 57</span>
|
|
1513
1437
|
|
|
1514
1438
|
<span class='kw'>def</span> <span class='id info'>info</span><span class='lparen'>(</span><span class='id refresh'>refresh</span> <span class='op'>=</span> <span class='kw'>false</span><span class='rparen'>)</span>
|
|
1515
1439
|
<span class='kw'>return</span> <span class='kw'>self</span> <span class='kw'>if</span> <span class='ivar'>@cached_info</span> <span class='kw'>and</span> <span class='kw'>not</span> <span class='id refresh'>refresh</span>
|
|
@@ -1533,9 +1457,8 @@ self
|
|
|
1533
1457
|
|
|
1534
1458
|
</p><div class="docstring">
|
|
1535
1459
|
<div class="discussion">
|
|
1536
|
-
|
|
1537
|
-
Move this item to the destination folder
|
|
1538
|
-
</p>
|
|
1460
|
+
|
|
1461
|
+
<p>Move this item to the destination folder.</p>
|
|
1539
1462
|
|
|
1540
1463
|
|
|
1541
1464
|
</div>
|
|
@@ -1554,14 +1477,14 @@ Move this item to the destination folder.
|
|
|
1554
1477
|
|
|
1555
1478
|
|
|
1556
1479
|
—
|
|
1557
|
-
<div class='inline'
|
|
1558
|
-
The new parent folder to use
|
|
1559
|
-
</p>
|
|
1480
|
+
<div class='inline'>
|
|
1481
|
+
<p>The new parent folder to use.</p>
|
|
1560
1482
|
</div>
|
|
1561
1483
|
|
|
1562
1484
|
</li>
|
|
1563
1485
|
|
|
1564
1486
|
</ul>
|
|
1487
|
+
|
|
1565
1488
|
<h3>Returns:</h3>
|
|
1566
1489
|
<ul class="return">
|
|
1567
1490
|
|
|
@@ -1573,9 +1496,8 @@ The new parent folder to use.
|
|
|
1573
1496
|
|
|
1574
1497
|
|
|
1575
1498
|
—
|
|
1576
|
-
<div class='inline'
|
|
1577
|
-
self
|
|
1578
|
-
</p>
|
|
1499
|
+
<div class='inline'>
|
|
1500
|
+
<p>self</p>
|
|
1579
1501
|
</div>
|
|
1580
1502
|
|
|
1581
1503
|
</li>
|
|
@@ -1588,8 +1510,6 @@ self
|
|
|
1588
1510
|
<pre class="lines">
|
|
1589
1511
|
|
|
1590
1512
|
|
|
1591
|
-
68
|
|
1592
|
-
69
|
|
1593
1513
|
70
|
|
1594
1514
|
71
|
|
1595
1515
|
72
|
|
@@ -1597,10 +1517,12 @@ self
|
|
|
1597
1517
|
74
|
|
1598
1518
|
75
|
|
1599
1519
|
76
|
|
1600
|
-
77
|
|
1520
|
+
77
|
|
1521
|
+
78
|
|
1522
|
+
79</pre>
|
|
1601
1523
|
</td>
|
|
1602
1524
|
<td>
|
|
1603
|
-
<pre class="code"><span class="info file"># File 'lib/box/item.rb', line
|
|
1525
|
+
<pre class="code"><span class="info file"># File 'lib/box/item.rb', line 70</span>
|
|
1604
1526
|
|
|
1605
1527
|
<span class='kw'>def</span> <span class='id move'>move</span><span class='lparen'>(</span><span class='id destination'>destination</span><span class='rparen'>)</span>
|
|
1606
1528
|
<span class='ivar'>@api</span><span class='period'>.</span><span class='id move'>move</span><span class='lparen'>(</span><span class='id type'>type</span><span class='comma'>,</span> <span class='id id'>id</span><span class='comma'>,</span> <span class='id destination'>destination</span><span class='period'>.</span><span class='id id'>id</span><span class='rparen'>)</span>
|
|
@@ -1626,15 +1548,15 @@ self
|
|
|
1626
1548
|
|
|
1627
1549
|
</p><div class="docstring">
|
|
1628
1550
|
<div class="discussion">
|
|
1629
|
-
|
|
1630
|
-
The path of this item. This starts with a
|
|
1631
|
-
</p>
|
|
1551
|
+
|
|
1552
|
+
<p>The path of this item. This starts with a '/', unless it is root.</p>
|
|
1632
1553
|
|
|
1633
1554
|
|
|
1634
1555
|
</div>
|
|
1635
1556
|
</div>
|
|
1636
1557
|
<div class="tags">
|
|
1637
|
-
|
|
1558
|
+
|
|
1559
|
+
<h3>Returns:</h3>
|
|
1638
1560
|
<ul class="return">
|
|
1639
1561
|
|
|
1640
1562
|
<li>
|
|
@@ -1645,9 +1567,8 @@ The path of this item. This starts with a ’/’.
|
|
|
1645
1567
|
|
|
1646
1568
|
|
|
1647
1569
|
—
|
|
1648
|
-
<div class='inline'
|
|
1649
|
-
The path of this item. This starts with a
|
|
1650
|
-
</p>
|
|
1570
|
+
<div class='inline'>
|
|
1571
|
+
<p>The path of this item. This starts with a '/', unless it is root.</p>
|
|
1651
1572
|
</div>
|
|
1652
1573
|
|
|
1653
1574
|
</li>
|
|
@@ -1660,12 +1581,12 @@ The path of this item. This starts with a ’/’.
|
|
|
1660
1581
|
<pre class="lines">
|
|
1661
1582
|
|
|
1662
1583
|
|
|
1663
|
-
|
|
1664
|
-
|
|
1665
|
-
|
|
1584
|
+
131
|
|
1585
|
+
132
|
|
1586
|
+
133</pre>
|
|
1666
1587
|
</td>
|
|
1667
1588
|
<td>
|
|
1668
|
-
<pre class="code"><span class="info file"># File 'lib/box/item.rb', line
|
|
1589
|
+
<pre class="code"><span class="info file"># File 'lib/box/item.rb', line 131</span>
|
|
1669
1590
|
|
|
1670
1591
|
<span class='kw'>def</span> <span class='id path'>path</span>
|
|
1671
1592
|
<span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span> <span class='id parent'>parent</span><span class='period'>.</span><span class='id path'>path</span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/</span><span class='tstring_end'>'</span></span> <span class='kw'>if</span> <span class='id parent'>parent</span> <span class='rbrace'>}</span><span class='embexpr_beg'>#{</span> <span class='id name'>name</span> <span class='rbrace'>}</span><span class='tstring_end'>"</span></span>
|
|
@@ -1684,9 +1605,8 @@ The path of this item. This starts with a ’/’.
|
|
|
1684
1605
|
|
|
1685
1606
|
</p><div class="docstring">
|
|
1686
1607
|
<div class="discussion">
|
|
1687
|
-
|
|
1688
|
-
Rename this item
|
|
1689
|
-
</p>
|
|
1608
|
+
|
|
1609
|
+
<p>Rename this item.</p>
|
|
1690
1610
|
|
|
1691
1611
|
|
|
1692
1612
|
</div>
|
|
@@ -1705,14 +1625,14 @@ Rename this item.
|
|
|
1705
1625
|
|
|
1706
1626
|
|
|
1707
1627
|
—
|
|
1708
|
-
<div class='inline'
|
|
1709
|
-
The new name for the item
|
|
1710
|
-
</p>
|
|
1628
|
+
<div class='inline'>
|
|
1629
|
+
<p>The new name for the item.</p>
|
|
1711
1630
|
</div>
|
|
1712
1631
|
|
|
1713
1632
|
</li>
|
|
1714
1633
|
|
|
1715
1634
|
</ul>
|
|
1635
|
+
|
|
1716
1636
|
<h3>Returns:</h3>
|
|
1717
1637
|
<ul class="return">
|
|
1718
1638
|
|
|
@@ -1724,9 +1644,8 @@ The new name for the item.
|
|
|
1724
1644
|
|
|
1725
1645
|
|
|
1726
1646
|
—
|
|
1727
|
-
<div class='inline'
|
|
1728
|
-
self
|
|
1729
|
-
</p>
|
|
1647
|
+
<div class='inline'>
|
|
1648
|
+
<p>self</p>
|
|
1730
1649
|
</div>
|
|
1731
1650
|
|
|
1732
1651
|
</li>
|
|
@@ -1739,16 +1658,16 @@ self
|
|
|
1739
1658
|
<pre class="lines">
|
|
1740
1659
|
|
|
1741
1660
|
|
|
1742
|
-
97
|
|
1743
|
-
98
|
|
1744
1661
|
99
|
|
1745
1662
|
100
|
|
1746
1663
|
101
|
|
1747
1664
|
102
|
|
1748
|
-
103
|
|
1665
|
+
103
|
|
1666
|
+
104
|
|
1667
|
+
105</pre>
|
|
1749
1668
|
</td>
|
|
1750
1669
|
<td>
|
|
1751
|
-
<pre class="code"><span class="info file"># File 'lib/box/item.rb', line
|
|
1670
|
+
<pre class="code"><span class="info file"># File 'lib/box/item.rb', line 99</span>
|
|
1752
1671
|
|
|
1753
1672
|
<span class='kw'>def</span> <span class='id rename'>rename</span><span class='lparen'>(</span><span class='id new_name'>new_name</span><span class='rparen'>)</span>
|
|
1754
1673
|
<span class='ivar'>@api</span><span class='period'>.</span><span class='id rename'>rename</span><span class='lparen'>(</span><span class='id type'>type</span><span class='comma'>,</span> <span class='id id'>id</span><span class='comma'>,</span> <span class='id new_name'>new_name</span><span class='rparen'>)</span>
|
|
@@ -1760,6 +1679,139 @@ self
|
|
|
1760
1679
|
</td>
|
|
1761
1680
|
</tr>
|
|
1762
1681
|
</table>
|
|
1682
|
+
</div>
|
|
1683
|
+
|
|
1684
|
+
<div class="method_details ">
|
|
1685
|
+
<p class="signature " id="respond_to?-instance_method">
|
|
1686
|
+
|
|
1687
|
+
- (<tt>Boolean</tt>) <strong>respond_to?</strong>(sym)
|
|
1688
|
+
|
|
1689
|
+
|
|
1690
|
+
|
|
1691
|
+
</p><div class="docstring">
|
|
1692
|
+
<div class="discussion">
|
|
1693
|
+
|
|
1694
|
+
<p>Handles some cases in method_missing, but won't always be accurate.</p>
|
|
1695
|
+
|
|
1696
|
+
|
|
1697
|
+
</div>
|
|
1698
|
+
</div>
|
|
1699
|
+
<div class="tags">
|
|
1700
|
+
|
|
1701
|
+
<h3>Returns:</h3>
|
|
1702
|
+
<ul class="return">
|
|
1703
|
+
|
|
1704
|
+
<li>
|
|
1705
|
+
|
|
1706
|
+
|
|
1707
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
1708
|
+
|
|
1709
|
+
|
|
1710
|
+
|
|
1711
|
+
</li>
|
|
1712
|
+
|
|
1713
|
+
</ul>
|
|
1714
|
+
|
|
1715
|
+
</div><table class="source_code">
|
|
1716
|
+
<tr>
|
|
1717
|
+
<td>
|
|
1718
|
+
<pre class="lines">
|
|
1719
|
+
|
|
1720
|
+
|
|
1721
|
+
168
|
|
1722
|
+
169
|
|
1723
|
+
170</pre>
|
|
1724
|
+
</td>
|
|
1725
|
+
<td>
|
|
1726
|
+
<pre class="code"><span class="info file"># File 'lib/box/item.rb', line 168</span>
|
|
1727
|
+
|
|
1728
|
+
<span class='kw'>def</span> <span class='id respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='id sym'>sym</span><span class='rparen'>)</span>
|
|
1729
|
+
<span class='ivar'>@data</span><span class='period'>.</span><span class='id key?'>key?</span><span class='lparen'>(</span><span class='id sym'>sym</span><span class='period'>.</span><span class='id to_s'>to_s</span><span class='rparen'>)</span> <span class='kw'>or</span> <span class='kw'>super</span>
|
|
1730
|
+
<span class='kw'>end</span></pre>
|
|
1731
|
+
</td>
|
|
1732
|
+
</tr>
|
|
1733
|
+
</table>
|
|
1734
|
+
</div>
|
|
1735
|
+
|
|
1736
|
+
<div class="method_details ">
|
|
1737
|
+
<p class="signature " id="set_description-instance_method">
|
|
1738
|
+
|
|
1739
|
+
- (<tt><span class='object_link'><a href="" title="Box::Item (class)">Item</a></span></tt>) <strong>set_description</strong>(message)
|
|
1740
|
+
|
|
1741
|
+
|
|
1742
|
+
|
|
1743
|
+
</p><div class="docstring">
|
|
1744
|
+
<div class="discussion">
|
|
1745
|
+
|
|
1746
|
+
<p>Set the description of this item.</p>
|
|
1747
|
+
|
|
1748
|
+
|
|
1749
|
+
</div>
|
|
1750
|
+
</div>
|
|
1751
|
+
<div class="tags">
|
|
1752
|
+
<h3>Parameters:</h3>
|
|
1753
|
+
<ul class="param">
|
|
1754
|
+
|
|
1755
|
+
<li>
|
|
1756
|
+
|
|
1757
|
+
<span class='name'>message</span>
|
|
1758
|
+
|
|
1759
|
+
|
|
1760
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1761
|
+
|
|
1762
|
+
|
|
1763
|
+
|
|
1764
|
+
—
|
|
1765
|
+
<div class='inline'>
|
|
1766
|
+
<p>The description message to use.</p>
|
|
1767
|
+
</div>
|
|
1768
|
+
|
|
1769
|
+
</li>
|
|
1770
|
+
|
|
1771
|
+
</ul>
|
|
1772
|
+
|
|
1773
|
+
<h3>Returns:</h3>
|
|
1774
|
+
<ul class="return">
|
|
1775
|
+
|
|
1776
|
+
<li>
|
|
1777
|
+
|
|
1778
|
+
|
|
1779
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Box::Item (class)">Item</a></span></tt>)</span>
|
|
1780
|
+
|
|
1781
|
+
|
|
1782
|
+
|
|
1783
|
+
—
|
|
1784
|
+
<div class='inline'>
|
|
1785
|
+
<p>self</p>
|
|
1786
|
+
</div>
|
|
1787
|
+
|
|
1788
|
+
</li>
|
|
1789
|
+
|
|
1790
|
+
</ul>
|
|
1791
|
+
|
|
1792
|
+
</div><table class="source_code">
|
|
1793
|
+
<tr>
|
|
1794
|
+
<td>
|
|
1795
|
+
<pre class="lines">
|
|
1796
|
+
|
|
1797
|
+
|
|
1798
|
+
124
|
|
1799
|
+
125
|
|
1800
|
+
126
|
|
1801
|
+
127
|
|
1802
|
+
128</pre>
|
|
1803
|
+
</td>
|
|
1804
|
+
<td>
|
|
1805
|
+
<pre class="code"><span class="info file"># File 'lib/box/item.rb', line 124</span>
|
|
1806
|
+
|
|
1807
|
+
<span class='kw'>def</span> <span class='id set_description'>set_description</span><span class='lparen'>(</span><span class='id message'>message</span><span class='rparen'>)</span>
|
|
1808
|
+
<span class='ivar'>@api</span><span class='period'>.</span><span class='id set_description'>set_description</span><span class='lparen'>(</span><span class='id type'>type</span><span class='comma'>,</span> <span class='id id'>id</span><span class='comma'>,</span> <span class='id message'>message</span><span class='rparen'>)</span>
|
|
1809
|
+
|
|
1810
|
+
<span class='kw'>self</span>
|
|
1811
|
+
<span class='kw'>end</span></pre>
|
|
1812
|
+
</td>
|
|
1813
|
+
</tr>
|
|
1814
|
+
</table>
|
|
1763
1815
|
</div>
|
|
1764
1816
|
|
|
1765
1817
|
<div class="method_details ">
|
|
@@ -1771,15 +1823,15 @@ self
|
|
|
1771
1823
|
|
|
1772
1824
|
</p><div class="docstring">
|
|
1773
1825
|
<div class="discussion">
|
|
1774
|
-
|
|
1775
|
-
The string representation of this item
|
|
1776
|
-
</p>
|
|
1826
|
+
|
|
1827
|
+
<p>The string representation of this item.</p>
|
|
1777
1828
|
|
|
1778
1829
|
|
|
1779
1830
|
</div>
|
|
1780
1831
|
</div>
|
|
1781
1832
|
<div class="tags">
|
|
1782
|
-
|
|
1833
|
+
|
|
1834
|
+
<h3>Returns:</h3>
|
|
1783
1835
|
<ul class="return">
|
|
1784
1836
|
|
|
1785
1837
|
<li>
|
|
@@ -1790,9 +1842,8 @@ The string representation of this item.
|
|
|
1790
1842
|
|
|
1791
1843
|
|
|
1792
1844
|
—
|
|
1793
|
-
<div class='inline'
|
|
1794
|
-
The string representation of this item
|
|
1795
|
-
</p>
|
|
1845
|
+
<div class='inline'>
|
|
1846
|
+
<p>The string representation of this item.</p>
|
|
1796
1847
|
</div>
|
|
1797
1848
|
|
|
1798
1849
|
</li>
|
|
@@ -1805,10 +1856,10 @@ The string representation of this item.
|
|
|
1805
1856
|
<pre class="lines">
|
|
1806
1857
|
|
|
1807
1858
|
|
|
1808
|
-
|
|
1859
|
+
41</pre>
|
|
1809
1860
|
</td>
|
|
1810
1861
|
<td>
|
|
1811
|
-
<pre class="code"><span class="info file"># File 'lib/box/item.rb', line
|
|
1862
|
+
<pre class="code"><span class="info file"># File 'lib/box/item.rb', line 41</span>
|
|
1812
1863
|
|
|
1813
1864
|
<span class='kw'>def</span> <span class='id type'>type</span><span class='semicolon'>;</span> <span class='kw'>self</span><span class='period'>.</span><span class='id class'>class</span><span class='period'>.</span><span class='id type'>type</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
|
|
1814
1865
|
</td>
|
|
@@ -1825,15 +1876,15 @@ The string representation of this item.
|
|
|
1825
1876
|
|
|
1826
1877
|
</p><div class="docstring">
|
|
1827
1878
|
<div class="discussion">
|
|
1828
|
-
|
|
1829
|
-
The plural string representation of this item
|
|
1830
|
-
</p>
|
|
1879
|
+
|
|
1880
|
+
<p>The plural string representation of this item.</p>
|
|
1831
1881
|
|
|
1832
1882
|
|
|
1833
1883
|
</div>
|
|
1834
1884
|
</div>
|
|
1835
1885
|
<div class="tags">
|
|
1836
|
-
|
|
1886
|
+
|
|
1887
|
+
<h3>Returns:</h3>
|
|
1837
1888
|
<ul class="return">
|
|
1838
1889
|
|
|
1839
1890
|
<li>
|
|
@@ -1844,9 +1895,8 @@ The plural string representation of this item.
|
|
|
1844
1895
|
|
|
1845
1896
|
|
|
1846
1897
|
—
|
|
1847
|
-
<div class='inline'
|
|
1848
|
-
The plural string representation of this item
|
|
1849
|
-
</p>
|
|
1898
|
+
<div class='inline'>
|
|
1899
|
+
<p>The plural string representation of this item.</p>
|
|
1850
1900
|
</div>
|
|
1851
1901
|
|
|
1852
1902
|
</li>
|
|
@@ -1859,10 +1909,10 @@ The plural string representation of this item.
|
|
|
1859
1909
|
<pre class="lines">
|
|
1860
1910
|
|
|
1861
1911
|
|
|
1862
|
-
|
|
1912
|
+
44</pre>
|
|
1863
1913
|
</td>
|
|
1864
1914
|
<td>
|
|
1865
|
-
<pre class="code"><span class="info file"># File 'lib/box/item.rb', line
|
|
1915
|
+
<pre class="code"><span class="info file"># File 'lib/box/item.rb', line 44</span>
|
|
1866
1916
|
|
|
1867
1917
|
<span class='kw'>def</span> <span class='id types'>types</span><span class='semicolon'>;</span> <span class='kw'>self</span><span class='period'>.</span><span class='id class'>class</span><span class='period'>.</span><span class='id types'>types</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
|
|
1868
1918
|
</td>
|
|
@@ -1875,9 +1925,9 @@ The plural string representation of this item.
|
|
|
1875
1925
|
</div>
|
|
1876
1926
|
|
|
1877
1927
|
<div id="footer">
|
|
1878
|
-
Generated on
|
|
1928
|
+
Generated on Tue Nov 8 15:32:23 2011 by
|
|
1879
1929
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1880
|
-
0.7.
|
|
1930
|
+
0.7.3 (ruby-1.9.3).
|
|
1881
1931
|
</div>
|
|
1882
1932
|
|
|
1883
1933
|
</body>
|