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,2995 @@
|
|
|
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::Resource
|
|
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::Resource";
|
|
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 (R)</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">Resource</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::Resource
|
|
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::Resource</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/resource.rb</dd>
|
|
98
|
+
</dl>
|
|
99
|
+
|
|
100
|
+
</div>
|
|
101
|
+
|
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
|
103
|
+
<div class="discussion">
|
|
104
|
+
|
|
105
|
+
<p>Resource 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_resources'>resources</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_resources'>resources</span>
|
|
117
|
+
|
|
118
|
+
<span class='comment'># Create a new resource
|
|
119
|
+
</span><span class='id identifier rubyid_resource'>resource</span> <span class='op'>=</span> <span class='id identifier rubyid_resources'>resources</span><span class='period'>.</span><span class='id identifier rubyid_create_resource'>create_resource</span><span class='lparen'>(</span><span class='label'>name:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>My Image</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
120
|
+
|
|
121
|
+
<span class='comment'># Upload a file
|
|
122
|
+
</span><span class='id identifier rubyid_uploaded'>uploaded</span> <span class='op'>=</span> <span class='id identifier rubyid_resources'>resources</span><span class='period'>.</span><span class='id identifier rubyid_upload_file'>upload_file</span><span class='lparen'>(</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_open'>open</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>image.jpg</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
|
|
123
|
+
|
|
124
|
+
<span class='comment'># Get resource data
|
|
125
|
+
</span><span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='id identifier rubyid_resources'>resources</span><span class='period'>.</span><span class='id identifier rubyid_get_resource_data'>get_resource_data</span><span class='lparen'>(</span><span class='int'>123</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_alternative_file-instance_method" title="#add_alternative_file (instance method)">#<strong>add_alternative_file</strong>(resource_id, file, name: nil, description: nil) ⇒ 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 an alternative file to a resource.</p>
|
|
198
|
+
</div></span>
|
|
199
|
+
|
|
200
|
+
</li>
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
<li class="public ">
|
|
204
|
+
<span class="summary_signature">
|
|
205
|
+
|
|
206
|
+
<a href="#copy_resource-instance_method" title="#copy_resource (instance method)">#<strong>copy_resource</strong>(resource_id, resource_type: nil) ⇒ Hash </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>Copy a resource.</p>
|
|
222
|
+
</div></span>
|
|
223
|
+
|
|
224
|
+
</li>
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
<li class="public ">
|
|
228
|
+
<span class="summary_signature">
|
|
229
|
+
|
|
230
|
+
<a href="#create_resource-instance_method" title="#create_resource (instance method)">#<strong>create_resource</strong>(name: nil, resource_type: 1, collection: nil, metadata: {}) ⇒ 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 resource.</p>
|
|
246
|
+
</div></span>
|
|
247
|
+
|
|
248
|
+
</li>
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
<li class="public ">
|
|
252
|
+
<span class="summary_signature">
|
|
253
|
+
|
|
254
|
+
<a href="#delete_alternative_file-instance_method" title="#delete_alternative_file (instance method)">#<strong>delete_alternative_file</strong>(resource_id, alt_file_id) ⇒ 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>Delete an alternative file.</p>
|
|
270
|
+
</div></span>
|
|
271
|
+
|
|
272
|
+
</li>
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
<li class="public ">
|
|
276
|
+
<span class="summary_signature">
|
|
277
|
+
|
|
278
|
+
<a href="#delete_resource-instance_method" title="#delete_resource (instance method)">#<strong>delete_resource</strong>(resource_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 resource.</p>
|
|
294
|
+
</div></span>
|
|
295
|
+
|
|
296
|
+
</li>
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
<li class="public ">
|
|
300
|
+
<span class="summary_signature">
|
|
301
|
+
|
|
302
|
+
<a href="#download_resource-instance_method" title="#download_resource (instance method)">#<strong>download_resource</strong>(resource_id, file_path, size: "") ⇒ Boolean </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>Download a resource file.</p>
|
|
318
|
+
</div></span>
|
|
319
|
+
|
|
320
|
+
</li>
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
<li class="public ">
|
|
324
|
+
<span class="summary_signature">
|
|
325
|
+
|
|
326
|
+
<a href="#edit_access%3F-instance_method" title="#edit_access? (instance method)">#<strong>edit_access?</strong>(resource_id) ⇒ Boolean </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>Check if user has edit access to resource.</p>
|
|
342
|
+
</div></span>
|
|
343
|
+
|
|
344
|
+
</li>
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
<li class="public ">
|
|
348
|
+
<span class="summary_signature">
|
|
349
|
+
|
|
350
|
+
<a href="#get_alternative_files-instance_method" title="#get_alternative_files (instance method)">#<strong>get_alternative_files</strong>(resource_id) ⇒ 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 alternative files for a resource.</p>
|
|
366
|
+
</div></span>
|
|
367
|
+
|
|
368
|
+
</li>
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
<li class="public ">
|
|
372
|
+
<span class="summary_signature">
|
|
373
|
+
|
|
374
|
+
<a href="#get_resource_access-instance_method" title="#get_resource_access (instance method)">#<strong>get_resource_access</strong>(resource_id) ⇒ Integer </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 resource access level.</p>
|
|
390
|
+
</div></span>
|
|
391
|
+
|
|
392
|
+
</li>
|
|
393
|
+
|
|
394
|
+
|
|
395
|
+
<li class="public ">
|
|
396
|
+
<span class="summary_signature">
|
|
397
|
+
|
|
398
|
+
<a href="#get_resource_all_image_sizes-instance_method" title="#get_resource_all_image_sizes (instance method)">#<strong>get_resource_all_image_sizes</strong>(resource_id) ⇒ Hash </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 all image sizes for a resource.</p>
|
|
414
|
+
</div></span>
|
|
415
|
+
|
|
416
|
+
</li>
|
|
417
|
+
|
|
418
|
+
|
|
419
|
+
<li class="public ">
|
|
420
|
+
<span class="summary_signature">
|
|
421
|
+
|
|
422
|
+
<a href="#get_resource_data-instance_method" title="#get_resource_data (instance method)">#<strong>get_resource_data</strong>(resource_id) ⇒ Hash </a>
|
|
423
|
+
|
|
424
|
+
|
|
425
|
+
|
|
426
|
+
</span>
|
|
427
|
+
|
|
428
|
+
|
|
429
|
+
|
|
430
|
+
|
|
431
|
+
|
|
432
|
+
|
|
433
|
+
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
<span class="summary_desc"><div class='inline'>
|
|
437
|
+
<p>Get resource data.</p>
|
|
438
|
+
</div></span>
|
|
439
|
+
|
|
440
|
+
</li>
|
|
441
|
+
|
|
442
|
+
|
|
443
|
+
<li class="public ">
|
|
444
|
+
<span class="summary_signature">
|
|
445
|
+
|
|
446
|
+
<a href="#get_resource_field_data-instance_method" title="#get_resource_field_data (instance method)">#<strong>get_resource_field_data</strong>(resource_id, field_id = nil) ⇒ Hash </a>
|
|
447
|
+
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
</span>
|
|
451
|
+
|
|
452
|
+
|
|
453
|
+
|
|
454
|
+
|
|
455
|
+
|
|
456
|
+
|
|
457
|
+
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
<span class="summary_desc"><div class='inline'>
|
|
461
|
+
<p>Get resource field data.</p>
|
|
462
|
+
</div></span>
|
|
463
|
+
|
|
464
|
+
</li>
|
|
465
|
+
|
|
466
|
+
|
|
467
|
+
<li class="public ">
|
|
468
|
+
<span class="summary_signature">
|
|
469
|
+
|
|
470
|
+
<a href="#get_resource_log-instance_method" title="#get_resource_log (instance method)">#<strong>get_resource_log</strong>(resource_id, entries: 50) ⇒ Array </a>
|
|
471
|
+
|
|
472
|
+
|
|
473
|
+
|
|
474
|
+
</span>
|
|
475
|
+
|
|
476
|
+
|
|
477
|
+
|
|
478
|
+
|
|
479
|
+
|
|
480
|
+
|
|
481
|
+
|
|
482
|
+
|
|
483
|
+
|
|
484
|
+
<span class="summary_desc"><div class='inline'>
|
|
485
|
+
<p>Get resource log.</p>
|
|
486
|
+
</div></span>
|
|
487
|
+
|
|
488
|
+
</li>
|
|
489
|
+
|
|
490
|
+
|
|
491
|
+
<li class="public ">
|
|
492
|
+
<span class="summary_signature">
|
|
493
|
+
|
|
494
|
+
<a href="#get_resource_path-instance_method" title="#get_resource_path (instance method)">#<strong>get_resource_path</strong>(resource_id, size: "", page: 1, ext: "") ⇒ String </a>
|
|
495
|
+
|
|
496
|
+
|
|
497
|
+
|
|
498
|
+
</span>
|
|
499
|
+
|
|
500
|
+
|
|
501
|
+
|
|
502
|
+
|
|
503
|
+
|
|
504
|
+
|
|
505
|
+
|
|
506
|
+
|
|
507
|
+
|
|
508
|
+
<span class="summary_desc"><div class='inline'>
|
|
509
|
+
<p>Get resource download path.</p>
|
|
510
|
+
</div></span>
|
|
511
|
+
|
|
512
|
+
</li>
|
|
513
|
+
|
|
514
|
+
|
|
515
|
+
<li class="public ">
|
|
516
|
+
<span class="summary_signature">
|
|
517
|
+
|
|
518
|
+
<a href="#get_resource_types-instance_method" title="#get_resource_types (instance method)">#<strong>get_resource_types</strong> ⇒ Array </a>
|
|
519
|
+
|
|
520
|
+
|
|
521
|
+
|
|
522
|
+
</span>
|
|
523
|
+
|
|
524
|
+
|
|
525
|
+
|
|
526
|
+
|
|
527
|
+
|
|
528
|
+
|
|
529
|
+
|
|
530
|
+
|
|
531
|
+
|
|
532
|
+
<span class="summary_desc"><div class='inline'>
|
|
533
|
+
<p>Get resource types.</p>
|
|
534
|
+
</div></span>
|
|
535
|
+
|
|
536
|
+
</li>
|
|
537
|
+
|
|
538
|
+
|
|
539
|
+
<li class="public ">
|
|
540
|
+
<span class="summary_signature">
|
|
541
|
+
|
|
542
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client) ⇒ Resource </a>
|
|
543
|
+
|
|
544
|
+
|
|
545
|
+
|
|
546
|
+
</span>
|
|
547
|
+
|
|
548
|
+
|
|
549
|
+
<span class="note title constructor">constructor</span>
|
|
550
|
+
|
|
551
|
+
|
|
552
|
+
|
|
553
|
+
|
|
554
|
+
|
|
555
|
+
|
|
556
|
+
|
|
557
|
+
|
|
558
|
+
<span class="summary_desc"><div class='inline'>
|
|
559
|
+
<p>Initialize the resource interface.</p>
|
|
560
|
+
</div></span>
|
|
561
|
+
|
|
562
|
+
</li>
|
|
563
|
+
|
|
564
|
+
|
|
565
|
+
<li class="public ">
|
|
566
|
+
<span class="summary_signature">
|
|
567
|
+
|
|
568
|
+
<a href="#replace_resource_file-instance_method" title="#replace_resource_file (instance method)">#<strong>replace_resource_file</strong>(resource_id, file, no_exif: false) ⇒ 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>Replace resource file.</p>
|
|
584
|
+
</div></span>
|
|
585
|
+
|
|
586
|
+
</li>
|
|
587
|
+
|
|
588
|
+
|
|
589
|
+
<li class="public ">
|
|
590
|
+
<span class="summary_signature">
|
|
591
|
+
|
|
592
|
+
<a href="#update_field-instance_method" title="#update_field (instance method)">#<strong>update_field</strong>(resource_id, field_id, value, node_values: false) ⇒ Hash </a>
|
|
593
|
+
|
|
594
|
+
|
|
595
|
+
|
|
596
|
+
</span>
|
|
597
|
+
|
|
598
|
+
|
|
599
|
+
|
|
600
|
+
|
|
601
|
+
|
|
602
|
+
|
|
603
|
+
|
|
604
|
+
|
|
605
|
+
|
|
606
|
+
<span class="summary_desc"><div class='inline'>
|
|
607
|
+
<p>Update a resource field.</p>
|
|
608
|
+
</div></span>
|
|
609
|
+
|
|
610
|
+
</li>
|
|
611
|
+
|
|
612
|
+
|
|
613
|
+
<li class="public ">
|
|
614
|
+
<span class="summary_signature">
|
|
615
|
+
|
|
616
|
+
<a href="#update_resource_type-instance_method" title="#update_resource_type (instance method)">#<strong>update_resource_type</strong>(resource_id, resource_type) ⇒ Hash </a>
|
|
617
|
+
|
|
618
|
+
|
|
619
|
+
|
|
620
|
+
</span>
|
|
621
|
+
|
|
622
|
+
|
|
623
|
+
|
|
624
|
+
|
|
625
|
+
|
|
626
|
+
|
|
627
|
+
|
|
628
|
+
|
|
629
|
+
|
|
630
|
+
<span class="summary_desc"><div class='inline'>
|
|
631
|
+
<p>Update resource type.</p>
|
|
632
|
+
</div></span>
|
|
633
|
+
|
|
634
|
+
</li>
|
|
635
|
+
|
|
636
|
+
|
|
637
|
+
<li class="public ">
|
|
638
|
+
<span class="summary_signature">
|
|
639
|
+
|
|
640
|
+
<a href="#upload_file-instance_method" title="#upload_file (instance method)">#<strong>upload_file</strong>(file, caption: nil, no_exif: false) ⇒ Hash </a>
|
|
641
|
+
|
|
642
|
+
|
|
643
|
+
|
|
644
|
+
</span>
|
|
645
|
+
|
|
646
|
+
|
|
647
|
+
|
|
648
|
+
|
|
649
|
+
|
|
650
|
+
|
|
651
|
+
|
|
652
|
+
|
|
653
|
+
|
|
654
|
+
<span class="summary_desc"><div class='inline'>
|
|
655
|
+
<p>Upload a file to ResourceSpace.</p>
|
|
656
|
+
</div></span>
|
|
657
|
+
|
|
658
|
+
</li>
|
|
659
|
+
|
|
660
|
+
|
|
661
|
+
<li class="public ">
|
|
662
|
+
<span class="summary_signature">
|
|
663
|
+
|
|
664
|
+
<a href="#upload_file_by_url-instance_method" title="#upload_file_by_url (instance method)">#<strong>upload_file_by_url</strong>(resource_id, url, save_as: nil, no_exif: false) ⇒ Hash </a>
|
|
665
|
+
|
|
666
|
+
|
|
667
|
+
|
|
668
|
+
</span>
|
|
669
|
+
|
|
670
|
+
|
|
671
|
+
|
|
672
|
+
|
|
673
|
+
|
|
674
|
+
|
|
675
|
+
|
|
676
|
+
|
|
677
|
+
|
|
678
|
+
<span class="summary_desc"><div class='inline'>
|
|
679
|
+
<p>Upload file by URL.</p>
|
|
680
|
+
</div></span>
|
|
681
|
+
|
|
682
|
+
</li>
|
|
683
|
+
|
|
684
|
+
|
|
685
|
+
</ul>
|
|
686
|
+
|
|
687
|
+
|
|
688
|
+
<div id="constructor_details" class="method_details_list">
|
|
689
|
+
<h2>Constructor Details</h2>
|
|
690
|
+
|
|
691
|
+
<div class="method_details first">
|
|
692
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
693
|
+
|
|
694
|
+
#<strong>initialize</strong>(client) ⇒ <tt><span class='object_link'><a href="" title="ResourceSpace::Resource (class)">Resource</a></span></tt>
|
|
695
|
+
|
|
696
|
+
|
|
697
|
+
|
|
698
|
+
|
|
699
|
+
|
|
700
|
+
</h3><div class="docstring">
|
|
701
|
+
<div class="discussion">
|
|
702
|
+
|
|
703
|
+
<p>Initialize the resource interface</p>
|
|
704
|
+
|
|
705
|
+
|
|
706
|
+
</div>
|
|
707
|
+
</div>
|
|
708
|
+
<div class="tags">
|
|
709
|
+
<p class="tag_title">Parameters:</p>
|
|
710
|
+
<ul class="param">
|
|
711
|
+
|
|
712
|
+
<li>
|
|
713
|
+
|
|
714
|
+
<span class='name'>client</span>
|
|
715
|
+
|
|
716
|
+
|
|
717
|
+
<span class='type'>(<tt><span class='object_link'><a href="Client.html" title="ResourceSpace::Client (class)">Client</a></span></tt>)</span>
|
|
718
|
+
|
|
719
|
+
|
|
720
|
+
|
|
721
|
+
—
|
|
722
|
+
<div class='inline'>
|
|
723
|
+
<p>ResourceSpace client instance</p>
|
|
724
|
+
</div>
|
|
725
|
+
|
|
726
|
+
</li>
|
|
727
|
+
|
|
728
|
+
</ul>
|
|
729
|
+
|
|
730
|
+
|
|
731
|
+
</div><table class="source_code">
|
|
732
|
+
<tr>
|
|
733
|
+
<td>
|
|
734
|
+
<pre class="lines">
|
|
735
|
+
|
|
736
|
+
|
|
737
|
+
24
|
|
738
|
+
25
|
|
739
|
+
26</pre>
|
|
740
|
+
</td>
|
|
741
|
+
<td>
|
|
742
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/resource.rb', line 24</span>
|
|
743
|
+
|
|
744
|
+
<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>
|
|
745
|
+
<span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
|
|
746
|
+
<span class='kw'>end</span></pre>
|
|
747
|
+
</td>
|
|
748
|
+
</tr>
|
|
749
|
+
</table>
|
|
750
|
+
</div>
|
|
751
|
+
|
|
752
|
+
</div>
|
|
753
|
+
|
|
754
|
+
<div id="instance_attr_details" class="attr_details">
|
|
755
|
+
<h2>Instance Attribute Details</h2>
|
|
756
|
+
|
|
757
|
+
|
|
758
|
+
<span id=""></span>
|
|
759
|
+
<div class="method_details first">
|
|
760
|
+
<h3 class="signature first" id="client-instance_method">
|
|
761
|
+
|
|
762
|
+
#<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>
|
|
763
|
+
|
|
764
|
+
|
|
765
|
+
|
|
766
|
+
|
|
767
|
+
|
|
768
|
+
</h3><div class="docstring">
|
|
769
|
+
<div class="discussion">
|
|
770
|
+
|
|
771
|
+
<p>Returns the ResourceSpace client.</p>
|
|
772
|
+
|
|
773
|
+
|
|
774
|
+
</div>
|
|
775
|
+
</div>
|
|
776
|
+
<div class="tags">
|
|
777
|
+
|
|
778
|
+
<p class="tag_title">Returns:</p>
|
|
779
|
+
<ul class="return">
|
|
780
|
+
|
|
781
|
+
<li>
|
|
782
|
+
|
|
783
|
+
|
|
784
|
+
<span class='type'>(<tt><span class='object_link'><a href="Client.html" title="ResourceSpace::Client (class)">Client</a></span></tt>)</span>
|
|
785
|
+
|
|
786
|
+
|
|
787
|
+
|
|
788
|
+
—
|
|
789
|
+
<div class='inline'>
|
|
790
|
+
<p>the ResourceSpace client</p>
|
|
791
|
+
</div>
|
|
792
|
+
|
|
793
|
+
</li>
|
|
794
|
+
|
|
795
|
+
</ul>
|
|
796
|
+
|
|
797
|
+
</div><table class="source_code">
|
|
798
|
+
<tr>
|
|
799
|
+
<td>
|
|
800
|
+
<pre class="lines">
|
|
801
|
+
|
|
802
|
+
|
|
803
|
+
19
|
|
804
|
+
20
|
|
805
|
+
21</pre>
|
|
806
|
+
</td>
|
|
807
|
+
<td>
|
|
808
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/resource.rb', line 19</span>
|
|
809
|
+
|
|
810
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
|
|
811
|
+
<span class='ivar'>@client</span>
|
|
812
|
+
<span class='kw'>end</span></pre>
|
|
813
|
+
</td>
|
|
814
|
+
</tr>
|
|
815
|
+
</table>
|
|
816
|
+
</div>
|
|
817
|
+
|
|
818
|
+
</div>
|
|
819
|
+
|
|
820
|
+
|
|
821
|
+
<div id="instance_method_details" class="method_details_list">
|
|
822
|
+
<h2>Instance Method Details</h2>
|
|
823
|
+
|
|
824
|
+
|
|
825
|
+
<div class="method_details first">
|
|
826
|
+
<h3 class="signature first" id="add_alternative_file-instance_method">
|
|
827
|
+
|
|
828
|
+
#<strong>add_alternative_file</strong>(resource_id, file, name: nil, description: nil) ⇒ <tt>Hash</tt>
|
|
829
|
+
|
|
830
|
+
|
|
831
|
+
|
|
832
|
+
|
|
833
|
+
|
|
834
|
+
</h3><div class="docstring">
|
|
835
|
+
<div class="discussion">
|
|
836
|
+
|
|
837
|
+
<p>Add an alternative file to a resource</p>
|
|
838
|
+
|
|
839
|
+
|
|
840
|
+
</div>
|
|
841
|
+
</div>
|
|
842
|
+
<div class="tags">
|
|
843
|
+
<p class="tag_title">Parameters:</p>
|
|
844
|
+
<ul class="param">
|
|
845
|
+
|
|
846
|
+
<li>
|
|
847
|
+
|
|
848
|
+
<span class='name'>resource_id</span>
|
|
849
|
+
|
|
850
|
+
|
|
851
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
852
|
+
|
|
853
|
+
|
|
854
|
+
|
|
855
|
+
—
|
|
856
|
+
<div class='inline'>
|
|
857
|
+
<p>resource ID</p>
|
|
858
|
+
</div>
|
|
859
|
+
|
|
860
|
+
</li>
|
|
861
|
+
|
|
862
|
+
<li>
|
|
863
|
+
|
|
864
|
+
<span class='name'>file</span>
|
|
865
|
+
|
|
866
|
+
|
|
867
|
+
<span class='type'>(<tt>File</tt>, <tt>String</tt>)</span>
|
|
868
|
+
|
|
869
|
+
|
|
870
|
+
|
|
871
|
+
—
|
|
872
|
+
<div class='inline'>
|
|
873
|
+
<p>file object or file path</p>
|
|
874
|
+
</div>
|
|
875
|
+
|
|
876
|
+
</li>
|
|
877
|
+
|
|
878
|
+
<li>
|
|
879
|
+
|
|
880
|
+
<span class='name'>name</span>
|
|
881
|
+
|
|
882
|
+
|
|
883
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
884
|
+
|
|
885
|
+
|
|
886
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
887
|
+
|
|
888
|
+
|
|
889
|
+
—
|
|
890
|
+
<div class='inline'>
|
|
891
|
+
<p>alternative file name</p>
|
|
892
|
+
</div>
|
|
893
|
+
|
|
894
|
+
</li>
|
|
895
|
+
|
|
896
|
+
<li>
|
|
897
|
+
|
|
898
|
+
<span class='name'>description</span>
|
|
899
|
+
|
|
900
|
+
|
|
901
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
902
|
+
|
|
903
|
+
|
|
904
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
905
|
+
|
|
906
|
+
|
|
907
|
+
—
|
|
908
|
+
<div class='inline'>
|
|
909
|
+
<p>alternative file description</p>
|
|
910
|
+
</div>
|
|
911
|
+
|
|
912
|
+
</li>
|
|
913
|
+
|
|
914
|
+
</ul>
|
|
915
|
+
|
|
916
|
+
<p class="tag_title">Returns:</p>
|
|
917
|
+
<ul class="return">
|
|
918
|
+
|
|
919
|
+
<li>
|
|
920
|
+
|
|
921
|
+
|
|
922
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
923
|
+
|
|
924
|
+
|
|
925
|
+
|
|
926
|
+
—
|
|
927
|
+
<div class='inline'>
|
|
928
|
+
<p>response</p>
|
|
929
|
+
</div>
|
|
930
|
+
|
|
931
|
+
</li>
|
|
932
|
+
|
|
933
|
+
</ul>
|
|
934
|
+
|
|
935
|
+
</div><table class="source_code">
|
|
936
|
+
<tr>
|
|
937
|
+
<td>
|
|
938
|
+
<pre class="lines">
|
|
939
|
+
|
|
940
|
+
|
|
941
|
+
164
|
|
942
|
+
165
|
|
943
|
+
166
|
|
944
|
+
167
|
|
945
|
+
168
|
|
946
|
+
169
|
|
947
|
+
170</pre>
|
|
948
|
+
</td>
|
|
949
|
+
<td>
|
|
950
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/resource.rb', line 164</span>
|
|
951
|
+
|
|
952
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_add_alternative_file'>add_alternative_file</span><span class='lparen'>(</span><span class='id identifier rubyid_resource_id'>resource_id</span><span class='comma'>,</span> <span class='id identifier rubyid_file'>file</span><span class='comma'>,</span> <span class='label'>name:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>description:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
953
|
+
<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_resource_id'>resource_id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='rbrace'>}</span>
|
|
954
|
+
<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>
|
|
955
|
+
<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_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
|
|
956
|
+
|
|
957
|
+
<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_upload_file'>upload_file</span><span class='lparen'>(</span><span class='id identifier rubyid_file'>file</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='label'>function:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>add_alternative_file</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
|
|
958
|
+
<span class='kw'>end</span></pre>
|
|
959
|
+
</td>
|
|
960
|
+
</tr>
|
|
961
|
+
</table>
|
|
962
|
+
</div>
|
|
963
|
+
|
|
964
|
+
<div class="method_details ">
|
|
965
|
+
<h3 class="signature " id="copy_resource-instance_method">
|
|
966
|
+
|
|
967
|
+
#<strong>copy_resource</strong>(resource_id, resource_type: nil) ⇒ <tt>Hash</tt>
|
|
968
|
+
|
|
969
|
+
|
|
970
|
+
|
|
971
|
+
|
|
972
|
+
|
|
973
|
+
</h3><div class="docstring">
|
|
974
|
+
<div class="discussion">
|
|
975
|
+
|
|
976
|
+
<p>Copy a resource</p>
|
|
977
|
+
|
|
978
|
+
|
|
979
|
+
</div>
|
|
980
|
+
</div>
|
|
981
|
+
<div class="tags">
|
|
982
|
+
<p class="tag_title">Parameters:</p>
|
|
983
|
+
<ul class="param">
|
|
984
|
+
|
|
985
|
+
<li>
|
|
986
|
+
|
|
987
|
+
<span class='name'>resource_id</span>
|
|
988
|
+
|
|
989
|
+
|
|
990
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
991
|
+
|
|
992
|
+
|
|
993
|
+
|
|
994
|
+
—
|
|
995
|
+
<div class='inline'>
|
|
996
|
+
<p>source resource ID</p>
|
|
997
|
+
</div>
|
|
998
|
+
|
|
999
|
+
</li>
|
|
1000
|
+
|
|
1001
|
+
<li>
|
|
1002
|
+
|
|
1003
|
+
<span class='name'>resource_type</span>
|
|
1004
|
+
|
|
1005
|
+
|
|
1006
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
1007
|
+
|
|
1008
|
+
|
|
1009
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1010
|
+
|
|
1011
|
+
|
|
1012
|
+
—
|
|
1013
|
+
<div class='inline'>
|
|
1014
|
+
<p>destination resource type (optional)</p>
|
|
1015
|
+
</div>
|
|
1016
|
+
|
|
1017
|
+
</li>
|
|
1018
|
+
|
|
1019
|
+
</ul>
|
|
1020
|
+
|
|
1021
|
+
<p class="tag_title">Returns:</p>
|
|
1022
|
+
<ul class="return">
|
|
1023
|
+
|
|
1024
|
+
<li>
|
|
1025
|
+
|
|
1026
|
+
|
|
1027
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1028
|
+
|
|
1029
|
+
|
|
1030
|
+
|
|
1031
|
+
—
|
|
1032
|
+
<div class='inline'>
|
|
1033
|
+
<p>new resource data</p>
|
|
1034
|
+
</div>
|
|
1035
|
+
|
|
1036
|
+
</li>
|
|
1037
|
+
|
|
1038
|
+
</ul>
|
|
1039
|
+
|
|
1040
|
+
</div><table class="source_code">
|
|
1041
|
+
<tr>
|
|
1042
|
+
<td>
|
|
1043
|
+
<pre class="lines">
|
|
1044
|
+
|
|
1045
|
+
|
|
1046
|
+
123
|
|
1047
|
+
124
|
|
1048
|
+
125
|
|
1049
|
+
126
|
|
1050
|
+
127
|
|
1051
|
+
128</pre>
|
|
1052
|
+
</td>
|
|
1053
|
+
<td>
|
|
1054
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/resource.rb', line 123</span>
|
|
1055
|
+
|
|
1056
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_copy_resource'>copy_resource</span><span class='lparen'>(</span><span class='id identifier rubyid_resource_id'>resource_id</span><span class='comma'>,</span> <span class='label'>resource_type:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1057
|
+
<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_resource_id'>resource_id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='rbrace'>}</span>
|
|
1058
|
+
<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_resource_type'>resource_type</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='kw'>if</span> <span class='id identifier rubyid_resource_type'>resource_type</span>
|
|
1059
|
+
|
|
1060
|
+
<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'>copy_resource</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
|
|
1061
|
+
<span class='kw'>end</span></pre>
|
|
1062
|
+
</td>
|
|
1063
|
+
</tr>
|
|
1064
|
+
</table>
|
|
1065
|
+
</div>
|
|
1066
|
+
|
|
1067
|
+
<div class="method_details ">
|
|
1068
|
+
<h3 class="signature " id="create_resource-instance_method">
|
|
1069
|
+
|
|
1070
|
+
#<strong>create_resource</strong>(name: nil, resource_type: 1, collection: nil, metadata: {}) ⇒ <tt>Hash</tt>
|
|
1071
|
+
|
|
1072
|
+
|
|
1073
|
+
|
|
1074
|
+
|
|
1075
|
+
|
|
1076
|
+
</h3><div class="docstring">
|
|
1077
|
+
<div class="discussion">
|
|
1078
|
+
|
|
1079
|
+
<p>Create a new resource</p>
|
|
1080
|
+
|
|
1081
|
+
|
|
1082
|
+
</div>
|
|
1083
|
+
</div>
|
|
1084
|
+
<div class="tags">
|
|
1085
|
+
<p class="tag_title">Parameters:</p>
|
|
1086
|
+
<ul class="param">
|
|
1087
|
+
|
|
1088
|
+
<li>
|
|
1089
|
+
|
|
1090
|
+
<span class='name'>name</span>
|
|
1091
|
+
|
|
1092
|
+
|
|
1093
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1094
|
+
|
|
1095
|
+
|
|
1096
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1097
|
+
|
|
1098
|
+
|
|
1099
|
+
—
|
|
1100
|
+
<div class='inline'>
|
|
1101
|
+
<p>resource name</p>
|
|
1102
|
+
</div>
|
|
1103
|
+
|
|
1104
|
+
</li>
|
|
1105
|
+
|
|
1106
|
+
<li>
|
|
1107
|
+
|
|
1108
|
+
<span class='name'>resource_type</span>
|
|
1109
|
+
|
|
1110
|
+
|
|
1111
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
1112
|
+
|
|
1113
|
+
|
|
1114
|
+
<em class="default">(defaults to: <tt>1</tt>)</em>
|
|
1115
|
+
|
|
1116
|
+
|
|
1117
|
+
—
|
|
1118
|
+
<div class='inline'>
|
|
1119
|
+
<p>resource type ID (default: 1)</p>
|
|
1120
|
+
</div>
|
|
1121
|
+
|
|
1122
|
+
</li>
|
|
1123
|
+
|
|
1124
|
+
<li>
|
|
1125
|
+
|
|
1126
|
+
<span class='name'>collection</span>
|
|
1127
|
+
|
|
1128
|
+
|
|
1129
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
1130
|
+
|
|
1131
|
+
|
|
1132
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1133
|
+
|
|
1134
|
+
|
|
1135
|
+
—
|
|
1136
|
+
<div class='inline'>
|
|
1137
|
+
<p>collection ID to add resource to</p>
|
|
1138
|
+
</div>
|
|
1139
|
+
|
|
1140
|
+
</li>
|
|
1141
|
+
|
|
1142
|
+
<li>
|
|
1143
|
+
|
|
1144
|
+
<span class='name'>metadata</span>
|
|
1145
|
+
|
|
1146
|
+
|
|
1147
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1148
|
+
|
|
1149
|
+
|
|
1150
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
1151
|
+
|
|
1152
|
+
|
|
1153
|
+
—
|
|
1154
|
+
<div class='inline'>
|
|
1155
|
+
<p>metadata fields to set</p>
|
|
1156
|
+
</div>
|
|
1157
|
+
|
|
1158
|
+
</li>
|
|
1159
|
+
|
|
1160
|
+
</ul>
|
|
1161
|
+
|
|
1162
|
+
<p class="tag_title">Returns:</p>
|
|
1163
|
+
<ul class="return">
|
|
1164
|
+
|
|
1165
|
+
<li>
|
|
1166
|
+
|
|
1167
|
+
|
|
1168
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1169
|
+
|
|
1170
|
+
|
|
1171
|
+
|
|
1172
|
+
—
|
|
1173
|
+
<div class='inline'>
|
|
1174
|
+
<p>created resource data</p>
|
|
1175
|
+
</div>
|
|
1176
|
+
|
|
1177
|
+
</li>
|
|
1178
|
+
|
|
1179
|
+
</ul>
|
|
1180
|
+
|
|
1181
|
+
</div><table class="source_code">
|
|
1182
|
+
<tr>
|
|
1183
|
+
<td>
|
|
1184
|
+
<pre class="lines">
|
|
1185
|
+
|
|
1186
|
+
|
|
1187
|
+
35
|
|
1188
|
+
36
|
|
1189
|
+
37
|
|
1190
|
+
38
|
|
1191
|
+
39
|
|
1192
|
+
40
|
|
1193
|
+
41
|
|
1194
|
+
42
|
|
1195
|
+
43
|
|
1196
|
+
44
|
|
1197
|
+
45
|
|
1198
|
+
46
|
|
1199
|
+
47
|
|
1200
|
+
48
|
|
1201
|
+
49
|
|
1202
|
+
50
|
|
1203
|
+
51
|
|
1204
|
+
52
|
|
1205
|
+
53
|
|
1206
|
+
54
|
|
1207
|
+
55
|
|
1208
|
+
56</pre>
|
|
1209
|
+
</td>
|
|
1210
|
+
<td>
|
|
1211
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/resource.rb', line 35</span>
|
|
1212
|
+
|
|
1213
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create_resource'>create_resource</span><span class='lparen'>(</span><span class='label'>name:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>resource_type:</span> <span class='int'>1</span><span class='comma'>,</span> <span class='label'>collection:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
1214
|
+
<span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1215
|
+
<span class='label'>param1:</span> <span class='id identifier rubyid_resource_type'>resource_type</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
|
|
1216
|
+
<span class='rbrace'>}</span>
|
|
1217
|
+
|
|
1218
|
+
<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_collection'>collection</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='kw'>if</span> <span class='id identifier rubyid_collection'>collection</span>
|
|
1219
|
+
|
|
1220
|
+
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <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_resource</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
|
|
1221
|
+
<span class='id identifier rubyid_resource_id'>resource_id</span> <span class='op'>=</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Hash</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='id identifier rubyid_response'>response</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>ref</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='id identifier rubyid_response'>response</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>id</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='op'>:</span> <span class='id identifier rubyid_response'>response</span>
|
|
1222
|
+
|
|
1223
|
+
<span class='comment'># Set resource name if provided
|
|
1224
|
+
</span> <span class='kw'>if</span> <span class='id identifier rubyid_name'>name</span> <span class='op'>&&</span> <span class='id identifier rubyid_resource_id'>resource_id</span>
|
|
1225
|
+
<span class='id identifier rubyid_update_field'>update_field</span><span class='lparen'>(</span><span class='id identifier rubyid_resource_id'>resource_id</span><span class='comma'>,</span> <span class='int'>8</span><span class='comma'>,</span> <span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span> <span class='comment'># Field 8 is typically the title/name field
|
|
1226
|
+
</span> <span class='kw'>end</span>
|
|
1227
|
+
|
|
1228
|
+
<span class='comment'># Set additional metadata if provided
|
|
1229
|
+
</span> <span class='id identifier rubyid_metadata'>metadata</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_field'>field</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='op'>|</span>
|
|
1230
|
+
<span class='id identifier rubyid_update_field'>update_field</span><span class='lparen'>(</span><span class='id identifier rubyid_resource_id'>resource_id</span><span class='comma'>,</span> <span class='id identifier rubyid_field'>field</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
|
|
1231
|
+
<span class='kw'>end</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span><span class='period'>.</span><span class='id identifier rubyid_any?'>any?</span>
|
|
1232
|
+
|
|
1233
|
+
<span class='id identifier rubyid_get_resource_data'>get_resource_data</span><span class='lparen'>(</span><span class='id identifier rubyid_resource_id'>resource_id</span><span class='rparen'>)</span>
|
|
1234
|
+
<span class='kw'>end</span></pre>
|
|
1235
|
+
</td>
|
|
1236
|
+
</tr>
|
|
1237
|
+
</table>
|
|
1238
|
+
</div>
|
|
1239
|
+
|
|
1240
|
+
<div class="method_details ">
|
|
1241
|
+
<h3 class="signature " id="delete_alternative_file-instance_method">
|
|
1242
|
+
|
|
1243
|
+
#<strong>delete_alternative_file</strong>(resource_id, alt_file_id) ⇒ <tt>Hash</tt>
|
|
1244
|
+
|
|
1245
|
+
|
|
1246
|
+
|
|
1247
|
+
|
|
1248
|
+
|
|
1249
|
+
</h3><div class="docstring">
|
|
1250
|
+
<div class="discussion">
|
|
1251
|
+
|
|
1252
|
+
<p>Delete an alternative file</p>
|
|
1253
|
+
|
|
1254
|
+
|
|
1255
|
+
</div>
|
|
1256
|
+
</div>
|
|
1257
|
+
<div class="tags">
|
|
1258
|
+
<p class="tag_title">Parameters:</p>
|
|
1259
|
+
<ul class="param">
|
|
1260
|
+
|
|
1261
|
+
<li>
|
|
1262
|
+
|
|
1263
|
+
<span class='name'>resource_id</span>
|
|
1264
|
+
|
|
1265
|
+
|
|
1266
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
1267
|
+
|
|
1268
|
+
|
|
1269
|
+
|
|
1270
|
+
—
|
|
1271
|
+
<div class='inline'>
|
|
1272
|
+
<p>resource ID</p>
|
|
1273
|
+
</div>
|
|
1274
|
+
|
|
1275
|
+
</li>
|
|
1276
|
+
|
|
1277
|
+
<li>
|
|
1278
|
+
|
|
1279
|
+
<span class='name'>alt_file_id</span>
|
|
1280
|
+
|
|
1281
|
+
|
|
1282
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
1283
|
+
|
|
1284
|
+
|
|
1285
|
+
|
|
1286
|
+
—
|
|
1287
|
+
<div class='inline'>
|
|
1288
|
+
<p>alternative file ID</p>
|
|
1289
|
+
</div>
|
|
1290
|
+
|
|
1291
|
+
</li>
|
|
1292
|
+
|
|
1293
|
+
</ul>
|
|
1294
|
+
|
|
1295
|
+
<p class="tag_title">Returns:</p>
|
|
1296
|
+
<ul class="return">
|
|
1297
|
+
|
|
1298
|
+
<li>
|
|
1299
|
+
|
|
1300
|
+
|
|
1301
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1302
|
+
|
|
1303
|
+
|
|
1304
|
+
|
|
1305
|
+
—
|
|
1306
|
+
<div class='inline'>
|
|
1307
|
+
<p>response</p>
|
|
1308
|
+
</div>
|
|
1309
|
+
|
|
1310
|
+
</li>
|
|
1311
|
+
|
|
1312
|
+
</ul>
|
|
1313
|
+
|
|
1314
|
+
</div><table class="source_code">
|
|
1315
|
+
<tr>
|
|
1316
|
+
<td>
|
|
1317
|
+
<pre class="lines">
|
|
1318
|
+
|
|
1319
|
+
|
|
1320
|
+
177
|
|
1321
|
+
178
|
|
1322
|
+
179
|
|
1323
|
+
180
|
|
1324
|
+
181
|
|
1325
|
+
182</pre>
|
|
1326
|
+
</td>
|
|
1327
|
+
<td>
|
|
1328
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/resource.rb', line 177</span>
|
|
1329
|
+
|
|
1330
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete_alternative_file'>delete_alternative_file</span><span class='lparen'>(</span><span class='id identifier rubyid_resource_id'>resource_id</span><span class='comma'>,</span> <span class='id identifier rubyid_alt_file_id'>alt_file_id</span><span class='rparen'>)</span>
|
|
1331
|
+
<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_alternative_file</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='lbrace'>{</span>
|
|
1332
|
+
<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>
|
|
1333
|
+
<span class='label'>param2:</span> <span class='id identifier rubyid_alt_file_id'>alt_file_id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
|
|
1334
|
+
<span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
1335
|
+
<span class='kw'>end</span></pre>
|
|
1336
|
+
</td>
|
|
1337
|
+
</tr>
|
|
1338
|
+
</table>
|
|
1339
|
+
</div>
|
|
1340
|
+
|
|
1341
|
+
<div class="method_details ">
|
|
1342
|
+
<h3 class="signature " id="delete_resource-instance_method">
|
|
1343
|
+
|
|
1344
|
+
#<strong>delete_resource</strong>(resource_id) ⇒ <tt>Hash</tt>
|
|
1345
|
+
|
|
1346
|
+
|
|
1347
|
+
|
|
1348
|
+
|
|
1349
|
+
|
|
1350
|
+
</h3><div class="docstring">
|
|
1351
|
+
<div class="discussion">
|
|
1352
|
+
|
|
1353
|
+
<p>Delete a resource</p>
|
|
1354
|
+
|
|
1355
|
+
|
|
1356
|
+
</div>
|
|
1357
|
+
</div>
|
|
1358
|
+
<div class="tags">
|
|
1359
|
+
<p class="tag_title">Parameters:</p>
|
|
1360
|
+
<ul class="param">
|
|
1361
|
+
|
|
1362
|
+
<li>
|
|
1363
|
+
|
|
1364
|
+
<span class='name'>resource_id</span>
|
|
1365
|
+
|
|
1366
|
+
|
|
1367
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
1368
|
+
|
|
1369
|
+
|
|
1370
|
+
|
|
1371
|
+
—
|
|
1372
|
+
<div class='inline'>
|
|
1373
|
+
<p>resource ID</p>
|
|
1374
|
+
</div>
|
|
1375
|
+
|
|
1376
|
+
</li>
|
|
1377
|
+
|
|
1378
|
+
</ul>
|
|
1379
|
+
|
|
1380
|
+
<p class="tag_title">Returns:</p>
|
|
1381
|
+
<ul class="return">
|
|
1382
|
+
|
|
1383
|
+
<li>
|
|
1384
|
+
|
|
1385
|
+
|
|
1386
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1387
|
+
|
|
1388
|
+
|
|
1389
|
+
|
|
1390
|
+
—
|
|
1391
|
+
<div class='inline'>
|
|
1392
|
+
<p>response</p>
|
|
1393
|
+
</div>
|
|
1394
|
+
|
|
1395
|
+
</li>
|
|
1396
|
+
|
|
1397
|
+
</ul>
|
|
1398
|
+
|
|
1399
|
+
</div><table class="source_code">
|
|
1400
|
+
<tr>
|
|
1401
|
+
<td>
|
|
1402
|
+
<pre class="lines">
|
|
1403
|
+
|
|
1404
|
+
|
|
1405
|
+
114
|
|
1406
|
+
115
|
|
1407
|
+
116</pre>
|
|
1408
|
+
</td>
|
|
1409
|
+
<td>
|
|
1410
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/resource.rb', line 114</span>
|
|
1411
|
+
|
|
1412
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete_resource'>delete_resource</span><span class='lparen'>(</span><span class='id identifier rubyid_resource_id'>resource_id</span><span class='rparen'>)</span>
|
|
1413
|
+
<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_resource</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_resource_id'>resource_id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
1414
|
+
<span class='kw'>end</span></pre>
|
|
1415
|
+
</td>
|
|
1416
|
+
</tr>
|
|
1417
|
+
</table>
|
|
1418
|
+
</div>
|
|
1419
|
+
|
|
1420
|
+
<div class="method_details ">
|
|
1421
|
+
<h3 class="signature " id="download_resource-instance_method">
|
|
1422
|
+
|
|
1423
|
+
#<strong>download_resource</strong>(resource_id, file_path, size: "") ⇒ <tt>Boolean</tt>
|
|
1424
|
+
|
|
1425
|
+
|
|
1426
|
+
|
|
1427
|
+
|
|
1428
|
+
|
|
1429
|
+
</h3><div class="docstring">
|
|
1430
|
+
<div class="discussion">
|
|
1431
|
+
|
|
1432
|
+
<p>Download a resource file</p>
|
|
1433
|
+
|
|
1434
|
+
|
|
1435
|
+
</div>
|
|
1436
|
+
</div>
|
|
1437
|
+
<div class="tags">
|
|
1438
|
+
<p class="tag_title">Parameters:</p>
|
|
1439
|
+
<ul class="param">
|
|
1440
|
+
|
|
1441
|
+
<li>
|
|
1442
|
+
|
|
1443
|
+
<span class='name'>resource_id</span>
|
|
1444
|
+
|
|
1445
|
+
|
|
1446
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
1447
|
+
|
|
1448
|
+
|
|
1449
|
+
|
|
1450
|
+
—
|
|
1451
|
+
<div class='inline'>
|
|
1452
|
+
<p>resource ID</p>
|
|
1453
|
+
</div>
|
|
1454
|
+
|
|
1455
|
+
</li>
|
|
1456
|
+
|
|
1457
|
+
<li>
|
|
1458
|
+
|
|
1459
|
+
<span class='name'>file_path</span>
|
|
1460
|
+
|
|
1461
|
+
|
|
1462
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1463
|
+
|
|
1464
|
+
|
|
1465
|
+
|
|
1466
|
+
—
|
|
1467
|
+
<div class='inline'>
|
|
1468
|
+
<p>local file path to save to</p>
|
|
1469
|
+
</div>
|
|
1470
|
+
|
|
1471
|
+
</li>
|
|
1472
|
+
|
|
1473
|
+
<li>
|
|
1474
|
+
|
|
1475
|
+
<span class='name'>size</span>
|
|
1476
|
+
|
|
1477
|
+
|
|
1478
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1479
|
+
|
|
1480
|
+
|
|
1481
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1482
|
+
|
|
1483
|
+
|
|
1484
|
+
—
|
|
1485
|
+
<div class='inline'>
|
|
1486
|
+
<p>image size</p>
|
|
1487
|
+
</div>
|
|
1488
|
+
|
|
1489
|
+
</li>
|
|
1490
|
+
|
|
1491
|
+
</ul>
|
|
1492
|
+
|
|
1493
|
+
<p class="tag_title">Returns:</p>
|
|
1494
|
+
<ul class="return">
|
|
1495
|
+
|
|
1496
|
+
<li>
|
|
1497
|
+
|
|
1498
|
+
|
|
1499
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
1500
|
+
|
|
1501
|
+
|
|
1502
|
+
|
|
1503
|
+
—
|
|
1504
|
+
<div class='inline'>
|
|
1505
|
+
<p>true if successful</p>
|
|
1506
|
+
</div>
|
|
1507
|
+
|
|
1508
|
+
</li>
|
|
1509
|
+
|
|
1510
|
+
</ul>
|
|
1511
|
+
|
|
1512
|
+
</div><table class="source_code">
|
|
1513
|
+
<tr>
|
|
1514
|
+
<td>
|
|
1515
|
+
<pre class="lines">
|
|
1516
|
+
|
|
1517
|
+
|
|
1518
|
+
278
|
|
1519
|
+
279
|
|
1520
|
+
280
|
|
1521
|
+
281
|
|
1522
|
+
282
|
|
1523
|
+
283</pre>
|
|
1524
|
+
</td>
|
|
1525
|
+
<td>
|
|
1526
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/resource.rb', line 278</span>
|
|
1527
|
+
|
|
1528
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_download_resource'>download_resource</span><span class='lparen'>(</span><span class='id identifier rubyid_resource_id'>resource_id</span><span class='comma'>,</span> <span class='id identifier rubyid_file_path'>file_path</span><span class='comma'>,</span> <span class='label'>size:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1529
|
+
<span class='id identifier rubyid_download_path'>download_path</span> <span class='op'>=</span> <span class='id identifier rubyid_get_resource_path'>get_resource_path</span><span class='lparen'>(</span><span class='id identifier rubyid_resource_id'>resource_id</span><span class='comma'>,</span> <span class='label'>size:</span> <span class='id identifier rubyid_size'>size</span><span class='rparen'>)</span>
|
|
1530
|
+
<span class='id identifier rubyid_download_url'>download_url</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_url'>url</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/api/</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_download_path'>download_path</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
|
1531
|
+
|
|
1532
|
+
<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_download_file'>download_file</span><span class='lparen'>(</span><span class='id identifier rubyid_download_url'>download_url</span><span class='comma'>,</span> <span class='id identifier rubyid_file_path'>file_path</span><span class='rparen'>)</span>
|
|
1533
|
+
<span class='kw'>end</span></pre>
|
|
1534
|
+
</td>
|
|
1535
|
+
</tr>
|
|
1536
|
+
</table>
|
|
1537
|
+
</div>
|
|
1538
|
+
|
|
1539
|
+
<div class="method_details ">
|
|
1540
|
+
<h3 class="signature " id="edit_access?-instance_method">
|
|
1541
|
+
|
|
1542
|
+
#<strong>edit_access?</strong>(resource_id) ⇒ <tt>Boolean</tt>
|
|
1543
|
+
|
|
1544
|
+
|
|
1545
|
+
|
|
1546
|
+
|
|
1547
|
+
|
|
1548
|
+
</h3><div class="docstring">
|
|
1549
|
+
<div class="discussion">
|
|
1550
|
+
|
|
1551
|
+
<p>Check if user has edit access to resource</p>
|
|
1552
|
+
|
|
1553
|
+
|
|
1554
|
+
</div>
|
|
1555
|
+
</div>
|
|
1556
|
+
<div class="tags">
|
|
1557
|
+
<p class="tag_title">Parameters:</p>
|
|
1558
|
+
<ul class="param">
|
|
1559
|
+
|
|
1560
|
+
<li>
|
|
1561
|
+
|
|
1562
|
+
<span class='name'>resource_id</span>
|
|
1563
|
+
|
|
1564
|
+
|
|
1565
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
1566
|
+
|
|
1567
|
+
|
|
1568
|
+
|
|
1569
|
+
—
|
|
1570
|
+
<div class='inline'>
|
|
1571
|
+
<p>resource ID</p>
|
|
1572
|
+
</div>
|
|
1573
|
+
|
|
1574
|
+
</li>
|
|
1575
|
+
|
|
1576
|
+
</ul>
|
|
1577
|
+
|
|
1578
|
+
<p class="tag_title">Returns:</p>
|
|
1579
|
+
<ul class="return">
|
|
1580
|
+
|
|
1581
|
+
<li>
|
|
1582
|
+
|
|
1583
|
+
|
|
1584
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
1585
|
+
|
|
1586
|
+
|
|
1587
|
+
|
|
1588
|
+
—
|
|
1589
|
+
<div class='inline'>
|
|
1590
|
+
<p>true if user has edit access</p>
|
|
1591
|
+
</div>
|
|
1592
|
+
|
|
1593
|
+
</li>
|
|
1594
|
+
|
|
1595
|
+
</ul>
|
|
1596
|
+
|
|
1597
|
+
</div><table class="source_code">
|
|
1598
|
+
<tr>
|
|
1599
|
+
<td>
|
|
1600
|
+
<pre class="lines">
|
|
1601
|
+
|
|
1602
|
+
|
|
1603
|
+
258
|
|
1604
|
+
259
|
|
1605
|
+
260
|
|
1606
|
+
261</pre>
|
|
1607
|
+
</td>
|
|
1608
|
+
<td>
|
|
1609
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/resource.rb', line 258</span>
|
|
1610
|
+
|
|
1611
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_edit_access?'>edit_access?</span><span class='lparen'>(</span><span class='id identifier rubyid_resource_id'>resource_id</span><span class='rparen'>)</span>
|
|
1612
|
+
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <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_edit_access</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_resource_id'>resource_id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
1613
|
+
<span class='id identifier rubyid_response'>response</span> <span class='op'>==</span> <span class='kw'>true</span> <span class='op'>||</span> <span class='id identifier rubyid_response'>response</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>true</span><span class='tstring_end'>"</span></span> <span class='op'>||</span> <span class='id identifier rubyid_response'>response</span> <span class='op'>==</span> <span class='int'>1</span> <span class='op'>||</span> <span class='id identifier rubyid_response'>response</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>
|
|
1614
|
+
<span class='kw'>end</span></pre>
|
|
1615
|
+
</td>
|
|
1616
|
+
</tr>
|
|
1617
|
+
</table>
|
|
1618
|
+
</div>
|
|
1619
|
+
|
|
1620
|
+
<div class="method_details ">
|
|
1621
|
+
<h3 class="signature " id="get_alternative_files-instance_method">
|
|
1622
|
+
|
|
1623
|
+
#<strong>get_alternative_files</strong>(resource_id) ⇒ <tt>Array</tt>
|
|
1624
|
+
|
|
1625
|
+
|
|
1626
|
+
|
|
1627
|
+
|
|
1628
|
+
|
|
1629
|
+
</h3><div class="docstring">
|
|
1630
|
+
<div class="discussion">
|
|
1631
|
+
|
|
1632
|
+
<p>Get alternative files for a resource</p>
|
|
1633
|
+
|
|
1634
|
+
|
|
1635
|
+
</div>
|
|
1636
|
+
</div>
|
|
1637
|
+
<div class="tags">
|
|
1638
|
+
<p class="tag_title">Parameters:</p>
|
|
1639
|
+
<ul class="param">
|
|
1640
|
+
|
|
1641
|
+
<li>
|
|
1642
|
+
|
|
1643
|
+
<span class='name'>resource_id</span>
|
|
1644
|
+
|
|
1645
|
+
|
|
1646
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
1647
|
+
|
|
1648
|
+
|
|
1649
|
+
|
|
1650
|
+
—
|
|
1651
|
+
<div class='inline'>
|
|
1652
|
+
<p>resource ID</p>
|
|
1653
|
+
</div>
|
|
1654
|
+
|
|
1655
|
+
</li>
|
|
1656
|
+
|
|
1657
|
+
</ul>
|
|
1658
|
+
|
|
1659
|
+
<p class="tag_title">Returns:</p>
|
|
1660
|
+
<ul class="return">
|
|
1661
|
+
|
|
1662
|
+
<li>
|
|
1663
|
+
|
|
1664
|
+
|
|
1665
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
|
1666
|
+
|
|
1667
|
+
|
|
1668
|
+
|
|
1669
|
+
—
|
|
1670
|
+
<div class='inline'>
|
|
1671
|
+
<p>alternative files data</p>
|
|
1672
|
+
</div>
|
|
1673
|
+
|
|
1674
|
+
</li>
|
|
1675
|
+
|
|
1676
|
+
</ul>
|
|
1677
|
+
|
|
1678
|
+
</div><table class="source_code">
|
|
1679
|
+
<tr>
|
|
1680
|
+
<td>
|
|
1681
|
+
<pre class="lines">
|
|
1682
|
+
|
|
1683
|
+
|
|
1684
|
+
153
|
|
1685
|
+
154
|
|
1686
|
+
155</pre>
|
|
1687
|
+
</td>
|
|
1688
|
+
<td>
|
|
1689
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/resource.rb', line 153</span>
|
|
1690
|
+
|
|
1691
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_alternative_files'>get_alternative_files</span><span class='lparen'>(</span><span class='id identifier rubyid_resource_id'>resource_id</span><span class='rparen'>)</span>
|
|
1692
|
+
<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_alternative_files</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_resource_id'>resource_id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
1693
|
+
<span class='kw'>end</span></pre>
|
|
1694
|
+
</td>
|
|
1695
|
+
</tr>
|
|
1696
|
+
</table>
|
|
1697
|
+
</div>
|
|
1698
|
+
|
|
1699
|
+
<div class="method_details ">
|
|
1700
|
+
<h3 class="signature " id="get_resource_access-instance_method">
|
|
1701
|
+
|
|
1702
|
+
#<strong>get_resource_access</strong>(resource_id) ⇒ <tt>Integer</tt>
|
|
1703
|
+
|
|
1704
|
+
|
|
1705
|
+
|
|
1706
|
+
|
|
1707
|
+
|
|
1708
|
+
</h3><div class="docstring">
|
|
1709
|
+
<div class="discussion">
|
|
1710
|
+
|
|
1711
|
+
<p>Get resource access level</p>
|
|
1712
|
+
|
|
1713
|
+
|
|
1714
|
+
</div>
|
|
1715
|
+
</div>
|
|
1716
|
+
<div class="tags">
|
|
1717
|
+
<p class="tag_title">Parameters:</p>
|
|
1718
|
+
<ul class="param">
|
|
1719
|
+
|
|
1720
|
+
<li>
|
|
1721
|
+
|
|
1722
|
+
<span class='name'>resource_id</span>
|
|
1723
|
+
|
|
1724
|
+
|
|
1725
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
1726
|
+
|
|
1727
|
+
|
|
1728
|
+
|
|
1729
|
+
—
|
|
1730
|
+
<div class='inline'>
|
|
1731
|
+
<p>resource ID</p>
|
|
1732
|
+
</div>
|
|
1733
|
+
|
|
1734
|
+
</li>
|
|
1735
|
+
|
|
1736
|
+
</ul>
|
|
1737
|
+
|
|
1738
|
+
<p class="tag_title">Returns:</p>
|
|
1739
|
+
<ul class="return">
|
|
1740
|
+
|
|
1741
|
+
<li>
|
|
1742
|
+
|
|
1743
|
+
|
|
1744
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
1745
|
+
|
|
1746
|
+
|
|
1747
|
+
|
|
1748
|
+
—
|
|
1749
|
+
<div class='inline'>
|
|
1750
|
+
<p>access level</p>
|
|
1751
|
+
</div>
|
|
1752
|
+
|
|
1753
|
+
</li>
|
|
1754
|
+
|
|
1755
|
+
</ul>
|
|
1756
|
+
|
|
1757
|
+
</div><table class="source_code">
|
|
1758
|
+
<tr>
|
|
1759
|
+
<td>
|
|
1760
|
+
<pre class="lines">
|
|
1761
|
+
|
|
1762
|
+
|
|
1763
|
+
267
|
|
1764
|
+
268
|
|
1765
|
+
269
|
|
1766
|
+
270</pre>
|
|
1767
|
+
</td>
|
|
1768
|
+
<td>
|
|
1769
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/resource.rb', line 267</span>
|
|
1770
|
+
|
|
1771
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_resource_access'>get_resource_access</span><span class='lparen'>(</span><span class='id identifier rubyid_resource_id'>resource_id</span><span class='rparen'>)</span>
|
|
1772
|
+
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <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_resource_access</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_resource_id'>resource_id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
1773
|
+
<span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
|
|
1774
|
+
<span class='kw'>end</span></pre>
|
|
1775
|
+
</td>
|
|
1776
|
+
</tr>
|
|
1777
|
+
</table>
|
|
1778
|
+
</div>
|
|
1779
|
+
|
|
1780
|
+
<div class="method_details ">
|
|
1781
|
+
<h3 class="signature " id="get_resource_all_image_sizes-instance_method">
|
|
1782
|
+
|
|
1783
|
+
#<strong>get_resource_all_image_sizes</strong>(resource_id) ⇒ <tt>Hash</tt>
|
|
1784
|
+
|
|
1785
|
+
|
|
1786
|
+
|
|
1787
|
+
|
|
1788
|
+
|
|
1789
|
+
</h3><div class="docstring">
|
|
1790
|
+
<div class="discussion">
|
|
1791
|
+
|
|
1792
|
+
<p>Get all image sizes for a resource</p>
|
|
1793
|
+
|
|
1794
|
+
|
|
1795
|
+
</div>
|
|
1796
|
+
</div>
|
|
1797
|
+
<div class="tags">
|
|
1798
|
+
<p class="tag_title">Parameters:</p>
|
|
1799
|
+
<ul class="param">
|
|
1800
|
+
|
|
1801
|
+
<li>
|
|
1802
|
+
|
|
1803
|
+
<span class='name'>resource_id</span>
|
|
1804
|
+
|
|
1805
|
+
|
|
1806
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
1807
|
+
|
|
1808
|
+
|
|
1809
|
+
|
|
1810
|
+
—
|
|
1811
|
+
<div class='inline'>
|
|
1812
|
+
<p>resource ID</p>
|
|
1813
|
+
</div>
|
|
1814
|
+
|
|
1815
|
+
</li>
|
|
1816
|
+
|
|
1817
|
+
</ul>
|
|
1818
|
+
|
|
1819
|
+
<p class="tag_title">Returns:</p>
|
|
1820
|
+
<ul class="return">
|
|
1821
|
+
|
|
1822
|
+
<li>
|
|
1823
|
+
|
|
1824
|
+
|
|
1825
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1826
|
+
|
|
1827
|
+
|
|
1828
|
+
|
|
1829
|
+
—
|
|
1830
|
+
<div class='inline'>
|
|
1831
|
+
<p>image sizes data</p>
|
|
1832
|
+
</div>
|
|
1833
|
+
|
|
1834
|
+
</li>
|
|
1835
|
+
|
|
1836
|
+
</ul>
|
|
1837
|
+
|
|
1838
|
+
</div><table class="source_code">
|
|
1839
|
+
<tr>
|
|
1840
|
+
<td>
|
|
1841
|
+
<pre class="lines">
|
|
1842
|
+
|
|
1843
|
+
|
|
1844
|
+
219
|
|
1845
|
+
220
|
|
1846
|
+
221</pre>
|
|
1847
|
+
</td>
|
|
1848
|
+
<td>
|
|
1849
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/resource.rb', line 219</span>
|
|
1850
|
+
|
|
1851
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_resource_all_image_sizes'>get_resource_all_image_sizes</span><span class='lparen'>(</span><span class='id identifier rubyid_resource_id'>resource_id</span><span class='rparen'>)</span>
|
|
1852
|
+
<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_resource_all_image_sizes</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_resource_id'>resource_id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
1853
|
+
<span class='kw'>end</span></pre>
|
|
1854
|
+
</td>
|
|
1855
|
+
</tr>
|
|
1856
|
+
</table>
|
|
1857
|
+
</div>
|
|
1858
|
+
|
|
1859
|
+
<div class="method_details ">
|
|
1860
|
+
<h3 class="signature " id="get_resource_data-instance_method">
|
|
1861
|
+
|
|
1862
|
+
#<strong>get_resource_data</strong>(resource_id) ⇒ <tt>Hash</tt>
|
|
1863
|
+
|
|
1864
|
+
|
|
1865
|
+
|
|
1866
|
+
|
|
1867
|
+
|
|
1868
|
+
</h3><div class="docstring">
|
|
1869
|
+
<div class="discussion">
|
|
1870
|
+
|
|
1871
|
+
<p>Get resource data</p>
|
|
1872
|
+
|
|
1873
|
+
|
|
1874
|
+
</div>
|
|
1875
|
+
</div>
|
|
1876
|
+
<div class="tags">
|
|
1877
|
+
<p class="tag_title">Parameters:</p>
|
|
1878
|
+
<ul class="param">
|
|
1879
|
+
|
|
1880
|
+
<li>
|
|
1881
|
+
|
|
1882
|
+
<span class='name'>resource_id</span>
|
|
1883
|
+
|
|
1884
|
+
|
|
1885
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
1886
|
+
|
|
1887
|
+
|
|
1888
|
+
|
|
1889
|
+
—
|
|
1890
|
+
<div class='inline'>
|
|
1891
|
+
<p>resource ID</p>
|
|
1892
|
+
</div>
|
|
1893
|
+
|
|
1894
|
+
</li>
|
|
1895
|
+
|
|
1896
|
+
</ul>
|
|
1897
|
+
|
|
1898
|
+
<p class="tag_title">Returns:</p>
|
|
1899
|
+
<ul class="return">
|
|
1900
|
+
|
|
1901
|
+
<li>
|
|
1902
|
+
|
|
1903
|
+
|
|
1904
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1905
|
+
|
|
1906
|
+
|
|
1907
|
+
|
|
1908
|
+
—
|
|
1909
|
+
<div class='inline'>
|
|
1910
|
+
<p>resource data</p>
|
|
1911
|
+
</div>
|
|
1912
|
+
|
|
1913
|
+
</li>
|
|
1914
|
+
|
|
1915
|
+
</ul>
|
|
1916
|
+
|
|
1917
|
+
</div><table class="source_code">
|
|
1918
|
+
<tr>
|
|
1919
|
+
<td>
|
|
1920
|
+
<pre class="lines">
|
|
1921
|
+
|
|
1922
|
+
|
|
1923
|
+
76
|
|
1924
|
+
77
|
|
1925
|
+
78</pre>
|
|
1926
|
+
</td>
|
|
1927
|
+
<td>
|
|
1928
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/resource.rb', line 76</span>
|
|
1929
|
+
|
|
1930
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_resource_data'>get_resource_data</span><span class='lparen'>(</span><span class='id identifier rubyid_resource_id'>resource_id</span><span class='rparen'>)</span>
|
|
1931
|
+
<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_resource_data</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_resource_id'>resource_id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
1932
|
+
<span class='kw'>end</span></pre>
|
|
1933
|
+
</td>
|
|
1934
|
+
</tr>
|
|
1935
|
+
</table>
|
|
1936
|
+
</div>
|
|
1937
|
+
|
|
1938
|
+
<div class="method_details ">
|
|
1939
|
+
<h3 class="signature " id="get_resource_field_data-instance_method">
|
|
1940
|
+
|
|
1941
|
+
#<strong>get_resource_field_data</strong>(resource_id, field_id = nil) ⇒ <tt>Hash</tt>
|
|
1942
|
+
|
|
1943
|
+
|
|
1944
|
+
|
|
1945
|
+
|
|
1946
|
+
|
|
1947
|
+
</h3><div class="docstring">
|
|
1948
|
+
<div class="discussion">
|
|
1949
|
+
|
|
1950
|
+
<p>Get resource field data</p>
|
|
1951
|
+
|
|
1952
|
+
|
|
1953
|
+
</div>
|
|
1954
|
+
</div>
|
|
1955
|
+
<div class="tags">
|
|
1956
|
+
<p class="tag_title">Parameters:</p>
|
|
1957
|
+
<ul class="param">
|
|
1958
|
+
|
|
1959
|
+
<li>
|
|
1960
|
+
|
|
1961
|
+
<span class='name'>resource_id</span>
|
|
1962
|
+
|
|
1963
|
+
|
|
1964
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
1965
|
+
|
|
1966
|
+
|
|
1967
|
+
|
|
1968
|
+
—
|
|
1969
|
+
<div class='inline'>
|
|
1970
|
+
<p>resource ID</p>
|
|
1971
|
+
</div>
|
|
1972
|
+
|
|
1973
|
+
</li>
|
|
1974
|
+
|
|
1975
|
+
<li>
|
|
1976
|
+
|
|
1977
|
+
<span class='name'>field_id</span>
|
|
1978
|
+
|
|
1979
|
+
|
|
1980
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
1981
|
+
|
|
1982
|
+
|
|
1983
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1984
|
+
|
|
1985
|
+
|
|
1986
|
+
—
|
|
1987
|
+
<div class='inline'>
|
|
1988
|
+
<p>field ID (optional)</p>
|
|
1989
|
+
</div>
|
|
1990
|
+
|
|
1991
|
+
</li>
|
|
1992
|
+
|
|
1993
|
+
</ul>
|
|
1994
|
+
|
|
1995
|
+
<p class="tag_title">Returns:</p>
|
|
1996
|
+
<ul class="return">
|
|
1997
|
+
|
|
1998
|
+
<li>
|
|
1999
|
+
|
|
2000
|
+
|
|
2001
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
2002
|
+
|
|
2003
|
+
|
|
2004
|
+
|
|
2005
|
+
—
|
|
2006
|
+
<div class='inline'>
|
|
2007
|
+
<p>field data</p>
|
|
2008
|
+
</div>
|
|
2009
|
+
|
|
2010
|
+
</li>
|
|
2011
|
+
|
|
2012
|
+
</ul>
|
|
2013
|
+
|
|
2014
|
+
</div><table class="source_code">
|
|
2015
|
+
<tr>
|
|
2016
|
+
<td>
|
|
2017
|
+
<pre class="lines">
|
|
2018
|
+
|
|
2019
|
+
|
|
2020
|
+
85
|
|
2021
|
+
86
|
|
2022
|
+
87
|
|
2023
|
+
88
|
|
2024
|
+
89
|
|
2025
|
+
90</pre>
|
|
2026
|
+
</td>
|
|
2027
|
+
<td>
|
|
2028
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/resource.rb', line 85</span>
|
|
2029
|
+
|
|
2030
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_resource_field_data'>get_resource_field_data</span><span class='lparen'>(</span><span class='id identifier rubyid_resource_id'>resource_id</span><span class='comma'>,</span> <span class='id identifier rubyid_field_id'>field_id</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
2031
|
+
<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_resource_id'>resource_id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='rbrace'>}</span>
|
|
2032
|
+
<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_field_id'>field_id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='kw'>if</span> <span class='id identifier rubyid_field_id'>field_id</span>
|
|
2033
|
+
|
|
2034
|
+
<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_resource_field_data</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
|
|
2035
|
+
<span class='kw'>end</span></pre>
|
|
2036
|
+
</td>
|
|
2037
|
+
</tr>
|
|
2038
|
+
</table>
|
|
2039
|
+
</div>
|
|
2040
|
+
|
|
2041
|
+
<div class="method_details ">
|
|
2042
|
+
<h3 class="signature " id="get_resource_log-instance_method">
|
|
2043
|
+
|
|
2044
|
+
#<strong>get_resource_log</strong>(resource_id, entries: 50) ⇒ <tt>Array</tt>
|
|
2045
|
+
|
|
2046
|
+
|
|
2047
|
+
|
|
2048
|
+
|
|
2049
|
+
|
|
2050
|
+
</h3><div class="docstring">
|
|
2051
|
+
<div class="discussion">
|
|
2052
|
+
|
|
2053
|
+
<p>Get resource log</p>
|
|
2054
|
+
|
|
2055
|
+
|
|
2056
|
+
</div>
|
|
2057
|
+
</div>
|
|
2058
|
+
<div class="tags">
|
|
2059
|
+
<p class="tag_title">Parameters:</p>
|
|
2060
|
+
<ul class="param">
|
|
2061
|
+
|
|
2062
|
+
<li>
|
|
2063
|
+
|
|
2064
|
+
<span class='name'>resource_id</span>
|
|
2065
|
+
|
|
2066
|
+
|
|
2067
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
2068
|
+
|
|
2069
|
+
|
|
2070
|
+
|
|
2071
|
+
—
|
|
2072
|
+
<div class='inline'>
|
|
2073
|
+
<p>resource ID</p>
|
|
2074
|
+
</div>
|
|
2075
|
+
|
|
2076
|
+
</li>
|
|
2077
|
+
|
|
2078
|
+
<li>
|
|
2079
|
+
|
|
2080
|
+
<span class='name'>entries</span>
|
|
2081
|
+
|
|
2082
|
+
|
|
2083
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
2084
|
+
|
|
2085
|
+
|
|
2086
|
+
<em class="default">(defaults to: <tt>50</tt>)</em>
|
|
2087
|
+
|
|
2088
|
+
|
|
2089
|
+
—
|
|
2090
|
+
<div class='inline'>
|
|
2091
|
+
<p>number of entries to return</p>
|
|
2092
|
+
</div>
|
|
2093
|
+
|
|
2094
|
+
</li>
|
|
2095
|
+
|
|
2096
|
+
</ul>
|
|
2097
|
+
|
|
2098
|
+
<p class="tag_title">Returns:</p>
|
|
2099
|
+
<ul class="return">
|
|
2100
|
+
|
|
2101
|
+
<li>
|
|
2102
|
+
|
|
2103
|
+
|
|
2104
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
|
2105
|
+
|
|
2106
|
+
|
|
2107
|
+
|
|
2108
|
+
—
|
|
2109
|
+
<div class='inline'>
|
|
2110
|
+
<p>log entries</p>
|
|
2111
|
+
</div>
|
|
2112
|
+
|
|
2113
|
+
</li>
|
|
2114
|
+
|
|
2115
|
+
</ul>
|
|
2116
|
+
|
|
2117
|
+
</div><table class="source_code">
|
|
2118
|
+
<tr>
|
|
2119
|
+
<td>
|
|
2120
|
+
<pre class="lines">
|
|
2121
|
+
|
|
2122
|
+
|
|
2123
|
+
208
|
|
2124
|
+
209
|
|
2125
|
+
210
|
|
2126
|
+
211
|
|
2127
|
+
212
|
|
2128
|
+
213</pre>
|
|
2129
|
+
</td>
|
|
2130
|
+
<td>
|
|
2131
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/resource.rb', line 208</span>
|
|
2132
|
+
|
|
2133
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_resource_log'>get_resource_log</span><span class='lparen'>(</span><span class='id identifier rubyid_resource_id'>resource_id</span><span class='comma'>,</span> <span class='label'>entries:</span> <span class='int'>50</span><span class='rparen'>)</span>
|
|
2134
|
+
<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_resource_log</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='lbrace'>{</span>
|
|
2135
|
+
<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>
|
|
2136
|
+
<span class='label'>param2:</span> <span class='id identifier rubyid_entries'>entries</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
|
|
2137
|
+
<span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
2138
|
+
<span class='kw'>end</span></pre>
|
|
2139
|
+
</td>
|
|
2140
|
+
</tr>
|
|
2141
|
+
</table>
|
|
2142
|
+
</div>
|
|
2143
|
+
|
|
2144
|
+
<div class="method_details ">
|
|
2145
|
+
<h3 class="signature " id="get_resource_path-instance_method">
|
|
2146
|
+
|
|
2147
|
+
#<strong>get_resource_path</strong>(resource_id, size: "", page: 1, ext: "") ⇒ <tt>String</tt>
|
|
2148
|
+
|
|
2149
|
+
|
|
2150
|
+
|
|
2151
|
+
|
|
2152
|
+
|
|
2153
|
+
</h3><div class="docstring">
|
|
2154
|
+
<div class="discussion">
|
|
2155
|
+
|
|
2156
|
+
<p>Get resource download path</p>
|
|
2157
|
+
|
|
2158
|
+
|
|
2159
|
+
</div>
|
|
2160
|
+
</div>
|
|
2161
|
+
<div class="tags">
|
|
2162
|
+
<p class="tag_title">Parameters:</p>
|
|
2163
|
+
<ul class="param">
|
|
2164
|
+
|
|
2165
|
+
<li>
|
|
2166
|
+
|
|
2167
|
+
<span class='name'>resource_id</span>
|
|
2168
|
+
|
|
2169
|
+
|
|
2170
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
2171
|
+
|
|
2172
|
+
|
|
2173
|
+
|
|
2174
|
+
—
|
|
2175
|
+
<div class='inline'>
|
|
2176
|
+
<p>resource ID</p>
|
|
2177
|
+
</div>
|
|
2178
|
+
|
|
2179
|
+
</li>
|
|
2180
|
+
|
|
2181
|
+
<li>
|
|
2182
|
+
|
|
2183
|
+
<span class='name'>size</span>
|
|
2184
|
+
|
|
2185
|
+
|
|
2186
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
2187
|
+
|
|
2188
|
+
|
|
2189
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
2190
|
+
|
|
2191
|
+
|
|
2192
|
+
—
|
|
2193
|
+
<div class='inline'>
|
|
2194
|
+
<p>image size (”, ‘pre’, ‘scr’, ‘thm’, ‘col’)</p>
|
|
2195
|
+
</div>
|
|
2196
|
+
|
|
2197
|
+
</li>
|
|
2198
|
+
|
|
2199
|
+
<li>
|
|
2200
|
+
|
|
2201
|
+
<span class='name'>page</span>
|
|
2202
|
+
|
|
2203
|
+
|
|
2204
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
2205
|
+
|
|
2206
|
+
|
|
2207
|
+
<em class="default">(defaults to: <tt>1</tt>)</em>
|
|
2208
|
+
|
|
2209
|
+
|
|
2210
|
+
—
|
|
2211
|
+
<div class='inline'>
|
|
2212
|
+
<p>page number for multi-page documents</p>
|
|
2213
|
+
</div>
|
|
2214
|
+
|
|
2215
|
+
</li>
|
|
2216
|
+
|
|
2217
|
+
<li>
|
|
2218
|
+
|
|
2219
|
+
<span class='name'>ext</span>
|
|
2220
|
+
|
|
2221
|
+
|
|
2222
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
2223
|
+
|
|
2224
|
+
|
|
2225
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
2226
|
+
|
|
2227
|
+
|
|
2228
|
+
—
|
|
2229
|
+
<div class='inline'>
|
|
2230
|
+
<p>file extension override</p>
|
|
2231
|
+
</div>
|
|
2232
|
+
|
|
2233
|
+
</li>
|
|
2234
|
+
|
|
2235
|
+
</ul>
|
|
2236
|
+
|
|
2237
|
+
<p class="tag_title">Returns:</p>
|
|
2238
|
+
<ul class="return">
|
|
2239
|
+
|
|
2240
|
+
<li>
|
|
2241
|
+
|
|
2242
|
+
|
|
2243
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
2244
|
+
|
|
2245
|
+
|
|
2246
|
+
|
|
2247
|
+
—
|
|
2248
|
+
<div class='inline'>
|
|
2249
|
+
<p>download path</p>
|
|
2250
|
+
</div>
|
|
2251
|
+
|
|
2252
|
+
</li>
|
|
2253
|
+
|
|
2254
|
+
</ul>
|
|
2255
|
+
|
|
2256
|
+
</div><table class="source_code">
|
|
2257
|
+
<tr>
|
|
2258
|
+
<td>
|
|
2259
|
+
<pre class="lines">
|
|
2260
|
+
|
|
2261
|
+
|
|
2262
|
+
137
|
|
2263
|
+
138
|
|
2264
|
+
139
|
|
2265
|
+
140
|
|
2266
|
+
141
|
|
2267
|
+
142
|
|
2268
|
+
143
|
|
2269
|
+
144
|
|
2270
|
+
145
|
|
2271
|
+
146
|
|
2272
|
+
147</pre>
|
|
2273
|
+
</td>
|
|
2274
|
+
<td>
|
|
2275
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/resource.rb', line 137</span>
|
|
2276
|
+
|
|
2277
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_resource_path'>get_resource_path</span><span class='lparen'>(</span><span class='id identifier rubyid_resource_id'>resource_id</span><span class='comma'>,</span> <span class='label'>size:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>page:</span> <span class='int'>1</span><span class='comma'>,</span> <span class='label'>ext:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
2278
|
+
<span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
2279
|
+
<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>
|
|
2280
|
+
<span class='label'>param2:</span> <span class='id identifier rubyid_size'>size</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='comma'>,</span>
|
|
2281
|
+
<span class='label'>param3:</span> <span class='id identifier rubyid_page'>page</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
|
|
2282
|
+
<span class='rbrace'>}</span>
|
|
2283
|
+
<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_ext'>ext</span> <span class='kw'>if</span> <span class='id identifier rubyid_ext'>ext</span> <span class='op'>&&</span> <span class='op'>!</span><span class='id identifier rubyid_ext'>ext</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
|
|
2284
|
+
|
|
2285
|
+
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <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_resource_path</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
|
|
2286
|
+
<span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>String</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='id identifier rubyid_response'>response</span> <span class='op'>:</span> <span class='id identifier rubyid_response'>response</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>path</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span>
|
|
2287
|
+
<span class='kw'>end</span></pre>
|
|
2288
|
+
</td>
|
|
2289
|
+
</tr>
|
|
2290
|
+
</table>
|
|
2291
|
+
</div>
|
|
2292
|
+
|
|
2293
|
+
<div class="method_details ">
|
|
2294
|
+
<h3 class="signature " id="get_resource_types-instance_method">
|
|
2295
|
+
|
|
2296
|
+
#<strong>get_resource_types</strong> ⇒ <tt>Array</tt>
|
|
2297
|
+
|
|
2298
|
+
|
|
2299
|
+
|
|
2300
|
+
|
|
2301
|
+
|
|
2302
|
+
</h3><div class="docstring">
|
|
2303
|
+
<div class="discussion">
|
|
2304
|
+
|
|
2305
|
+
<p>Get resource types</p>
|
|
2306
|
+
|
|
2307
|
+
|
|
2308
|
+
</div>
|
|
2309
|
+
</div>
|
|
2310
|
+
<div class="tags">
|
|
2311
|
+
|
|
2312
|
+
<p class="tag_title">Returns:</p>
|
|
2313
|
+
<ul class="return">
|
|
2314
|
+
|
|
2315
|
+
<li>
|
|
2316
|
+
|
|
2317
|
+
|
|
2318
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
|
2319
|
+
|
|
2320
|
+
|
|
2321
|
+
|
|
2322
|
+
—
|
|
2323
|
+
<div class='inline'>
|
|
2324
|
+
<p>resource types</p>
|
|
2325
|
+
</div>
|
|
2326
|
+
|
|
2327
|
+
</li>
|
|
2328
|
+
|
|
2329
|
+
</ul>
|
|
2330
|
+
|
|
2331
|
+
</div><table class="source_code">
|
|
2332
|
+
<tr>
|
|
2333
|
+
<td>
|
|
2334
|
+
<pre class="lines">
|
|
2335
|
+
|
|
2336
|
+
|
|
2337
|
+
187
|
|
2338
|
+
188
|
|
2339
|
+
189</pre>
|
|
2340
|
+
</td>
|
|
2341
|
+
<td>
|
|
2342
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/resource.rb', line 187</span>
|
|
2343
|
+
|
|
2344
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_resource_types'>get_resource_types</span>
|
|
2345
|
+
<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_resource_types</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
2346
|
+
<span class='kw'>end</span></pre>
|
|
2347
|
+
</td>
|
|
2348
|
+
</tr>
|
|
2349
|
+
</table>
|
|
2350
|
+
</div>
|
|
2351
|
+
|
|
2352
|
+
<div class="method_details ">
|
|
2353
|
+
<h3 class="signature " id="replace_resource_file-instance_method">
|
|
2354
|
+
|
|
2355
|
+
#<strong>replace_resource_file</strong>(resource_id, file, no_exif: false) ⇒ <tt>Hash</tt>
|
|
2356
|
+
|
|
2357
|
+
|
|
2358
|
+
|
|
2359
|
+
|
|
2360
|
+
|
|
2361
|
+
</h3><div class="docstring">
|
|
2362
|
+
<div class="discussion">
|
|
2363
|
+
|
|
2364
|
+
<p>Replace resource file</p>
|
|
2365
|
+
|
|
2366
|
+
|
|
2367
|
+
</div>
|
|
2368
|
+
</div>
|
|
2369
|
+
<div class="tags">
|
|
2370
|
+
<p class="tag_title">Parameters:</p>
|
|
2371
|
+
<ul class="param">
|
|
2372
|
+
|
|
2373
|
+
<li>
|
|
2374
|
+
|
|
2375
|
+
<span class='name'>resource_id</span>
|
|
2376
|
+
|
|
2377
|
+
|
|
2378
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
2379
|
+
|
|
2380
|
+
|
|
2381
|
+
|
|
2382
|
+
—
|
|
2383
|
+
<div class='inline'>
|
|
2384
|
+
<p>resource ID</p>
|
|
2385
|
+
</div>
|
|
2386
|
+
|
|
2387
|
+
</li>
|
|
2388
|
+
|
|
2389
|
+
<li>
|
|
2390
|
+
|
|
2391
|
+
<span class='name'>file</span>
|
|
2392
|
+
|
|
2393
|
+
|
|
2394
|
+
<span class='type'>(<tt>File</tt>, <tt>String</tt>)</span>
|
|
2395
|
+
|
|
2396
|
+
|
|
2397
|
+
|
|
2398
|
+
—
|
|
2399
|
+
<div class='inline'>
|
|
2400
|
+
<p>new file</p>
|
|
2401
|
+
</div>
|
|
2402
|
+
|
|
2403
|
+
</li>
|
|
2404
|
+
|
|
2405
|
+
<li>
|
|
2406
|
+
|
|
2407
|
+
<span class='name'>no_exif</span>
|
|
2408
|
+
|
|
2409
|
+
|
|
2410
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
2411
|
+
|
|
2412
|
+
|
|
2413
|
+
<em class="default">(defaults to: <tt>false</tt>)</em>
|
|
2414
|
+
|
|
2415
|
+
|
|
2416
|
+
—
|
|
2417
|
+
<div class='inline'>
|
|
2418
|
+
<p>skip EXIF extraction</p>
|
|
2419
|
+
</div>
|
|
2420
|
+
|
|
2421
|
+
</li>
|
|
2422
|
+
|
|
2423
|
+
</ul>
|
|
2424
|
+
|
|
2425
|
+
<p class="tag_title">Returns:</p>
|
|
2426
|
+
<ul class="return">
|
|
2427
|
+
|
|
2428
|
+
<li>
|
|
2429
|
+
|
|
2430
|
+
|
|
2431
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
2432
|
+
|
|
2433
|
+
|
|
2434
|
+
|
|
2435
|
+
—
|
|
2436
|
+
<div class='inline'>
|
|
2437
|
+
<p>response</p>
|
|
2438
|
+
</div>
|
|
2439
|
+
|
|
2440
|
+
</li>
|
|
2441
|
+
|
|
2442
|
+
</ul>
|
|
2443
|
+
|
|
2444
|
+
</div><table class="source_code">
|
|
2445
|
+
<tr>
|
|
2446
|
+
<td>
|
|
2447
|
+
<pre class="lines">
|
|
2448
|
+
|
|
2449
|
+
|
|
2450
|
+
229
|
|
2451
|
+
230
|
|
2452
|
+
231
|
|
2453
|
+
232
|
|
2454
|
+
233
|
|
2455
|
+
234</pre>
|
|
2456
|
+
</td>
|
|
2457
|
+
<td>
|
|
2458
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/resource.rb', line 229</span>
|
|
2459
|
+
|
|
2460
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_replace_resource_file'>replace_resource_file</span><span class='lparen'>(</span><span class='id identifier rubyid_resource_id'>resource_id</span><span class='comma'>,</span> <span class='id identifier rubyid_file'>file</span><span class='comma'>,</span> <span class='label'>no_exif:</span> <span class='kw'>false</span><span class='rparen'>)</span>
|
|
2461
|
+
<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_resource_id'>resource_id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='rbrace'>}</span>
|
|
2462
|
+
<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='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>1</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_no_exif'>no_exif</span>
|
|
2463
|
+
|
|
2464
|
+
<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_upload_file'>upload_file</span><span class='lparen'>(</span><span class='id identifier rubyid_file'>file</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='label'>function:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>replace_resource_file</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
|
|
2465
|
+
<span class='kw'>end</span></pre>
|
|
2466
|
+
</td>
|
|
2467
|
+
</tr>
|
|
2468
|
+
</table>
|
|
2469
|
+
</div>
|
|
2470
|
+
|
|
2471
|
+
<div class="method_details ">
|
|
2472
|
+
<h3 class="signature " id="update_field-instance_method">
|
|
2473
|
+
|
|
2474
|
+
#<strong>update_field</strong>(resource_id, field_id, value, node_values: false) ⇒ <tt>Hash</tt>
|
|
2475
|
+
|
|
2476
|
+
|
|
2477
|
+
|
|
2478
|
+
|
|
2479
|
+
|
|
2480
|
+
</h3><div class="docstring">
|
|
2481
|
+
<div class="discussion">
|
|
2482
|
+
|
|
2483
|
+
<p>Update a resource field</p>
|
|
2484
|
+
|
|
2485
|
+
|
|
2486
|
+
</div>
|
|
2487
|
+
</div>
|
|
2488
|
+
<div class="tags">
|
|
2489
|
+
<p class="tag_title">Parameters:</p>
|
|
2490
|
+
<ul class="param">
|
|
2491
|
+
|
|
2492
|
+
<li>
|
|
2493
|
+
|
|
2494
|
+
<span class='name'>resource_id</span>
|
|
2495
|
+
|
|
2496
|
+
|
|
2497
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
2498
|
+
|
|
2499
|
+
|
|
2500
|
+
|
|
2501
|
+
—
|
|
2502
|
+
<div class='inline'>
|
|
2503
|
+
<p>resource ID</p>
|
|
2504
|
+
</div>
|
|
2505
|
+
|
|
2506
|
+
</li>
|
|
2507
|
+
|
|
2508
|
+
<li>
|
|
2509
|
+
|
|
2510
|
+
<span class='name'>field_id</span>
|
|
2511
|
+
|
|
2512
|
+
|
|
2513
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
2514
|
+
|
|
2515
|
+
|
|
2516
|
+
|
|
2517
|
+
—
|
|
2518
|
+
<div class='inline'>
|
|
2519
|
+
<p>field ID</p>
|
|
2520
|
+
</div>
|
|
2521
|
+
|
|
2522
|
+
</li>
|
|
2523
|
+
|
|
2524
|
+
<li>
|
|
2525
|
+
|
|
2526
|
+
<span class='name'>value</span>
|
|
2527
|
+
|
|
2528
|
+
|
|
2529
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
2530
|
+
|
|
2531
|
+
|
|
2532
|
+
|
|
2533
|
+
—
|
|
2534
|
+
<div class='inline'>
|
|
2535
|
+
<p>field value</p>
|
|
2536
|
+
</div>
|
|
2537
|
+
|
|
2538
|
+
</li>
|
|
2539
|
+
|
|
2540
|
+
<li>
|
|
2541
|
+
|
|
2542
|
+
<span class='name'>node_values</span>
|
|
2543
|
+
|
|
2544
|
+
|
|
2545
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
2546
|
+
|
|
2547
|
+
|
|
2548
|
+
<em class="default">(defaults to: <tt>false</tt>)</em>
|
|
2549
|
+
|
|
2550
|
+
|
|
2551
|
+
—
|
|
2552
|
+
<div class='inline'>
|
|
2553
|
+
<p>whether value contains node IDs</p>
|
|
2554
|
+
</div>
|
|
2555
|
+
|
|
2556
|
+
</li>
|
|
2557
|
+
|
|
2558
|
+
</ul>
|
|
2559
|
+
|
|
2560
|
+
<p class="tag_title">Returns:</p>
|
|
2561
|
+
<ul class="return">
|
|
2562
|
+
|
|
2563
|
+
<li>
|
|
2564
|
+
|
|
2565
|
+
|
|
2566
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
2567
|
+
|
|
2568
|
+
|
|
2569
|
+
|
|
2570
|
+
—
|
|
2571
|
+
<div class='inline'>
|
|
2572
|
+
<p>response</p>
|
|
2573
|
+
</div>
|
|
2574
|
+
|
|
2575
|
+
</li>
|
|
2576
|
+
|
|
2577
|
+
</ul>
|
|
2578
|
+
|
|
2579
|
+
</div><table class="source_code">
|
|
2580
|
+
<tr>
|
|
2581
|
+
<td>
|
|
2582
|
+
<pre class="lines">
|
|
2583
|
+
|
|
2584
|
+
|
|
2585
|
+
99
|
|
2586
|
+
100
|
|
2587
|
+
101
|
|
2588
|
+
102
|
|
2589
|
+
103
|
|
2590
|
+
104
|
|
2591
|
+
105
|
|
2592
|
+
106
|
|
2593
|
+
107
|
|
2594
|
+
108</pre>
|
|
2595
|
+
</td>
|
|
2596
|
+
<td>
|
|
2597
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/resource.rb', line 99</span>
|
|
2598
|
+
|
|
2599
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update_field'>update_field</span><span class='lparen'>(</span><span class='id identifier rubyid_resource_id'>resource_id</span><span class='comma'>,</span> <span class='id identifier rubyid_field_id'>field_id</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='comma'>,</span> <span class='label'>node_values:</span> <span class='kw'>false</span><span class='rparen'>)</span>
|
|
2600
|
+
<span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
2601
|
+
<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>
|
|
2602
|
+
<span class='label'>param2:</span> <span class='id identifier rubyid_field_id'>field_id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='comma'>,</span>
|
|
2603
|
+
<span class='label'>param3:</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
|
|
2604
|
+
<span class='rbrace'>}</span>
|
|
2605
|
+
<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_node_values'>node_values</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='kw'>if</span> <span class='id identifier rubyid_node_values'>node_values</span>
|
|
2606
|
+
|
|
2607
|
+
<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'>update_field</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
|
|
2608
|
+
<span class='kw'>end</span></pre>
|
|
2609
|
+
</td>
|
|
2610
|
+
</tr>
|
|
2611
|
+
</table>
|
|
2612
|
+
</div>
|
|
2613
|
+
|
|
2614
|
+
<div class="method_details ">
|
|
2615
|
+
<h3 class="signature " id="update_resource_type-instance_method">
|
|
2616
|
+
|
|
2617
|
+
#<strong>update_resource_type</strong>(resource_id, resource_type) ⇒ <tt>Hash</tt>
|
|
2618
|
+
|
|
2619
|
+
|
|
2620
|
+
|
|
2621
|
+
|
|
2622
|
+
|
|
2623
|
+
</h3><div class="docstring">
|
|
2624
|
+
<div class="discussion">
|
|
2625
|
+
|
|
2626
|
+
<p>Update resource type</p>
|
|
2627
|
+
|
|
2628
|
+
|
|
2629
|
+
</div>
|
|
2630
|
+
</div>
|
|
2631
|
+
<div class="tags">
|
|
2632
|
+
<p class="tag_title">Parameters:</p>
|
|
2633
|
+
<ul class="param">
|
|
2634
|
+
|
|
2635
|
+
<li>
|
|
2636
|
+
|
|
2637
|
+
<span class='name'>resource_id</span>
|
|
2638
|
+
|
|
2639
|
+
|
|
2640
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
2641
|
+
|
|
2642
|
+
|
|
2643
|
+
|
|
2644
|
+
—
|
|
2645
|
+
<div class='inline'>
|
|
2646
|
+
<p>resource ID</p>
|
|
2647
|
+
</div>
|
|
2648
|
+
|
|
2649
|
+
</li>
|
|
2650
|
+
|
|
2651
|
+
<li>
|
|
2652
|
+
|
|
2653
|
+
<span class='name'>resource_type</span>
|
|
2654
|
+
|
|
2655
|
+
|
|
2656
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
2657
|
+
|
|
2658
|
+
|
|
2659
|
+
|
|
2660
|
+
—
|
|
2661
|
+
<div class='inline'>
|
|
2662
|
+
<p>new resource type ID</p>
|
|
2663
|
+
</div>
|
|
2664
|
+
|
|
2665
|
+
</li>
|
|
2666
|
+
|
|
2667
|
+
</ul>
|
|
2668
|
+
|
|
2669
|
+
<p class="tag_title">Returns:</p>
|
|
2670
|
+
<ul class="return">
|
|
2671
|
+
|
|
2672
|
+
<li>
|
|
2673
|
+
|
|
2674
|
+
|
|
2675
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
2676
|
+
|
|
2677
|
+
|
|
2678
|
+
|
|
2679
|
+
—
|
|
2680
|
+
<div class='inline'>
|
|
2681
|
+
<p>response</p>
|
|
2682
|
+
</div>
|
|
2683
|
+
|
|
2684
|
+
</li>
|
|
2685
|
+
|
|
2686
|
+
</ul>
|
|
2687
|
+
|
|
2688
|
+
</div><table class="source_code">
|
|
2689
|
+
<tr>
|
|
2690
|
+
<td>
|
|
2691
|
+
<pre class="lines">
|
|
2692
|
+
|
|
2693
|
+
|
|
2694
|
+
196
|
|
2695
|
+
197
|
|
2696
|
+
198
|
|
2697
|
+
199
|
|
2698
|
+
200
|
|
2699
|
+
201</pre>
|
|
2700
|
+
</td>
|
|
2701
|
+
<td>
|
|
2702
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/resource.rb', line 196</span>
|
|
2703
|
+
|
|
2704
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update_resource_type'>update_resource_type</span><span class='lparen'>(</span><span class='id identifier rubyid_resource_id'>resource_id</span><span class='comma'>,</span> <span class='id identifier rubyid_resource_type'>resource_type</span><span class='rparen'>)</span>
|
|
2705
|
+
<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'>update_resource_type</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='lbrace'>{</span>
|
|
2706
|
+
<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>
|
|
2707
|
+
<span class='label'>param2:</span> <span class='id identifier rubyid_resource_type'>resource_type</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
|
|
2708
|
+
<span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
2709
|
+
<span class='kw'>end</span></pre>
|
|
2710
|
+
</td>
|
|
2711
|
+
</tr>
|
|
2712
|
+
</table>
|
|
2713
|
+
</div>
|
|
2714
|
+
|
|
2715
|
+
<div class="method_details ">
|
|
2716
|
+
<h3 class="signature " id="upload_file-instance_method">
|
|
2717
|
+
|
|
2718
|
+
#<strong>upload_file</strong>(file, caption: nil, no_exif: false) ⇒ <tt>Hash</tt>
|
|
2719
|
+
|
|
2720
|
+
|
|
2721
|
+
|
|
2722
|
+
|
|
2723
|
+
|
|
2724
|
+
</h3><div class="docstring">
|
|
2725
|
+
<div class="discussion">
|
|
2726
|
+
|
|
2727
|
+
<p>Upload a file to ResourceSpace</p>
|
|
2728
|
+
|
|
2729
|
+
|
|
2730
|
+
</div>
|
|
2731
|
+
</div>
|
|
2732
|
+
<div class="tags">
|
|
2733
|
+
<p class="tag_title">Parameters:</p>
|
|
2734
|
+
<ul class="param">
|
|
2735
|
+
|
|
2736
|
+
<li>
|
|
2737
|
+
|
|
2738
|
+
<span class='name'>file</span>
|
|
2739
|
+
|
|
2740
|
+
|
|
2741
|
+
<span class='type'>(<tt>File</tt>, <tt>String</tt>)</span>
|
|
2742
|
+
|
|
2743
|
+
|
|
2744
|
+
|
|
2745
|
+
—
|
|
2746
|
+
<div class='inline'>
|
|
2747
|
+
<p>file object or file path</p>
|
|
2748
|
+
</div>
|
|
2749
|
+
|
|
2750
|
+
</li>
|
|
2751
|
+
|
|
2752
|
+
<li>
|
|
2753
|
+
|
|
2754
|
+
<span class='name'>caption</span>
|
|
2755
|
+
|
|
2756
|
+
|
|
2757
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
2758
|
+
|
|
2759
|
+
|
|
2760
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
2761
|
+
|
|
2762
|
+
|
|
2763
|
+
—
|
|
2764
|
+
<div class='inline'>
|
|
2765
|
+
<p>file caption</p>
|
|
2766
|
+
</div>
|
|
2767
|
+
|
|
2768
|
+
</li>
|
|
2769
|
+
|
|
2770
|
+
<li>
|
|
2771
|
+
|
|
2772
|
+
<span class='name'>no_exif</span>
|
|
2773
|
+
|
|
2774
|
+
|
|
2775
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
2776
|
+
|
|
2777
|
+
|
|
2778
|
+
<em class="default">(defaults to: <tt>false</tt>)</em>
|
|
2779
|
+
|
|
2780
|
+
|
|
2781
|
+
—
|
|
2782
|
+
<div class='inline'>
|
|
2783
|
+
<p>whether to skip EXIF data extraction</p>
|
|
2784
|
+
</div>
|
|
2785
|
+
|
|
2786
|
+
</li>
|
|
2787
|
+
|
|
2788
|
+
</ul>
|
|
2789
|
+
|
|
2790
|
+
<p class="tag_title">Returns:</p>
|
|
2791
|
+
<ul class="return">
|
|
2792
|
+
|
|
2793
|
+
<li>
|
|
2794
|
+
|
|
2795
|
+
|
|
2796
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
2797
|
+
|
|
2798
|
+
|
|
2799
|
+
|
|
2800
|
+
—
|
|
2801
|
+
<div class='inline'>
|
|
2802
|
+
<p>uploaded file data</p>
|
|
2803
|
+
</div>
|
|
2804
|
+
|
|
2805
|
+
</li>
|
|
2806
|
+
|
|
2807
|
+
</ul>
|
|
2808
|
+
|
|
2809
|
+
</div><table class="source_code">
|
|
2810
|
+
<tr>
|
|
2811
|
+
<td>
|
|
2812
|
+
<pre class="lines">
|
|
2813
|
+
|
|
2814
|
+
|
|
2815
|
+
64
|
|
2816
|
+
65
|
|
2817
|
+
66
|
|
2818
|
+
67
|
|
2819
|
+
68
|
|
2820
|
+
69
|
|
2821
|
+
70</pre>
|
|
2822
|
+
</td>
|
|
2823
|
+
<td>
|
|
2824
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/resource.rb', line 64</span>
|
|
2825
|
+
|
|
2826
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_upload_file'>upload_file</span><span class='lparen'>(</span><span class='id identifier rubyid_file'>file</span><span class='comma'>,</span> <span class='label'>caption:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>no_exif:</span> <span class='kw'>false</span><span class='rparen'>)</span>
|
|
2827
|
+
<span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
2828
|
+
<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_caption'>caption</span> <span class='kw'>if</span> <span class='id identifier rubyid_caption'>caption</span>
|
|
2829
|
+
<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='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>1</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_no_exif'>no_exif</span>
|
|
2830
|
+
|
|
2831
|
+
<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_upload_file'>upload_file</span><span class='lparen'>(</span><span class='id identifier rubyid_file'>file</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
|
|
2832
|
+
<span class='kw'>end</span></pre>
|
|
2833
|
+
</td>
|
|
2834
|
+
</tr>
|
|
2835
|
+
</table>
|
|
2836
|
+
</div>
|
|
2837
|
+
|
|
2838
|
+
<div class="method_details ">
|
|
2839
|
+
<h3 class="signature " id="upload_file_by_url-instance_method">
|
|
2840
|
+
|
|
2841
|
+
#<strong>upload_file_by_url</strong>(resource_id, url, save_as: nil, no_exif: false) ⇒ <tt>Hash</tt>
|
|
2842
|
+
|
|
2843
|
+
|
|
2844
|
+
|
|
2845
|
+
|
|
2846
|
+
|
|
2847
|
+
</h3><div class="docstring">
|
|
2848
|
+
<div class="discussion">
|
|
2849
|
+
|
|
2850
|
+
<p>Upload file by URL</p>
|
|
2851
|
+
|
|
2852
|
+
|
|
2853
|
+
</div>
|
|
2854
|
+
</div>
|
|
2855
|
+
<div class="tags">
|
|
2856
|
+
<p class="tag_title">Parameters:</p>
|
|
2857
|
+
<ul class="param">
|
|
2858
|
+
|
|
2859
|
+
<li>
|
|
2860
|
+
|
|
2861
|
+
<span class='name'>resource_id</span>
|
|
2862
|
+
|
|
2863
|
+
|
|
2864
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
2865
|
+
|
|
2866
|
+
|
|
2867
|
+
|
|
2868
|
+
—
|
|
2869
|
+
<div class='inline'>
|
|
2870
|
+
<p>resource ID</p>
|
|
2871
|
+
</div>
|
|
2872
|
+
|
|
2873
|
+
</li>
|
|
2874
|
+
|
|
2875
|
+
<li>
|
|
2876
|
+
|
|
2877
|
+
<span class='name'>url</span>
|
|
2878
|
+
|
|
2879
|
+
|
|
2880
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
2881
|
+
|
|
2882
|
+
|
|
2883
|
+
|
|
2884
|
+
—
|
|
2885
|
+
<div class='inline'>
|
|
2886
|
+
<p>file URL</p>
|
|
2887
|
+
</div>
|
|
2888
|
+
|
|
2889
|
+
</li>
|
|
2890
|
+
|
|
2891
|
+
<li>
|
|
2892
|
+
|
|
2893
|
+
<span class='name'>save_as</span>
|
|
2894
|
+
|
|
2895
|
+
|
|
2896
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
2897
|
+
|
|
2898
|
+
|
|
2899
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
2900
|
+
|
|
2901
|
+
|
|
2902
|
+
—
|
|
2903
|
+
<div class='inline'>
|
|
2904
|
+
<p>filename to save as</p>
|
|
2905
|
+
</div>
|
|
2906
|
+
|
|
2907
|
+
</li>
|
|
2908
|
+
|
|
2909
|
+
<li>
|
|
2910
|
+
|
|
2911
|
+
<span class='name'>no_exif</span>
|
|
2912
|
+
|
|
2913
|
+
|
|
2914
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
2915
|
+
|
|
2916
|
+
|
|
2917
|
+
<em class="default">(defaults to: <tt>false</tt>)</em>
|
|
2918
|
+
|
|
2919
|
+
|
|
2920
|
+
—
|
|
2921
|
+
<div class='inline'>
|
|
2922
|
+
<p>skip EXIF extraction</p>
|
|
2923
|
+
</div>
|
|
2924
|
+
|
|
2925
|
+
</li>
|
|
2926
|
+
|
|
2927
|
+
</ul>
|
|
2928
|
+
|
|
2929
|
+
<p class="tag_title">Returns:</p>
|
|
2930
|
+
<ul class="return">
|
|
2931
|
+
|
|
2932
|
+
<li>
|
|
2933
|
+
|
|
2934
|
+
|
|
2935
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
2936
|
+
|
|
2937
|
+
|
|
2938
|
+
|
|
2939
|
+
—
|
|
2940
|
+
<div class='inline'>
|
|
2941
|
+
<p>response</p>
|
|
2942
|
+
</div>
|
|
2943
|
+
|
|
2944
|
+
</li>
|
|
2945
|
+
|
|
2946
|
+
</ul>
|
|
2947
|
+
|
|
2948
|
+
</div><table class="source_code">
|
|
2949
|
+
<tr>
|
|
2950
|
+
<td>
|
|
2951
|
+
<pre class="lines">
|
|
2952
|
+
|
|
2953
|
+
|
|
2954
|
+
243
|
|
2955
|
+
244
|
|
2956
|
+
245
|
|
2957
|
+
246
|
|
2958
|
+
247
|
|
2959
|
+
248
|
|
2960
|
+
249
|
|
2961
|
+
250
|
|
2962
|
+
251
|
|
2963
|
+
252</pre>
|
|
2964
|
+
</td>
|
|
2965
|
+
<td>
|
|
2966
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/resource.rb', line 243</span>
|
|
2967
|
+
|
|
2968
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_upload_file_by_url'>upload_file_by_url</span><span class='lparen'>(</span><span class='id identifier rubyid_resource_id'>resource_id</span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='label'>save_as:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>no_exif:</span> <span class='kw'>false</span><span class='rparen'>)</span>
|
|
2969
|
+
<span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
2970
|
+
<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>
|
|
2971
|
+
<span class='label'>param2:</span> <span class='id identifier rubyid_url'>url</span>
|
|
2972
|
+
<span class='rbrace'>}</span>
|
|
2973
|
+
<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_save_as'>save_as</span> <span class='kw'>if</span> <span class='id identifier rubyid_save_as'>save_as</span>
|
|
2974
|
+
<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='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>1</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_no_exif'>no_exif</span>
|
|
2975
|
+
|
|
2976
|
+
<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'>upload_file_by_url</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
|
|
2977
|
+
<span class='kw'>end</span></pre>
|
|
2978
|
+
</td>
|
|
2979
|
+
</tr>
|
|
2980
|
+
</table>
|
|
2981
|
+
</div>
|
|
2982
|
+
|
|
2983
|
+
</div>
|
|
2984
|
+
|
|
2985
|
+
</div>
|
|
2986
|
+
|
|
2987
|
+
<div id="footer">
|
|
2988
|
+
Generated on Sat May 24 15:41:24 2025 by
|
|
2989
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
2990
|
+
0.9.37 (ruby-3.4.4).
|
|
2991
|
+
</div>
|
|
2992
|
+
|
|
2993
|
+
</div>
|
|
2994
|
+
</body>
|
|
2995
|
+
</html>
|