built.io 0.4 → 0.7

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.
@@ -1,397 +0,0 @@
1
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
- <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
- <head>
5
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
- <title>
7
- Class: Built::Client
8
-
9
- &mdash; Documentation by YARD 0.8.7.2
10
-
11
- </title>
12
-
13
- <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
14
-
15
- <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
16
-
17
- <script type="text/javascript" charset="utf-8">
18
- hasFrames = window.top.frames.main ? true : false;
19
- relpath = '../';
20
- framesUrl = "../frames.html#!" + escape(window.location.href);
21
- </script>
22
-
23
-
24
- <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
25
-
26
- <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
27
-
28
-
29
- </head>
30
- <body>
31
- <div id="header">
32
- <div id="menu">
33
-
34
- <a href="../_index.html">Index (C)</a> &raquo;
35
- <span class='title'><span class='object_link'><a href="../Built.html" title="Built (module)">Built</a></span></span>
36
- &raquo;
37
- <span class="title">Client</span>
38
-
39
-
40
- <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
41
- </div>
42
-
43
- <div id="search">
44
-
45
- <a class="full_list_link" id="class_list_link"
46
- href="../class_list.html">
47
- Class List
48
- </a>
49
-
50
- <a class="full_list_link" id="method_list_link"
51
- href="../method_list.html">
52
- Method List
53
- </a>
54
-
55
- <a class="full_list_link" id="file_list_link"
56
- href="../file_list.html">
57
- File List
58
- </a>
59
-
60
- </div>
61
- <div class="clear"></div>
62
- </div>
63
-
64
- <iframe id="search_frame"></iframe>
65
-
66
- <div id="content"><h1>Class: Built::Client
67
-
68
-
69
-
70
- </h1>
71
-
72
- <dl class="box">
73
-
74
- <dt class="r1">Inherits:</dt>
75
- <dd class="r1">
76
- <span class="inheritName">Object</span>
77
-
78
- <ul class="fullTree">
79
- <li>Object</li>
80
-
81
- <li class="next">Built::Client</li>
82
-
83
- </ul>
84
- <a href="#" class="inheritanceTree">show all</a>
85
-
86
- </dd>
87
-
88
-
89
-
90
-
91
-
92
-
93
- <dt class="r2">Includes:</dt>
94
- <dd class="r2">HTTMultiParty</dd>
95
-
96
-
97
-
98
-
99
-
100
- <dt class="r1 last">Defined in:</dt>
101
- <dd class="r1 last">lib/built/client.rb</dd>
102
-
103
- </dl>
104
- <div class="clear"></div>
105
-
106
-
107
-
108
-
109
-
110
-
111
-
112
-
113
-
114
- <h2>
115
- Instance Method Summary
116
- <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
117
- </h2>
118
-
119
- <ul class="summary">
120
-
121
- <li class="public ">
122
- <span class="summary_signature">
123
-
124
- <a href="#authtoken%3D-instance_method" title="#authtoken= (instance method)">- (Object) <strong>authtoken=</strong>(authtoken) </a>
125
-
126
-
127
-
128
- </span>
129
-
130
-
131
-
132
-
133
-
134
-
135
-
136
-
137
-
138
- <span class="summary_desc"><div class='inline'>
139
- <p>set the authtoken.</p>
140
- </div></span>
141
-
142
- </li>
143
-
144
-
145
- <li class="public ">
146
- <span class="summary_signature">
147
-
148
- <a href="#initialize-instance_method" title="#initialize (instance method)">- (Client) <strong>initialize</strong>(options = {}) </a>
149
-
150
-
151
-
152
- </span>
153
-
154
-
155
- <span class="note title constructor">constructor</span>
156
-
157
-
158
-
159
-
160
-
161
-
162
-
163
-
164
- <span class="summary_desc"><div class='inline'>
165
- <p>A new instance of Client.</p>
166
- </div></span>
167
-
168
- </li>
169
-
170
-
171
- <li class="public ">
172
- <span class="summary_signature">
173
-
174
- <a href="#request-instance_method" title="#request (instance method)">- (Object) <strong>request</strong>(uri, method = :get, body = nil, query = nil, additionalHeaders = {}) </a>
175
-
176
-
177
-
178
- </span>
179
-
180
-
181
-
182
-
183
-
184
-
185
-
186
-
187
-
188
- <span class="summary_desc"><div class='inline'>
189
- <p>perform a regular request.</p>
190
- </div></span>
191
-
192
- </li>
193
-
194
-
195
- </ul>
196
-
197
-
198
-
199
- <div id="constructor_details" class="method_details_list">
200
- <h2>Constructor Details</h2>
201
-
202
- <div class="method_details first">
203
- <h3 class="signature first" id="initialize-instance_method">
204
-
205
- - (<tt><span class='object_link'><a href="" title="Built::Client (class)">Client</a></span></tt>) <strong>initialize</strong>(options = {})
206
-
207
-
208
-
209
-
210
-
211
- </h3><div class="docstring">
212
- <div class="discussion">
213
-
214
- <p>Returns a new instance of Client</p>
215
-
216
-
217
- </div>
218
- </div>
219
- <div class="tags">
220
-
221
-
222
- </div><table class="source_code">
223
- <tr>
224
- <td>
225
- <pre class="lines">
226
-
227
-
228
- 5
229
- 6
230
- 7
231
- 8
232
- 9
233
- 10
234
- 11
235
- 12
236
- 13
237
- 14</pre>
238
- </td>
239
- <td>
240
- <pre class="code"><span class="info file"># File 'lib/built/client.rb', line 5</span>
241
-
242
- <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
243
- <span class='ivar'>@api_key</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:application_api_key</span><span class='rbracket'>]</span>
244
- <span class='ivar'>@master_key</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:master_key</span><span class='rbracket'>]</span>
245
- <span class='ivar'>@host</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:host</span><span class='rbracket'>]</span>
246
- <span class='ivar'>@version</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:version</span><span class='rbracket'>]</span>
247
- <span class='ivar'>@authtoken</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:authtoken</span><span class='rbracket'>]</span>
248
-
249
- <span class='comment'># set the base uri
250
- </span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_base_uri'>base_uri</span> <span class='ivar'>@version</span> <span class='op'>?</span> <span class='lbracket'>[</span><span class='ivar'>@host</span><span class='comma'>,</span> <span class='ivar'>@version</span><span class='rbracket'>]</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> <span class='op'>:</span> <span class='ivar'>@host</span>
251
- <span class='kw'>end</span></pre>
252
- </td>
253
- </tr>
254
- </table>
255
- </div>
256
-
257
- </div>
258
-
259
-
260
- <div id="instance_method_details" class="method_details_list">
261
- <h2>Instance Method Details</h2>
262
-
263
-
264
- <div class="method_details first">
265
- <h3 class="signature first" id="authtoken=-instance_method">
266
-
267
- - (<tt><span class='object_link'><a href="Object.html" title="Built::Object (class)">Object</a></span></tt>) <strong>authtoken=</strong>(authtoken)
268
-
269
-
270
-
271
-
272
-
273
- </h3><div class="docstring">
274
- <div class="discussion">
275
-
276
- <p>set the authtoken</p>
277
-
278
-
279
- </div>
280
- </div>
281
- <div class="tags">
282
-
283
-
284
- </div><table class="source_code">
285
- <tr>
286
- <td>
287
- <pre class="lines">
288
-
289
-
290
- 17
291
- 18
292
- 19</pre>
293
- </td>
294
- <td>
295
- <pre class="code"><span class="info file"># File 'lib/built/client.rb', line 17</span>
296
-
297
- <span class='kw'>def</span> <span class='id identifier rubyid_authtoken='>authtoken=</span><span class='lparen'>(</span><span class='id identifier rubyid_authtoken'>authtoken</span><span class='rparen'>)</span>
298
- <span class='ivar'>@authtoken</span> <span class='op'>=</span> <span class='id identifier rubyid_authtoken'>authtoken</span>
299
- <span class='kw'>end</span></pre>
300
- </td>
301
- </tr>
302
- </table>
303
- </div>
304
-
305
- <div class="method_details ">
306
- <h3 class="signature " id="request-instance_method">
307
-
308
- - (<tt><span class='object_link'><a href="Object.html" title="Built::Object (class)">Object</a></span></tt>) <strong>request</strong>(uri, method = :get, body = nil, query = nil, additionalHeaders = {})
309
-
310
-
311
-
312
-
313
-
314
- </h3><div class="docstring">
315
- <div class="discussion">
316
-
317
- <p>perform a regular request</p>
318
-
319
-
320
- </div>
321
- </div>
322
- <div class="tags">
323
-
324
-
325
- </div><table class="source_code">
326
- <tr>
327
- <td>
328
- <pre class="lines">
329
-
330
-
331
- 22
332
- 23
333
- 24
334
- 25
335
- 26
336
- 27
337
- 28
338
- 29
339
- 30
340
- 31
341
- 32
342
- 33
343
- 34
344
- 35
345
- 36
346
- 37
347
- 38
348
- 39
349
- 40
350
- 41
351
- 42
352
- 43
353
- 44</pre>
354
- </td>
355
- <td>
356
- <pre class="code"><span class="info file"># File 'lib/built/client.rb', line 22</span>
357
-
358
- <span class='kw'>def</span> <span class='id identifier rubyid_request'>request</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='comma'>,</span> <span class='id identifier rubyid_method'>method</span><span class='op'>=</span><span class='symbol'>:get</span><span class='comma'>,</span> <span class='id identifier rubyid_body'>body</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_query'>query</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_additionalHeaders'>additionalHeaders</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
359
- <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
360
- <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:query</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_query'>query</span> <span class='kw'>if</span> <span class='id identifier rubyid_query'>query</span>
361
- <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:body</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_body'>body</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span> <span class='kw'>if</span> <span class='id identifier rubyid_body'>body</span>
362
-
363
- <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:headers</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='lbrace'>{</span>
364
- <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>application_api_key</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='ivar'>@api_key</span><span class='comma'>,</span>
365
- <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Content-Type</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>application/json</span><span class='tstring_end'>&quot;</span></span>
366
- <span class='rbrace'>}</span>
367
-
368
- <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:headers</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='symbol'>:authtoken</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@authtoken</span> <span class='kw'>if</span> <span class='ivar'>@authtoken</span>
369
- <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:headers</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='symbol'>:master_key</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@master_key</span> <span class='kw'>if</span> <span class='ivar'>@master_key</span>
370
- <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:headers</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='id identifier rubyid_additionalHeaders'>additionalHeaders</span><span class='rparen'>)</span>
371
-
372
- <span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='id identifier rubyid_method'>method</span><span class='comma'>,</span> <span class='id identifier rubyid_uri'>uri</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
373
-
374
- <span class='kw'>if</span> <span class='op'>!</span><span class='lbracket'>[</span><span class='int'>200</span><span class='comma'>,</span> <span class='int'>201</span><span class='comma'>,</span> <span class='int'>204</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_code'>code</span><span class='rparen'>)</span>
375
- <span class='comment'># error, throw it
376
- </span> <span class='id identifier rubyid_raise'>raise</span> <span class='const'>BuiltAPIError</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_parsed_response'>parsed_response</span><span class='rparen'>)</span>
377
- <span class='kw'>end</span>
378
-
379
- <span class='id identifier rubyid_response'>response</span>
380
- <span class='kw'>end</span></pre>
381
- </td>
382
- </tr>
383
- </table>
384
- </div>
385
-
386
- </div>
387
-
388
- </div>
389
-
390
- <div id="footer">
391
- Generated on Mon Mar 24 18:29:44 2014 by
392
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
393
- 0.8.7.2 (ruby-1.9.3).
394
- </div>
395
-
396
- </body>
397
- </html>
@@ -1,1128 +0,0 @@
1
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
- <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
- <head>
5
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
- <title>
7
- Class: Built::Object
8
-
9
- &mdash; Documentation by YARD 0.8.7.2
10
-
11
- </title>
12
-
13
- <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
14
-
15
- <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
16
-
17
- <script type="text/javascript" charset="utf-8">
18
- hasFrames = window.top.frames.main ? true : false;
19
- relpath = '../';
20
- framesUrl = "../frames.html#!" + escape(window.location.href);
21
- </script>
22
-
23
-
24
- <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
25
-
26
- <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
27
-
28
-
29
- </head>
30
- <body>
31
- <div id="header">
32
- <div id="menu">
33
-
34
- <a href="../_index.html">Index (O)</a> &raquo;
35
- <span class='title'><span class='object_link'><a href="../Built.html" title="Built (module)">Built</a></span></span>
36
- &raquo;
37
- <span class="title">Object</span>
38
-
39
-
40
- <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
41
- </div>
42
-
43
- <div id="search">
44
-
45
- <a class="full_list_link" id="class_list_link"
46
- href="../class_list.html">
47
- Class List
48
- </a>
49
-
50
- <a class="full_list_link" id="method_list_link"
51
- href="../method_list.html">
52
- Method List
53
- </a>
54
-
55
- <a class="full_list_link" id="file_list_link"
56
- href="../file_list.html">
57
- File List
58
- </a>
59
-
60
- </div>
61
- <div class="clear"></div>
62
- </div>
63
-
64
- <iframe id="search_frame"></iframe>
65
-
66
- <div id="content"><h1>Class: Built::Object
67
-
68
-
69
-
70
- </h1>
71
-
72
- <dl class="box">
73
-
74
- <dt class="r1">Inherits:</dt>
75
- <dd class="r1">
76
- <span class="inheritName">Hash</span>
77
-
78
- <ul class="fullTree">
79
- <li>Object</li>
80
-
81
- <li class="next">Hash</li>
82
-
83
- <li class="next">Built::Object</li>
84
-
85
- </ul>
86
- <a href="#" class="inheritanceTree">show all</a>
87
-
88
- </dd>
89
-
90
-
91
-
92
-
93
-
94
-
95
- <dt class="r2">Includes:</dt>
96
- <dd class="r2"><span class='object_link'><a href="Timestamps.html" title="Built::Timestamps (module)">Timestamps</a></span></dd>
97
-
98
-
99
-
100
-
101
-
102
- <dt class="r1 last">Defined in:</dt>
103
- <dd class="r1 last">lib/built/object.rb</dd>
104
-
105
- </dl>
106
- <div class="clear"></div>
107
-
108
- <h2>Overview</h2><div class="docstring">
109
- <div class="discussion">
110
-
111
- <p>Built::Object is the unit of data in built.io</p>
112
-
113
-
114
- </div>
115
- </div>
116
- <div class="tags">
117
-
118
-
119
- </div>
120
-
121
-
122
-
123
-
124
-
125
-
126
-
127
- <h2>
128
- Class Method Summary
129
- <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
130
- </h2>
131
-
132
- <ul class="summary">
133
-
134
- <li class="public ">
135
- <span class="summary_signature">
136
-
137
- <a href="#uri-class_method" title="uri (class method)">+ (Object) <strong>uri</strong>(class_uid) </a>
138
-
139
-
140
-
141
- </span>
142
-
143
-
144
-
145
-
146
-
147
-
148
- <span class="private note title">private</span>
149
-
150
-
151
- <span class="summary_desc"><div class='inline'></div></span>
152
-
153
- </li>
154
-
155
-
156
- </ul>
157
-
158
- <h2>
159
- Instance Method Summary
160
- <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
161
- </h2>
162
-
163
- <ul class="summary">
164
-
165
- <li class="public ">
166
- <span class="summary_signature">
167
-
168
- <a href="#destroy-instance_method" title="#destroy (instance method)">- (Object) <strong>destroy</strong> </a>
169
-
170
-
171
-
172
- </span>
173
-
174
-
175
-
176
-
177
-
178
-
179
-
180
-
181
-
182
- <span class="summary_desc"><div class='inline'>
183
- <p>Delete this object.</p>
184
- </div></span>
185
-
186
- </li>
187
-
188
-
189
- <li class="public ">
190
- <span class="summary_signature">
191
-
192
- <a href="#fetch-instance_method" title="#fetch (instance method)">- (Object) <strong>fetch</strong> </a>
193
-
194
-
195
-
196
- </span>
197
-
198
-
199
-
200
-
201
-
202
-
203
-
204
-
205
-
206
- <span class="summary_desc"><div class='inline'>
207
- <p>Fetch the latest instance of this object from built.</p>
208
- </div></span>
209
-
210
- </li>
211
-
212
-
213
- <li class="public ">
214
- <span class="summary_signature">
215
-
216
- <a href="#get_class-instance_method" title="#get_class (instance method)">- (Class) <strong>get_class</strong> </a>
217
-
218
-
219
-
220
- </span>
221
-
222
-
223
-
224
-
225
-
226
-
227
-
228
-
229
-
230
- <span class="summary_desc"><div class='inline'>
231
- <p>Get the class in which this object belongs.</p>
232
- </div></span>
233
-
234
- </li>
235
-
236
-
237
- <li class="public ">
238
- <span class="summary_signature">
239
-
240
- <a href="#initialize-instance_method" title="#initialize (instance method)">- (Object) <strong>initialize</strong>(class_uid, data = nil) </a>
241
-
242
-
243
-
244
- </span>
245
-
246
-
247
- <span class="note title constructor">constructor</span>
248
-
249
-
250
-
251
-
252
-
253
-
254
-
255
-
256
- <span class="summary_desc"><div class='inline'>
257
- <p>Initialize a new object.</p>
258
- </div></span>
259
-
260
- </li>
261
-
262
-
263
- <li class="public ">
264
- <span class="summary_signature">
265
-
266
- <a href="#is_new%3F-instance_method" title="#is_new? (instance method)">- (Boolean) <strong>is_new?</strong> </a>
267
-
268
-
269
-
270
- </span>
271
-
272
-
273
-
274
-
275
-
276
-
277
-
278
-
279
-
280
- <span class="summary_desc"><div class='inline'>
281
- <p>Is this a new, unsaved object?.</p>
282
- </div></span>
283
-
284
- </li>
285
-
286
-
287
- <li class="public ">
288
- <span class="summary_signature">
289
-
290
- <a href="#save-instance_method" title="#save (instance method)">- (Object) <strong>save</strong>(options = {}) </a>
291
-
292
-
293
-
294
- </span>
295
-
296
-
297
-
298
-
299
-
300
-
301
-
302
-
303
-
304
- <span class="summary_desc"><div class='inline'>
305
- <p>Save / persist the object to built.io.</p>
306
- </div></span>
307
-
308
- </li>
309
-
310
-
311
- <li class="public ">
312
- <span class="summary_signature">
313
-
314
- <a href="#uid-instance_method" title="#uid (instance method)">- (Object) <strong>uid</strong> </a>
315
-
316
-
317
-
318
- </span>
319
-
320
-
321
-
322
-
323
-
324
-
325
-
326
-
327
-
328
- <span class="summary_desc"><div class='inline'>
329
- <p>Get the uid for this object.</p>
330
- </div></span>
331
-
332
- </li>
333
-
334
-
335
- <li class="public ">
336
- <span class="summary_signature">
337
-
338
- <a href="#uid%3D-instance_method" title="#uid= (instance method)">- (Object) <strong>uid=</strong>(uid) </a>
339
-
340
-
341
-
342
- </span>
343
-
344
-
345
-
346
-
347
-
348
-
349
-
350
-
351
-
352
- <span class="summary_desc"><div class='inline'>
353
- <p>Set the uid for this object.</p>
354
- </div></span>
355
-
356
- </li>
357
-
358
-
359
- </ul>
360
-
361
-
362
-
363
-
364
-
365
-
366
-
367
-
368
-
369
-
370
-
371
- <h3 class="inherited">Methods included from <span class='object_link'><a href="Timestamps.html" title="Built::Timestamps (module)">Timestamps</a></span></h3>
372
- <p class="inherited"><span class='object_link'><a href="Timestamps.html#created_at-instance_method" title="Built::Timestamps#created_at (method)">#created_at</a></span>, <span class='object_link'><a href="Timestamps.html#deleted_at-instance_method" title="Built::Timestamps#deleted_at (method)">#deleted_at</a></span>, <span class='object_link'><a href="Timestamps.html#updated_at-instance_method" title="Built::Timestamps#updated_at (method)">#updated_at</a></span></p>
373
-
374
- <div id="constructor_details" class="method_details_list">
375
- <h2>Constructor Details</h2>
376
-
377
- <div class="method_details first">
378
- <h3 class="signature first" id="initialize-instance_method">
379
-
380
- - (<tt><span class='object_link'><a href="" title="Built::Object (class)">Object</a></span></tt>) <strong>initialize</strong>(class_uid, data = nil)
381
-
382
-
383
-
384
-
385
-
386
- </h3><div class="docstring">
387
- <div class="discussion">
388
-
389
- <p>Initialize a new object</p>
390
-
391
-
392
- </div>
393
- </div>
394
- <div class="tags">
395
- <p class="tag_title">Parameters:</p>
396
- <ul class="param">
397
-
398
- <li>
399
-
400
- <span class='name'>class_uid</span>
401
-
402
-
403
- <span class='type'>(<tt>String</tt>)</span>
404
-
405
-
406
-
407
- &mdash;
408
- <div class='inline'>
409
- <p>The uid of the class to which this object belongs</p>
410
- </div>
411
-
412
- </li>
413
-
414
- <li>
415
-
416
- <span class='name'>data</span>
417
-
418
-
419
- <span class='type'>(<tt>Hash</tt>)</span>
420
-
421
-
422
- <em class="default">(defaults to: <tt>nil</tt>)</em>
423
-
424
-
425
- &mdash;
426
- <div class='inline'>
427
- <p>Data to initialize the object with</p>
428
- </div>
429
-
430
- </li>
431
-
432
- </ul>
433
-
434
-
435
- </div><table class="source_code">
436
- <tr>
437
- <td>
438
- <pre class="lines">
439
-
440
-
441
- 96
442
- 97
443
- 98
444
- 99
445
- 100
446
- 101
447
- 102
448
- 103
449
- 104
450
- 105
451
- 106
452
- 107
453
- 108</pre>
454
- </td>
455
- <td>
456
- <pre class="code"><span class="info file"># File 'lib/built/object.rb', line 96</span>
457
-
458
- <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_class_uid'>class_uid</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
459
- <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_class_uid'>class_uid</span>
460
- <span class='id identifier rubyid_raise'>raise</span> <span class='const'>BuiltError</span><span class='comma'>,</span> <span class='const'>I18n</span><span class='period'>.</span><span class='id identifier rubyid_t'>t</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>objects.class_uid</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
461
- <span class='kw'>end</span>
462
-
463
- <span class='ivar'>@class_uid</span> <span class='op'>=</span> <span class='id identifier rubyid_class_uid'>class_uid</span>
464
-
465
- <span class='kw'>if</span> <span class='id identifier rubyid_data'>data</span>
466
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
467
- <span class='kw'>end</span>
468
-
469
- <span class='kw'>self</span>
470
- <span class='kw'>end</span></pre>
471
- </td>
472
- </tr>
473
- </table>
474
- </div>
475
-
476
- </div>
477
-
478
-
479
- <div id="class_method_details" class="method_details_list">
480
- <h2>Class Method Details</h2>
481
-
482
-
483
- <div class="method_details first">
484
- <h3 class="signature first" id="uri-class_method">
485
-
486
- + (<tt><span class='object_link'><a href="" title="Built::Object (class)">Object</a></span></tt>) <strong>uri</strong>(class_uid)
487
-
488
-
489
-
490
-
491
-
492
- </h3><div class="docstring">
493
- <div class="discussion">
494
- <p class="note private">
495
- <strong>This method is part of a private API.</strong>
496
- You should avoid using this method if possible, as it may be removed or be changed in the future.
497
- </p>
498
-
499
-
500
- </div>
501
- </div>
502
- <div class="tags">
503
-
504
-
505
- </div><table class="source_code">
506
- <tr>
507
- <td>
508
- <pre class="lines">
509
-
510
-
511
- 130
512
- 131
513
- 132
514
- 133
515
- 134</pre>
516
- </td>
517
- <td>
518
- <pre class="code"><span class="info file"># File 'lib/built/object.rb', line 130</span>
519
-
520
- <span class='kw'>def</span> <span class='id identifier rubyid_uri'>uri</span><span class='lparen'>(</span><span class='id identifier rubyid_class_uid'>class_uid</span><span class='rparen'>)</span>
521
- <span class='id identifier rubyid_class_uri'>class_uri</span> <span class='op'>=</span> <span class='const'>Built</span><span class='op'>::</span><span class='const'>Class</span><span class='period'>.</span><span class='id identifier rubyid_uri'>uri</span><span class='lparen'>(</span><span class='id identifier rubyid_class_uid'>class_uid</span><span class='rparen'>)</span>
522
-
523
- <span class='lbracket'>[</span><span class='id identifier rubyid_class_uri'>class_uri</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>objects</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
524
- <span class='kw'>end</span></pre>
525
- </td>
526
- </tr>
527
- </table>
528
- </div>
529
-
530
- </div>
531
-
532
- <div id="instance_method_details" class="method_details_list">
533
- <h2>Instance Method Details</h2>
534
-
535
-
536
- <div class="method_details first">
537
- <h3 class="signature first" id="destroy-instance_method">
538
-
539
- - (<tt><span class='object_link'><a href="" title="Built::Object (class)">Object</a></span></tt>) <strong>destroy</strong>
540
-
541
-
542
-
543
-
544
-
545
- </h3><div class="docstring">
546
- <div class="discussion">
547
-
548
- <p>Delete this object</p>
549
-
550
-
551
- </div>
552
- </div>
553
- <div class="tags">
554
-
555
- <p class="tag_title">Returns:</p>
556
- <ul class="return">
557
-
558
- <li>
559
-
560
-
561
- <span class='type'>(<tt><span class='object_link'><a href="" title="Built::Object (class)">Object</a></span></tt>)</span>
562
-
563
-
564
-
565
- &mdash;
566
- <div class='inline'>
567
- <p>self</p>
568
- </div>
569
-
570
- </li>
571
-
572
- </ul>
573
- <p class="tag_title">Raises:</p>
574
- <ul class="raise">
575
-
576
- <li>
577
-
578
-
579
- <span class='type'></span>
580
-
581
-
582
-
583
-
584
- <div class='inline'>
585
- <p>BuiltError If the uid is not set</p>
586
- </div>
587
-
588
- </li>
589
-
590
- </ul>
591
-
592
- </div><table class="source_code">
593
- <tr>
594
- <td>
595
- <pre class="lines">
596
-
597
-
598
- 67
599
- 68
600
- 69
601
- 70
602
- 71
603
- 72
604
- 73
605
- 74
606
- 75
607
- 76
608
- 77
609
- 78</pre>
610
- </td>
611
- <td>
612
- <pre class="code"><span class="info file"># File 'lib/built/object.rb', line 67</span>
613
-
614
- <span class='kw'>def</span> <span class='id identifier rubyid_destroy'>destroy</span>
615
- <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_uid'>uid</span>
616
- <span class='comment'># uid is not set
617
- </span> <span class='id identifier rubyid_raise'>raise</span> <span class='const'>BuiltError</span><span class='comma'>,</span> <span class='const'>I18n</span><span class='period'>.</span><span class='id identifier rubyid_t'>t</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>objects.uid_not_set</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
618
- <span class='kw'>end</span>
619
-
620
- <span class='const'>Built</span><span class='period'>.</span><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_request'>request</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='comma'>,</span> <span class='symbol'>:delete</span><span class='rparen'>)</span>
621
-
622
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_clear'>clear</span>
623
-
624
- <span class='kw'>self</span>
625
- <span class='kw'>end</span></pre>
626
- </td>
627
- </tr>
628
- </table>
629
- </div>
630
-
631
- <div class="method_details ">
632
- <h3 class="signature " id="fetch-instance_method">
633
-
634
- - (<tt><span class='object_link'><a href="" title="Built::Object (class)">Object</a></span></tt>) <strong>fetch</strong>
635
-
636
-
637
-
638
-
639
-
640
- </h3><div class="docstring">
641
- <div class="discussion">
642
-
643
- <p>Fetch the latest instance of this object from built</p>
644
-
645
-
646
- </div>
647
- </div>
648
- <div class="tags">
649
-
650
- <p class="tag_title">Returns:</p>
651
- <ul class="return">
652
-
653
- <li>
654
-
655
-
656
- <span class='type'>(<tt><span class='object_link'><a href="" title="Built::Object (class)">Object</a></span></tt>)</span>
657
-
658
-
659
-
660
- &mdash;
661
- <div class='inline'>
662
- <p>self</p>
663
- </div>
664
-
665
- </li>
666
-
667
- </ul>
668
- <p class="tag_title">Raises:</p>
669
- <ul class="raise">
670
-
671
- <li>
672
-
673
-
674
- <span class='type'></span>
675
-
676
-
677
-
678
-
679
- <div class='inline'>
680
- <p>BuiltError If the uid is not set</p>
681
- </div>
682
-
683
- </li>
684
-
685
- </ul>
686
-
687
- </div><table class="source_code">
688
- <tr>
689
- <td>
690
- <pre class="lines">
691
-
692
-
693
- 20
694
- 21
695
- 22
696
- 23
697
- 24
698
- 25
699
- 26
700
- 27
701
- 28
702
- 29
703
- 30
704
- 31
705
- 32</pre>
706
- </td>
707
- <td>
708
- <pre class="code"><span class="info file"># File 'lib/built/object.rb', line 20</span>
709
-
710
- <span class='kw'>def</span> <span class='id identifier rubyid_fetch'>fetch</span>
711
- <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_uid'>uid</span>
712
- <span class='comment'># uid is not set
713
- </span> <span class='id identifier rubyid_raise'>raise</span> <span class='const'>BuiltError</span><span class='comma'>,</span> <span class='const'>I18n</span><span class='period'>.</span><span class='id identifier rubyid_t'>t</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>objects.uid_not_set</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
714
- <span class='kw'>end</span>
715
-
716
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span>
717
- <span class='const'>Built</span><span class='period'>.</span><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_request'>request</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='rparen'>)</span><span class='period'>
718
- </span><span class='id identifier rubyid_ .parsed_response'> .parsed_response</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>object</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
719
- <span class='rparen'>)</span>
720
-
721
- <span class='kw'>self</span>
722
- <span class='kw'>end</span></pre>
723
- </td>
724
- </tr>
725
- </table>
726
- </div>
727
-
728
- <div class="method_details ">
729
- <h3 class="signature " id="get_class-instance_method">
730
-
731
- - (<tt><span class='object_link'><a href="Class.html" title="Built::Class (class)">Class</a></span></tt>) <strong>get_class</strong>
732
-
733
-
734
-
735
-
736
-
737
- </h3><div class="docstring">
738
- <div class="discussion">
739
-
740
- <p>Get the class in which this object belongs</p>
741
-
742
-
743
- </div>
744
- </div>
745
- <div class="tags">
746
-
747
- <p class="tag_title">Returns:</p>
748
- <ul class="return">
749
-
750
- <li>
751
-
752
-
753
- <span class='type'>(<tt><span class='object_link'><a href="Class.html" title="Built::Class (class)">Class</a></span></tt>)</span>
754
-
755
-
756
-
757
- &mdash;
758
- <div class='inline'>
759
- <p>class</p>
760
- </div>
761
-
762
- </li>
763
-
764
- </ul>
765
-
766
- </div><table class="source_code">
767
- <tr>
768
- <td>
769
- <pre class="lines">
770
-
771
-
772
- 82
773
- 83
774
- 84</pre>
775
- </td>
776
- <td>
777
- <pre class="code"><span class="info file"># File 'lib/built/object.rb', line 82</span>
778
-
779
- <span class='kw'>def</span> <span class='id identifier rubyid_get_class'>get_class</span>
780
- <span class='const'>Built</span><span class='op'>::</span><span class='const'>Class</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='ivar'>@class_uid</span><span class='rparen'>)</span>
781
- <span class='kw'>end</span></pre>
782
- </td>
783
- </tr>
784
- </table>
785
- </div>
786
-
787
- <div class="method_details ">
788
- <h3 class="signature " id="is_new?-instance_method">
789
-
790
- - (<tt>Boolean</tt>) <strong>is_new?</strong>
791
-
792
-
793
-
794
-
795
-
796
- </h3><div class="docstring">
797
- <div class="discussion">
798
-
799
- <p>Is this a new, unsaved object?</p>
800
-
801
-
802
- </div>
803
- </div>
804
- <div class="tags">
805
-
806
- <p class="tag_title">Returns:</p>
807
- <ul class="return">
808
-
809
- <li>
810
-
811
-
812
- <span class='type'>(<tt>Boolean</tt>)</span>
813
-
814
-
815
-
816
- </li>
817
-
818
- </ul>
819
-
820
- </div><table class="source_code">
821
- <tr>
822
- <td>
823
- <pre class="lines">
824
-
825
-
826
- 89
827
- 90
828
- 91</pre>
829
- </td>
830
- <td>
831
- <pre class="code"><span class="info file"># File 'lib/built/object.rb', line 89</span>
832
-
833
- <span class='kw'>def</span> <span class='id identifier rubyid_is_new?'>is_new?</span>
834
- <span class='const'>Util</span><span class='period'>.</span><span class='id identifier rubyid_blank?'>blank?</span><span class='lparen'>(</span><span class='kw'>self</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>uid</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
835
- <span class='kw'>end</span></pre>
836
- </td>
837
- </tr>
838
- </table>
839
- </div>
840
-
841
- <div class="method_details ">
842
- <h3 class="signature " id="save-instance_method">
843
-
844
- - (<tt><span class='object_link'><a href="" title="Built::Object (class)">Object</a></span></tt>) <strong>save</strong>(options = {})
845
-
846
-
847
-
848
-
849
-
850
- </h3><div class="docstring">
851
- <div class="discussion">
852
-
853
- <p>Save / persist the object to built.io</p>
854
-
855
-
856
- </div>
857
- </div>
858
- <div class="tags">
859
- <p class="tag_title">Parameters:</p>
860
- <ul class="param">
861
-
862
- <li>
863
-
864
- <span class='name'>options</span>
865
-
866
-
867
- <span class='type'>(<tt>Hash</tt>)</span>
868
-
869
-
870
- <em class="default">(defaults to: <tt>{}</tt>)</em>
871
-
872
-
873
- &mdash;
874
- <div class='inline'>
875
- <p>Options</p>
876
- </div>
877
-
878
- </li>
879
-
880
- </ul>
881
-
882
-
883
-
884
-
885
- <p class="tag_title">Options Hash (<tt>options</tt>):</p>
886
- <ul class="option">
887
-
888
- <li>
889
- <span class="name">:timeless</span>
890
- <span class="type">(<tt>Boolean</tt>)</span>
891
- <span class="default">
892
-
893
- </span>
894
-
895
- &mdash; <div class='inline'>
896
- <p>Perform a timeless update</p>
897
- </div>
898
-
899
- </li>
900
-
901
- <li>
902
- <span class="name">:draft</span>
903
- <span class="type">(<tt>Boolean</tt>)</span>
904
- <span class="default">
905
-
906
- </span>
907
-
908
- &mdash; <div class='inline'>
909
- <p>Save the object as draft</p>
910
- </div>
911
-
912
- </li>
913
-
914
- </ul>
915
-
916
-
917
- <p class="tag_title">Returns:</p>
918
- <ul class="return">
919
-
920
- <li>
921
-
922
-
923
- <span class='type'>(<tt><span class='object_link'><a href="" title="Built::Object (class)">Object</a></span></tt>)</span>
924
-
925
-
926
-
927
- &mdash;
928
- <div class='inline'>
929
- <p>self</p>
930
- </div>
931
-
932
- </li>
933
-
934
- </ul>
935
- <p class="tag_title">Raises:</p>
936
- <ul class="raise">
937
-
938
- <li>
939
-
940
-
941
- <span class='type'></span>
942
-
943
-
944
-
945
-
946
- <div class='inline'>
947
- <p>BuiltAPIError</p>
948
- </div>
949
-
950
- </li>
951
-
952
- </ul>
953
-
954
- </div><table class="source_code">
955
- <tr>
956
- <td>
957
- <pre class="lines">
958
-
959
-
960
- 40
961
- 41
962
- 42
963
- 43
964
- 44
965
- 45
966
- 46
967
- 47
968
- 48
969
- 49
970
- 50
971
- 51
972
- 52
973
- 53
974
- 54
975
- 55
976
- 56
977
- 57
978
- 58
979
- 59
980
- 60
981
- 61
982
- 62</pre>
983
- </td>
984
- <td>
985
- <pre class="code"><span class="info file"># File 'lib/built/object.rb', line 40</span>
986
-
987
- <span class='kw'>def</span> <span class='id identifier rubyid_save'>save</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
988
- <span class='kw'>if</span> <span class='id identifier rubyid_is_new?'>is_new?</span>
989
- <span class='comment'># create
990
- </span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span>
991
- <span class='const'>Built</span><span class='period'>.</span><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_request'>request</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='comma'>,</span> <span class='symbol'>:post</span><span class='comma'>,</span> <span class='id identifier rubyid_wrap'>wrap</span><span class='rparen'>)</span><span class='period'>
992
- </span><span class='id identifier rubyid_ .parsed_response'> .parsed_response</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>object</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
993
- <span class='rparen'>)</span>
994
- <span class='kw'>else</span>
995
- <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
996
-
997
- <span class='id identifier rubyid_headers'>headers</span><span class='lbracket'>[</span><span class='symbol'>:timeless</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='kw'>true</span> <span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:timeless</span><span class='rbracket'>]</span>
998
-
999
- <span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:draft</span><span class='rbracket'>]</span>
1000
- <span class='kw'>self</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>published</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='kw'>false</span>
1001
- <span class='kw'>end</span>
1002
-
1003
- <span class='comment'># update
1004
- </span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span>
1005
- <span class='const'>Built</span><span class='period'>.</span><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_request'>request</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='comma'>,</span> <span class='symbol'>:put</span><span class='comma'>,</span> <span class='id identifier rubyid_wrap'>wrap</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span><span class='period'>
1006
- </span><span class='id identifier rubyid_ .parsed_response'> .parsed_response</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>object</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
1007
- <span class='rparen'>)</span>
1008
- <span class='kw'>end</span>
1009
- <span class='kw'>end</span></pre>
1010
- </td>
1011
- </tr>
1012
- </table>
1013
- </div>
1014
-
1015
- <div class="method_details ">
1016
- <h3 class="signature " id="uid-instance_method">
1017
-
1018
- - (<tt><span class='object_link'><a href="" title="Built::Object (class)">Object</a></span></tt>) <strong>uid</strong>
1019
-
1020
-
1021
-
1022
-
1023
-
1024
- </h3><div class="docstring">
1025
- <div class="discussion">
1026
-
1027
- <p>Get the uid for this object</p>
1028
-
1029
-
1030
- </div>
1031
- </div>
1032
- <div class="tags">
1033
-
1034
-
1035
- </div><table class="source_code">
1036
- <tr>
1037
- <td>
1038
- <pre class="lines">
1039
-
1040
-
1041
- 7
1042
- 8
1043
- 9</pre>
1044
- </td>
1045
- <td>
1046
- <pre class="code"><span class="info file"># File 'lib/built/object.rb', line 7</span>
1047
-
1048
- <span class='kw'>def</span> <span class='id identifier rubyid_uid'>uid</span>
1049
- <span class='kw'>self</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>uid</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
1050
- <span class='kw'>end</span></pre>
1051
- </td>
1052
- </tr>
1053
- </table>
1054
- </div>
1055
-
1056
- <div class="method_details ">
1057
- <h3 class="signature " id="uid=-instance_method">
1058
-
1059
- - (<tt><span class='object_link'><a href="" title="Built::Object (class)">Object</a></span></tt>) <strong>uid=</strong>(uid)
1060
-
1061
-
1062
-
1063
-
1064
-
1065
- </h3><div class="docstring">
1066
- <div class="discussion">
1067
-
1068
- <p>Set the uid for this object</p>
1069
-
1070
-
1071
- </div>
1072
- </div>
1073
- <div class="tags">
1074
- <p class="tag_title">Parameters:</p>
1075
- <ul class="param">
1076
-
1077
- <li>
1078
-
1079
- <span class='name'>uid</span>
1080
-
1081
-
1082
- <span class='type'>(<tt>String</tt>)</span>
1083
-
1084
-
1085
-
1086
- &mdash;
1087
- <div class='inline'>
1088
- <p>A valid object uid</p>
1089
- </div>
1090
-
1091
- </li>
1092
-
1093
- </ul>
1094
-
1095
-
1096
- </div><table class="source_code">
1097
- <tr>
1098
- <td>
1099
- <pre class="lines">
1100
-
1101
-
1102
- 13
1103
- 14
1104
- 15</pre>
1105
- </td>
1106
- <td>
1107
- <pre class="code"><span class="info file"># File 'lib/built/object.rb', line 13</span>
1108
-
1109
- <span class='kw'>def</span> <span class='id identifier rubyid_uid='>uid=</span><span class='lparen'>(</span><span class='id identifier rubyid_uid'>uid</span><span class='rparen'>)</span>
1110
- <span class='kw'>self</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>uid</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_uid'>uid</span>
1111
- <span class='kw'>end</span></pre>
1112
- </td>
1113
- </tr>
1114
- </table>
1115
- </div>
1116
-
1117
- </div>
1118
-
1119
- </div>
1120
-
1121
- <div id="footer">
1122
- Generated on Mon Mar 24 18:29:44 2014 by
1123
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1124
- 0.8.7.2 (ruby-1.9.3).
1125
- </div>
1126
-
1127
- </body>
1128
- </html>