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,2222 @@
|
|
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::Metadata
|
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::Metadata";
|
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 (M)</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">Metadata</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::Metadata
|
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::Metadata</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/metadata.rb</dd>
|
98
|
+
</dl>
|
99
|
+
|
100
|
+
</div>
|
101
|
+
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
103
|
+
<div class="discussion">
|
104
|
+
|
105
|
+
<p>Metadata 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_metadata'>metadata</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_metadata'>metadata</span>
|
117
|
+
|
118
|
+
<span class='comment'># Get field options
|
119
|
+
</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span><span class='period'>.</span><span class='id identifier rubyid_get_field_options'>get_field_options</span><span class='lparen'>(</span><span class='int'>75</span><span class='rparen'>)</span>
|
120
|
+
|
121
|
+
<span class='comment'># Create a resource type field
|
122
|
+
</span><span class='id identifier rubyid_field'>field</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span><span class='period'>.</span><span class='id identifier rubyid_create_resource_type_field'>create_resource_type_field</span><span class='lparen'>(</span>
|
123
|
+
<span class='label'>name:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Web Asset Type</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
124
|
+
<span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>dropdown</span><span class='tstring_end'>"</span></span>
|
125
|
+
<span class='rparen'>)</span></code></pre>
|
126
|
+
|
127
|
+
</div>
|
128
|
+
|
129
|
+
|
130
|
+
</div>
|
131
|
+
|
132
|
+
|
133
|
+
|
134
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
135
|
+
<ul class="summary">
|
136
|
+
|
137
|
+
<li class="public ">
|
138
|
+
<span class="summary_signature">
|
139
|
+
|
140
|
+
<a href="#client-instance_method" title="#client (instance method)">#<strong>client</strong> ⇒ Client </a>
|
141
|
+
|
142
|
+
|
143
|
+
|
144
|
+
</span>
|
145
|
+
|
146
|
+
|
147
|
+
|
148
|
+
|
149
|
+
<span class="note title readonly">readonly</span>
|
150
|
+
|
151
|
+
|
152
|
+
|
153
|
+
|
154
|
+
|
155
|
+
|
156
|
+
|
157
|
+
|
158
|
+
|
159
|
+
<span class="summary_desc"><div class='inline'>
|
160
|
+
<p>The ResourceSpace client.</p>
|
161
|
+
</div></span>
|
162
|
+
|
163
|
+
</li>
|
164
|
+
|
165
|
+
|
166
|
+
</ul>
|
167
|
+
|
168
|
+
|
169
|
+
|
170
|
+
|
171
|
+
|
172
|
+
<h2>
|
173
|
+
Instance Method Summary
|
174
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
175
|
+
</h2>
|
176
|
+
|
177
|
+
<ul class="summary">
|
178
|
+
|
179
|
+
<li class="public ">
|
180
|
+
<span class="summary_signature">
|
181
|
+
|
182
|
+
<a href="#add_resource_nodes-instance_method" title="#add_resource_nodes (instance method)">#<strong>add_resource_nodes</strong>(resource_id, field_id, node_ids) ⇒ 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 resource nodes (multiple field values).</p>
|
198
|
+
</div></span>
|
199
|
+
|
200
|
+
</li>
|
201
|
+
|
202
|
+
|
203
|
+
<li class="public ">
|
204
|
+
<span class="summary_signature">
|
205
|
+
|
206
|
+
<a href="#add_resource_nodes_multi-instance_method" title="#add_resource_nodes_multi (instance method)">#<strong>add_resource_nodes_multi</strong>(resource_id, field_data) ⇒ 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>Add resource nodes for multiple fields.</p>
|
222
|
+
</div></span>
|
223
|
+
|
224
|
+
</li>
|
225
|
+
|
226
|
+
|
227
|
+
<li class="public ">
|
228
|
+
<span class="summary_signature">
|
229
|
+
|
230
|
+
<a href="#create_resource_type_field-instance_method" title="#create_resource_type_field (instance method)">#<strong>create_resource_type_field</strong>(name:, type:, resource_types: [1], **options) ⇒ 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 type field.</p>
|
246
|
+
</div></span>
|
247
|
+
|
248
|
+
</li>
|
249
|
+
|
250
|
+
|
251
|
+
<li class="public ">
|
252
|
+
<span class="summary_signature">
|
253
|
+
|
254
|
+
<a href="#create_web_asset_fields-instance_method" title="#create_web_asset_fields (instance method)">#<strong>create_web_asset_fields</strong>(resource_types: [1]) ⇒ Array </a>
|
255
|
+
|
256
|
+
|
257
|
+
|
258
|
+
</span>
|
259
|
+
|
260
|
+
|
261
|
+
|
262
|
+
|
263
|
+
|
264
|
+
|
265
|
+
|
266
|
+
|
267
|
+
|
268
|
+
<span class="summary_desc"><div class='inline'>
|
269
|
+
<p>Create web asset metadata fields.</p>
|
270
|
+
</div></span>
|
271
|
+
|
272
|
+
</li>
|
273
|
+
|
274
|
+
|
275
|
+
<li class="public ">
|
276
|
+
<span class="summary_signature">
|
277
|
+
|
278
|
+
<a href="#get_field_options-instance_method" title="#get_field_options (instance method)">#<strong>get_field_options</strong>(field_id, node_info: false) ⇒ Array </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>Get field options for dropdown/checkbox fields.</p>
|
294
|
+
</div></span>
|
295
|
+
|
296
|
+
</li>
|
297
|
+
|
298
|
+
|
299
|
+
<li class="public ">
|
300
|
+
<span class="summary_signature">
|
301
|
+
|
302
|
+
<a href="#get_node_id-instance_method" title="#get_node_id (instance method)">#<strong>get_node_id</strong>(field_id, value) ⇒ Integer </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>Get node ID for a field value.</p>
|
318
|
+
</div></span>
|
319
|
+
|
320
|
+
</li>
|
321
|
+
|
322
|
+
|
323
|
+
<li class="public ">
|
324
|
+
<span class="summary_signature">
|
325
|
+
|
326
|
+
<a href="#get_nodes-instance_method" title="#get_nodes (instance method)">#<strong>get_nodes</strong>(field_id) ⇒ Array </a>
|
327
|
+
|
328
|
+
|
329
|
+
|
330
|
+
</span>
|
331
|
+
|
332
|
+
|
333
|
+
|
334
|
+
|
335
|
+
|
336
|
+
|
337
|
+
|
338
|
+
|
339
|
+
|
340
|
+
<span class="summary_desc"><div class='inline'>
|
341
|
+
<p>Get all nodes for a field.</p>
|
342
|
+
</div></span>
|
343
|
+
|
344
|
+
</li>
|
345
|
+
|
346
|
+
|
347
|
+
<li class="public ">
|
348
|
+
<span class="summary_signature">
|
349
|
+
|
350
|
+
<a href="#get_resource_type_fields-instance_method" title="#get_resource_type_fields (instance method)">#<strong>get_resource_type_fields</strong>(resource_type = nil) ⇒ 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 resource type fields.</p>
|
366
|
+
</div></span>
|
367
|
+
|
368
|
+
</li>
|
369
|
+
|
370
|
+
|
371
|
+
<li class="public ">
|
372
|
+
<span class="summary_signature">
|
373
|
+
|
374
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client) ⇒ Metadata </a>
|
375
|
+
|
376
|
+
|
377
|
+
|
378
|
+
</span>
|
379
|
+
|
380
|
+
|
381
|
+
<span class="note title constructor">constructor</span>
|
382
|
+
|
383
|
+
|
384
|
+
|
385
|
+
|
386
|
+
|
387
|
+
|
388
|
+
|
389
|
+
|
390
|
+
<span class="summary_desc"><div class='inline'>
|
391
|
+
<p>Initialize the metadata interface.</p>
|
392
|
+
</div></span>
|
393
|
+
|
394
|
+
</li>
|
395
|
+
|
396
|
+
|
397
|
+
<li class="public ">
|
398
|
+
<span class="summary_signature">
|
399
|
+
|
400
|
+
<a href="#set_node-instance_method" title="#set_node (instance method)">#<strong>set_node</strong>(field_id, value, return_existing: true) ⇒ Integer </a>
|
401
|
+
|
402
|
+
|
403
|
+
|
404
|
+
</span>
|
405
|
+
|
406
|
+
|
407
|
+
|
408
|
+
|
409
|
+
|
410
|
+
|
411
|
+
|
412
|
+
|
413
|
+
|
414
|
+
<span class="summary_desc"><div class='inline'>
|
415
|
+
<p>Set/create a node value.</p>
|
416
|
+
</div></span>
|
417
|
+
|
418
|
+
</li>
|
419
|
+
|
420
|
+
|
421
|
+
<li class="public ">
|
422
|
+
<span class="summary_signature">
|
423
|
+
|
424
|
+
<a href="#toggle_active_state_for_nodes-instance_method" title="#toggle_active_state_for_nodes (instance method)">#<strong>toggle_active_state_for_nodes</strong>(field_id, node_ids, active: true) ⇒ Hash </a>
|
425
|
+
|
426
|
+
|
427
|
+
|
428
|
+
</span>
|
429
|
+
|
430
|
+
|
431
|
+
|
432
|
+
|
433
|
+
|
434
|
+
|
435
|
+
|
436
|
+
|
437
|
+
|
438
|
+
<span class="summary_desc"><div class='inline'>
|
439
|
+
<p>Toggle active state for nodes.</p>
|
440
|
+
</div></span>
|
441
|
+
|
442
|
+
</li>
|
443
|
+
|
444
|
+
|
445
|
+
<li class="public ">
|
446
|
+
<span class="summary_signature">
|
447
|
+
|
448
|
+
<a href="#update_field-instance_method" title="#update_field (instance method)">#<strong>update_field</strong>(field_id, properties = {}) ⇒ Hash </a>
|
449
|
+
|
450
|
+
|
451
|
+
|
452
|
+
</span>
|
453
|
+
|
454
|
+
|
455
|
+
|
456
|
+
|
457
|
+
|
458
|
+
|
459
|
+
|
460
|
+
|
461
|
+
|
462
|
+
<span class="summary_desc"><div class='inline'>
|
463
|
+
<p>Update a field definition.</p>
|
464
|
+
</div></span>
|
465
|
+
|
466
|
+
</li>
|
467
|
+
|
468
|
+
|
469
|
+
<li class="public ">
|
470
|
+
<span class="summary_signature">
|
471
|
+
|
472
|
+
<a href="#update_web_asset_metadata-instance_method" title="#update_web_asset_metadata (instance method)">#<strong>update_web_asset_metadata</strong>(resource_id, metadata = {}) ⇒ Array </a>
|
473
|
+
|
474
|
+
|
475
|
+
|
476
|
+
</span>
|
477
|
+
|
478
|
+
|
479
|
+
|
480
|
+
|
481
|
+
|
482
|
+
|
483
|
+
|
484
|
+
|
485
|
+
|
486
|
+
<span class="summary_desc"><div class='inline'>
|
487
|
+
<p>Update resource with web asset metadata.</p>
|
488
|
+
</div></span>
|
489
|
+
|
490
|
+
</li>
|
491
|
+
|
492
|
+
|
493
|
+
<li class="public ">
|
494
|
+
<span class="summary_signature">
|
495
|
+
|
496
|
+
<a href="#web_asset_schema-instance_method" title="#web_asset_schema (instance method)">#<strong>web_asset_schema</strong> ⇒ Hash </a>
|
497
|
+
|
498
|
+
|
499
|
+
|
500
|
+
</span>
|
501
|
+
|
502
|
+
|
503
|
+
|
504
|
+
|
505
|
+
|
506
|
+
|
507
|
+
|
508
|
+
|
509
|
+
|
510
|
+
<span class="summary_desc"><div class='inline'>
|
511
|
+
<p>Get metadata schema for web assets.</p>
|
512
|
+
</div></span>
|
513
|
+
|
514
|
+
</li>
|
515
|
+
|
516
|
+
|
517
|
+
</ul>
|
518
|
+
|
519
|
+
|
520
|
+
<div id="constructor_details" class="method_details_list">
|
521
|
+
<h2>Constructor Details</h2>
|
522
|
+
|
523
|
+
<div class="method_details first">
|
524
|
+
<h3 class="signature first" id="initialize-instance_method">
|
525
|
+
|
526
|
+
#<strong>initialize</strong>(client) ⇒ <tt><span class='object_link'><a href="" title="ResourceSpace::Metadata (class)">Metadata</a></span></tt>
|
527
|
+
|
528
|
+
|
529
|
+
|
530
|
+
|
531
|
+
|
532
|
+
</h3><div class="docstring">
|
533
|
+
<div class="discussion">
|
534
|
+
|
535
|
+
<p>Initialize the metadata interface</p>
|
536
|
+
|
537
|
+
|
538
|
+
</div>
|
539
|
+
</div>
|
540
|
+
<div class="tags">
|
541
|
+
<p class="tag_title">Parameters:</p>
|
542
|
+
<ul class="param">
|
543
|
+
|
544
|
+
<li>
|
545
|
+
|
546
|
+
<span class='name'>client</span>
|
547
|
+
|
548
|
+
|
549
|
+
<span class='type'>(<tt><span class='object_link'><a href="Client.html" title="ResourceSpace::Client (class)">Client</a></span></tt>)</span>
|
550
|
+
|
551
|
+
|
552
|
+
|
553
|
+
—
|
554
|
+
<div class='inline'>
|
555
|
+
<p>ResourceSpace client instance</p>
|
556
|
+
</div>
|
557
|
+
|
558
|
+
</li>
|
559
|
+
|
560
|
+
</ul>
|
561
|
+
|
562
|
+
|
563
|
+
</div><table class="source_code">
|
564
|
+
<tr>
|
565
|
+
<td>
|
566
|
+
<pre class="lines">
|
567
|
+
|
568
|
+
|
569
|
+
24
|
570
|
+
25
|
571
|
+
26</pre>
|
572
|
+
</td>
|
573
|
+
<td>
|
574
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/metadata.rb', line 24</span>
|
575
|
+
|
576
|
+
<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>
|
577
|
+
<span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
|
578
|
+
<span class='kw'>end</span></pre>
|
579
|
+
</td>
|
580
|
+
</tr>
|
581
|
+
</table>
|
582
|
+
</div>
|
583
|
+
|
584
|
+
</div>
|
585
|
+
|
586
|
+
<div id="instance_attr_details" class="attr_details">
|
587
|
+
<h2>Instance Attribute Details</h2>
|
588
|
+
|
589
|
+
|
590
|
+
<span id=""></span>
|
591
|
+
<div class="method_details first">
|
592
|
+
<h3 class="signature first" id="client-instance_method">
|
593
|
+
|
594
|
+
#<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>
|
595
|
+
|
596
|
+
|
597
|
+
|
598
|
+
|
599
|
+
|
600
|
+
</h3><div class="docstring">
|
601
|
+
<div class="discussion">
|
602
|
+
|
603
|
+
<p>Returns the ResourceSpace client.</p>
|
604
|
+
|
605
|
+
|
606
|
+
</div>
|
607
|
+
</div>
|
608
|
+
<div class="tags">
|
609
|
+
|
610
|
+
<p class="tag_title">Returns:</p>
|
611
|
+
<ul class="return">
|
612
|
+
|
613
|
+
<li>
|
614
|
+
|
615
|
+
|
616
|
+
<span class='type'>(<tt><span class='object_link'><a href="Client.html" title="ResourceSpace::Client (class)">Client</a></span></tt>)</span>
|
617
|
+
|
618
|
+
|
619
|
+
|
620
|
+
—
|
621
|
+
<div class='inline'>
|
622
|
+
<p>the ResourceSpace client</p>
|
623
|
+
</div>
|
624
|
+
|
625
|
+
</li>
|
626
|
+
|
627
|
+
</ul>
|
628
|
+
|
629
|
+
</div><table class="source_code">
|
630
|
+
<tr>
|
631
|
+
<td>
|
632
|
+
<pre class="lines">
|
633
|
+
|
634
|
+
|
635
|
+
19
|
636
|
+
20
|
637
|
+
21</pre>
|
638
|
+
</td>
|
639
|
+
<td>
|
640
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/metadata.rb', line 19</span>
|
641
|
+
|
642
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
|
643
|
+
<span class='ivar'>@client</span>
|
644
|
+
<span class='kw'>end</span></pre>
|
645
|
+
</td>
|
646
|
+
</tr>
|
647
|
+
</table>
|
648
|
+
</div>
|
649
|
+
|
650
|
+
</div>
|
651
|
+
|
652
|
+
|
653
|
+
<div id="instance_method_details" class="method_details_list">
|
654
|
+
<h2>Instance Method Details</h2>
|
655
|
+
|
656
|
+
|
657
|
+
<div class="method_details first">
|
658
|
+
<h3 class="signature first" id="add_resource_nodes-instance_method">
|
659
|
+
|
660
|
+
#<strong>add_resource_nodes</strong>(resource_id, field_id, node_ids) ⇒ <tt>Hash</tt>
|
661
|
+
|
662
|
+
|
663
|
+
|
664
|
+
|
665
|
+
|
666
|
+
</h3><div class="docstring">
|
667
|
+
<div class="discussion">
|
668
|
+
|
669
|
+
<p>Add resource nodes (multiple field values)</p>
|
670
|
+
|
671
|
+
|
672
|
+
</div>
|
673
|
+
</div>
|
674
|
+
<div class="tags">
|
675
|
+
<p class="tag_title">Parameters:</p>
|
676
|
+
<ul class="param">
|
677
|
+
|
678
|
+
<li>
|
679
|
+
|
680
|
+
<span class='name'>resource_id</span>
|
681
|
+
|
682
|
+
|
683
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
684
|
+
|
685
|
+
|
686
|
+
|
687
|
+
—
|
688
|
+
<div class='inline'>
|
689
|
+
<p>resource ID</p>
|
690
|
+
</div>
|
691
|
+
|
692
|
+
</li>
|
693
|
+
|
694
|
+
<li>
|
695
|
+
|
696
|
+
<span class='name'>field_id</span>
|
697
|
+
|
698
|
+
|
699
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
700
|
+
|
701
|
+
|
702
|
+
|
703
|
+
—
|
704
|
+
<div class='inline'>
|
705
|
+
<p>field ID</p>
|
706
|
+
</div>
|
707
|
+
|
708
|
+
</li>
|
709
|
+
|
710
|
+
<li>
|
711
|
+
|
712
|
+
<span class='name'>node_ids</span>
|
713
|
+
|
714
|
+
|
715
|
+
<span class='type'>(<tt>Array<Integer></tt>)</span>
|
716
|
+
|
717
|
+
|
718
|
+
|
719
|
+
—
|
720
|
+
<div class='inline'>
|
721
|
+
<p>array of node IDs</p>
|
722
|
+
</div>
|
723
|
+
|
724
|
+
</li>
|
725
|
+
|
726
|
+
</ul>
|
727
|
+
|
728
|
+
<p class="tag_title">Returns:</p>
|
729
|
+
<ul class="return">
|
730
|
+
|
731
|
+
<li>
|
732
|
+
|
733
|
+
|
734
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
735
|
+
|
736
|
+
|
737
|
+
|
738
|
+
—
|
739
|
+
<div class='inline'>
|
740
|
+
<p>response</p>
|
741
|
+
</div>
|
742
|
+
|
743
|
+
</li>
|
744
|
+
|
745
|
+
</ul>
|
746
|
+
|
747
|
+
</div><table class="source_code">
|
748
|
+
<tr>
|
749
|
+
<td>
|
750
|
+
<pre class="lines">
|
751
|
+
|
752
|
+
|
753
|
+
84
|
754
|
+
85
|
755
|
+
86
|
756
|
+
87
|
757
|
+
88
|
758
|
+
89
|
759
|
+
90
|
760
|
+
91
|
761
|
+
92</pre>
|
762
|
+
</td>
|
763
|
+
<td>
|
764
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/metadata.rb', line 84</span>
|
765
|
+
|
766
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_add_resource_nodes'>add_resource_nodes</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_node_ids'>node_ids</span><span class='rparen'>)</span>
|
767
|
+
<span class='id identifier rubyid_node_ids_str'>node_ids_str</span> <span class='op'>=</span> <span class='const'>Array</span><span class='lparen'>(</span><span class='id identifier rubyid_node_ids'>node_ids</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>,</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
768
|
+
|
769
|
+
<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>add_resource_nodes</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='lbrace'>{</span>
|
770
|
+
<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>
|
771
|
+
<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>
|
772
|
+
<span class='label'>param3:</span> <span class='id identifier rubyid_node_ids_str'>node_ids_str</span>
|
773
|
+
<span class='rbrace'>}</span><span class='rparen'>)</span>
|
774
|
+
<span class='kw'>end</span></pre>
|
775
|
+
</td>
|
776
|
+
</tr>
|
777
|
+
</table>
|
778
|
+
</div>
|
779
|
+
|
780
|
+
<div class="method_details ">
|
781
|
+
<h3 class="signature " id="add_resource_nodes_multi-instance_method">
|
782
|
+
|
783
|
+
#<strong>add_resource_nodes_multi</strong>(resource_id, field_data) ⇒ <tt>Hash</tt>
|
784
|
+
|
785
|
+
|
786
|
+
|
787
|
+
|
788
|
+
|
789
|
+
</h3><div class="docstring">
|
790
|
+
<div class="discussion">
|
791
|
+
|
792
|
+
<p>Add resource nodes for multiple fields</p>
|
793
|
+
|
794
|
+
|
795
|
+
</div>
|
796
|
+
</div>
|
797
|
+
<div class="tags">
|
798
|
+
<p class="tag_title">Parameters:</p>
|
799
|
+
<ul class="param">
|
800
|
+
|
801
|
+
<li>
|
802
|
+
|
803
|
+
<span class='name'>resource_id</span>
|
804
|
+
|
805
|
+
|
806
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
807
|
+
|
808
|
+
|
809
|
+
|
810
|
+
—
|
811
|
+
<div class='inline'>
|
812
|
+
<p>resource ID</p>
|
813
|
+
</div>
|
814
|
+
|
815
|
+
</li>
|
816
|
+
|
817
|
+
<li>
|
818
|
+
|
819
|
+
<span class='name'>field_data</span>
|
820
|
+
|
821
|
+
|
822
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
823
|
+
|
824
|
+
|
825
|
+
|
826
|
+
—
|
827
|
+
<div class='inline'>
|
828
|
+
<p>hash of field_id => node_ids pairs</p>
|
829
|
+
</div>
|
830
|
+
|
831
|
+
</li>
|
832
|
+
|
833
|
+
</ul>
|
834
|
+
|
835
|
+
<p class="tag_title">Returns:</p>
|
836
|
+
<ul class="return">
|
837
|
+
|
838
|
+
<li>
|
839
|
+
|
840
|
+
|
841
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
842
|
+
|
843
|
+
|
844
|
+
|
845
|
+
—
|
846
|
+
<div class='inline'>
|
847
|
+
<p>response</p>
|
848
|
+
</div>
|
849
|
+
|
850
|
+
</li>
|
851
|
+
|
852
|
+
</ul>
|
853
|
+
|
854
|
+
</div><table class="source_code">
|
855
|
+
<tr>
|
856
|
+
<td>
|
857
|
+
<pre class="lines">
|
858
|
+
|
859
|
+
|
860
|
+
99
|
861
|
+
100
|
862
|
+
101
|
863
|
+
102
|
864
|
+
103
|
865
|
+
104
|
866
|
+
105
|
867
|
+
106
|
868
|
+
107
|
869
|
+
108
|
870
|
+
109
|
871
|
+
110</pre>
|
872
|
+
</td>
|
873
|
+
<td>
|
874
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/metadata.rb', line 99</span>
|
875
|
+
|
876
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_add_resource_nodes_multi'>add_resource_nodes_multi</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_data'>field_data</span><span class='rparen'>)</span>
|
877
|
+
<span class='comment'># Convert field_data to the format expected by the API
|
878
|
+
</span> <span class='comment'># This might need adjustment based on the exact API format
|
879
|
+
</span> <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>
|
880
|
+
|
881
|
+
<span class='id identifier rubyid_field_data'>field_data</span><span class='period'>.</span><span class='id identifier rubyid_each_with_index'>each_with_index</span> <span class='kw'>do</span> <span class='op'>|</span><span class='lparen'>(</span><span class='id identifier rubyid_field_id'>field_id</span><span class='comma'>,</span> <span class='id identifier rubyid_node_ids'>node_ids</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_index'>index</span><span class='op'>|</span>
|
882
|
+
<span class='id identifier rubyid_node_ids_str'>node_ids_str</span> <span class='op'>=</span> <span class='const'>Array</span><span class='lparen'>(</span><span class='id identifier rubyid_node_ids'>node_ids</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>,</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
883
|
+
<span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>param</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_index'>index</span> <span class='op'>+</span> <span class='int'>2</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_field_id'>field_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>:</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_node_ids_str'>node_ids_str</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
884
|
+
<span class='kw'>end</span>
|
885
|
+
|
886
|
+
<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>add_resource_nodes_multi</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
|
887
|
+
<span class='kw'>end</span></pre>
|
888
|
+
</td>
|
889
|
+
</tr>
|
890
|
+
</table>
|
891
|
+
</div>
|
892
|
+
|
893
|
+
<div class="method_details ">
|
894
|
+
<h3 class="signature " id="create_resource_type_field-instance_method">
|
895
|
+
|
896
|
+
#<strong>create_resource_type_field</strong>(name:, type:, resource_types: [1], **options) ⇒ <tt>Hash</tt>
|
897
|
+
|
898
|
+
|
899
|
+
|
900
|
+
|
901
|
+
|
902
|
+
</h3><div class="docstring">
|
903
|
+
<div class="discussion">
|
904
|
+
|
905
|
+
<p>Create a new resource type field</p>
|
906
|
+
|
907
|
+
|
908
|
+
</div>
|
909
|
+
</div>
|
910
|
+
<div class="tags">
|
911
|
+
<p class="tag_title">Parameters:</p>
|
912
|
+
<ul class="param">
|
913
|
+
|
914
|
+
<li>
|
915
|
+
|
916
|
+
<span class='name'>name</span>
|
917
|
+
|
918
|
+
|
919
|
+
<span class='type'>(<tt>String</tt>)</span>
|
920
|
+
|
921
|
+
|
922
|
+
|
923
|
+
—
|
924
|
+
<div class='inline'>
|
925
|
+
<p>field name</p>
|
926
|
+
</div>
|
927
|
+
|
928
|
+
</li>
|
929
|
+
|
930
|
+
<li>
|
931
|
+
|
932
|
+
<span class='name'>type</span>
|
933
|
+
|
934
|
+
|
935
|
+
<span class='type'>(<tt>String</tt>)</span>
|
936
|
+
|
937
|
+
|
938
|
+
|
939
|
+
—
|
940
|
+
<div class='inline'>
|
941
|
+
<p>field type (“text”, “dropdown”, “checkbox”, “date”, etc.)</p>
|
942
|
+
</div>
|
943
|
+
|
944
|
+
</li>
|
945
|
+
|
946
|
+
<li>
|
947
|
+
|
948
|
+
<span class='name'>resource_types</span>
|
949
|
+
|
950
|
+
|
951
|
+
<span class='type'>(<tt>Array<Integer></tt>)</span>
|
952
|
+
|
953
|
+
|
954
|
+
<em class="default">(defaults to: <tt>[1]</tt>)</em>
|
955
|
+
|
956
|
+
|
957
|
+
—
|
958
|
+
<div class='inline'>
|
959
|
+
<p>resource types this field applies to</p>
|
960
|
+
</div>
|
961
|
+
|
962
|
+
</li>
|
963
|
+
|
964
|
+
<li>
|
965
|
+
|
966
|
+
<span class='name'>options</span>
|
967
|
+
|
968
|
+
|
969
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
970
|
+
|
971
|
+
|
972
|
+
|
973
|
+
—
|
974
|
+
<div class='inline'>
|
975
|
+
<p>additional field options</p>
|
976
|
+
</div>
|
977
|
+
|
978
|
+
</li>
|
979
|
+
|
980
|
+
</ul>
|
981
|
+
|
982
|
+
<p class="tag_title">Returns:</p>
|
983
|
+
<ul class="return">
|
984
|
+
|
985
|
+
<li>
|
986
|
+
|
987
|
+
|
988
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
989
|
+
|
990
|
+
|
991
|
+
|
992
|
+
—
|
993
|
+
<div class='inline'>
|
994
|
+
<p>created field data</p>
|
995
|
+
</div>
|
996
|
+
|
997
|
+
</li>
|
998
|
+
|
999
|
+
</ul>
|
1000
|
+
|
1001
|
+
</div><table class="source_code">
|
1002
|
+
<tr>
|
1003
|
+
<td>
|
1004
|
+
<pre class="lines">
|
1005
|
+
|
1006
|
+
|
1007
|
+
146
|
1008
|
+
147
|
1009
|
+
148
|
1010
|
+
149
|
1011
|
+
150
|
1012
|
+
151
|
1013
|
+
152
|
1014
|
+
153
|
1015
|
+
154
|
1016
|
+
155
|
1017
|
+
156
|
1018
|
+
157
|
1019
|
+
158
|
1020
|
+
159</pre>
|
1021
|
+
</td>
|
1022
|
+
<td>
|
1023
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/metadata.rb', line 146</span>
|
1024
|
+
|
1025
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create_resource_type_field'>create_resource_type_field</span><span class='lparen'>(</span><span class='label'>name:</span><span class='comma'>,</span> <span class='label'>type:</span><span class='comma'>,</span> <span class='label'>resource_types:</span> <span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
1026
|
+
<span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1027
|
+
<span class='label'>param1:</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span>
|
1028
|
+
<span class='label'>param2:</span> <span class='id identifier rubyid_type'>type</span><span class='comma'>,</span>
|
1029
|
+
<span class='label'>param3:</span> <span class='const'>Array</span><span class='lparen'>(</span><span class='id identifier rubyid_resource_types'>resource_types</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>,</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
1030
|
+
<span class='rbrace'>}</span>
|
1031
|
+
|
1032
|
+
<span class='comment'># Add additional options
|
1033
|
+
</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_each_with_index'>each_with_index</span> <span class='kw'>do</span> <span class='op'>|</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_index'>index</span><span class='op'>|</span>
|
1034
|
+
<span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>param</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_index'>index</span> <span class='op'>+</span> <span class='int'>4</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_key'>key</span><span class='embexpr_end'>}</span><span class='tstring_content'>:</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_value'>value</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
1035
|
+
<span class='kw'>end</span>
|
1036
|
+
|
1037
|
+
<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_type_field</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
|
1038
|
+
<span class='kw'>end</span></pre>
|
1039
|
+
</td>
|
1040
|
+
</tr>
|
1041
|
+
</table>
|
1042
|
+
</div>
|
1043
|
+
|
1044
|
+
<div class="method_details ">
|
1045
|
+
<h3 class="signature " id="create_web_asset_fields-instance_method">
|
1046
|
+
|
1047
|
+
#<strong>create_web_asset_fields</strong>(resource_types: [1]) ⇒ <tt>Array</tt>
|
1048
|
+
|
1049
|
+
|
1050
|
+
|
1051
|
+
|
1052
|
+
|
1053
|
+
</h3><div class="docstring">
|
1054
|
+
<div class="discussion">
|
1055
|
+
|
1056
|
+
<p>Create web asset metadata fields</p>
|
1057
|
+
|
1058
|
+
|
1059
|
+
</div>
|
1060
|
+
</div>
|
1061
|
+
<div class="tags">
|
1062
|
+
<p class="tag_title">Parameters:</p>
|
1063
|
+
<ul class="param">
|
1064
|
+
|
1065
|
+
<li>
|
1066
|
+
|
1067
|
+
<span class='name'>resource_types</span>
|
1068
|
+
|
1069
|
+
|
1070
|
+
<span class='type'>(<tt>Array<Integer></tt>)</span>
|
1071
|
+
|
1072
|
+
|
1073
|
+
<em class="default">(defaults to: <tt>[1]</tt>)</em>
|
1074
|
+
|
1075
|
+
|
1076
|
+
—
|
1077
|
+
<div class='inline'>
|
1078
|
+
<p>resource types to apply fields to</p>
|
1079
|
+
</div>
|
1080
|
+
|
1081
|
+
</li>
|
1082
|
+
|
1083
|
+
</ul>
|
1084
|
+
|
1085
|
+
<p class="tag_title">Returns:</p>
|
1086
|
+
<ul class="return">
|
1087
|
+
|
1088
|
+
<li>
|
1089
|
+
|
1090
|
+
|
1091
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
1092
|
+
|
1093
|
+
|
1094
|
+
|
1095
|
+
—
|
1096
|
+
<div class='inline'>
|
1097
|
+
<p>created field data</p>
|
1098
|
+
</div>
|
1099
|
+
|
1100
|
+
</li>
|
1101
|
+
|
1102
|
+
</ul>
|
1103
|
+
|
1104
|
+
</div><table class="source_code">
|
1105
|
+
<tr>
|
1106
|
+
<td>
|
1107
|
+
<pre class="lines">
|
1108
|
+
|
1109
|
+
|
1110
|
+
198
|
1111
|
+
199
|
1112
|
+
200
|
1113
|
+
201
|
1114
|
+
202
|
1115
|
+
203
|
1116
|
+
204
|
1117
|
+
205
|
1118
|
+
206
|
1119
|
+
207
|
1120
|
+
208
|
1121
|
+
209
|
1122
|
+
210
|
1123
|
+
211
|
1124
|
+
212
|
1125
|
+
213
|
1126
|
+
214
|
1127
|
+
215
|
1128
|
+
216
|
1129
|
+
217
|
1130
|
+
218
|
1131
|
+
219
|
1132
|
+
220
|
1133
|
+
221
|
1134
|
+
222
|
1135
|
+
223
|
1136
|
+
224
|
1137
|
+
225
|
1138
|
+
226
|
1139
|
+
227
|
1140
|
+
228
|
1141
|
+
229
|
1142
|
+
230
|
1143
|
+
231
|
1144
|
+
232
|
1145
|
+
233
|
1146
|
+
234
|
1147
|
+
235
|
1148
|
+
236
|
1149
|
+
237
|
1150
|
+
238
|
1151
|
+
239
|
1152
|
+
240
|
1153
|
+
241
|
1154
|
+
242
|
1155
|
+
243
|
1156
|
+
244
|
1157
|
+
245
|
1158
|
+
246
|
1159
|
+
247
|
1160
|
+
248
|
1161
|
+
249
|
1162
|
+
250
|
1163
|
+
251
|
1164
|
+
252
|
1165
|
+
253</pre>
|
1166
|
+
</td>
|
1167
|
+
<td>
|
1168
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/metadata.rb', line 198</span>
|
1169
|
+
|
1170
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create_web_asset_fields'>create_web_asset_fields</span><span class='lparen'>(</span><span class='label'>resource_types:</span> <span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
1171
|
+
<span class='id identifier rubyid_fields_to_create'>fields_to_create</span> <span class='op'>=</span> <span class='lbracket'>[</span>
|
1172
|
+
<span class='lbrace'>{</span>
|
1173
|
+
<span class='label'>name:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Web Asset Type</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
1174
|
+
<span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>dropdown</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
1175
|
+
<span class='label'>options:</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Image</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>CSS</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>JavaScript</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Font</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Icon</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Video</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Audio</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span>
|
1176
|
+
<span class='rbrace'>}</span><span class='comma'>,</span>
|
1177
|
+
<span class='lbrace'>{</span>
|
1178
|
+
<span class='label'>name:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Usage Rights</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
1179
|
+
<span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>dropdown</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
1180
|
+
<span class='label'>options:</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Public Domain</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Creative Commons</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Licensed</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Proprietary</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span>
|
1181
|
+
<span class='rbrace'>}</span><span class='comma'>,</span>
|
1182
|
+
<span class='lbrace'>{</span>
|
1183
|
+
<span class='label'>name:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Dimensions</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
1184
|
+
<span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>text</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
1185
|
+
<span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Width x Height (e.g., 1920x1080)</span><span class='tstring_end'>"</span></span>
|
1186
|
+
<span class='rbrace'>}</span><span class='comma'>,</span>
|
1187
|
+
<span class='lbrace'>{</span>
|
1188
|
+
<span class='label'>name:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>File Size</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
1189
|
+
<span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>text</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
1190
|
+
<span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>File size in bytes/KB/MB</span><span class='tstring_end'>"</span></span>
|
1191
|
+
<span class='rbrace'>}</span><span class='comma'>,</span>
|
1192
|
+
<span class='lbrace'>{</span>
|
1193
|
+
<span class='label'>name:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Compression</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
1194
|
+
<span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>dropdown</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
1195
|
+
<span class='label'>options:</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>None</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Lossless</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Lossy</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Optimized</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span>
|
1196
|
+
<span class='rbrace'>}</span><span class='comma'>,</span>
|
1197
|
+
<span class='lbrace'>{</span>
|
1198
|
+
<span class='label'>name:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Color Profile</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
1199
|
+
<span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>dropdown</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
1200
|
+
<span class='label'>options:</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>sRGB</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Adobe RGB</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>ProPhoto RGB</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>CMYK</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Grayscale</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span>
|
1201
|
+
<span class='rbrace'>}</span><span class='comma'>,</span>
|
1202
|
+
<span class='lbrace'>{</span>
|
1203
|
+
<span class='label'>name:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Purpose/Context</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
1204
|
+
<span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>text</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
1205
|
+
<span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Intended use or context for this asset</span><span class='tstring_end'>"</span></span>
|
1206
|
+
<span class='rbrace'>}</span>
|
1207
|
+
<span class='rbracket'>]</span>
|
1208
|
+
|
1209
|
+
<span class='id identifier rubyid_created_fields'>created_fields</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
|
1210
|
+
<span class='id identifier rubyid_fields_to_create'>fields_to_create</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_data'>field_data</span><span class='op'>|</span>
|
1211
|
+
<span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='id identifier rubyid_field_data'>field_data</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</span>
|
1212
|
+
<span class='id identifier rubyid_name'>name</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='symbol'>:name</span><span class='rparen'>)</span>
|
1213
|
+
<span class='id identifier rubyid_type'>type</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='symbol'>:type</span><span class='rparen'>)</span>
|
1214
|
+
|
1215
|
+
<span class='id identifier rubyid_created_field'>created_field</span> <span class='op'>=</span> <span class='id identifier rubyid_create_resource_type_field'>create_resource_type_field</span><span class='lparen'>(</span>
|
1216
|
+
<span class='label'>name:</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span>
|
1217
|
+
<span class='label'>type:</span> <span class='id identifier rubyid_type'>type</span><span class='comma'>,</span>
|
1218
|
+
<span class='label'>resource_types:</span> <span class='id identifier rubyid_resource_types'>resource_types</span><span class='comma'>,</span>
|
1219
|
+
<span class='op'>**</span><span class='id identifier rubyid_options'>options</span>
|
1220
|
+
<span class='rparen'>)</span>
|
1221
|
+
<span class='id identifier rubyid_created_fields'>created_fields</span> <span class='op'><<</span> <span class='id identifier rubyid_created_field'>created_field</span>
|
1222
|
+
<span class='kw'>end</span>
|
1223
|
+
|
1224
|
+
<span class='id identifier rubyid_created_fields'>created_fields</span>
|
1225
|
+
<span class='kw'>end</span></pre>
|
1226
|
+
</td>
|
1227
|
+
</tr>
|
1228
|
+
</table>
|
1229
|
+
</div>
|
1230
|
+
|
1231
|
+
<div class="method_details ">
|
1232
|
+
<h3 class="signature " id="get_field_options-instance_method">
|
1233
|
+
|
1234
|
+
#<strong>get_field_options</strong>(field_id, node_info: false) ⇒ <tt>Array</tt>
|
1235
|
+
|
1236
|
+
|
1237
|
+
|
1238
|
+
|
1239
|
+
|
1240
|
+
</h3><div class="docstring">
|
1241
|
+
<div class="discussion">
|
1242
|
+
|
1243
|
+
<p>Get field options for dropdown/checkbox fields</p>
|
1244
|
+
|
1245
|
+
|
1246
|
+
</div>
|
1247
|
+
</div>
|
1248
|
+
<div class="tags">
|
1249
|
+
<p class="tag_title">Parameters:</p>
|
1250
|
+
<ul class="param">
|
1251
|
+
|
1252
|
+
<li>
|
1253
|
+
|
1254
|
+
<span class='name'>field_id</span>
|
1255
|
+
|
1256
|
+
|
1257
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
1258
|
+
|
1259
|
+
|
1260
|
+
|
1261
|
+
—
|
1262
|
+
<div class='inline'>
|
1263
|
+
<p>field ID</p>
|
1264
|
+
</div>
|
1265
|
+
|
1266
|
+
</li>
|
1267
|
+
|
1268
|
+
<li>
|
1269
|
+
|
1270
|
+
<span class='name'>node_info</span>
|
1271
|
+
|
1272
|
+
|
1273
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
1274
|
+
|
1275
|
+
|
1276
|
+
<em class="default">(defaults to: <tt>false</tt>)</em>
|
1277
|
+
|
1278
|
+
|
1279
|
+
—
|
1280
|
+
<div class='inline'>
|
1281
|
+
<p>whether to include detailed node information</p>
|
1282
|
+
</div>
|
1283
|
+
|
1284
|
+
</li>
|
1285
|
+
|
1286
|
+
</ul>
|
1287
|
+
|
1288
|
+
<p class="tag_title">Returns:</p>
|
1289
|
+
<ul class="return">
|
1290
|
+
|
1291
|
+
<li>
|
1292
|
+
|
1293
|
+
|
1294
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
1295
|
+
|
1296
|
+
|
1297
|
+
|
1298
|
+
—
|
1299
|
+
<div class='inline'>
|
1300
|
+
<p>field options</p>
|
1301
|
+
</div>
|
1302
|
+
|
1303
|
+
</li>
|
1304
|
+
|
1305
|
+
</ul>
|
1306
|
+
|
1307
|
+
</div><table class="source_code">
|
1308
|
+
<tr>
|
1309
|
+
<td>
|
1310
|
+
<pre class="lines">
|
1311
|
+
|
1312
|
+
|
1313
|
+
33
|
1314
|
+
34
|
1315
|
+
35
|
1316
|
+
36
|
1317
|
+
37
|
1318
|
+
38</pre>
|
1319
|
+
</td>
|
1320
|
+
<td>
|
1321
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/metadata.rb', line 33</span>
|
1322
|
+
|
1323
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_field_options'>get_field_options</span><span class='lparen'>(</span><span class='id identifier rubyid_field_id'>field_id</span><span class='comma'>,</span> <span class='label'>node_info:</span> <span class='kw'>false</span><span class='rparen'>)</span>
|
1324
|
+
<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_field_id'>field_id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='rbrace'>}</span>
|
1325
|
+
<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_node_info'>node_info</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='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>false</span><span class='tstring_end'>"</span></span>
|
1326
|
+
|
1327
|
+
<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_field_options</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
|
1328
|
+
<span class='kw'>end</span></pre>
|
1329
|
+
</td>
|
1330
|
+
</tr>
|
1331
|
+
</table>
|
1332
|
+
</div>
|
1333
|
+
|
1334
|
+
<div class="method_details ">
|
1335
|
+
<h3 class="signature " id="get_node_id-instance_method">
|
1336
|
+
|
1337
|
+
#<strong>get_node_id</strong>(field_id, value) ⇒ <tt>Integer</tt>
|
1338
|
+
|
1339
|
+
|
1340
|
+
|
1341
|
+
|
1342
|
+
|
1343
|
+
</h3><div class="docstring">
|
1344
|
+
<div class="discussion">
|
1345
|
+
|
1346
|
+
<p>Get node ID for a field value</p>
|
1347
|
+
|
1348
|
+
|
1349
|
+
</div>
|
1350
|
+
</div>
|
1351
|
+
<div class="tags">
|
1352
|
+
<p class="tag_title">Parameters:</p>
|
1353
|
+
<ul class="param">
|
1354
|
+
|
1355
|
+
<li>
|
1356
|
+
|
1357
|
+
<span class='name'>field_id</span>
|
1358
|
+
|
1359
|
+
|
1360
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
1361
|
+
|
1362
|
+
|
1363
|
+
|
1364
|
+
—
|
1365
|
+
<div class='inline'>
|
1366
|
+
<p>field ID</p>
|
1367
|
+
</div>
|
1368
|
+
|
1369
|
+
</li>
|
1370
|
+
|
1371
|
+
<li>
|
1372
|
+
|
1373
|
+
<span class='name'>value</span>
|
1374
|
+
|
1375
|
+
|
1376
|
+
<span class='type'>(<tt>String</tt>)</span>
|
1377
|
+
|
1378
|
+
|
1379
|
+
|
1380
|
+
—
|
1381
|
+
<div class='inline'>
|
1382
|
+
<p>field value</p>
|
1383
|
+
</div>
|
1384
|
+
|
1385
|
+
</li>
|
1386
|
+
|
1387
|
+
</ul>
|
1388
|
+
|
1389
|
+
<p class="tag_title">Returns:</p>
|
1390
|
+
<ul class="return">
|
1391
|
+
|
1392
|
+
<li>
|
1393
|
+
|
1394
|
+
|
1395
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
1396
|
+
|
1397
|
+
|
1398
|
+
|
1399
|
+
—
|
1400
|
+
<div class='inline'>
|
1401
|
+
<p>node ID</p>
|
1402
|
+
</div>
|
1403
|
+
|
1404
|
+
</li>
|
1405
|
+
|
1406
|
+
</ul>
|
1407
|
+
|
1408
|
+
</div><table class="source_code">
|
1409
|
+
<tr>
|
1410
|
+
<td>
|
1411
|
+
<pre class="lines">
|
1412
|
+
|
1413
|
+
|
1414
|
+
45
|
1415
|
+
46
|
1416
|
+
47
|
1417
|
+
48
|
1418
|
+
49
|
1419
|
+
50
|
1420
|
+
51</pre>
|
1421
|
+
</td>
|
1422
|
+
<td>
|
1423
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/metadata.rb', line 45</span>
|
1424
|
+
|
1425
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_node_id'>get_node_id</span><span class='lparen'>(</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='rparen'>)</span>
|
1426
|
+
<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_node_id</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='lbrace'>{</span>
|
1427
|
+
<span class='label'>param1:</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>
|
1428
|
+
<span class='label'>param2:</span> <span class='id identifier rubyid_value'>value</span>
|
1429
|
+
<span class='rbrace'>}</span><span class='rparen'>)</span>
|
1430
|
+
<span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
|
1431
|
+
<span class='kw'>end</span></pre>
|
1432
|
+
</td>
|
1433
|
+
</tr>
|
1434
|
+
</table>
|
1435
|
+
</div>
|
1436
|
+
|
1437
|
+
<div class="method_details ">
|
1438
|
+
<h3 class="signature " id="get_nodes-instance_method">
|
1439
|
+
|
1440
|
+
#<strong>get_nodes</strong>(field_id) ⇒ <tt>Array</tt>
|
1441
|
+
|
1442
|
+
|
1443
|
+
|
1444
|
+
|
1445
|
+
|
1446
|
+
</h3><div class="docstring">
|
1447
|
+
<div class="discussion">
|
1448
|
+
|
1449
|
+
<p>Get all nodes for a field</p>
|
1450
|
+
|
1451
|
+
|
1452
|
+
</div>
|
1453
|
+
</div>
|
1454
|
+
<div class="tags">
|
1455
|
+
<p class="tag_title">Parameters:</p>
|
1456
|
+
<ul class="param">
|
1457
|
+
|
1458
|
+
<li>
|
1459
|
+
|
1460
|
+
<span class='name'>field_id</span>
|
1461
|
+
|
1462
|
+
|
1463
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
1464
|
+
|
1465
|
+
|
1466
|
+
|
1467
|
+
—
|
1468
|
+
<div class='inline'>
|
1469
|
+
<p>field ID</p>
|
1470
|
+
</div>
|
1471
|
+
|
1472
|
+
</li>
|
1473
|
+
|
1474
|
+
</ul>
|
1475
|
+
|
1476
|
+
<p class="tag_title">Returns:</p>
|
1477
|
+
<ul class="return">
|
1478
|
+
|
1479
|
+
<li>
|
1480
|
+
|
1481
|
+
|
1482
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
1483
|
+
|
1484
|
+
|
1485
|
+
|
1486
|
+
—
|
1487
|
+
<div class='inline'>
|
1488
|
+
<p>field nodes</p>
|
1489
|
+
</div>
|
1490
|
+
|
1491
|
+
</li>
|
1492
|
+
|
1493
|
+
</ul>
|
1494
|
+
|
1495
|
+
</div><table class="source_code">
|
1496
|
+
<tr>
|
1497
|
+
<td>
|
1498
|
+
<pre class="lines">
|
1499
|
+
|
1500
|
+
|
1501
|
+
57
|
1502
|
+
58
|
1503
|
+
59</pre>
|
1504
|
+
</td>
|
1505
|
+
<td>
|
1506
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/metadata.rb', line 57</span>
|
1507
|
+
|
1508
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_nodes'>get_nodes</span><span class='lparen'>(</span><span class='id identifier rubyid_field_id'>field_id</span><span class='rparen'>)</span>
|
1509
|
+
<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_nodes</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_field_id'>field_id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
|
1510
|
+
<span class='kw'>end</span></pre>
|
1511
|
+
</td>
|
1512
|
+
</tr>
|
1513
|
+
</table>
|
1514
|
+
</div>
|
1515
|
+
|
1516
|
+
<div class="method_details ">
|
1517
|
+
<h3 class="signature " id="get_resource_type_fields-instance_method">
|
1518
|
+
|
1519
|
+
#<strong>get_resource_type_fields</strong>(resource_type = nil) ⇒ <tt>Array</tt>
|
1520
|
+
|
1521
|
+
|
1522
|
+
|
1523
|
+
|
1524
|
+
|
1525
|
+
</h3><div class="docstring">
|
1526
|
+
<div class="discussion">
|
1527
|
+
|
1528
|
+
<p>Get resource type fields</p>
|
1529
|
+
|
1530
|
+
|
1531
|
+
</div>
|
1532
|
+
</div>
|
1533
|
+
<div class="tags">
|
1534
|
+
<p class="tag_title">Parameters:</p>
|
1535
|
+
<ul class="param">
|
1536
|
+
|
1537
|
+
<li>
|
1538
|
+
|
1539
|
+
<span class='name'>resource_type</span>
|
1540
|
+
|
1541
|
+
|
1542
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
1543
|
+
|
1544
|
+
|
1545
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1546
|
+
|
1547
|
+
|
1548
|
+
—
|
1549
|
+
<div class='inline'>
|
1550
|
+
<p>resource type ID</p>
|
1551
|
+
</div>
|
1552
|
+
|
1553
|
+
</li>
|
1554
|
+
|
1555
|
+
</ul>
|
1556
|
+
|
1557
|
+
<p class="tag_title">Returns:</p>
|
1558
|
+
<ul class="return">
|
1559
|
+
|
1560
|
+
<li>
|
1561
|
+
|
1562
|
+
|
1563
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
1564
|
+
|
1565
|
+
|
1566
|
+
|
1567
|
+
—
|
1568
|
+
<div class='inline'>
|
1569
|
+
<p>fields for the resource type</p>
|
1570
|
+
</div>
|
1571
|
+
|
1572
|
+
</li>
|
1573
|
+
|
1574
|
+
</ul>
|
1575
|
+
|
1576
|
+
</div><table class="source_code">
|
1577
|
+
<tr>
|
1578
|
+
<td>
|
1579
|
+
<pre class="lines">
|
1580
|
+
|
1581
|
+
|
1582
|
+
132
|
1583
|
+
133
|
1584
|
+
134
|
1585
|
+
135
|
1586
|
+
136
|
1587
|
+
137</pre>
|
1588
|
+
</td>
|
1589
|
+
<td>
|
1590
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/metadata.rb', line 132</span>
|
1591
|
+
|
1592
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_resource_type_fields'>get_resource_type_fields</span><span class='lparen'>(</span><span class='id identifier rubyid_resource_type'>resource_type</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
1593
|
+
<span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
1594
|
+
<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_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>
|
1595
|
+
|
1596
|
+
<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_type_fields</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
|
1597
|
+
<span class='kw'>end</span></pre>
|
1598
|
+
</td>
|
1599
|
+
</tr>
|
1600
|
+
</table>
|
1601
|
+
</div>
|
1602
|
+
|
1603
|
+
<div class="method_details ">
|
1604
|
+
<h3 class="signature " id="set_node-instance_method">
|
1605
|
+
|
1606
|
+
#<strong>set_node</strong>(field_id, value, return_existing: true) ⇒ <tt>Integer</tt>
|
1607
|
+
|
1608
|
+
|
1609
|
+
|
1610
|
+
|
1611
|
+
|
1612
|
+
</h3><div class="docstring">
|
1613
|
+
<div class="discussion">
|
1614
|
+
|
1615
|
+
<p>Set/create a node value</p>
|
1616
|
+
|
1617
|
+
|
1618
|
+
</div>
|
1619
|
+
</div>
|
1620
|
+
<div class="tags">
|
1621
|
+
<p class="tag_title">Parameters:</p>
|
1622
|
+
<ul class="param">
|
1623
|
+
|
1624
|
+
<li>
|
1625
|
+
|
1626
|
+
<span class='name'>field_id</span>
|
1627
|
+
|
1628
|
+
|
1629
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
1630
|
+
|
1631
|
+
|
1632
|
+
|
1633
|
+
—
|
1634
|
+
<div class='inline'>
|
1635
|
+
<p>field ID</p>
|
1636
|
+
</div>
|
1637
|
+
|
1638
|
+
</li>
|
1639
|
+
|
1640
|
+
<li>
|
1641
|
+
|
1642
|
+
<span class='name'>value</span>
|
1643
|
+
|
1644
|
+
|
1645
|
+
<span class='type'>(<tt>String</tt>)</span>
|
1646
|
+
|
1647
|
+
|
1648
|
+
|
1649
|
+
—
|
1650
|
+
<div class='inline'>
|
1651
|
+
<p>node value</p>
|
1652
|
+
</div>
|
1653
|
+
|
1654
|
+
</li>
|
1655
|
+
|
1656
|
+
<li>
|
1657
|
+
|
1658
|
+
<span class='name'>return_existing</span>
|
1659
|
+
|
1660
|
+
|
1661
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
1662
|
+
|
1663
|
+
|
1664
|
+
<em class="default">(defaults to: <tt>true</tt>)</em>
|
1665
|
+
|
1666
|
+
|
1667
|
+
—
|
1668
|
+
<div class='inline'>
|
1669
|
+
<p>return existing node if it exists</p>
|
1670
|
+
</div>
|
1671
|
+
|
1672
|
+
</li>
|
1673
|
+
|
1674
|
+
</ul>
|
1675
|
+
|
1676
|
+
<p class="tag_title">Returns:</p>
|
1677
|
+
<ul class="return">
|
1678
|
+
|
1679
|
+
<li>
|
1680
|
+
|
1681
|
+
|
1682
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
1683
|
+
|
1684
|
+
|
1685
|
+
|
1686
|
+
—
|
1687
|
+
<div class='inline'>
|
1688
|
+
<p>node ID</p>
|
1689
|
+
</div>
|
1690
|
+
|
1691
|
+
</li>
|
1692
|
+
|
1693
|
+
</ul>
|
1694
|
+
|
1695
|
+
</div><table class="source_code">
|
1696
|
+
<tr>
|
1697
|
+
<td>
|
1698
|
+
<pre class="lines">
|
1699
|
+
|
1700
|
+
|
1701
|
+
67
|
1702
|
+
68
|
1703
|
+
69
|
1704
|
+
70
|
1705
|
+
71
|
1706
|
+
72
|
1707
|
+
73
|
1708
|
+
74
|
1709
|
+
75
|
1710
|
+
76</pre>
|
1711
|
+
</td>
|
1712
|
+
<td>
|
1713
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/metadata.rb', line 67</span>
|
1714
|
+
|
1715
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_set_node'>set_node</span><span class='lparen'>(</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'>return_existing:</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
1716
|
+
<span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1717
|
+
<span class='label'>param1:</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>
|
1718
|
+
<span class='label'>param2:</span> <span class='id identifier rubyid_value'>value</span>
|
1719
|
+
<span class='rbrace'>}</span>
|
1720
|
+
<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_return_existing'>return_existing</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='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>false</span><span class='tstring_end'>"</span></span>
|
1721
|
+
|
1722
|
+
<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'>set_node</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
|
1723
|
+
<span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
|
1724
|
+
<span class='kw'>end</span></pre>
|
1725
|
+
</td>
|
1726
|
+
</tr>
|
1727
|
+
</table>
|
1728
|
+
</div>
|
1729
|
+
|
1730
|
+
<div class="method_details ">
|
1731
|
+
<h3 class="signature " id="toggle_active_state_for_nodes-instance_method">
|
1732
|
+
|
1733
|
+
#<strong>toggle_active_state_for_nodes</strong>(field_id, node_ids, active: true) ⇒ <tt>Hash</tt>
|
1734
|
+
|
1735
|
+
|
1736
|
+
|
1737
|
+
|
1738
|
+
|
1739
|
+
</h3><div class="docstring">
|
1740
|
+
<div class="discussion">
|
1741
|
+
|
1742
|
+
<p>Toggle active state for nodes</p>
|
1743
|
+
|
1744
|
+
|
1745
|
+
</div>
|
1746
|
+
</div>
|
1747
|
+
<div class="tags">
|
1748
|
+
<p class="tag_title">Parameters:</p>
|
1749
|
+
<ul class="param">
|
1750
|
+
|
1751
|
+
<li>
|
1752
|
+
|
1753
|
+
<span class='name'>field_id</span>
|
1754
|
+
|
1755
|
+
|
1756
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
1757
|
+
|
1758
|
+
|
1759
|
+
|
1760
|
+
—
|
1761
|
+
<div class='inline'>
|
1762
|
+
<p>field ID</p>
|
1763
|
+
</div>
|
1764
|
+
|
1765
|
+
</li>
|
1766
|
+
|
1767
|
+
<li>
|
1768
|
+
|
1769
|
+
<span class='name'>node_ids</span>
|
1770
|
+
|
1771
|
+
|
1772
|
+
<span class='type'>(<tt>Array<Integer></tt>)</span>
|
1773
|
+
|
1774
|
+
|
1775
|
+
|
1776
|
+
—
|
1777
|
+
<div class='inline'>
|
1778
|
+
<p>node IDs to toggle</p>
|
1779
|
+
</div>
|
1780
|
+
|
1781
|
+
</li>
|
1782
|
+
|
1783
|
+
<li>
|
1784
|
+
|
1785
|
+
<span class='name'>active</span>
|
1786
|
+
|
1787
|
+
|
1788
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
1789
|
+
|
1790
|
+
|
1791
|
+
<em class="default">(defaults to: <tt>true</tt>)</em>
|
1792
|
+
|
1793
|
+
|
1794
|
+
—
|
1795
|
+
<div class='inline'>
|
1796
|
+
<p>whether to activate or deactivate</p>
|
1797
|
+
</div>
|
1798
|
+
|
1799
|
+
</li>
|
1800
|
+
|
1801
|
+
</ul>
|
1802
|
+
|
1803
|
+
<p class="tag_title">Returns:</p>
|
1804
|
+
<ul class="return">
|
1805
|
+
|
1806
|
+
<li>
|
1807
|
+
|
1808
|
+
|
1809
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
1810
|
+
|
1811
|
+
|
1812
|
+
|
1813
|
+
—
|
1814
|
+
<div class='inline'>
|
1815
|
+
<p>response</p>
|
1816
|
+
</div>
|
1817
|
+
|
1818
|
+
</li>
|
1819
|
+
|
1820
|
+
</ul>
|
1821
|
+
|
1822
|
+
</div><table class="source_code">
|
1823
|
+
<tr>
|
1824
|
+
<td>
|
1825
|
+
<pre class="lines">
|
1826
|
+
|
1827
|
+
|
1828
|
+
167
|
1829
|
+
168
|
1830
|
+
169
|
1831
|
+
170
|
1832
|
+
171
|
1833
|
+
172
|
1834
|
+
173
|
1835
|
+
174
|
1836
|
+
175</pre>
|
1837
|
+
</td>
|
1838
|
+
<td>
|
1839
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/metadata.rb', line 167</span>
|
1840
|
+
|
1841
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_toggle_active_state_for_nodes'>toggle_active_state_for_nodes</span><span class='lparen'>(</span><span class='id identifier rubyid_field_id'>field_id</span><span class='comma'>,</span> <span class='id identifier rubyid_node_ids'>node_ids</span><span class='comma'>,</span> <span class='label'>active:</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
1842
|
+
<span class='id identifier rubyid_node_ids_str'>node_ids_str</span> <span class='op'>=</span> <span class='const'>Array</span><span class='lparen'>(</span><span class='id identifier rubyid_node_ids'>node_ids</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>,</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
1843
|
+
|
1844
|
+
<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'>toggle_active_state_for_nodes</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='lbrace'>{</span>
|
1845
|
+
<span class='label'>param1:</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>
|
1846
|
+
<span class='label'>param2:</span> <span class='id identifier rubyid_node_ids_str'>node_ids_str</span><span class='comma'>,</span>
|
1847
|
+
<span class='label'>param3:</span> <span class='id identifier rubyid_active'>active</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>1</span><span class='tstring_end'>"</span></span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>0</span><span class='tstring_end'>"</span></span>
|
1848
|
+
<span class='rbrace'>}</span><span class='rparen'>)</span>
|
1849
|
+
<span class='kw'>end</span></pre>
|
1850
|
+
</td>
|
1851
|
+
</tr>
|
1852
|
+
</table>
|
1853
|
+
</div>
|
1854
|
+
|
1855
|
+
<div class="method_details ">
|
1856
|
+
<h3 class="signature " id="update_field-instance_method">
|
1857
|
+
|
1858
|
+
#<strong>update_field</strong>(field_id, properties = {}) ⇒ <tt>Hash</tt>
|
1859
|
+
|
1860
|
+
|
1861
|
+
|
1862
|
+
|
1863
|
+
|
1864
|
+
</h3><div class="docstring">
|
1865
|
+
<div class="discussion">
|
1866
|
+
|
1867
|
+
<p>Update a field definition</p>
|
1868
|
+
|
1869
|
+
|
1870
|
+
</div>
|
1871
|
+
</div>
|
1872
|
+
<div class="tags">
|
1873
|
+
<p class="tag_title">Parameters:</p>
|
1874
|
+
<ul class="param">
|
1875
|
+
|
1876
|
+
<li>
|
1877
|
+
|
1878
|
+
<span class='name'>field_id</span>
|
1879
|
+
|
1880
|
+
|
1881
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
1882
|
+
|
1883
|
+
|
1884
|
+
|
1885
|
+
—
|
1886
|
+
<div class='inline'>
|
1887
|
+
<p>field ID</p>
|
1888
|
+
</div>
|
1889
|
+
|
1890
|
+
</li>
|
1891
|
+
|
1892
|
+
<li>
|
1893
|
+
|
1894
|
+
<span class='name'>properties</span>
|
1895
|
+
|
1896
|
+
|
1897
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
1898
|
+
|
1899
|
+
|
1900
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
1901
|
+
|
1902
|
+
|
1903
|
+
—
|
1904
|
+
<div class='inline'>
|
1905
|
+
<p>field properties to update</p>
|
1906
|
+
</div>
|
1907
|
+
|
1908
|
+
</li>
|
1909
|
+
|
1910
|
+
</ul>
|
1911
|
+
|
1912
|
+
<p class="tag_title">Returns:</p>
|
1913
|
+
<ul class="return">
|
1914
|
+
|
1915
|
+
<li>
|
1916
|
+
|
1917
|
+
|
1918
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
1919
|
+
|
1920
|
+
|
1921
|
+
|
1922
|
+
—
|
1923
|
+
<div class='inline'>
|
1924
|
+
<p>response</p>
|
1925
|
+
</div>
|
1926
|
+
|
1927
|
+
</li>
|
1928
|
+
|
1929
|
+
</ul>
|
1930
|
+
|
1931
|
+
</div><table class="source_code">
|
1932
|
+
<tr>
|
1933
|
+
<td>
|
1934
|
+
<pre class="lines">
|
1935
|
+
|
1936
|
+
|
1937
|
+
117
|
1938
|
+
118
|
1939
|
+
119
|
1940
|
+
120
|
1941
|
+
121
|
1942
|
+
122
|
1943
|
+
123
|
1944
|
+
124
|
1945
|
+
125
|
1946
|
+
126</pre>
|
1947
|
+
</td>
|
1948
|
+
<td>
|
1949
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/metadata.rb', line 117</span>
|
1950
|
+
|
1951
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update_field'>update_field</span><span class='lparen'>(</span><span class='id identifier rubyid_field_id'>field_id</span><span class='comma'>,</span> <span class='id identifier rubyid_properties'>properties</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
1952
|
+
<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_field_id'>field_id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='rbrace'>}</span>
|
1953
|
+
|
1954
|
+
<span class='comment'># Add properties as additional parameters
|
1955
|
+
</span> <span class='id identifier rubyid_properties'>properties</span><span class='period'>.</span><span class='id identifier rubyid_each_with_index'>each_with_index</span> <span class='kw'>do</span> <span class='op'>|</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_index'>index</span><span class='op'>|</span>
|
1956
|
+
<span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>param</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_index'>index</span> <span class='op'>+</span> <span class='int'>2</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_key'>key</span><span class='embexpr_end'>}</span><span class='tstring_content'>:</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_value'>value</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
1957
|
+
<span class='kw'>end</span>
|
1958
|
+
|
1959
|
+
<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>
|
1960
|
+
<span class='kw'>end</span></pre>
|
1961
|
+
</td>
|
1962
|
+
</tr>
|
1963
|
+
</table>
|
1964
|
+
</div>
|
1965
|
+
|
1966
|
+
<div class="method_details ">
|
1967
|
+
<h3 class="signature " id="update_web_asset_metadata-instance_method">
|
1968
|
+
|
1969
|
+
#<strong>update_web_asset_metadata</strong>(resource_id, metadata = {}) ⇒ <tt>Array</tt>
|
1970
|
+
|
1971
|
+
|
1972
|
+
|
1973
|
+
|
1974
|
+
|
1975
|
+
</h3><div class="docstring">
|
1976
|
+
<div class="discussion">
|
1977
|
+
|
1978
|
+
<p>Update resource with web asset metadata</p>
|
1979
|
+
|
1980
|
+
|
1981
|
+
</div>
|
1982
|
+
</div>
|
1983
|
+
<div class="tags">
|
1984
|
+
<p class="tag_title">Parameters:</p>
|
1985
|
+
<ul class="param">
|
1986
|
+
|
1987
|
+
<li>
|
1988
|
+
|
1989
|
+
<span class='name'>resource_id</span>
|
1990
|
+
|
1991
|
+
|
1992
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
1993
|
+
|
1994
|
+
|
1995
|
+
|
1996
|
+
—
|
1997
|
+
<div class='inline'>
|
1998
|
+
<p>resource ID</p>
|
1999
|
+
</div>
|
2000
|
+
|
2001
|
+
</li>
|
2002
|
+
|
2003
|
+
<li>
|
2004
|
+
|
2005
|
+
<span class='name'>metadata</span>
|
2006
|
+
|
2007
|
+
|
2008
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
2009
|
+
|
2010
|
+
|
2011
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
2012
|
+
|
2013
|
+
|
2014
|
+
—
|
2015
|
+
<div class='inline'>
|
2016
|
+
<p>web asset metadata</p>
|
2017
|
+
</div>
|
2018
|
+
|
2019
|
+
</li>
|
2020
|
+
|
2021
|
+
</ul>
|
2022
|
+
|
2023
|
+
<p class="tag_title">Returns:</p>
|
2024
|
+
<ul class="return">
|
2025
|
+
|
2026
|
+
<li>
|
2027
|
+
|
2028
|
+
|
2029
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
2030
|
+
|
2031
|
+
|
2032
|
+
|
2033
|
+
—
|
2034
|
+
<div class='inline'>
|
2035
|
+
<p>array of update responses</p>
|
2036
|
+
</div>
|
2037
|
+
|
2038
|
+
</li>
|
2039
|
+
|
2040
|
+
</ul>
|
2041
|
+
|
2042
|
+
</div><table class="source_code">
|
2043
|
+
<tr>
|
2044
|
+
<td>
|
2045
|
+
<pre class="lines">
|
2046
|
+
|
2047
|
+
|
2048
|
+
260
|
2049
|
+
261
|
2050
|
+
262
|
2051
|
+
263
|
2052
|
+
264
|
2053
|
+
265
|
2054
|
+
266
|
2055
|
+
267
|
2056
|
+
268
|
2057
|
+
269
|
2058
|
+
270
|
2059
|
+
271
|
2060
|
+
272
|
2061
|
+
273
|
2062
|
+
274
|
2063
|
+
275
|
2064
|
+
276
|
2065
|
+
277
|
2066
|
+
278
|
2067
|
+
279
|
2068
|
+
280
|
2069
|
+
281
|
2070
|
+
282
|
2071
|
+
283
|
2072
|
+
284
|
2073
|
+
285
|
2074
|
+
286
|
2075
|
+
287
|
2076
|
+
288
|
2077
|
+
289
|
2078
|
+
290
|
2079
|
+
291
|
2080
|
+
292
|
2081
|
+
293
|
2082
|
+
294
|
2083
|
+
295
|
2084
|
+
296</pre>
|
2085
|
+
</td>
|
2086
|
+
<td>
|
2087
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/metadata.rb', line 260</span>
|
2088
|
+
|
2089
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update_web_asset_metadata'>update_web_asset_metadata</span><span class='lparen'>(</span><span class='id identifier rubyid_resource_id'>resource_id</span><span class='comma'>,</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
2090
|
+
<span class='id identifier rubyid_updates'>updates</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
|
2091
|
+
|
2092
|
+
<span class='id identifier rubyid_schema'>schema</span> <span class='op'>=</span> <span class='id identifier rubyid_web_asset_schema'>web_asset_schema</span>
|
2093
|
+
|
2094
|
+
<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_name'>field_name</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='op'>|</span>
|
2095
|
+
<span class='id identifier rubyid_field_id'>field_id</span> <span class='op'>=</span> <span class='kw'>case</span> <span class='id identifier rubyid_field_name'>field_name</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_downcase'>downcase</span>
|
2096
|
+
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>title</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>name</span><span class='tstring_end'>"</span></span>
|
2097
|
+
<span class='int'>8</span>
|
2098
|
+
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>keywords</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>tags</span><span class='tstring_end'>"</span></span>
|
2099
|
+
<span class='int'>12</span>
|
2100
|
+
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>asset_type</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>type</span><span class='tstring_end'>"</span></span>
|
2101
|
+
<span class='int'>51</span>
|
2102
|
+
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>usage_rights</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>rights</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>license</span><span class='tstring_end'>"</span></span>
|
2103
|
+
<span class='int'>52</span>
|
2104
|
+
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>dimensions</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>size</span><span class='tstring_end'>"</span></span>
|
2105
|
+
<span class='int'>53</span>
|
2106
|
+
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>file_size</span><span class='tstring_end'>"</span></span>
|
2107
|
+
<span class='int'>54</span>
|
2108
|
+
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>compression</span><span class='tstring_end'>"</span></span>
|
2109
|
+
<span class='int'>55</span>
|
2110
|
+
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>color_profile</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>color</span><span class='tstring_end'>"</span></span>
|
2111
|
+
<span class='int'>56</span>
|
2112
|
+
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>purpose</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>context</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>description</span><span class='tstring_end'>"</span></span>
|
2113
|
+
<span class='int'>57</span>
|
2114
|
+
<span class='kw'>else</span>
|
2115
|
+
<span class='id identifier rubyid_field_name'>field_name</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span> <span class='kw'>if</span> <span class='id identifier rubyid_field_name'>field_name</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_match?'>match?</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^\d+$</span><span class='regexp_end'>/</span></span><span class='rparen'>)</span>
|
2116
|
+
<span class='kw'>end</span>
|
2117
|
+
|
2118
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_field_id'>field_id</span>
|
2119
|
+
<span class='id identifier rubyid_update_response'>update_response</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><span class='period'>.</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='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rparen'>)</span>
|
2120
|
+
<span class='id identifier rubyid_updates'>updates</span> <span class='op'><<</span> <span class='lbrace'>{</span> <span class='label'>field_id:</span> <span class='id identifier rubyid_field_id'>field_id</span><span class='comma'>,</span> <span class='label'>field_name:</span> <span class='id identifier rubyid_field_name'>field_name</span><span class='comma'>,</span> <span class='label'>response:</span> <span class='id identifier rubyid_update_response'>update_response</span> <span class='rbrace'>}</span>
|
2121
|
+
<span class='kw'>end</span>
|
2122
|
+
<span class='kw'>end</span>
|
2123
|
+
|
2124
|
+
<span class='id identifier rubyid_updates'>updates</span>
|
2125
|
+
<span class='kw'>end</span></pre>
|
2126
|
+
</td>
|
2127
|
+
</tr>
|
2128
|
+
</table>
|
2129
|
+
</div>
|
2130
|
+
|
2131
|
+
<div class="method_details ">
|
2132
|
+
<h3 class="signature " id="web_asset_schema-instance_method">
|
2133
|
+
|
2134
|
+
#<strong>web_asset_schema</strong> ⇒ <tt>Hash</tt>
|
2135
|
+
|
2136
|
+
|
2137
|
+
|
2138
|
+
|
2139
|
+
|
2140
|
+
</h3><div class="docstring">
|
2141
|
+
<div class="discussion">
|
2142
|
+
|
2143
|
+
<p>Get metadata schema for web assets</p>
|
2144
|
+
|
2145
|
+
|
2146
|
+
</div>
|
2147
|
+
</div>
|
2148
|
+
<div class="tags">
|
2149
|
+
|
2150
|
+
<p class="tag_title">Returns:</p>
|
2151
|
+
<ul class="return">
|
2152
|
+
|
2153
|
+
<li>
|
2154
|
+
|
2155
|
+
|
2156
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
2157
|
+
|
2158
|
+
|
2159
|
+
|
2160
|
+
—
|
2161
|
+
<div class='inline'>
|
2162
|
+
<p>recommended metadata fields for web assets</p>
|
2163
|
+
</div>
|
2164
|
+
|
2165
|
+
</li>
|
2166
|
+
|
2167
|
+
</ul>
|
2168
|
+
|
2169
|
+
</div><table class="source_code">
|
2170
|
+
<tr>
|
2171
|
+
<td>
|
2172
|
+
<pre class="lines">
|
2173
|
+
|
2174
|
+
|
2175
|
+
180
|
2176
|
+
181
|
2177
|
+
182
|
2178
|
+
183
|
2179
|
+
184
|
2180
|
+
185
|
2181
|
+
186
|
2182
|
+
187
|
2183
|
+
188
|
2184
|
+
189
|
2185
|
+
190
|
2186
|
+
191
|
2187
|
+
192</pre>
|
2188
|
+
</td>
|
2189
|
+
<td>
|
2190
|
+
<pre class="code"><span class="info file"># File 'lib/resourcespace/metadata.rb', line 180</span>
|
2191
|
+
|
2192
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_web_asset_schema'>web_asset_schema</span>
|
2193
|
+
<span class='lbrace'>{</span>
|
2194
|
+
<span class='int'>8</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Title/Name</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
2195
|
+
<span class='int'>12</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Keywords/Tags</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
2196
|
+
<span class='int'>51</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Asset Type</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='comment'># Custom field for web asset type
|
2197
|
+
</span> <span class='int'>52</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Usage Rights</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='comment'># Custom field for usage/license
|
2198
|
+
</span> <span class='int'>53</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Dimensions</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='comment'># Custom field for dimensions
|
2199
|
+
</span> <span class='int'>54</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>File Size</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='comment'># Custom field for file size
|
2200
|
+
</span> <span class='int'>55</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Compression</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='comment'># Custom field for compression type
|
2201
|
+
</span> <span class='int'>56</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Color Profile</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='comment'># Custom field for color profile
|
2202
|
+
</span> <span class='int'>57</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Purpose/Context</span><span class='tstring_end'>"</span></span> <span class='comment'># Custom field for intended use
|
2203
|
+
</span> <span class='rbrace'>}</span>
|
2204
|
+
<span class='kw'>end</span></pre>
|
2205
|
+
</td>
|
2206
|
+
</tr>
|
2207
|
+
</table>
|
2208
|
+
</div>
|
2209
|
+
|
2210
|
+
</div>
|
2211
|
+
|
2212
|
+
</div>
|
2213
|
+
|
2214
|
+
<div id="footer">
|
2215
|
+
Generated on Sat May 24 15:41:24 2025 by
|
2216
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
2217
|
+
0.9.37 (ruby-3.4.4).
|
2218
|
+
</div>
|
2219
|
+
|
2220
|
+
</div>
|
2221
|
+
</body>
|
2222
|
+
</html>
|