resourcespace-ruby 0.1.1 → 0.1.2
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.
- checksums.yaml +4 -4
- data/.yardoc/checksums +10 -0
- data/.yardoc/complete +0 -0
- data/.yardoc/object_types +0 -0
- data/.yardoc/objects/root.dat +0 -0
- data/.yardoc/proxy_types +0 -0
- data/.yardopts +7 -0
- data/README.md +1 -2
- data/doc/ResourceSpace/AuthenticationError.html +159 -0
- data/doc/ResourceSpace/AuthorizationError.html +159 -0
- data/doc/ResourceSpace/Client.html +2412 -0
- data/doc/ResourceSpace/ClientError.html +159 -0
- data/doc/ResourceSpace/Collection.html +2301 -0
- data/doc/ResourceSpace/Configuration.html +1655 -0
- data/doc/ResourceSpace/ConfigurationError.html +159 -0
- data/doc/ResourceSpace/ConflictError.html +159 -0
- data/doc/ResourceSpace/Error.html +682 -0
- data/doc/ResourceSpace/Metadata.html +2222 -0
- data/doc/ResourceSpace/NetworkError.html +159 -0
- data/doc/ResourceSpace/NotFoundError.html +159 -0
- data/doc/ResourceSpace/ParseError.html +159 -0
- data/doc/ResourceSpace/QuotaExceededError.html +159 -0
- data/doc/ResourceSpace/RateLimitError.html +159 -0
- data/doc/ResourceSpace/Resource.html +2995 -0
- data/doc/ResourceSpace/Search.html +2487 -0
- data/doc/ResourceSpace/ServerError.html +159 -0
- data/doc/ResourceSpace/TimeoutError.html +159 -0
- data/doc/ResourceSpace/UploadError.html +159 -0
- data/doc/ResourceSpace/User.html +2080 -0
- data/doc/ResourceSpace/ValidationError.html +159 -0
- data/doc/ResourceSpace.html +763 -0
- data/doc/_index.html +358 -0
- data/doc/class_list.html +54 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +58 -0
- data/doc/css/style.css +503 -0
- data/doc/file.CHANGELOG.html +105 -0
- data/doc/file.LICENSE.html +70 -0
- data/doc/file.README.html +419 -0
- data/doc/file_list.html +69 -0
- data/doc/frames.html +22 -0
- data/doc/index.html +419 -0
- data/doc/js/app.js +344 -0
- data/doc/js/full_list.js +242 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +1142 -0
- data/doc/top-level-namespace.html +110 -0
- data/lib/resourcespace/version.rb +1 -1
- data/resourcespace-ruby-0.1.0.gem +0 -0
- data/resourcespace-ruby-0.1.1.gem +0 -0
- data/resourcespace-ruby.gemspec +5 -5
- metadata +54 -7
|
@@ -0,0 +1,2301 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
Class: ResourceSpace::Collection
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.37
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="../css/style.css" type="text/css" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="../css/common.css" type="text/css" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript">
|
|
18
|
+
pathId = "ResourceSpace::Collection";
|
|
19
|
+
relpath = '../';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="../class_list.html?1"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="../_index.html">Index (C)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../ResourceSpace.html" title="ResourceSpace (module)">ResourceSpace</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">Collection</span>
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
<div id="search">
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
|
49
|
+
href="../class_list.html">
|
|
50
|
+
|
|
51
|
+
<svg width="24" height="24">
|
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
</svg>
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<div id="content"><h1>Class: ResourceSpace::Collection
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
<dl>
|
|
70
|
+
<dt>Inherits:</dt>
|
|
71
|
+
<dd>
|
|
72
|
+
<span class="inheritName">Object</span>
|
|
73
|
+
|
|
74
|
+
<ul class="fullTree">
|
|
75
|
+
<li>Object</li>
|
|
76
|
+
|
|
77
|
+
<li class="next">ResourceSpace::Collection</li>
|
|
78
|
+
|
|
79
|
+
</ul>
|
|
80
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
81
|
+
|
|
82
|
+
</dd>
|
|
83
|
+
</dl>
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
<dl>
|
|
96
|
+
<dt>Defined in:</dt>
|
|
97
|
+
<dd>lib/resourcespace/collection.rb</dd>
|
|
98
|
+
</dl>
|
|
99
|
+
|
|
100
|
+
</div>
|
|
101
|
+
|
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
|
103
|
+
<div class="discussion">
|
|
104
|
+
|
|
105
|
+
<p>Collection management interface for ResourceSpace API</p>
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
</div>
|
|
109
|
+
</div>
|
|
110
|
+
<div class="tags">
|
|
111
|
+
|
|
112
|
+
<div class="examples">
|
|
113
|
+
<h4 class="tag_title">Examples:</h4>
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
<pre class="example code"><code><span class='id identifier rubyid_collections'>collections</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_collections'>collections</span>
|
|
117
|
+
|
|
118
|
+
<span class='comment'># Get user collections
|
|
119
|
+
</span><span class='id identifier rubyid_user_collections'>user_collections</span> <span class='op'>=</span> <span class='id identifier rubyid_collections'>collections</span><span class='period'>.</span><span class='id identifier rubyid_get_user_collections'>get_user_collections</span>
|
|
120
|
+
|
|
121
|
+
<span class='comment'># Create a new collection
|
|
122
|
+
</span><span class='id identifier rubyid_collection'>collection</span> <span class='op'>=</span> <span class='id identifier rubyid_collections'>collections</span><span class='period'>.</span><span class='id identifier rubyid_create_collection'>create_collection</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>My Web Assets</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
123
|
+
|
|
124
|
+
<span class='comment'># Add resources to collection
|
|
125
|
+
</span><span class='id identifier rubyid_collections'>collections</span><span class='period'>.</span><span class='id identifier rubyid_add_resource_to_collection'>add_resource_to_collection</span><span class='lparen'>(</span><span class='int'>123</span><span class='comma'>,</span> <span class='id identifier rubyid_collection_id'>collection_id</span><span class='rparen'>)</span></code></pre>
|
|
126
|
+
|
|
127
|
+
</div>
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
</div>
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
135
|
+
<ul class="summary">
|
|
136
|
+
|
|
137
|
+
<li class="public ">
|
|
138
|
+
<span class="summary_signature">
|
|
139
|
+
|
|
140
|
+
<a href="#client-instance_method" title="#client (instance method)">#<strong>client</strong> ⇒ Client </a>
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
</span>
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
<span class="note title readonly">readonly</span>
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
<span class="summary_desc"><div class='inline'>
|
|
160
|
+
<p>The ResourceSpace client.</p>
|
|
161
|
+
</div></span>
|
|
162
|
+
|
|
163
|
+
</li>
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
</ul>
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
<h2>
|
|
173
|
+
Instance Method Summary
|
|
174
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
175
|
+
</h2>
|
|
176
|
+
|
|
177
|
+
<ul class="summary">
|
|
178
|
+
|
|
179
|
+
<li class="public ">
|
|
180
|
+
<span class="summary_signature">
|
|
181
|
+
|
|
182
|
+
<a href="#add_resource_to_collection-instance_method" title="#add_resource_to_collection (instance method)">#<strong>add_resource_to_collection</strong>(resource_id, collection_id) ⇒ Hash </a>
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
</span>
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
<span class="summary_desc"><div class='inline'>
|
|
197
|
+
<p>Add a resource to a collection.</p>
|
|
198
|
+
</div></span>
|
|
199
|
+
|
|
200
|
+
</li>
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
<li class="public ">
|
|
204
|
+
<span class="summary_signature">
|
|
205
|
+
|
|
206
|
+
<a href="#add_resources_to_collection-instance_method" title="#add_resources_to_collection (instance method)">#<strong>add_resources_to_collection</strong>(resource_ids, collection_id) ⇒ Array </a>
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
</span>
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
<span class="summary_desc"><div class='inline'>
|
|
221
|
+
<p>Add multiple resources to a collection.</p>
|
|
222
|
+
</div></span>
|
|
223
|
+
|
|
224
|
+
</li>
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
<li class="public ">
|
|
228
|
+
<span class="summary_signature">
|
|
229
|
+
|
|
230
|
+
<a href="#create_collection-instance_method" title="#create_collection (instance method)">#<strong>create_collection</strong>(name, public: false, allow_changes: true) ⇒ Hash </a>
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
</span>
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
<span class="summary_desc"><div class='inline'>
|
|
245
|
+
<p>Create a new collection.</p>
|
|
246
|
+
</div></span>
|
|
247
|
+
|
|
248
|
+
</li>
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
<li class="public ">
|
|
252
|
+
<span class="summary_signature">
|
|
253
|
+
|
|
254
|
+
<a href="#create_web_asset_collection-instance_method" title="#create_web_asset_collection (instance method)">#<strong>create_web_asset_collection</strong>(name, asset_type: nil, public: false) ⇒ Hash </a>
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
</span>
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
<span class="summary_desc"><div class='inline'>
|
|
269
|
+
<p>Create a collection for web assets.</p>
|
|
270
|
+
</div></span>
|
|
271
|
+
|
|
272
|
+
</li>
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
<li class="public ">
|
|
276
|
+
<span class="summary_signature">
|
|
277
|
+
|
|
278
|
+
<a href="#delete_collection-instance_method" title="#delete_collection (instance method)">#<strong>delete_collection</strong>(collection_id) ⇒ Hash </a>
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
</span>
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
<span class="summary_desc"><div class='inline'>
|
|
293
|
+
<p>Delete a collection.</p>
|
|
294
|
+
</div></span>
|
|
295
|
+
|
|
296
|
+
</li>
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
<li class="public ">
|
|
300
|
+
<span class="summary_signature">
|
|
301
|
+
|
|
302
|
+
<a href="#delete_resources_in_collection-instance_method" title="#delete_resources_in_collection (instance method)">#<strong>delete_resources_in_collection</strong>(collection_id) ⇒ Hash </a>
|
|
303
|
+
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
</span>
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
<span class="summary_desc"><div class='inline'>
|
|
317
|
+
<p>Delete all resources in a collection.</p>
|
|
318
|
+
</div></span>
|
|
319
|
+
|
|
320
|
+
</li>
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
<li class="public ">
|
|
324
|
+
<span class="summary_signature">
|
|
325
|
+
|
|
326
|
+
<a href="#get_collection-instance_method" title="#get_collection (instance method)">#<strong>get_collection</strong>(collection_id) ⇒ Hash </a>
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
</span>
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
<span class="summary_desc"><div class='inline'>
|
|
341
|
+
<p>Get collection details.</p>
|
|
342
|
+
</div></span>
|
|
343
|
+
|
|
344
|
+
</li>
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
<li class="public ">
|
|
348
|
+
<span class="summary_signature">
|
|
349
|
+
|
|
350
|
+
<a href="#get_featured_collections-instance_method" title="#get_featured_collections (instance method)">#<strong>get_featured_collections</strong> ⇒ Array </a>
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
</span>
|
|
355
|
+
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
<span class="summary_desc"><div class='inline'>
|
|
365
|
+
<p>Get featured collections.</p>
|
|
366
|
+
</div></span>
|
|
367
|
+
|
|
368
|
+
</li>
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
<li class="public ">
|
|
372
|
+
<span class="summary_signature">
|
|
373
|
+
|
|
374
|
+
<a href="#get_user_collections-instance_method" title="#get_user_collections (instance method)">#<strong>get_user_collections</strong>(user = nil) ⇒ Array </a>
|
|
375
|
+
|
|
376
|
+
|
|
377
|
+
|
|
378
|
+
</span>
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
<span class="summary_desc"><div class='inline'>
|
|
389
|
+
<p>Get user collections.</p>
|
|
390
|
+
</div></span>
|
|
391
|
+
|
|
392
|
+
</li>
|
|
393
|
+
|
|
394
|
+
|
|
395
|
+
<li class="public ">
|
|
396
|
+
<span class="summary_signature">
|
|
397
|
+
|
|
398
|
+
<a href="#get_web_asset_collections-instance_method" title="#get_web_asset_collections (instance method)">#<strong>get_web_asset_collections</strong>(asset_type: nil) ⇒ Array </a>
|
|
399
|
+
|
|
400
|
+
|
|
401
|
+
|
|
402
|
+
</span>
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
|
|
408
|
+
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
<span class="summary_desc"><div class='inline'>
|
|
413
|
+
<p>Get collections containing web assets.</p>
|
|
414
|
+
</div></span>
|
|
415
|
+
|
|
416
|
+
</li>
|
|
417
|
+
|
|
418
|
+
|
|
419
|
+
<li class="public ">
|
|
420
|
+
<span class="summary_signature">
|
|
421
|
+
|
|
422
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client) ⇒ Collection </a>
|
|
423
|
+
|
|
424
|
+
|
|
425
|
+
|
|
426
|
+
</span>
|
|
427
|
+
|
|
428
|
+
|
|
429
|
+
<span class="note title constructor">constructor</span>
|
|
430
|
+
|
|
431
|
+
|
|
432
|
+
|
|
433
|
+
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
<span class="summary_desc"><div class='inline'>
|
|
439
|
+
<p>Initialize the collection interface.</p>
|
|
440
|
+
</div></span>
|
|
441
|
+
|
|
442
|
+
</li>
|
|
443
|
+
|
|
444
|
+
|
|
445
|
+
<li class="public ">
|
|
446
|
+
<span class="summary_signature">
|
|
447
|
+
|
|
448
|
+
<a href="#remove_resource_from_collection-instance_method" title="#remove_resource_from_collection (instance method)">#<strong>remove_resource_from_collection</strong>(resource_id, collection_id) ⇒ Hash </a>
|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
|
|
452
|
+
</span>
|
|
453
|
+
|
|
454
|
+
|
|
455
|
+
|
|
456
|
+
|
|
457
|
+
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
<span class="summary_desc"><div class='inline'>
|
|
463
|
+
<p>Remove a resource from a collection.</p>
|
|
464
|
+
</div></span>
|
|
465
|
+
|
|
466
|
+
</li>
|
|
467
|
+
|
|
468
|
+
|
|
469
|
+
<li class="public ">
|
|
470
|
+
<span class="summary_signature">
|
|
471
|
+
|
|
472
|
+
<a href="#remove_resources_from_collection-instance_method" title="#remove_resources_from_collection (instance method)">#<strong>remove_resources_from_collection</strong>(resource_ids, collection_id) ⇒ Array </a>
|
|
473
|
+
|
|
474
|
+
|
|
475
|
+
|
|
476
|
+
</span>
|
|
477
|
+
|
|
478
|
+
|
|
479
|
+
|
|
480
|
+
|
|
481
|
+
|
|
482
|
+
|
|
483
|
+
|
|
484
|
+
|
|
485
|
+
|
|
486
|
+
<span class="summary_desc"><div class='inline'>
|
|
487
|
+
<p>Remove multiple resources from a collection.</p>
|
|
488
|
+
</div></span>
|
|
489
|
+
|
|
490
|
+
</li>
|
|
491
|
+
|
|
492
|
+
|
|
493
|
+
<li class="public ">
|
|
494
|
+
<span class="summary_signature">
|
|
495
|
+
|
|
496
|
+
<a href="#save_collection-instance_method" title="#save_collection (instance method)">#<strong>save_collection</strong>(collection_id, name: nil, public: nil, allow_changes: nil) ⇒ Hash </a>
|
|
497
|
+
|
|
498
|
+
|
|
499
|
+
|
|
500
|
+
</span>
|
|
501
|
+
|
|
502
|
+
|
|
503
|
+
|
|
504
|
+
|
|
505
|
+
|
|
506
|
+
|
|
507
|
+
|
|
508
|
+
|
|
509
|
+
|
|
510
|
+
<span class="summary_desc"><div class='inline'>
|
|
511
|
+
<p>Save collection (update collection details).</p>
|
|
512
|
+
</div></span>
|
|
513
|
+
|
|
514
|
+
</li>
|
|
515
|
+
|
|
516
|
+
|
|
517
|
+
<li class="public ">
|
|
518
|
+
<span class="summary_signature">
|
|
519
|
+
|
|
520
|
+
<a href="#search_public_collections-instance_method" title="#search_public_collections (instance method)">#<strong>search_public_collections</strong>(search_term) ⇒ Array </a>
|
|
521
|
+
|
|
522
|
+
|
|
523
|
+
|
|
524
|
+
</span>
|
|
525
|
+
|
|
526
|
+
|
|
527
|
+
|
|
528
|
+
|
|
529
|
+
|
|
530
|
+
|
|
531
|
+
|
|
532
|
+
|
|
533
|
+
|
|
534
|
+
<span class="summary_desc"><div class='inline'>
|
|
535
|
+
<p>Search public collections.</p>
|
|
536
|
+
</div></span>
|
|
537
|
+
|
|
538
|
+
</li>
|
|
539
|
+
|
|
540
|
+
|
|
541
|
+
<li class="public ">
|
|
542
|
+
<span class="summary_signature">
|
|
543
|
+
|
|
544
|
+
<a href="#send_collection_to_admin-instance_method" title="#send_collection_to_admin (instance method)">#<strong>send_collection_to_admin</strong>(collection_id, message = "") ⇒ Hash </a>
|
|
545
|
+
|
|
546
|
+
|
|
547
|
+
|
|
548
|
+
</span>
|
|
549
|
+
|
|
550
|
+
|
|
551
|
+
|
|
552
|
+
|
|
553
|
+
|
|
554
|
+
|
|
555
|
+
|
|
556
|
+
|
|
557
|
+
|
|
558
|
+
<span class="summary_desc"><div class='inline'>
|
|
559
|
+
<p>Send collection to admin.</p>
|
|
560
|
+
</div></span>
|
|
561
|
+
|
|
562
|
+
</li>
|
|
563
|
+
|
|
564
|
+
|
|
565
|
+
<li class="public ">
|
|
566
|
+
<span class="summary_signature">
|
|
567
|
+
|
|
568
|
+
<a href="#show_hide_collection-instance_method" title="#show_hide_collection (instance method)">#<strong>show_hide_collection</strong>(collection_id, show: true) ⇒ Hash </a>
|
|
569
|
+
|
|
570
|
+
|
|
571
|
+
|
|
572
|
+
</span>
|
|
573
|
+
|
|
574
|
+
|
|
575
|
+
|
|
576
|
+
|
|
577
|
+
|
|
578
|
+
|
|
579
|
+
|
|
580
|
+
|
|
581
|
+
|
|
582
|
+
<span class="summary_desc"><div class='inline'>
|
|
583
|
+
<p>Show or hide a collection.</p>
|
|
584
|
+
</div></span>
|
|
585
|
+
|
|
586
|
+
</li>
|
|
587
|
+
|
|
588
|
+
|
|
589
|
+
</ul>
|
|
590
|
+
|
|
591
|
+
|
|
592
|
+
<div id="constructor_details" class="method_details_list">
|
|
593
|
+
<h2>Constructor Details</h2>
|
|
594
|
+
|
|
595
|
+
<div class="method_details first">
|
|
596
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
597
|
+
|
|
598
|
+
#<strong>initialize</strong>(client) ⇒ <tt><span class='object_link'><a href="" title="ResourceSpace::Collection (class)">Collection</a></span></tt>
|
|
599
|
+
|
|
600
|
+
|
|
601
|
+
|
|
602
|
+
|
|
603
|
+
|
|
604
|
+
</h3><div class="docstring">
|
|
605
|
+
<div class="discussion">
|
|
606
|
+
|
|
607
|
+
<p>Initialize the collection interface</p>
|
|
608
|
+
|
|
609
|
+
|
|
610
|
+
</div>
|
|
611
|
+
</div>
|
|
612
|
+
<div class="tags">
|
|
613
|
+
<p class="tag_title">Parameters:</p>
|
|
614
|
+
<ul class="param">
|
|
615
|
+
|
|
616
|
+
<li>
|
|
617
|
+
|
|
618
|
+
<span class='name'>client</span>
|
|
619
|
+
|
|
620
|
+
|
|
621
|
+
<span class='type'>(<tt><span class='object_link'><a href="Client.html" title="ResourceSpace::Client (class)">Client</a></span></tt>)</span>
|
|
622
|
+
|
|
623
|
+
|
|
624
|
+
|
|
625
|
+
—
|
|
626
|
+
<div class='inline'>
|
|
627
|
+
<p>ResourceSpace client instance</p>
|
|
628
|
+
</div>
|
|
629
|
+
|
|
630
|
+
</li>
|
|
631
|
+
|
|
632
|
+
</ul>
|
|
633
|
+
|
|
634
|
+
|
|
635
|
+
</div><table class="source_code">
|
|
636
|
+
<tr>
|
|
637
|
+
<td>
|
|
638
|
+
<pre class="lines">
|
|
639
|
+
|
|
640
|
+
|
|
641
|
+
24
|
|
642
|
+
25
|
|
643
|
+
26</pre>
|
|
644
|
+
</td>
|
|
645
|
+
<td>
|
|
646
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/collection.rb', line 24</span>
|
|
647
|
+
|
|
648
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='rparen'>)</span>
|
|
649
|
+
<span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
|
|
650
|
+
<span class='kw'>end</span></pre>
|
|
651
|
+
</td>
|
|
652
|
+
</tr>
|
|
653
|
+
</table>
|
|
654
|
+
</div>
|
|
655
|
+
|
|
656
|
+
</div>
|
|
657
|
+
|
|
658
|
+
<div id="instance_attr_details" class="attr_details">
|
|
659
|
+
<h2>Instance Attribute Details</h2>
|
|
660
|
+
|
|
661
|
+
|
|
662
|
+
<span id=""></span>
|
|
663
|
+
<div class="method_details first">
|
|
664
|
+
<h3 class="signature first" id="client-instance_method">
|
|
665
|
+
|
|
666
|
+
#<strong>client</strong> ⇒ <tt><span class='object_link'><a href="Client.html" title="ResourceSpace::Client (class)">Client</a></span></tt> <span class="extras">(readonly)</span>
|
|
667
|
+
|
|
668
|
+
|
|
669
|
+
|
|
670
|
+
|
|
671
|
+
|
|
672
|
+
</h3><div class="docstring">
|
|
673
|
+
<div class="discussion">
|
|
674
|
+
|
|
675
|
+
<p>Returns the ResourceSpace client.</p>
|
|
676
|
+
|
|
677
|
+
|
|
678
|
+
</div>
|
|
679
|
+
</div>
|
|
680
|
+
<div class="tags">
|
|
681
|
+
|
|
682
|
+
<p class="tag_title">Returns:</p>
|
|
683
|
+
<ul class="return">
|
|
684
|
+
|
|
685
|
+
<li>
|
|
686
|
+
|
|
687
|
+
|
|
688
|
+
<span class='type'>(<tt><span class='object_link'><a href="Client.html" title="ResourceSpace::Client (class)">Client</a></span></tt>)</span>
|
|
689
|
+
|
|
690
|
+
|
|
691
|
+
|
|
692
|
+
—
|
|
693
|
+
<div class='inline'>
|
|
694
|
+
<p>the ResourceSpace client</p>
|
|
695
|
+
</div>
|
|
696
|
+
|
|
697
|
+
</li>
|
|
698
|
+
|
|
699
|
+
</ul>
|
|
700
|
+
|
|
701
|
+
</div><table class="source_code">
|
|
702
|
+
<tr>
|
|
703
|
+
<td>
|
|
704
|
+
<pre class="lines">
|
|
705
|
+
|
|
706
|
+
|
|
707
|
+
19
|
|
708
|
+
20
|
|
709
|
+
21</pre>
|
|
710
|
+
</td>
|
|
711
|
+
<td>
|
|
712
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/collection.rb', line 19</span>
|
|
713
|
+
|
|
714
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
|
|
715
|
+
<span class='ivar'>@client</span>
|
|
716
|
+
<span class='kw'>end</span></pre>
|
|
717
|
+
</td>
|
|
718
|
+
</tr>
|
|
719
|
+
</table>
|
|
720
|
+
</div>
|
|
721
|
+
|
|
722
|
+
</div>
|
|
723
|
+
|
|
724
|
+
|
|
725
|
+
<div id="instance_method_details" class="method_details_list">
|
|
726
|
+
<h2>Instance Method Details</h2>
|
|
727
|
+
|
|
728
|
+
|
|
729
|
+
<div class="method_details first">
|
|
730
|
+
<h3 class="signature first" id="add_resource_to_collection-instance_method">
|
|
731
|
+
|
|
732
|
+
#<strong>add_resource_to_collection</strong>(resource_id, collection_id) ⇒ <tt>Hash</tt>
|
|
733
|
+
|
|
734
|
+
|
|
735
|
+
|
|
736
|
+
|
|
737
|
+
|
|
738
|
+
</h3><div class="docstring">
|
|
739
|
+
<div class="discussion">
|
|
740
|
+
|
|
741
|
+
<p>Add a resource to a collection</p>
|
|
742
|
+
|
|
743
|
+
|
|
744
|
+
</div>
|
|
745
|
+
</div>
|
|
746
|
+
<div class="tags">
|
|
747
|
+
<p class="tag_title">Parameters:</p>
|
|
748
|
+
<ul class="param">
|
|
749
|
+
|
|
750
|
+
<li>
|
|
751
|
+
|
|
752
|
+
<span class='name'>resource_id</span>
|
|
753
|
+
|
|
754
|
+
|
|
755
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
756
|
+
|
|
757
|
+
|
|
758
|
+
|
|
759
|
+
—
|
|
760
|
+
<div class='inline'>
|
|
761
|
+
<p>resource ID</p>
|
|
762
|
+
</div>
|
|
763
|
+
|
|
764
|
+
</li>
|
|
765
|
+
|
|
766
|
+
<li>
|
|
767
|
+
|
|
768
|
+
<span class='name'>collection_id</span>
|
|
769
|
+
|
|
770
|
+
|
|
771
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
772
|
+
|
|
773
|
+
|
|
774
|
+
|
|
775
|
+
—
|
|
776
|
+
<div class='inline'>
|
|
777
|
+
<p>collection ID</p>
|
|
778
|
+
</div>
|
|
779
|
+
|
|
780
|
+
</li>
|
|
781
|
+
|
|
782
|
+
</ul>
|
|
783
|
+
|
|
784
|
+
<p class="tag_title">Returns:</p>
|
|
785
|
+
<ul class="return">
|
|
786
|
+
|
|
787
|
+
<li>
|
|
788
|
+
|
|
789
|
+
|
|
790
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
791
|
+
|
|
792
|
+
|
|
793
|
+
|
|
794
|
+
—
|
|
795
|
+
<div class='inline'>
|
|
796
|
+
<p>response</p>
|
|
797
|
+
</div>
|
|
798
|
+
|
|
799
|
+
</li>
|
|
800
|
+
|
|
801
|
+
</ul>
|
|
802
|
+
|
|
803
|
+
</div><table class="source_code">
|
|
804
|
+
<tr>
|
|
805
|
+
<td>
|
|
806
|
+
<pre class="lines">
|
|
807
|
+
|
|
808
|
+
|
|
809
|
+
92
|
|
810
|
+
93
|
|
811
|
+
94
|
|
812
|
+
95
|
|
813
|
+
96
|
|
814
|
+
97</pre>
|
|
815
|
+
</td>
|
|
816
|
+
<td>
|
|
817
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/collection.rb', line 92</span>
|
|
818
|
+
|
|
819
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_add_resource_to_collection'>add_resource_to_collection</span><span class='lparen'>(</span><span class='id identifier rubyid_resource_id'>resource_id</span><span class='comma'>,</span> <span class='id identifier rubyid_collection_id'>collection_id</span><span class='rparen'>)</span>
|
|
820
|
+
<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>add_resource_to_collection</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='lbrace'>{</span>
|
|
821
|
+
<span class='label'>param1:</span> <span class='id identifier rubyid_resource_id'>resource_id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='comma'>,</span>
|
|
822
|
+
<span class='label'>param2:</span> <span class='id identifier rubyid_collection_id'>collection_id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
|
|
823
|
+
<span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
824
|
+
<span class='kw'>end</span></pre>
|
|
825
|
+
</td>
|
|
826
|
+
</tr>
|
|
827
|
+
</table>
|
|
828
|
+
</div>
|
|
829
|
+
|
|
830
|
+
<div class="method_details ">
|
|
831
|
+
<h3 class="signature " id="add_resources_to_collection-instance_method">
|
|
832
|
+
|
|
833
|
+
#<strong>add_resources_to_collection</strong>(resource_ids, collection_id) ⇒ <tt>Array</tt>
|
|
834
|
+
|
|
835
|
+
|
|
836
|
+
|
|
837
|
+
|
|
838
|
+
|
|
839
|
+
</h3><div class="docstring">
|
|
840
|
+
<div class="discussion">
|
|
841
|
+
|
|
842
|
+
<p>Add multiple resources to a collection</p>
|
|
843
|
+
|
|
844
|
+
|
|
845
|
+
</div>
|
|
846
|
+
</div>
|
|
847
|
+
<div class="tags">
|
|
848
|
+
<p class="tag_title">Parameters:</p>
|
|
849
|
+
<ul class="param">
|
|
850
|
+
|
|
851
|
+
<li>
|
|
852
|
+
|
|
853
|
+
<span class='name'>resource_ids</span>
|
|
854
|
+
|
|
855
|
+
|
|
856
|
+
<span class='type'>(<tt>Array<Integer></tt>)</span>
|
|
857
|
+
|
|
858
|
+
|
|
859
|
+
|
|
860
|
+
—
|
|
861
|
+
<div class='inline'>
|
|
862
|
+
<p>array of resource IDs</p>
|
|
863
|
+
</div>
|
|
864
|
+
|
|
865
|
+
</li>
|
|
866
|
+
|
|
867
|
+
<li>
|
|
868
|
+
|
|
869
|
+
<span class='name'>collection_id</span>
|
|
870
|
+
|
|
871
|
+
|
|
872
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
873
|
+
|
|
874
|
+
|
|
875
|
+
|
|
876
|
+
—
|
|
877
|
+
<div class='inline'>
|
|
878
|
+
<p>collection ID</p>
|
|
879
|
+
</div>
|
|
880
|
+
|
|
881
|
+
</li>
|
|
882
|
+
|
|
883
|
+
</ul>
|
|
884
|
+
|
|
885
|
+
<p class="tag_title">Returns:</p>
|
|
886
|
+
<ul class="return">
|
|
887
|
+
|
|
888
|
+
<li>
|
|
889
|
+
|
|
890
|
+
|
|
891
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
|
892
|
+
|
|
893
|
+
|
|
894
|
+
|
|
895
|
+
—
|
|
896
|
+
<div class='inline'>
|
|
897
|
+
<p>array of responses</p>
|
|
898
|
+
</div>
|
|
899
|
+
|
|
900
|
+
</li>
|
|
901
|
+
|
|
902
|
+
</ul>
|
|
903
|
+
|
|
904
|
+
</div><table class="source_code">
|
|
905
|
+
<tr>
|
|
906
|
+
<td>
|
|
907
|
+
<pre class="lines">
|
|
908
|
+
|
|
909
|
+
|
|
910
|
+
163
|
|
911
|
+
164
|
|
912
|
+
165
|
|
913
|
+
166
|
|
914
|
+
167</pre>
|
|
915
|
+
</td>
|
|
916
|
+
<td>
|
|
917
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/collection.rb', line 163</span>
|
|
918
|
+
|
|
919
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_add_resources_to_collection'>add_resources_to_collection</span><span class='lparen'>(</span><span class='id identifier rubyid_resource_ids'>resource_ids</span><span class='comma'>,</span> <span class='id identifier rubyid_collection_id'>collection_id</span><span class='rparen'>)</span>
|
|
920
|
+
<span class='const'>Array</span><span class='lparen'>(</span><span class='id identifier rubyid_resource_ids'>resource_ids</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_resource_id'>resource_id</span><span class='op'>|</span>
|
|
921
|
+
<span class='id identifier rubyid_add_resource_to_collection'>add_resource_to_collection</span><span class='lparen'>(</span><span class='id identifier rubyid_resource_id'>resource_id</span><span class='comma'>,</span> <span class='id identifier rubyid_collection_id'>collection_id</span><span class='rparen'>)</span>
|
|
922
|
+
<span class='kw'>end</span>
|
|
923
|
+
<span class='kw'>end</span></pre>
|
|
924
|
+
</td>
|
|
925
|
+
</tr>
|
|
926
|
+
</table>
|
|
927
|
+
</div>
|
|
928
|
+
|
|
929
|
+
<div class="method_details ">
|
|
930
|
+
<h3 class="signature " id="create_collection-instance_method">
|
|
931
|
+
|
|
932
|
+
#<strong>create_collection</strong>(name, public: false, allow_changes: true) ⇒ <tt>Hash</tt>
|
|
933
|
+
|
|
934
|
+
|
|
935
|
+
|
|
936
|
+
|
|
937
|
+
|
|
938
|
+
</h3><div class="docstring">
|
|
939
|
+
<div class="discussion">
|
|
940
|
+
|
|
941
|
+
<p>Create a new collection</p>
|
|
942
|
+
|
|
943
|
+
|
|
944
|
+
</div>
|
|
945
|
+
</div>
|
|
946
|
+
<div class="tags">
|
|
947
|
+
<p class="tag_title">Parameters:</p>
|
|
948
|
+
<ul class="param">
|
|
949
|
+
|
|
950
|
+
<li>
|
|
951
|
+
|
|
952
|
+
<span class='name'>name</span>
|
|
953
|
+
|
|
954
|
+
|
|
955
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
956
|
+
|
|
957
|
+
|
|
958
|
+
|
|
959
|
+
—
|
|
960
|
+
<div class='inline'>
|
|
961
|
+
<p>collection name</p>
|
|
962
|
+
</div>
|
|
963
|
+
|
|
964
|
+
</li>
|
|
965
|
+
|
|
966
|
+
<li>
|
|
967
|
+
|
|
968
|
+
<span class='name'>public</span>
|
|
969
|
+
|
|
970
|
+
|
|
971
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
972
|
+
|
|
973
|
+
|
|
974
|
+
<em class="default">(defaults to: <tt>false</tt>)</em>
|
|
975
|
+
|
|
976
|
+
|
|
977
|
+
—
|
|
978
|
+
<div class='inline'>
|
|
979
|
+
<p>whether collection is public</p>
|
|
980
|
+
</div>
|
|
981
|
+
|
|
982
|
+
</li>
|
|
983
|
+
|
|
984
|
+
<li>
|
|
985
|
+
|
|
986
|
+
<span class='name'>allow_changes</span>
|
|
987
|
+
|
|
988
|
+
|
|
989
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
990
|
+
|
|
991
|
+
|
|
992
|
+
<em class="default">(defaults to: <tt>true</tt>)</em>
|
|
993
|
+
|
|
994
|
+
|
|
995
|
+
—
|
|
996
|
+
<div class='inline'>
|
|
997
|
+
<p>whether to allow changes to collection</p>
|
|
998
|
+
</div>
|
|
999
|
+
|
|
1000
|
+
</li>
|
|
1001
|
+
|
|
1002
|
+
</ul>
|
|
1003
|
+
|
|
1004
|
+
<p class="tag_title">Returns:</p>
|
|
1005
|
+
<ul class="return">
|
|
1006
|
+
|
|
1007
|
+
<li>
|
|
1008
|
+
|
|
1009
|
+
|
|
1010
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1011
|
+
|
|
1012
|
+
|
|
1013
|
+
|
|
1014
|
+
—
|
|
1015
|
+
<div class='inline'>
|
|
1016
|
+
<p>created collection data</p>
|
|
1017
|
+
</div>
|
|
1018
|
+
|
|
1019
|
+
</li>
|
|
1020
|
+
|
|
1021
|
+
</ul>
|
|
1022
|
+
|
|
1023
|
+
</div><table class="source_code">
|
|
1024
|
+
<tr>
|
|
1025
|
+
<td>
|
|
1026
|
+
<pre class="lines">
|
|
1027
|
+
|
|
1028
|
+
|
|
1029
|
+
45
|
|
1030
|
+
46
|
|
1031
|
+
47
|
|
1032
|
+
48
|
|
1033
|
+
49
|
|
1034
|
+
50
|
|
1035
|
+
51
|
|
1036
|
+
52
|
|
1037
|
+
53</pre>
|
|
1038
|
+
</td>
|
|
1039
|
+
<td>
|
|
1040
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/collection.rb', line 45</span>
|
|
1041
|
+
|
|
1042
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create_collection'>create_collection</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='label'>public:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>allow_changes:</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
|
1043
|
+
<span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1044
|
+
<span class='label'>param1:</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span>
|
|
1045
|
+
<span class='label'>param2:</span> <span class='id identifier rubyid_public'>public</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>1</span><span class='tstring_end'>"</span></span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>0</span><span class='tstring_end'>"</span></span>
|
|
1046
|
+
<span class='rbrace'>}</span>
|
|
1047
|
+
<span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:param3</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_allow_changes'>allow_changes</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>1</span><span class='tstring_end'>"</span></span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>0</span><span class='tstring_end'>"</span></span>
|
|
1048
|
+
|
|
1049
|
+
<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>create_collection</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
|
|
1050
|
+
<span class='kw'>end</span></pre>
|
|
1051
|
+
</td>
|
|
1052
|
+
</tr>
|
|
1053
|
+
</table>
|
|
1054
|
+
</div>
|
|
1055
|
+
|
|
1056
|
+
<div class="method_details ">
|
|
1057
|
+
<h3 class="signature " id="create_web_asset_collection-instance_method">
|
|
1058
|
+
|
|
1059
|
+
#<strong>create_web_asset_collection</strong>(name, asset_type: nil, public: false) ⇒ <tt>Hash</tt>
|
|
1060
|
+
|
|
1061
|
+
|
|
1062
|
+
|
|
1063
|
+
|
|
1064
|
+
|
|
1065
|
+
</h3><div class="docstring">
|
|
1066
|
+
<div class="discussion">
|
|
1067
|
+
|
|
1068
|
+
<p>Create a collection for web assets</p>
|
|
1069
|
+
|
|
1070
|
+
|
|
1071
|
+
</div>
|
|
1072
|
+
</div>
|
|
1073
|
+
<div class="tags">
|
|
1074
|
+
<p class="tag_title">Parameters:</p>
|
|
1075
|
+
<ul class="param">
|
|
1076
|
+
|
|
1077
|
+
<li>
|
|
1078
|
+
|
|
1079
|
+
<span class='name'>name</span>
|
|
1080
|
+
|
|
1081
|
+
|
|
1082
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1083
|
+
|
|
1084
|
+
|
|
1085
|
+
|
|
1086
|
+
—
|
|
1087
|
+
<div class='inline'>
|
|
1088
|
+
<p>collection name</p>
|
|
1089
|
+
</div>
|
|
1090
|
+
|
|
1091
|
+
</li>
|
|
1092
|
+
|
|
1093
|
+
<li>
|
|
1094
|
+
|
|
1095
|
+
<span class='name'>asset_type</span>
|
|
1096
|
+
|
|
1097
|
+
|
|
1098
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1099
|
+
|
|
1100
|
+
|
|
1101
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1102
|
+
|
|
1103
|
+
|
|
1104
|
+
—
|
|
1105
|
+
<div class='inline'>
|
|
1106
|
+
<p>type of web assets (“images”, “css”, “js”, “fonts”, “icons”)</p>
|
|
1107
|
+
</div>
|
|
1108
|
+
|
|
1109
|
+
</li>
|
|
1110
|
+
|
|
1111
|
+
<li>
|
|
1112
|
+
|
|
1113
|
+
<span class='name'>public</span>
|
|
1114
|
+
|
|
1115
|
+
|
|
1116
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
1117
|
+
|
|
1118
|
+
|
|
1119
|
+
<em class="default">(defaults to: <tt>false</tt>)</em>
|
|
1120
|
+
|
|
1121
|
+
|
|
1122
|
+
—
|
|
1123
|
+
<div class='inline'>
|
|
1124
|
+
<p>whether collection is public</p>
|
|
1125
|
+
</div>
|
|
1126
|
+
|
|
1127
|
+
</li>
|
|
1128
|
+
|
|
1129
|
+
</ul>
|
|
1130
|
+
|
|
1131
|
+
<p class="tag_title">Returns:</p>
|
|
1132
|
+
<ul class="return">
|
|
1133
|
+
|
|
1134
|
+
<li>
|
|
1135
|
+
|
|
1136
|
+
|
|
1137
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1138
|
+
|
|
1139
|
+
|
|
1140
|
+
|
|
1141
|
+
—
|
|
1142
|
+
<div class='inline'>
|
|
1143
|
+
<p>created collection data</p>
|
|
1144
|
+
</div>
|
|
1145
|
+
|
|
1146
|
+
</li>
|
|
1147
|
+
|
|
1148
|
+
</ul>
|
|
1149
|
+
|
|
1150
|
+
</div><table class="source_code">
|
|
1151
|
+
<tr>
|
|
1152
|
+
<td>
|
|
1153
|
+
<pre class="lines">
|
|
1154
|
+
|
|
1155
|
+
|
|
1156
|
+
186
|
|
1157
|
+
187
|
|
1158
|
+
188
|
|
1159
|
+
189</pre>
|
|
1160
|
+
</td>
|
|
1161
|
+
<td>
|
|
1162
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/collection.rb', line 186</span>
|
|
1163
|
+
|
|
1164
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create_web_asset_collection'>create_web_asset_collection</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='label'>asset_type:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>public:</span> <span class='kw'>false</span><span class='rparen'>)</span>
|
|
1165
|
+
<span class='id identifier rubyid_collection_name'>collection_name</span> <span class='op'>=</span> <span class='id identifier rubyid_asset_type'>asset_type</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_name'>name</span><span class='embexpr_end'>}</span><span class='tstring_content'> - </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_asset_type'>asset_type</span><span class='period'>.</span><span class='id identifier rubyid_capitalize'>capitalize</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='op'>:</span> <span class='id identifier rubyid_name'>name</span>
|
|
1166
|
+
<span class='id identifier rubyid_create_collection'>create_collection</span><span class='lparen'>(</span><span class='id identifier rubyid_collection_name'>collection_name</span><span class='comma'>,</span> <span class='label'>public:</span> <span class='id identifier rubyid_public'>public</span><span class='rparen'>)</span>
|
|
1167
|
+
<span class='kw'>end</span></pre>
|
|
1168
|
+
</td>
|
|
1169
|
+
</tr>
|
|
1170
|
+
</table>
|
|
1171
|
+
</div>
|
|
1172
|
+
|
|
1173
|
+
<div class="method_details ">
|
|
1174
|
+
<h3 class="signature " id="delete_collection-instance_method">
|
|
1175
|
+
|
|
1176
|
+
#<strong>delete_collection</strong>(collection_id) ⇒ <tt>Hash</tt>
|
|
1177
|
+
|
|
1178
|
+
|
|
1179
|
+
|
|
1180
|
+
|
|
1181
|
+
|
|
1182
|
+
</h3><div class="docstring">
|
|
1183
|
+
<div class="discussion">
|
|
1184
|
+
|
|
1185
|
+
<p>Delete a collection</p>
|
|
1186
|
+
|
|
1187
|
+
|
|
1188
|
+
</div>
|
|
1189
|
+
</div>
|
|
1190
|
+
<div class="tags">
|
|
1191
|
+
<p class="tag_title">Parameters:</p>
|
|
1192
|
+
<ul class="param">
|
|
1193
|
+
|
|
1194
|
+
<li>
|
|
1195
|
+
|
|
1196
|
+
<span class='name'>collection_id</span>
|
|
1197
|
+
|
|
1198
|
+
|
|
1199
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
1200
|
+
|
|
1201
|
+
|
|
1202
|
+
|
|
1203
|
+
—
|
|
1204
|
+
<div class='inline'>
|
|
1205
|
+
<p>collection ID</p>
|
|
1206
|
+
</div>
|
|
1207
|
+
|
|
1208
|
+
</li>
|
|
1209
|
+
|
|
1210
|
+
</ul>
|
|
1211
|
+
|
|
1212
|
+
<p class="tag_title">Returns:</p>
|
|
1213
|
+
<ul class="return">
|
|
1214
|
+
|
|
1215
|
+
<li>
|
|
1216
|
+
|
|
1217
|
+
|
|
1218
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1219
|
+
|
|
1220
|
+
|
|
1221
|
+
|
|
1222
|
+
—
|
|
1223
|
+
<div class='inline'>
|
|
1224
|
+
<p>response</p>
|
|
1225
|
+
</div>
|
|
1226
|
+
|
|
1227
|
+
</li>
|
|
1228
|
+
|
|
1229
|
+
</ul>
|
|
1230
|
+
|
|
1231
|
+
</div><table class="source_code">
|
|
1232
|
+
<tr>
|
|
1233
|
+
<td>
|
|
1234
|
+
<pre class="lines">
|
|
1235
|
+
|
|
1236
|
+
|
|
1237
|
+
59
|
|
1238
|
+
60
|
|
1239
|
+
61</pre>
|
|
1240
|
+
</td>
|
|
1241
|
+
<td>
|
|
1242
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/collection.rb', line 59</span>
|
|
1243
|
+
|
|
1244
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete_collection'>delete_collection</span><span class='lparen'>(</span><span class='id identifier rubyid_collection_id'>collection_id</span><span class='rparen'>)</span>
|
|
1245
|
+
<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>delete_collection</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='label'>param1:</span> <span class='id identifier rubyid_collection_id'>collection_id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
1246
|
+
<span class='kw'>end</span></pre>
|
|
1247
|
+
</td>
|
|
1248
|
+
</tr>
|
|
1249
|
+
</table>
|
|
1250
|
+
</div>
|
|
1251
|
+
|
|
1252
|
+
<div class="method_details ">
|
|
1253
|
+
<h3 class="signature " id="delete_resources_in_collection-instance_method">
|
|
1254
|
+
|
|
1255
|
+
#<strong>delete_resources_in_collection</strong>(collection_id) ⇒ <tt>Hash</tt>
|
|
1256
|
+
|
|
1257
|
+
|
|
1258
|
+
|
|
1259
|
+
|
|
1260
|
+
|
|
1261
|
+
</h3><div class="docstring">
|
|
1262
|
+
<div class="discussion">
|
|
1263
|
+
|
|
1264
|
+
<p>Delete all resources in a collection</p>
|
|
1265
|
+
|
|
1266
|
+
|
|
1267
|
+
</div>
|
|
1268
|
+
</div>
|
|
1269
|
+
<div class="tags">
|
|
1270
|
+
<p class="tag_title">Parameters:</p>
|
|
1271
|
+
<ul class="param">
|
|
1272
|
+
|
|
1273
|
+
<li>
|
|
1274
|
+
|
|
1275
|
+
<span class='name'>collection_id</span>
|
|
1276
|
+
|
|
1277
|
+
|
|
1278
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
1279
|
+
|
|
1280
|
+
|
|
1281
|
+
|
|
1282
|
+
—
|
|
1283
|
+
<div class='inline'>
|
|
1284
|
+
<p>collection ID</p>
|
|
1285
|
+
</div>
|
|
1286
|
+
|
|
1287
|
+
</li>
|
|
1288
|
+
|
|
1289
|
+
</ul>
|
|
1290
|
+
|
|
1291
|
+
<p class="tag_title">Returns:</p>
|
|
1292
|
+
<ul class="return">
|
|
1293
|
+
|
|
1294
|
+
<li>
|
|
1295
|
+
|
|
1296
|
+
|
|
1297
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1298
|
+
|
|
1299
|
+
|
|
1300
|
+
|
|
1301
|
+
—
|
|
1302
|
+
<div class='inline'>
|
|
1303
|
+
<p>response</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
|
+
154
|
|
1317
|
+
155
|
|
1318
|
+
156</pre>
|
|
1319
|
+
</td>
|
|
1320
|
+
<td>
|
|
1321
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/collection.rb', line 154</span>
|
|
1322
|
+
|
|
1323
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete_resources_in_collection'>delete_resources_in_collection</span><span class='lparen'>(</span><span class='id identifier rubyid_collection_id'>collection_id</span><span class='rparen'>)</span>
|
|
1324
|
+
<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>delete_resources_in_collection</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='label'>param1:</span> <span class='id identifier rubyid_collection_id'>collection_id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
1325
|
+
<span class='kw'>end</span></pre>
|
|
1326
|
+
</td>
|
|
1327
|
+
</tr>
|
|
1328
|
+
</table>
|
|
1329
|
+
</div>
|
|
1330
|
+
|
|
1331
|
+
<div class="method_details ">
|
|
1332
|
+
<h3 class="signature " id="get_collection-instance_method">
|
|
1333
|
+
|
|
1334
|
+
#<strong>get_collection</strong>(collection_id) ⇒ <tt>Hash</tt>
|
|
1335
|
+
|
|
1336
|
+
|
|
1337
|
+
|
|
1338
|
+
|
|
1339
|
+
|
|
1340
|
+
</h3><div class="docstring">
|
|
1341
|
+
<div class="discussion">
|
|
1342
|
+
|
|
1343
|
+
<p>Get collection details</p>
|
|
1344
|
+
|
|
1345
|
+
|
|
1346
|
+
</div>
|
|
1347
|
+
</div>
|
|
1348
|
+
<div class="tags">
|
|
1349
|
+
<p class="tag_title">Parameters:</p>
|
|
1350
|
+
<ul class="param">
|
|
1351
|
+
|
|
1352
|
+
<li>
|
|
1353
|
+
|
|
1354
|
+
<span class='name'>collection_id</span>
|
|
1355
|
+
|
|
1356
|
+
|
|
1357
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
1358
|
+
|
|
1359
|
+
|
|
1360
|
+
|
|
1361
|
+
—
|
|
1362
|
+
<div class='inline'>
|
|
1363
|
+
<p>collection ID</p>
|
|
1364
|
+
</div>
|
|
1365
|
+
|
|
1366
|
+
</li>
|
|
1367
|
+
|
|
1368
|
+
</ul>
|
|
1369
|
+
|
|
1370
|
+
<p class="tag_title">Returns:</p>
|
|
1371
|
+
<ul class="return">
|
|
1372
|
+
|
|
1373
|
+
<li>
|
|
1374
|
+
|
|
1375
|
+
|
|
1376
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1377
|
+
|
|
1378
|
+
|
|
1379
|
+
|
|
1380
|
+
—
|
|
1381
|
+
<div class='inline'>
|
|
1382
|
+
<p>collection details</p>
|
|
1383
|
+
</div>
|
|
1384
|
+
|
|
1385
|
+
</li>
|
|
1386
|
+
|
|
1387
|
+
</ul>
|
|
1388
|
+
|
|
1389
|
+
</div><table class="source_code">
|
|
1390
|
+
<tr>
|
|
1391
|
+
<td>
|
|
1392
|
+
<pre class="lines">
|
|
1393
|
+
|
|
1394
|
+
|
|
1395
|
+
67
|
|
1396
|
+
68
|
|
1397
|
+
69</pre>
|
|
1398
|
+
</td>
|
|
1399
|
+
<td>
|
|
1400
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/collection.rb', line 67</span>
|
|
1401
|
+
|
|
1402
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_collection'>get_collection</span><span class='lparen'>(</span><span class='id identifier rubyid_collection_id'>collection_id</span><span class='rparen'>)</span>
|
|
1403
|
+
<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>get_collection</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='label'>param1:</span> <span class='id identifier rubyid_collection_id'>collection_id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
1404
|
+
<span class='kw'>end</span></pre>
|
|
1405
|
+
</td>
|
|
1406
|
+
</tr>
|
|
1407
|
+
</table>
|
|
1408
|
+
</div>
|
|
1409
|
+
|
|
1410
|
+
<div class="method_details ">
|
|
1411
|
+
<h3 class="signature " id="get_featured_collections-instance_method">
|
|
1412
|
+
|
|
1413
|
+
#<strong>get_featured_collections</strong> ⇒ <tt>Array</tt>
|
|
1414
|
+
|
|
1415
|
+
|
|
1416
|
+
|
|
1417
|
+
|
|
1418
|
+
|
|
1419
|
+
</h3><div class="docstring">
|
|
1420
|
+
<div class="discussion">
|
|
1421
|
+
|
|
1422
|
+
<p>Get featured collections</p>
|
|
1423
|
+
|
|
1424
|
+
|
|
1425
|
+
</div>
|
|
1426
|
+
</div>
|
|
1427
|
+
<div class="tags">
|
|
1428
|
+
|
|
1429
|
+
<p class="tag_title">Returns:</p>
|
|
1430
|
+
<ul class="return">
|
|
1431
|
+
|
|
1432
|
+
<li>
|
|
1433
|
+
|
|
1434
|
+
|
|
1435
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
|
1436
|
+
|
|
1437
|
+
|
|
1438
|
+
|
|
1439
|
+
—
|
|
1440
|
+
<div class='inline'>
|
|
1441
|
+
<p>featured collections</p>
|
|
1442
|
+
</div>
|
|
1443
|
+
|
|
1444
|
+
</li>
|
|
1445
|
+
|
|
1446
|
+
</ul>
|
|
1447
|
+
|
|
1448
|
+
</div><table class="source_code">
|
|
1449
|
+
<tr>
|
|
1450
|
+
<td>
|
|
1451
|
+
<pre class="lines">
|
|
1452
|
+
|
|
1453
|
+
|
|
1454
|
+
146
|
|
1455
|
+
147
|
|
1456
|
+
148</pre>
|
|
1457
|
+
</td>
|
|
1458
|
+
<td>
|
|
1459
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/collection.rb', line 146</span>
|
|
1460
|
+
|
|
1461
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_featured_collections'>get_featured_collections</span>
|
|
1462
|
+
<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>get_featured_collections</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1463
|
+
<span class='kw'>end</span></pre>
|
|
1464
|
+
</td>
|
|
1465
|
+
</tr>
|
|
1466
|
+
</table>
|
|
1467
|
+
</div>
|
|
1468
|
+
|
|
1469
|
+
<div class="method_details ">
|
|
1470
|
+
<h3 class="signature " id="get_user_collections-instance_method">
|
|
1471
|
+
|
|
1472
|
+
#<strong>get_user_collections</strong>(user = nil) ⇒ <tt>Array</tt>
|
|
1473
|
+
|
|
1474
|
+
|
|
1475
|
+
|
|
1476
|
+
|
|
1477
|
+
|
|
1478
|
+
</h3><div class="docstring">
|
|
1479
|
+
<div class="discussion">
|
|
1480
|
+
|
|
1481
|
+
<p>Get user collections</p>
|
|
1482
|
+
|
|
1483
|
+
|
|
1484
|
+
</div>
|
|
1485
|
+
</div>
|
|
1486
|
+
<div class="tags">
|
|
1487
|
+
<p class="tag_title">Parameters:</p>
|
|
1488
|
+
<ul class="param">
|
|
1489
|
+
|
|
1490
|
+
<li>
|
|
1491
|
+
|
|
1492
|
+
<span class='name'>user</span>
|
|
1493
|
+
|
|
1494
|
+
|
|
1495
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1496
|
+
|
|
1497
|
+
|
|
1498
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1499
|
+
|
|
1500
|
+
|
|
1501
|
+
—
|
|
1502
|
+
<div class='inline'>
|
|
1503
|
+
<p>username (optional, defaults to current user)</p>
|
|
1504
|
+
</div>
|
|
1505
|
+
|
|
1506
|
+
</li>
|
|
1507
|
+
|
|
1508
|
+
</ul>
|
|
1509
|
+
|
|
1510
|
+
<p class="tag_title">Returns:</p>
|
|
1511
|
+
<ul class="return">
|
|
1512
|
+
|
|
1513
|
+
<li>
|
|
1514
|
+
|
|
1515
|
+
|
|
1516
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
|
1517
|
+
|
|
1518
|
+
|
|
1519
|
+
|
|
1520
|
+
—
|
|
1521
|
+
<div class='inline'>
|
|
1522
|
+
<p>user collections</p>
|
|
1523
|
+
</div>
|
|
1524
|
+
|
|
1525
|
+
</li>
|
|
1526
|
+
|
|
1527
|
+
</ul>
|
|
1528
|
+
|
|
1529
|
+
</div><table class="source_code">
|
|
1530
|
+
<tr>
|
|
1531
|
+
<td>
|
|
1532
|
+
<pre class="lines">
|
|
1533
|
+
|
|
1534
|
+
|
|
1535
|
+
32
|
|
1536
|
+
33
|
|
1537
|
+
34
|
|
1538
|
+
35
|
|
1539
|
+
36
|
|
1540
|
+
37</pre>
|
|
1541
|
+
</td>
|
|
1542
|
+
<td>
|
|
1543
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/collection.rb', line 32</span>
|
|
1544
|
+
|
|
1545
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_user_collections'>get_user_collections</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1546
|
+
<span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1547
|
+
<span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:param1</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_user'>user</span> <span class='kw'>if</span> <span class='id identifier rubyid_user'>user</span>
|
|
1548
|
+
|
|
1549
|
+
<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>get_user_collections</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
|
|
1550
|
+
<span class='kw'>end</span></pre>
|
|
1551
|
+
</td>
|
|
1552
|
+
</tr>
|
|
1553
|
+
</table>
|
|
1554
|
+
</div>
|
|
1555
|
+
|
|
1556
|
+
<div class="method_details ">
|
|
1557
|
+
<h3 class="signature " id="get_web_asset_collections-instance_method">
|
|
1558
|
+
|
|
1559
|
+
#<strong>get_web_asset_collections</strong>(asset_type: nil) ⇒ <tt>Array</tt>
|
|
1560
|
+
|
|
1561
|
+
|
|
1562
|
+
|
|
1563
|
+
|
|
1564
|
+
|
|
1565
|
+
</h3><div class="docstring">
|
|
1566
|
+
<div class="discussion">
|
|
1567
|
+
|
|
1568
|
+
<p>Get collections containing web assets</p>
|
|
1569
|
+
|
|
1570
|
+
|
|
1571
|
+
</div>
|
|
1572
|
+
</div>
|
|
1573
|
+
<div class="tags">
|
|
1574
|
+
<p class="tag_title">Parameters:</p>
|
|
1575
|
+
<ul class="param">
|
|
1576
|
+
|
|
1577
|
+
<li>
|
|
1578
|
+
|
|
1579
|
+
<span class='name'>asset_type</span>
|
|
1580
|
+
|
|
1581
|
+
|
|
1582
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1583
|
+
|
|
1584
|
+
|
|
1585
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1586
|
+
|
|
1587
|
+
|
|
1588
|
+
—
|
|
1589
|
+
<div class='inline'>
|
|
1590
|
+
<p>type of web assets to filter by</p>
|
|
1591
|
+
</div>
|
|
1592
|
+
|
|
1593
|
+
</li>
|
|
1594
|
+
|
|
1595
|
+
</ul>
|
|
1596
|
+
|
|
1597
|
+
<p class="tag_title">Returns:</p>
|
|
1598
|
+
<ul class="return">
|
|
1599
|
+
|
|
1600
|
+
<li>
|
|
1601
|
+
|
|
1602
|
+
|
|
1603
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
|
1604
|
+
|
|
1605
|
+
|
|
1606
|
+
|
|
1607
|
+
—
|
|
1608
|
+
<div class='inline'>
|
|
1609
|
+
<p>collections with web assets</p>
|
|
1610
|
+
</div>
|
|
1611
|
+
|
|
1612
|
+
</li>
|
|
1613
|
+
|
|
1614
|
+
</ul>
|
|
1615
|
+
|
|
1616
|
+
</div><table class="source_code">
|
|
1617
|
+
<tr>
|
|
1618
|
+
<td>
|
|
1619
|
+
<pre class="lines">
|
|
1620
|
+
|
|
1621
|
+
|
|
1622
|
+
195
|
|
1623
|
+
196
|
|
1624
|
+
197
|
|
1625
|
+
198
|
|
1626
|
+
199
|
|
1627
|
+
200
|
|
1628
|
+
201
|
|
1629
|
+
202
|
|
1630
|
+
203
|
|
1631
|
+
204
|
|
1632
|
+
205
|
|
1633
|
+
206
|
|
1634
|
+
207
|
|
1635
|
+
208
|
|
1636
|
+
209</pre>
|
|
1637
|
+
</td>
|
|
1638
|
+
<td>
|
|
1639
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/collection.rb', line 195</span>
|
|
1640
|
+
|
|
1641
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_web_asset_collections'>get_web_asset_collections</span><span class='lparen'>(</span><span class='label'>asset_type:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1642
|
+
<span class='id identifier rubyid_collections'>collections</span> <span class='op'>=</span> <span class='id identifier rubyid_get_user_collections'>get_user_collections</span>
|
|
1643
|
+
|
|
1644
|
+
<span class='comment'># Filter collections that likely contain web assets based on name
|
|
1645
|
+
</span> <span class='id identifier rubyid_web_asset_keywords'>web_asset_keywords</span> <span class='op'>=</span> <span class='qwords_beg'>%w[</span><span class='tstring_content'>web</span><span class='words_sep'> </span><span class='tstring_content'>asset</span><span class='words_sep'> </span><span class='tstring_content'>css</span><span class='words_sep'> </span><span class='tstring_content'>js</span><span class='words_sep'> </span><span class='tstring_content'>javascript</span><span class='words_sep'> </span><span class='tstring_content'>image</span><span class='words_sep'> </span><span class='tstring_content'>icon</span><span class='words_sep'> </span><span class='tstring_content'>font</span><span class='words_sep'> </span><span class='tstring_content'>stylesheet</span><span class='tstring_end'>]</span></span>
|
|
1646
|
+
|
|
1647
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_asset_type'>asset_type</span>
|
|
1648
|
+
<span class='id identifier rubyid_web_asset_keywords'>web_asset_keywords</span> <span class='op'><<</span> <span class='id identifier rubyid_asset_type'>asset_type</span><span class='period'>.</span><span class='id identifier rubyid_downcase'>downcase</span>
|
|
1649
|
+
<span class='kw'>end</span>
|
|
1650
|
+
|
|
1651
|
+
<span class='id identifier rubyid_collections'>collections</span><span class='period'>.</span><span class='id identifier rubyid_select'>select</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_collection'>collection</span><span class='op'>|</span>
|
|
1652
|
+
<span class='id identifier rubyid_name'>name</span> <span class='op'>=</span> <span class='id identifier rubyid_collection'>collection</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>name</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='op'>&.</span><span class='id identifier rubyid_downcase'>downcase</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
1653
|
+
<span class='id identifier rubyid_web_asset_keywords'>web_asset_keywords</span><span class='period'>.</span><span class='id identifier rubyid_any?'>any?</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_keyword'>keyword</span><span class='op'>|</span> <span class='id identifier rubyid_name'>name</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_keyword'>keyword</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
|
|
1654
|
+
<span class='kw'>end</span>
|
|
1655
|
+
<span class='kw'>end</span></pre>
|
|
1656
|
+
</td>
|
|
1657
|
+
</tr>
|
|
1658
|
+
</table>
|
|
1659
|
+
</div>
|
|
1660
|
+
|
|
1661
|
+
<div class="method_details ">
|
|
1662
|
+
<h3 class="signature " id="remove_resource_from_collection-instance_method">
|
|
1663
|
+
|
|
1664
|
+
#<strong>remove_resource_from_collection</strong>(resource_id, collection_id) ⇒ <tt>Hash</tt>
|
|
1665
|
+
|
|
1666
|
+
|
|
1667
|
+
|
|
1668
|
+
|
|
1669
|
+
|
|
1670
|
+
</h3><div class="docstring">
|
|
1671
|
+
<div class="discussion">
|
|
1672
|
+
|
|
1673
|
+
<p>Remove a resource from a collection</p>
|
|
1674
|
+
|
|
1675
|
+
|
|
1676
|
+
</div>
|
|
1677
|
+
</div>
|
|
1678
|
+
<div class="tags">
|
|
1679
|
+
<p class="tag_title">Parameters:</p>
|
|
1680
|
+
<ul class="param">
|
|
1681
|
+
|
|
1682
|
+
<li>
|
|
1683
|
+
|
|
1684
|
+
<span class='name'>resource_id</span>
|
|
1685
|
+
|
|
1686
|
+
|
|
1687
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
1688
|
+
|
|
1689
|
+
|
|
1690
|
+
|
|
1691
|
+
—
|
|
1692
|
+
<div class='inline'>
|
|
1693
|
+
<p>resource ID</p>
|
|
1694
|
+
</div>
|
|
1695
|
+
|
|
1696
|
+
</li>
|
|
1697
|
+
|
|
1698
|
+
<li>
|
|
1699
|
+
|
|
1700
|
+
<span class='name'>collection_id</span>
|
|
1701
|
+
|
|
1702
|
+
|
|
1703
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
1704
|
+
|
|
1705
|
+
|
|
1706
|
+
|
|
1707
|
+
—
|
|
1708
|
+
<div class='inline'>
|
|
1709
|
+
<p>collection ID</p>
|
|
1710
|
+
</div>
|
|
1711
|
+
|
|
1712
|
+
</li>
|
|
1713
|
+
|
|
1714
|
+
</ul>
|
|
1715
|
+
|
|
1716
|
+
<p class="tag_title">Returns:</p>
|
|
1717
|
+
<ul class="return">
|
|
1718
|
+
|
|
1719
|
+
<li>
|
|
1720
|
+
|
|
1721
|
+
|
|
1722
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1723
|
+
|
|
1724
|
+
|
|
1725
|
+
|
|
1726
|
+
—
|
|
1727
|
+
<div class='inline'>
|
|
1728
|
+
<p>response</p>
|
|
1729
|
+
</div>
|
|
1730
|
+
|
|
1731
|
+
</li>
|
|
1732
|
+
|
|
1733
|
+
</ul>
|
|
1734
|
+
|
|
1735
|
+
</div><table class="source_code">
|
|
1736
|
+
<tr>
|
|
1737
|
+
<td>
|
|
1738
|
+
<pre class="lines">
|
|
1739
|
+
|
|
1740
|
+
|
|
1741
|
+
104
|
|
1742
|
+
105
|
|
1743
|
+
106
|
|
1744
|
+
107
|
|
1745
|
+
108
|
|
1746
|
+
109</pre>
|
|
1747
|
+
</td>
|
|
1748
|
+
<td>
|
|
1749
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/collection.rb', line 104</span>
|
|
1750
|
+
|
|
1751
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_remove_resource_from_collection'>remove_resource_from_collection</span><span class='lparen'>(</span><span class='id identifier rubyid_resource_id'>resource_id</span><span class='comma'>,</span> <span class='id identifier rubyid_collection_id'>collection_id</span><span class='rparen'>)</span>
|
|
1752
|
+
<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>remove_resource_from_collection</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='lbrace'>{</span>
|
|
1753
|
+
<span class='label'>param1:</span> <span class='id identifier rubyid_resource_id'>resource_id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='comma'>,</span>
|
|
1754
|
+
<span class='label'>param2:</span> <span class='id identifier rubyid_collection_id'>collection_id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
|
|
1755
|
+
<span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
1756
|
+
<span class='kw'>end</span></pre>
|
|
1757
|
+
</td>
|
|
1758
|
+
</tr>
|
|
1759
|
+
</table>
|
|
1760
|
+
</div>
|
|
1761
|
+
|
|
1762
|
+
<div class="method_details ">
|
|
1763
|
+
<h3 class="signature " id="remove_resources_from_collection-instance_method">
|
|
1764
|
+
|
|
1765
|
+
#<strong>remove_resources_from_collection</strong>(resource_ids, collection_id) ⇒ <tt>Array</tt>
|
|
1766
|
+
|
|
1767
|
+
|
|
1768
|
+
|
|
1769
|
+
|
|
1770
|
+
|
|
1771
|
+
</h3><div class="docstring">
|
|
1772
|
+
<div class="discussion">
|
|
1773
|
+
|
|
1774
|
+
<p>Remove multiple resources from a collection</p>
|
|
1775
|
+
|
|
1776
|
+
|
|
1777
|
+
</div>
|
|
1778
|
+
</div>
|
|
1779
|
+
<div class="tags">
|
|
1780
|
+
<p class="tag_title">Parameters:</p>
|
|
1781
|
+
<ul class="param">
|
|
1782
|
+
|
|
1783
|
+
<li>
|
|
1784
|
+
|
|
1785
|
+
<span class='name'>resource_ids</span>
|
|
1786
|
+
|
|
1787
|
+
|
|
1788
|
+
<span class='type'>(<tt>Array<Integer></tt>)</span>
|
|
1789
|
+
|
|
1790
|
+
|
|
1791
|
+
|
|
1792
|
+
—
|
|
1793
|
+
<div class='inline'>
|
|
1794
|
+
<p>array of resource IDs</p>
|
|
1795
|
+
</div>
|
|
1796
|
+
|
|
1797
|
+
</li>
|
|
1798
|
+
|
|
1799
|
+
<li>
|
|
1800
|
+
|
|
1801
|
+
<span class='name'>collection_id</span>
|
|
1802
|
+
|
|
1803
|
+
|
|
1804
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
1805
|
+
|
|
1806
|
+
|
|
1807
|
+
|
|
1808
|
+
—
|
|
1809
|
+
<div class='inline'>
|
|
1810
|
+
<p>collection ID</p>
|
|
1811
|
+
</div>
|
|
1812
|
+
|
|
1813
|
+
</li>
|
|
1814
|
+
|
|
1815
|
+
</ul>
|
|
1816
|
+
|
|
1817
|
+
<p class="tag_title">Returns:</p>
|
|
1818
|
+
<ul class="return">
|
|
1819
|
+
|
|
1820
|
+
<li>
|
|
1821
|
+
|
|
1822
|
+
|
|
1823
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
|
1824
|
+
|
|
1825
|
+
|
|
1826
|
+
|
|
1827
|
+
—
|
|
1828
|
+
<div class='inline'>
|
|
1829
|
+
<p>array of responses</p>
|
|
1830
|
+
</div>
|
|
1831
|
+
|
|
1832
|
+
</li>
|
|
1833
|
+
|
|
1834
|
+
</ul>
|
|
1835
|
+
|
|
1836
|
+
</div><table class="source_code">
|
|
1837
|
+
<tr>
|
|
1838
|
+
<td>
|
|
1839
|
+
<pre class="lines">
|
|
1840
|
+
|
|
1841
|
+
|
|
1842
|
+
174
|
|
1843
|
+
175
|
|
1844
|
+
176
|
|
1845
|
+
177
|
|
1846
|
+
178</pre>
|
|
1847
|
+
</td>
|
|
1848
|
+
<td>
|
|
1849
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/collection.rb', line 174</span>
|
|
1850
|
+
|
|
1851
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_remove_resources_from_collection'>remove_resources_from_collection</span><span class='lparen'>(</span><span class='id identifier rubyid_resource_ids'>resource_ids</span><span class='comma'>,</span> <span class='id identifier rubyid_collection_id'>collection_id</span><span class='rparen'>)</span>
|
|
1852
|
+
<span class='const'>Array</span><span class='lparen'>(</span><span class='id identifier rubyid_resource_ids'>resource_ids</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_resource_id'>resource_id</span><span class='op'>|</span>
|
|
1853
|
+
<span class='id identifier rubyid_remove_resource_from_collection'>remove_resource_from_collection</span><span class='lparen'>(</span><span class='id identifier rubyid_resource_id'>resource_id</span><span class='comma'>,</span> <span class='id identifier rubyid_collection_id'>collection_id</span><span class='rparen'>)</span>
|
|
1854
|
+
<span class='kw'>end</span>
|
|
1855
|
+
<span class='kw'>end</span></pre>
|
|
1856
|
+
</td>
|
|
1857
|
+
</tr>
|
|
1858
|
+
</table>
|
|
1859
|
+
</div>
|
|
1860
|
+
|
|
1861
|
+
<div class="method_details ">
|
|
1862
|
+
<h3 class="signature " id="save_collection-instance_method">
|
|
1863
|
+
|
|
1864
|
+
#<strong>save_collection</strong>(collection_id, name: nil, public: nil, allow_changes: nil) ⇒ <tt>Hash</tt>
|
|
1865
|
+
|
|
1866
|
+
|
|
1867
|
+
|
|
1868
|
+
|
|
1869
|
+
|
|
1870
|
+
</h3><div class="docstring">
|
|
1871
|
+
<div class="discussion">
|
|
1872
|
+
|
|
1873
|
+
<p>Save collection (update collection details)</p>
|
|
1874
|
+
|
|
1875
|
+
|
|
1876
|
+
</div>
|
|
1877
|
+
</div>
|
|
1878
|
+
<div class="tags">
|
|
1879
|
+
<p class="tag_title">Parameters:</p>
|
|
1880
|
+
<ul class="param">
|
|
1881
|
+
|
|
1882
|
+
<li>
|
|
1883
|
+
|
|
1884
|
+
<span class='name'>collection_id</span>
|
|
1885
|
+
|
|
1886
|
+
|
|
1887
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
1888
|
+
|
|
1889
|
+
|
|
1890
|
+
|
|
1891
|
+
—
|
|
1892
|
+
<div class='inline'>
|
|
1893
|
+
<p>collection ID</p>
|
|
1894
|
+
</div>
|
|
1895
|
+
|
|
1896
|
+
</li>
|
|
1897
|
+
|
|
1898
|
+
<li>
|
|
1899
|
+
|
|
1900
|
+
<span class='name'>name</span>
|
|
1901
|
+
|
|
1902
|
+
|
|
1903
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1904
|
+
|
|
1905
|
+
|
|
1906
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1907
|
+
|
|
1908
|
+
|
|
1909
|
+
—
|
|
1910
|
+
<div class='inline'>
|
|
1911
|
+
<p>new collection name</p>
|
|
1912
|
+
</div>
|
|
1913
|
+
|
|
1914
|
+
</li>
|
|
1915
|
+
|
|
1916
|
+
<li>
|
|
1917
|
+
|
|
1918
|
+
<span class='name'>public</span>
|
|
1919
|
+
|
|
1920
|
+
|
|
1921
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
1922
|
+
|
|
1923
|
+
|
|
1924
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1925
|
+
|
|
1926
|
+
|
|
1927
|
+
—
|
|
1928
|
+
<div class='inline'>
|
|
1929
|
+
<p>whether collection is public</p>
|
|
1930
|
+
</div>
|
|
1931
|
+
|
|
1932
|
+
</li>
|
|
1933
|
+
|
|
1934
|
+
<li>
|
|
1935
|
+
|
|
1936
|
+
<span class='name'>allow_changes</span>
|
|
1937
|
+
|
|
1938
|
+
|
|
1939
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
1940
|
+
|
|
1941
|
+
|
|
1942
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1943
|
+
|
|
1944
|
+
|
|
1945
|
+
—
|
|
1946
|
+
<div class='inline'>
|
|
1947
|
+
<p>whether to allow changes</p>
|
|
1948
|
+
</div>
|
|
1949
|
+
|
|
1950
|
+
</li>
|
|
1951
|
+
|
|
1952
|
+
</ul>
|
|
1953
|
+
|
|
1954
|
+
<p class="tag_title">Returns:</p>
|
|
1955
|
+
<ul class="return">
|
|
1956
|
+
|
|
1957
|
+
<li>
|
|
1958
|
+
|
|
1959
|
+
|
|
1960
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1961
|
+
|
|
1962
|
+
|
|
1963
|
+
|
|
1964
|
+
—
|
|
1965
|
+
<div class='inline'>
|
|
1966
|
+
<p>response</p>
|
|
1967
|
+
</div>
|
|
1968
|
+
|
|
1969
|
+
</li>
|
|
1970
|
+
|
|
1971
|
+
</ul>
|
|
1972
|
+
|
|
1973
|
+
</div><table class="source_code">
|
|
1974
|
+
<tr>
|
|
1975
|
+
<td>
|
|
1976
|
+
<pre class="lines">
|
|
1977
|
+
|
|
1978
|
+
|
|
1979
|
+
78
|
|
1980
|
+
79
|
|
1981
|
+
80
|
|
1982
|
+
81
|
|
1983
|
+
82
|
|
1984
|
+
83
|
|
1985
|
+
84
|
|
1986
|
+
85</pre>
|
|
1987
|
+
</td>
|
|
1988
|
+
<td>
|
|
1989
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/collection.rb', line 78</span>
|
|
1990
|
+
|
|
1991
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_save_collection'>save_collection</span><span class='lparen'>(</span><span class='id identifier rubyid_collection_id'>collection_id</span><span class='comma'>,</span> <span class='label'>name:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>public:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>allow_changes:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1992
|
+
<span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>param1:</span> <span class='id identifier rubyid_collection_id'>collection_id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='rbrace'>}</span>
|
|
1993
|
+
<span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:param2</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span> <span class='kw'>if</span> <span class='id identifier rubyid_name'>name</span>
|
|
1994
|
+
<span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:param3</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_public'>public</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>1</span><span class='tstring_end'>"</span></span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>0</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_public'>public</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
1995
|
+
<span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:param4</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_allow_changes'>allow_changes</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>1</span><span class='tstring_end'>"</span></span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>0</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_allow_changes'>allow_changes</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
1996
|
+
|
|
1997
|
+
<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>save_collection</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
|
|
1998
|
+
<span class='kw'>end</span></pre>
|
|
1999
|
+
</td>
|
|
2000
|
+
</tr>
|
|
2001
|
+
</table>
|
|
2002
|
+
</div>
|
|
2003
|
+
|
|
2004
|
+
<div class="method_details ">
|
|
2005
|
+
<h3 class="signature " id="search_public_collections-instance_method">
|
|
2006
|
+
|
|
2007
|
+
#<strong>search_public_collections</strong>(search_term) ⇒ <tt>Array</tt>
|
|
2008
|
+
|
|
2009
|
+
|
|
2010
|
+
|
|
2011
|
+
|
|
2012
|
+
|
|
2013
|
+
</h3><div class="docstring">
|
|
2014
|
+
<div class="discussion">
|
|
2015
|
+
|
|
2016
|
+
<p>Search public collections</p>
|
|
2017
|
+
|
|
2018
|
+
|
|
2019
|
+
</div>
|
|
2020
|
+
</div>
|
|
2021
|
+
<div class="tags">
|
|
2022
|
+
<p class="tag_title">Parameters:</p>
|
|
2023
|
+
<ul class="param">
|
|
2024
|
+
|
|
2025
|
+
<li>
|
|
2026
|
+
|
|
2027
|
+
<span class='name'>search_term</span>
|
|
2028
|
+
|
|
2029
|
+
|
|
2030
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
2031
|
+
|
|
2032
|
+
|
|
2033
|
+
|
|
2034
|
+
—
|
|
2035
|
+
<div class='inline'>
|
|
2036
|
+
<p>search term</p>
|
|
2037
|
+
</div>
|
|
2038
|
+
|
|
2039
|
+
</li>
|
|
2040
|
+
|
|
2041
|
+
</ul>
|
|
2042
|
+
|
|
2043
|
+
<p class="tag_title">Returns:</p>
|
|
2044
|
+
<ul class="return">
|
|
2045
|
+
|
|
2046
|
+
<li>
|
|
2047
|
+
|
|
2048
|
+
|
|
2049
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
|
2050
|
+
|
|
2051
|
+
|
|
2052
|
+
|
|
2053
|
+
—
|
|
2054
|
+
<div class='inline'>
|
|
2055
|
+
<p>matching public collections</p>
|
|
2056
|
+
</div>
|
|
2057
|
+
|
|
2058
|
+
</li>
|
|
2059
|
+
|
|
2060
|
+
</ul>
|
|
2061
|
+
|
|
2062
|
+
</div><table class="source_code">
|
|
2063
|
+
<tr>
|
|
2064
|
+
<td>
|
|
2065
|
+
<pre class="lines">
|
|
2066
|
+
|
|
2067
|
+
|
|
2068
|
+
139
|
|
2069
|
+
140
|
|
2070
|
+
141</pre>
|
|
2071
|
+
</td>
|
|
2072
|
+
<td>
|
|
2073
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/collection.rb', line 139</span>
|
|
2074
|
+
|
|
2075
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_search_public_collections'>search_public_collections</span><span class='lparen'>(</span><span class='id identifier rubyid_search_term'>search_term</span><span class='rparen'>)</span>
|
|
2076
|
+
<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>search_public_collections</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='label'>param1:</span> <span class='id identifier rubyid_search_term'>search_term</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
2077
|
+
<span class='kw'>end</span></pre>
|
|
2078
|
+
</td>
|
|
2079
|
+
</tr>
|
|
2080
|
+
</table>
|
|
2081
|
+
</div>
|
|
2082
|
+
|
|
2083
|
+
<div class="method_details ">
|
|
2084
|
+
<h3 class="signature " id="send_collection_to_admin-instance_method">
|
|
2085
|
+
|
|
2086
|
+
#<strong>send_collection_to_admin</strong>(collection_id, message = "") ⇒ <tt>Hash</tt>
|
|
2087
|
+
|
|
2088
|
+
|
|
2089
|
+
|
|
2090
|
+
|
|
2091
|
+
|
|
2092
|
+
</h3><div class="docstring">
|
|
2093
|
+
<div class="discussion">
|
|
2094
|
+
|
|
2095
|
+
<p>Send collection to admin</p>
|
|
2096
|
+
|
|
2097
|
+
|
|
2098
|
+
</div>
|
|
2099
|
+
</div>
|
|
2100
|
+
<div class="tags">
|
|
2101
|
+
<p class="tag_title">Parameters:</p>
|
|
2102
|
+
<ul class="param">
|
|
2103
|
+
|
|
2104
|
+
<li>
|
|
2105
|
+
|
|
2106
|
+
<span class='name'>collection_id</span>
|
|
2107
|
+
|
|
2108
|
+
|
|
2109
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
2110
|
+
|
|
2111
|
+
|
|
2112
|
+
|
|
2113
|
+
—
|
|
2114
|
+
<div class='inline'>
|
|
2115
|
+
<p>collection ID</p>
|
|
2116
|
+
</div>
|
|
2117
|
+
|
|
2118
|
+
</li>
|
|
2119
|
+
|
|
2120
|
+
<li>
|
|
2121
|
+
|
|
2122
|
+
<span class='name'>message</span>
|
|
2123
|
+
|
|
2124
|
+
|
|
2125
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
2126
|
+
|
|
2127
|
+
|
|
2128
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
2129
|
+
|
|
2130
|
+
|
|
2131
|
+
—
|
|
2132
|
+
<div class='inline'>
|
|
2133
|
+
<p>message to admin</p>
|
|
2134
|
+
</div>
|
|
2135
|
+
|
|
2136
|
+
</li>
|
|
2137
|
+
|
|
2138
|
+
</ul>
|
|
2139
|
+
|
|
2140
|
+
<p class="tag_title">Returns:</p>
|
|
2141
|
+
<ul class="return">
|
|
2142
|
+
|
|
2143
|
+
<li>
|
|
2144
|
+
|
|
2145
|
+
|
|
2146
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
2147
|
+
|
|
2148
|
+
|
|
2149
|
+
|
|
2150
|
+
—
|
|
2151
|
+
<div class='inline'>
|
|
2152
|
+
<p>response</p>
|
|
2153
|
+
</div>
|
|
2154
|
+
|
|
2155
|
+
</li>
|
|
2156
|
+
|
|
2157
|
+
</ul>
|
|
2158
|
+
|
|
2159
|
+
</div><table class="source_code">
|
|
2160
|
+
<tr>
|
|
2161
|
+
<td>
|
|
2162
|
+
<pre class="lines">
|
|
2163
|
+
|
|
2164
|
+
|
|
2165
|
+
128
|
|
2166
|
+
129
|
|
2167
|
+
130
|
|
2168
|
+
131
|
|
2169
|
+
132
|
|
2170
|
+
133</pre>
|
|
2171
|
+
</td>
|
|
2172
|
+
<td>
|
|
2173
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/collection.rb', line 128</span>
|
|
2174
|
+
|
|
2175
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_send_collection_to_admin'>send_collection_to_admin</span><span class='lparen'>(</span><span class='id identifier rubyid_collection_id'>collection_id</span><span class='comma'>,</span> <span class='id identifier rubyid_message'>message</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
2176
|
+
<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>send_collection_to_admin</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='lbrace'>{</span>
|
|
2177
|
+
<span class='label'>param1:</span> <span class='id identifier rubyid_collection_id'>collection_id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='comma'>,</span>
|
|
2178
|
+
<span class='label'>param2:</span> <span class='id identifier rubyid_message'>message</span>
|
|
2179
|
+
<span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
2180
|
+
<span class='kw'>end</span></pre>
|
|
2181
|
+
</td>
|
|
2182
|
+
</tr>
|
|
2183
|
+
</table>
|
|
2184
|
+
</div>
|
|
2185
|
+
|
|
2186
|
+
<div class="method_details ">
|
|
2187
|
+
<h3 class="signature " id="show_hide_collection-instance_method">
|
|
2188
|
+
|
|
2189
|
+
#<strong>show_hide_collection</strong>(collection_id, show: true) ⇒ <tt>Hash</tt>
|
|
2190
|
+
|
|
2191
|
+
|
|
2192
|
+
|
|
2193
|
+
|
|
2194
|
+
|
|
2195
|
+
</h3><div class="docstring">
|
|
2196
|
+
<div class="discussion">
|
|
2197
|
+
|
|
2198
|
+
<p>Show or hide a collection</p>
|
|
2199
|
+
|
|
2200
|
+
|
|
2201
|
+
</div>
|
|
2202
|
+
</div>
|
|
2203
|
+
<div class="tags">
|
|
2204
|
+
<p class="tag_title">Parameters:</p>
|
|
2205
|
+
<ul class="param">
|
|
2206
|
+
|
|
2207
|
+
<li>
|
|
2208
|
+
|
|
2209
|
+
<span class='name'>collection_id</span>
|
|
2210
|
+
|
|
2211
|
+
|
|
2212
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
2213
|
+
|
|
2214
|
+
|
|
2215
|
+
|
|
2216
|
+
—
|
|
2217
|
+
<div class='inline'>
|
|
2218
|
+
<p>collection ID</p>
|
|
2219
|
+
</div>
|
|
2220
|
+
|
|
2221
|
+
</li>
|
|
2222
|
+
|
|
2223
|
+
<li>
|
|
2224
|
+
|
|
2225
|
+
<span class='name'>show</span>
|
|
2226
|
+
|
|
2227
|
+
|
|
2228
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
2229
|
+
|
|
2230
|
+
|
|
2231
|
+
<em class="default">(defaults to: <tt>true</tt>)</em>
|
|
2232
|
+
|
|
2233
|
+
|
|
2234
|
+
—
|
|
2235
|
+
<div class='inline'>
|
|
2236
|
+
<p>true to show, false to hide</p>
|
|
2237
|
+
</div>
|
|
2238
|
+
|
|
2239
|
+
</li>
|
|
2240
|
+
|
|
2241
|
+
</ul>
|
|
2242
|
+
|
|
2243
|
+
<p class="tag_title">Returns:</p>
|
|
2244
|
+
<ul class="return">
|
|
2245
|
+
|
|
2246
|
+
<li>
|
|
2247
|
+
|
|
2248
|
+
|
|
2249
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
2250
|
+
|
|
2251
|
+
|
|
2252
|
+
|
|
2253
|
+
—
|
|
2254
|
+
<div class='inline'>
|
|
2255
|
+
<p>response</p>
|
|
2256
|
+
</div>
|
|
2257
|
+
|
|
2258
|
+
</li>
|
|
2259
|
+
|
|
2260
|
+
</ul>
|
|
2261
|
+
|
|
2262
|
+
</div><table class="source_code">
|
|
2263
|
+
<tr>
|
|
2264
|
+
<td>
|
|
2265
|
+
<pre class="lines">
|
|
2266
|
+
|
|
2267
|
+
|
|
2268
|
+
116
|
|
2269
|
+
117
|
|
2270
|
+
118
|
|
2271
|
+
119
|
|
2272
|
+
120
|
|
2273
|
+
121</pre>
|
|
2274
|
+
</td>
|
|
2275
|
+
<td>
|
|
2276
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/collection.rb', line 116</span>
|
|
2277
|
+
|
|
2278
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_show_hide_collection'>show_hide_collection</span><span class='lparen'>(</span><span class='id identifier rubyid_collection_id'>collection_id</span><span class='comma'>,</span> <span class='label'>show:</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
|
2279
|
+
<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>show_hide_collection</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='lbrace'>{</span>
|
|
2280
|
+
<span class='label'>param1:</span> <span class='id identifier rubyid_collection_id'>collection_id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='comma'>,</span>
|
|
2281
|
+
<span class='label'>param2:</span> <span class='id identifier rubyid_show'>show</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>1</span><span class='tstring_end'>"</span></span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>0</span><span class='tstring_end'>"</span></span>
|
|
2282
|
+
<span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
2283
|
+
<span class='kw'>end</span></pre>
|
|
2284
|
+
</td>
|
|
2285
|
+
</tr>
|
|
2286
|
+
</table>
|
|
2287
|
+
</div>
|
|
2288
|
+
|
|
2289
|
+
</div>
|
|
2290
|
+
|
|
2291
|
+
</div>
|
|
2292
|
+
|
|
2293
|
+
<div id="footer">
|
|
2294
|
+
Generated on Sat May 24 15:41:24 2025 by
|
|
2295
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
2296
|
+
0.9.37 (ruby-3.4.4).
|
|
2297
|
+
</div>
|
|
2298
|
+
|
|
2299
|
+
</div>
|
|
2300
|
+
</body>
|
|
2301
|
+
</html>
|