basecamp3 0.1.3
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 +7 -0
- data/.gitignore +12 -0
- data/.rspec +2 -0
- data/.travis.yml +5 -0
- data/Gemfile +2 -0
- data/LICENSE.txt +21 -0
- data/README.md +65 -0
- data/Rakefile +6 -0
- data/basecamp3.gemspec +38 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/docs/Basecamp3.html +367 -0
- data/docs/Basecamp3/Campfire.html +901 -0
- data/docs/Basecamp3/CampfireLine.html +1025 -0
- data/docs/Basecamp3/Comment.html +1284 -0
- data/docs/Basecamp3/Concerns.html +117 -0
- data/docs/Basecamp3/Concerns/Bucketable.html +211 -0
- data/docs/Basecamp3/Concerns/Commentable.html +285 -0
- data/docs/Basecamp3/Concerns/Creatorable.html +209 -0
- data/docs/Basecamp3/Concerns/Parentable.html +211 -0
- data/docs/Basecamp3/Concerns/Recordingable.html +189 -0
- data/docs/Basecamp3/Concerns/Recordingable/ClassMethods.html +236 -0
- data/docs/Basecamp3/Document.html +1262 -0
- data/docs/Basecamp3/Forward.html +1070 -0
- data/docs/Basecamp3/Inbox.html +840 -0
- data/docs/Basecamp3/Message.html +1262 -0
- data/docs/Basecamp3/MessageBoard.html +840 -0
- data/docs/Basecamp3/MessageType.html +1160 -0
- data/docs/Basecamp3/Model.html +236 -0
- data/docs/Basecamp3/Person.html +1288 -0
- data/docs/Basecamp3/Project.html +1280 -0
- data/docs/Basecamp3/Question.html +1050 -0
- data/docs/Basecamp3/QuestionAnswer.html +887 -0
- data/docs/Basecamp3/Questionnaire.html +840 -0
- data/docs/Basecamp3/Request.html +933 -0
- data/docs/Basecamp3/ResponseParser.html +303 -0
- data/docs/Basecamp3/Schedule.html +840 -0
- data/docs/Basecamp3/ScheduleEntry.html +1560 -0
- data/docs/Basecamp3/Todo.html +1726 -0
- data/docs/Basecamp3/TodoList.html +1480 -0
- data/docs/Basecamp3/TodoSet.html +980 -0
- data/docs/Basecamp3/TypeMapper.html +329 -0
- data/docs/Basecamp3/Vault.html +1514 -0
- data/docs/_index.html +415 -0
- data/docs/class_list.html +51 -0
- data/docs/css/common.css +1 -0
- data/docs/css/full_list.css +58 -0
- data/docs/css/style.css +492 -0
- data/docs/file.README.html +157 -0
- data/docs/file_list.html +56 -0
- data/docs/frames.html +17 -0
- data/docs/index.html +157 -0
- data/docs/js/app.js +248 -0
- data/docs/js/full_list.js +216 -0
- data/docs/js/jquery.js +4 -0
- data/docs/method_list.html +1875 -0
- data/docs/top-level-namespace.html +110 -0
- data/lib/basecamp3.rb +61 -0
- data/lib/basecamp3/concerns/bucketable.rb +17 -0
- data/lib/basecamp3/concerns/commentable.rb +15 -0
- data/lib/basecamp3/concerns/creatorable.rb +16 -0
- data/lib/basecamp3/concerns/parentable.rb +17 -0
- data/lib/basecamp3/concerns/recordingable.rb +22 -0
- data/lib/basecamp3/model.rb +23 -0
- data/lib/basecamp3/models/campfire.rb +42 -0
- data/lib/basecamp3/models/campfire_line.rb +52 -0
- data/lib/basecamp3/models/comment.rb +65 -0
- data/lib/basecamp3/models/document.rb +71 -0
- data/lib/basecamp3/models/forward.rb +40 -0
- data/lib/basecamp3/models/inbox.rb +31 -0
- data/lib/basecamp3/models/message.rb +73 -0
- data/lib/basecamp3/models/message_board.rb +31 -0
- data/lib/basecamp3/models/message_type.rb +68 -0
- data/lib/basecamp3/models/person.rb +46 -0
- data/lib/basecamp3/models/project.rb +70 -0
- data/lib/basecamp3/models/question.rb +43 -0
- data/lib/basecamp3/models/question_answer.rb +35 -0
- data/lib/basecamp3/models/questionnaire.rb +31 -0
- data/lib/basecamp3/models/schedule.rb +31 -0
- data/lib/basecamp3/models/schedule_entry.rb +93 -0
- data/lib/basecamp3/models/todo.rb +108 -0
- data/lib/basecamp3/models/todo_list.rb +77 -0
- data/lib/basecamp3/models/todo_set.rb +33 -0
- data/lib/basecamp3/models/vault.rb +79 -0
- data/lib/basecamp3/request.rb +163 -0
- data/lib/basecamp3/response_parser.rb +44 -0
- data/lib/basecamp3/type_mapper.rb +53 -0
- data/lib/basecamp3/version.rb +3 -0
- metadata +202 -0
|
@@ -0,0 +1,329 @@
|
|
|
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: Basecamp3::TypeMapper
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.9
|
|
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
|
+
pathId = "Basecamp3::TypeMapper";
|
|
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 (T)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../Basecamp3.html" title="Basecamp3 (module)">Basecamp3</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">TypeMapper</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: Basecamp3::TypeMapper
|
|
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">Basecamp3::TypeMapper</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/basecamp3/type_mapper.rb</dd>
|
|
98
|
+
</dl>
|
|
99
|
+
|
|
100
|
+
</div>
|
|
101
|
+
|
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
|
103
|
+
<div class="discussion">
|
|
104
|
+
|
|
105
|
+
<p>The basecamp type to wrapper type mapper</p>
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
</div>
|
|
109
|
+
</div>
|
|
110
|
+
<div class="tags">
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
</div>
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
<h2>
|
|
122
|
+
Class Method Summary
|
|
123
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
124
|
+
</h2>
|
|
125
|
+
|
|
126
|
+
<ul class="summary">
|
|
127
|
+
|
|
128
|
+
<li class="public ">
|
|
129
|
+
<span class="summary_signature">
|
|
130
|
+
|
|
131
|
+
<a href="#map-class_method" title="map (class method)">.<strong>map</strong>(basecamp_type) ⇒ Class, OpenStruct </a>
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
</span>
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
<span class="summary_desc"><div class='inline'>
|
|
146
|
+
<p>Maps the basecamp model type to wrapper model type.</p>
|
|
147
|
+
</div></span>
|
|
148
|
+
|
|
149
|
+
</li>
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
</ul>
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
<div id="class_method_details" class="method_details_list">
|
|
158
|
+
<h2>Class Method Details</h2>
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
<div class="method_details first">
|
|
162
|
+
<h3 class="signature first" id="map-class_method">
|
|
163
|
+
|
|
164
|
+
.<strong>map</strong>(basecamp_type) ⇒ <tt>Class</tt>, <tt>OpenStruct</tt>
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
</h3><div class="docstring">
|
|
171
|
+
<div class="discussion">
|
|
172
|
+
|
|
173
|
+
<p>Maps the basecamp model type to wrapper model type.</p>
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
</div>
|
|
177
|
+
</div>
|
|
178
|
+
<div class="tags">
|
|
179
|
+
<p class="tag_title">Parameters:</p>
|
|
180
|
+
<ul class="param">
|
|
181
|
+
|
|
182
|
+
<li>
|
|
183
|
+
|
|
184
|
+
<span class='name'>basecamp_type</span>
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
—
|
|
192
|
+
<div class='inline'>
|
|
193
|
+
<p>the basecamp model name</p>
|
|
194
|
+
</div>
|
|
195
|
+
|
|
196
|
+
</li>
|
|
197
|
+
|
|
198
|
+
</ul>
|
|
199
|
+
|
|
200
|
+
<p class="tag_title">Returns:</p>
|
|
201
|
+
<ul class="return">
|
|
202
|
+
|
|
203
|
+
<li>
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
<span class='type'>(<tt>Class</tt>, <tt>OpenStruct</tt>)</span>
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
</li>
|
|
211
|
+
|
|
212
|
+
</ul>
|
|
213
|
+
|
|
214
|
+
</div><table class="source_code">
|
|
215
|
+
<tr>
|
|
216
|
+
<td>
|
|
217
|
+
<pre class="lines">
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
9
|
|
221
|
+
10
|
|
222
|
+
11
|
|
223
|
+
12
|
|
224
|
+
13
|
|
225
|
+
14
|
|
226
|
+
15
|
|
227
|
+
16
|
|
228
|
+
17
|
|
229
|
+
18
|
|
230
|
+
19
|
|
231
|
+
20
|
|
232
|
+
21
|
|
233
|
+
22
|
|
234
|
+
23
|
|
235
|
+
24
|
|
236
|
+
25
|
|
237
|
+
26
|
|
238
|
+
27
|
|
239
|
+
28
|
|
240
|
+
29
|
|
241
|
+
30
|
|
242
|
+
31
|
|
243
|
+
32
|
|
244
|
+
33
|
|
245
|
+
34
|
|
246
|
+
35
|
|
247
|
+
36
|
|
248
|
+
37
|
|
249
|
+
38
|
|
250
|
+
39
|
|
251
|
+
40
|
|
252
|
+
41
|
|
253
|
+
42
|
|
254
|
+
43
|
|
255
|
+
44
|
|
256
|
+
45
|
|
257
|
+
46
|
|
258
|
+
47
|
|
259
|
+
48
|
|
260
|
+
49
|
|
261
|
+
50
|
|
262
|
+
51
|
|
263
|
+
52</pre>
|
|
264
|
+
</td>
|
|
265
|
+
<td>
|
|
266
|
+
<pre class="code"><span class="info file"># File 'lib/basecamp3/type_mapper.rb', line 9</span>
|
|
267
|
+
|
|
268
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='id identifier rubyid_basecamp_type'>basecamp_type</span><span class='rparen'>)</span>
|
|
269
|
+
<span class='kw'>case</span> <span class='id identifier rubyid_basecamp_type'>basecamp_type</span>
|
|
270
|
+
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Project</span><span class='tstring_end'>'</span></span>
|
|
271
|
+
<span class='const'><span class='object_link'><a href="../Basecamp3.html" title="Basecamp3 (module)">Basecamp3</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Project.html" title="Basecamp3::Project (class)">Project</a></span></span>
|
|
272
|
+
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Chat::Transcript</span><span class='tstring_end'>'</span></span>
|
|
273
|
+
<span class='const'><span class='object_link'><a href="../Basecamp3.html" title="Basecamp3 (module)">Basecamp3</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Campfire.html" title="Basecamp3::Campfire (class)">Campfire</a></span></span>
|
|
274
|
+
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Chat::Lines::Text</span><span class='tstring_end'>'</span></span>
|
|
275
|
+
<span class='const'><span class='object_link'><a href="../Basecamp3.html" title="Basecamp3 (module)">Basecamp3</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="CampfireLine.html" title="Basecamp3::CampfireLine (class)">CampfireLine</a></span></span>
|
|
276
|
+
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Comment</span><span class='tstring_end'>'</span></span>
|
|
277
|
+
<span class='const'><span class='object_link'><a href="../Basecamp3.html" title="Basecamp3 (module)">Basecamp3</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Comment.html" title="Basecamp3::Comment (class)">Comment</a></span></span>
|
|
278
|
+
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Document</span><span class='tstring_end'>'</span></span>
|
|
279
|
+
<span class='const'><span class='object_link'><a href="../Basecamp3.html" title="Basecamp3 (module)">Basecamp3</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Document.html" title="Basecamp3::Document (class)">Document</a></span></span>
|
|
280
|
+
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Inbox::Forward</span><span class='tstring_end'>'</span></span>
|
|
281
|
+
<span class='const'><span class='object_link'><a href="../Basecamp3.html" title="Basecamp3 (module)">Basecamp3</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Forward.html" title="Basecamp3::Forward (class)">Forward</a></span></span>
|
|
282
|
+
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Inbox</span><span class='tstring_end'>'</span></span>
|
|
283
|
+
<span class='const'><span class='object_link'><a href="../Basecamp3.html" title="Basecamp3 (module)">Basecamp3</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Inbox.html" title="Basecamp3::Inbox (class)">Inbox</a></span></span>
|
|
284
|
+
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Message::Board</span><span class='tstring_end'>'</span></span>
|
|
285
|
+
<span class='const'><span class='object_link'><a href="../Basecamp3.html" title="Basecamp3 (module)">Basecamp3</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="MessageBoard.html" title="Basecamp3::MessageBoard (class)">MessageBoard</a></span></span>
|
|
286
|
+
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Message</span><span class='tstring_end'>'</span></span>
|
|
287
|
+
<span class='const'><span class='object_link'><a href="../Basecamp3.html" title="Basecamp3 (module)">Basecamp3</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Message.html" title="Basecamp3::Message (class)">Message</a></span></span>
|
|
288
|
+
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>User</span><span class='tstring_end'>'</span></span>
|
|
289
|
+
<span class='const'><span class='object_link'><a href="../Basecamp3.html" title="Basecamp3 (module)">Basecamp3</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Person.html" title="Basecamp3::Person (class)">Person</a></span></span>
|
|
290
|
+
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Question::Answer</span><span class='tstring_end'>'</span></span>
|
|
291
|
+
<span class='const'><span class='object_link'><a href="../Basecamp3.html" title="Basecamp3 (module)">Basecamp3</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="QuestionAnswer.html" title="Basecamp3::QuestionAnswer (class)">QuestionAnswer</a></span></span>
|
|
292
|
+
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Questionnaire</span><span class='tstring_end'>'</span></span>
|
|
293
|
+
<span class='const'><span class='object_link'><a href="../Basecamp3.html" title="Basecamp3 (module)">Basecamp3</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Questionnaire.html" title="Basecamp3::Questionnaire (class)">Questionnaire</a></span></span>
|
|
294
|
+
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Question</span><span class='tstring_end'>'</span></span>
|
|
295
|
+
<span class='const'><span class='object_link'><a href="../Basecamp3.html" title="Basecamp3 (module)">Basecamp3</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Question.html" title="Basecamp3::Question (class)">Question</a></span></span>
|
|
296
|
+
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Schedule::Entry</span><span class='tstring_end'>'</span></span>
|
|
297
|
+
<span class='const'><span class='object_link'><a href="../Basecamp3.html" title="Basecamp3 (module)">Basecamp3</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="ScheduleEntry.html" title="Basecamp3::ScheduleEntry (class)">ScheduleEntry</a></span></span>
|
|
298
|
+
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Schedule</span><span class='tstring_end'>'</span></span>
|
|
299
|
+
<span class='const'><span class='object_link'><a href="../Basecamp3.html" title="Basecamp3 (module)">Basecamp3</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Schedule.html" title="Basecamp3::Schedule (class)">Schedule</a></span></span>
|
|
300
|
+
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Todolist</span><span class='tstring_end'>'</span></span>
|
|
301
|
+
<span class='const'><span class='object_link'><a href="../Basecamp3.html" title="Basecamp3 (module)">Basecamp3</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="TodoList.html" title="Basecamp3::TodoList (class)">TodoList</a></span></span>
|
|
302
|
+
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Todo</span><span class='tstring_end'>'</span></span>
|
|
303
|
+
<span class='const'><span class='object_link'><a href="../Basecamp3.html" title="Basecamp3 (module)">Basecamp3</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Todo.html" title="Basecamp3::Todo (class)">Todo</a></span></span>
|
|
304
|
+
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Todoset</span><span class='tstring_end'>'</span></span>
|
|
305
|
+
<span class='const'><span class='object_link'><a href="../Basecamp3.html" title="Basecamp3 (module)">Basecamp3</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="TodoSet.html" title="Basecamp3::TodoSet (class)">TodoSet</a></span></span>
|
|
306
|
+
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Vault</span><span class='tstring_end'>'</span></span>
|
|
307
|
+
<span class='const'><span class='object_link'><a href="../Basecamp3.html" title="Basecamp3 (module)">Basecamp3</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Vault.html" title="Basecamp3::Vault (class)">Vault</a></span></span>
|
|
308
|
+
<span class='kw'>else</span>
|
|
309
|
+
<span class='const'>OpenStruct</span>
|
|
310
|
+
<span class='kw'>end</span>
|
|
311
|
+
<span class='kw'>end</span></pre>
|
|
312
|
+
</td>
|
|
313
|
+
</tr>
|
|
314
|
+
</table>
|
|
315
|
+
</div>
|
|
316
|
+
|
|
317
|
+
</div>
|
|
318
|
+
|
|
319
|
+
</div>
|
|
320
|
+
|
|
321
|
+
<div id="footer">
|
|
322
|
+
Generated on Tue May 9 15:32:16 2017 by
|
|
323
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
324
|
+
0.9.9 (ruby-2.2.2).
|
|
325
|
+
</div>
|
|
326
|
+
|
|
327
|
+
</div>
|
|
328
|
+
</body>
|
|
329
|
+
</html>
|
|
@@ -0,0 +1,1514 @@
|
|
|
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: Basecamp3::Vault
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.9
|
|
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
|
+
pathId = "Basecamp3::Vault";
|
|
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 (V)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../Basecamp3.html" title="Basecamp3 (module)">Basecamp3</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">Vault</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: Basecamp3::Vault
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
<dl>
|
|
70
|
+
<dt>Inherits:</dt>
|
|
71
|
+
<dd>
|
|
72
|
+
<span class="inheritName"><span class='object_link'><a href="Model.html" title="Basecamp3::Model (class)">Model</a></span></span>
|
|
73
|
+
|
|
74
|
+
<ul class="fullTree">
|
|
75
|
+
<li>Object</li>
|
|
76
|
+
|
|
77
|
+
<li class="next"><span class='object_link'><a href="Model.html" title="Basecamp3::Model (class)">Model</a></span></li>
|
|
78
|
+
|
|
79
|
+
<li class="next">Basecamp3::Vault</li>
|
|
80
|
+
|
|
81
|
+
</ul>
|
|
82
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
83
|
+
|
|
84
|
+
</dd>
|
|
85
|
+
</dl>
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
<dl>
|
|
93
|
+
<dt>Includes:</dt>
|
|
94
|
+
<dd><span class='object_link'><a href="Concerns/Bucketable.html" title="Basecamp3::Concerns::Bucketable (module)">Concerns::Bucketable</a></span>, <span class='object_link'><a href="Concerns/Creatorable.html" title="Basecamp3::Concerns::Creatorable (module)">Concerns::Creatorable</a></span>, <span class='object_link'><a href="Concerns/Parentable.html" title="Basecamp3::Concerns::Parentable (module)">Concerns::Parentable</a></span></dd>
|
|
95
|
+
</dl>
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
<dl>
|
|
103
|
+
<dt>Defined in:</dt>
|
|
104
|
+
<dd>lib/basecamp3/models/vault.rb</dd>
|
|
105
|
+
</dl>
|
|
106
|
+
|
|
107
|
+
</div>
|
|
108
|
+
|
|
109
|
+
<h2>Overview</h2><div class="docstring">
|
|
110
|
+
<div class="discussion">
|
|
111
|
+
|
|
112
|
+
<p>A model for Basecamp's Vault</p>
|
|
113
|
+
|
|
114
|
+
<p><a href="https://github.com/basecamp/bc3-api/blob/master/sections/vaults.md#vaults" target="_parent" title="For more information, see the official Basecamp3 API documentation for Vaults">For more information, see the official Basecamp3 API documentation for Vaults</a></p>
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
</div>
|
|
118
|
+
</div>
|
|
119
|
+
<div class="tags">
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
</div>
|
|
123
|
+
<h2>Constant Summary</h2>
|
|
124
|
+
<dl class="constants">
|
|
125
|
+
|
|
126
|
+
<dt id="REQUIRED_FIELDS-constant" class="">REQUIRED_FIELDS =
|
|
127
|
+
|
|
128
|
+
</dt>
|
|
129
|
+
<dd><pre class="code"><span class='qwords_beg'>%w(</span><span class='tstring_content'>title</span><span class='words_sep'>)</span></pre></dd>
|
|
130
|
+
|
|
131
|
+
</dl>
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
137
|
+
<ul class="summary">
|
|
138
|
+
|
|
139
|
+
<li class="public ">
|
|
140
|
+
<span class="summary_signature">
|
|
141
|
+
|
|
142
|
+
<a href="#created_at-instance_method" title="#created_at (instance method)">#<strong>created_at</strong> ⇒ Object </a>
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
</span>
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
<span class="summary_desc"><div class='inline'>
|
|
160
|
+
<p>Returns the value of attribute created_at.</p>
|
|
161
|
+
</div></span>
|
|
162
|
+
|
|
163
|
+
</li>
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
<li class="public ">
|
|
167
|
+
<span class="summary_signature">
|
|
168
|
+
|
|
169
|
+
<a href="#documents_count-instance_method" title="#documents_count (instance method)">#<strong>documents_count</strong> ⇒ Object </a>
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
</span>
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
<span class="summary_desc"><div class='inline'>
|
|
187
|
+
<p>Returns the value of attribute documents_count.</p>
|
|
188
|
+
</div></span>
|
|
189
|
+
|
|
190
|
+
</li>
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
<li class="public ">
|
|
194
|
+
<span class="summary_signature">
|
|
195
|
+
|
|
196
|
+
<a href="#id-instance_method" title="#id (instance method)">#<strong>id</strong> ⇒ Object </a>
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
</span>
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
<span class="summary_desc"><div class='inline'>
|
|
214
|
+
<p>Returns the value of attribute id.</p>
|
|
215
|
+
</div></span>
|
|
216
|
+
|
|
217
|
+
</li>
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
<li class="public ">
|
|
221
|
+
<span class="summary_signature">
|
|
222
|
+
|
|
223
|
+
<a href="#status-instance_method" title="#status (instance method)">#<strong>status</strong> ⇒ Object </a>
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
</span>
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
<span class="summary_desc"><div class='inline'>
|
|
241
|
+
<p>Returns the value of attribute status.</p>
|
|
242
|
+
</div></span>
|
|
243
|
+
|
|
244
|
+
</li>
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
<li class="public ">
|
|
248
|
+
<span class="summary_signature">
|
|
249
|
+
|
|
250
|
+
<a href="#title-instance_method" title="#title (instance method)">#<strong>title</strong> ⇒ Object </a>
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
</span>
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
<span class="summary_desc"><div class='inline'>
|
|
268
|
+
<p>Returns the value of attribute title.</p>
|
|
269
|
+
</div></span>
|
|
270
|
+
|
|
271
|
+
</li>
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
<li class="public ">
|
|
275
|
+
<span class="summary_signature">
|
|
276
|
+
|
|
277
|
+
<a href="#updated_at-instance_method" title="#updated_at (instance method)">#<strong>updated_at</strong> ⇒ Object </a>
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
</span>
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
<span class="summary_desc"><div class='inline'>
|
|
295
|
+
<p>Returns the value of attribute updated_at.</p>
|
|
296
|
+
</div></span>
|
|
297
|
+
|
|
298
|
+
</li>
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
<li class="public ">
|
|
302
|
+
<span class="summary_signature">
|
|
303
|
+
|
|
304
|
+
<a href="#uploads_count-instance_method" title="#uploads_count (instance method)">#<strong>uploads_count</strong> ⇒ Object </a>
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
</span>
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
<span class="summary_desc"><div class='inline'>
|
|
322
|
+
<p>Returns the value of attribute uploads_count.</p>
|
|
323
|
+
</div></span>
|
|
324
|
+
|
|
325
|
+
</li>
|
|
326
|
+
|
|
327
|
+
|
|
328
|
+
<li class="public ">
|
|
329
|
+
<span class="summary_signature">
|
|
330
|
+
|
|
331
|
+
<a href="#vaults_count-instance_method" title="#vaults_count (instance method)">#<strong>vaults_count</strong> ⇒ Object </a>
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
|
|
335
|
+
</span>
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
<span class="summary_desc"><div class='inline'>
|
|
349
|
+
<p>Returns the value of attribute vaults_count.</p>
|
|
350
|
+
</div></span>
|
|
351
|
+
|
|
352
|
+
</li>
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
</ul>
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
<h2>
|
|
362
|
+
Class Method Summary
|
|
363
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
364
|
+
</h2>
|
|
365
|
+
|
|
366
|
+
<ul class="summary">
|
|
367
|
+
|
|
368
|
+
<li class="public ">
|
|
369
|
+
<span class="summary_signature">
|
|
370
|
+
|
|
371
|
+
<a href="#all-class_method" title="all (class method)">.<strong>all</strong>(bucket_id, parent_id, params = {}) ⇒ Array<Basecamp3::Vault> </a>
|
|
372
|
+
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
</span>
|
|
376
|
+
|
|
377
|
+
|
|
378
|
+
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
<span class="summary_desc"><div class='inline'>
|
|
386
|
+
<p>Returns a paginated list of active vaults.</p>
|
|
387
|
+
</div></span>
|
|
388
|
+
|
|
389
|
+
</li>
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
<li class="public ">
|
|
393
|
+
<span class="summary_signature">
|
|
394
|
+
|
|
395
|
+
<a href="#create-class_method" title="create (class method)">.<strong>create</strong>(bucket_id, parent_id, data) ⇒ Basecamp3::Vault </a>
|
|
396
|
+
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
</span>
|
|
400
|
+
|
|
401
|
+
|
|
402
|
+
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
|
|
408
|
+
|
|
409
|
+
<span class="summary_desc"><div class='inline'>
|
|
410
|
+
<p>Creates a vault.</p>
|
|
411
|
+
</div></span>
|
|
412
|
+
|
|
413
|
+
</li>
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
<li class="public ">
|
|
417
|
+
<span class="summary_signature">
|
|
418
|
+
|
|
419
|
+
<a href="#find-class_method" title="find (class method)">.<strong>find</strong>(bucket_id, id) ⇒ Basecamp3::Vault </a>
|
|
420
|
+
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
</span>
|
|
424
|
+
|
|
425
|
+
|
|
426
|
+
|
|
427
|
+
|
|
428
|
+
|
|
429
|
+
|
|
430
|
+
|
|
431
|
+
|
|
432
|
+
|
|
433
|
+
<span class="summary_desc"><div class='inline'>
|
|
434
|
+
<p>Returns the vault.</p>
|
|
435
|
+
</div></span>
|
|
436
|
+
|
|
437
|
+
</li>
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
<li class="public ">
|
|
441
|
+
<span class="summary_signature">
|
|
442
|
+
|
|
443
|
+
<a href="#update-class_method" title="update (class method)">.<strong>update</strong>(bucket_id, id, data) ⇒ Basecamp3::Vault </a>
|
|
444
|
+
|
|
445
|
+
|
|
446
|
+
|
|
447
|
+
</span>
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
|
|
452
|
+
|
|
453
|
+
|
|
454
|
+
|
|
455
|
+
|
|
456
|
+
|
|
457
|
+
<span class="summary_desc"><div class='inline'>
|
|
458
|
+
<p>Updates the vault.</p>
|
|
459
|
+
</div></span>
|
|
460
|
+
|
|
461
|
+
</li>
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
</ul>
|
|
465
|
+
|
|
466
|
+
<h2>
|
|
467
|
+
Instance Method Summary
|
|
468
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
469
|
+
</h2>
|
|
470
|
+
|
|
471
|
+
<ul class="summary">
|
|
472
|
+
|
|
473
|
+
<li class="public ">
|
|
474
|
+
<span class="summary_signature">
|
|
475
|
+
|
|
476
|
+
<a href="#documents-instance_method" title="#documents (instance method)">#<strong>documents</strong> ⇒ Array<Basecamp3::Document> </a>
|
|
477
|
+
|
|
478
|
+
|
|
479
|
+
|
|
480
|
+
</span>
|
|
481
|
+
|
|
482
|
+
|
|
483
|
+
|
|
484
|
+
|
|
485
|
+
|
|
486
|
+
|
|
487
|
+
|
|
488
|
+
|
|
489
|
+
|
|
490
|
+
<span class="summary_desc"><div class='inline'>
|
|
491
|
+
<p>Returns a list of related documents.</p>
|
|
492
|
+
</div></span>
|
|
493
|
+
|
|
494
|
+
</li>
|
|
495
|
+
|
|
496
|
+
|
|
497
|
+
<li class="public ">
|
|
498
|
+
<span class="summary_signature">
|
|
499
|
+
|
|
500
|
+
<a href="#vaults-instance_method" title="#vaults (instance method)">#<strong>vaults</strong> ⇒ Array<Basecamp3::Vault> </a>
|
|
501
|
+
|
|
502
|
+
|
|
503
|
+
|
|
504
|
+
</span>
|
|
505
|
+
|
|
506
|
+
|
|
507
|
+
|
|
508
|
+
|
|
509
|
+
|
|
510
|
+
|
|
511
|
+
|
|
512
|
+
|
|
513
|
+
|
|
514
|
+
<span class="summary_desc"><div class='inline'>
|
|
515
|
+
<p>Returns a list of related vaults.</p>
|
|
516
|
+
</div></span>
|
|
517
|
+
|
|
518
|
+
</li>
|
|
519
|
+
|
|
520
|
+
|
|
521
|
+
</ul>
|
|
522
|
+
|
|
523
|
+
|
|
524
|
+
|
|
525
|
+
|
|
526
|
+
|
|
527
|
+
|
|
528
|
+
|
|
529
|
+
|
|
530
|
+
|
|
531
|
+
|
|
532
|
+
|
|
533
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="Concerns/Parentable.html" title="Basecamp3::Concerns::Parentable (module)">Concerns::Parentable</a></span></h3>
|
|
534
|
+
<p class="inherited"><span class='object_link'><a href="Concerns/Parentable.html#parent-instance_method" title="Basecamp3::Concerns::Parentable#parent (method)">#parent</a></span></p>
|
|
535
|
+
|
|
536
|
+
|
|
537
|
+
|
|
538
|
+
|
|
539
|
+
|
|
540
|
+
|
|
541
|
+
|
|
542
|
+
|
|
543
|
+
|
|
544
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="Concerns/Bucketable.html" title="Basecamp3::Concerns::Bucketable (module)">Concerns::Bucketable</a></span></h3>
|
|
545
|
+
<p class="inherited"><span class='object_link'><a href="Concerns/Bucketable.html#bucket-instance_method" title="Basecamp3::Concerns::Bucketable#bucket (method)">#bucket</a></span></p>
|
|
546
|
+
|
|
547
|
+
|
|
548
|
+
|
|
549
|
+
|
|
550
|
+
|
|
551
|
+
|
|
552
|
+
|
|
553
|
+
|
|
554
|
+
|
|
555
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="Concerns/Creatorable.html" title="Basecamp3::Concerns::Creatorable (module)">Concerns::Creatorable</a></span></h3>
|
|
556
|
+
<p class="inherited"><span class='object_link'><a href="Concerns/Creatorable.html#creator-instance_method" title="Basecamp3::Concerns::Creatorable#creator (method)">#creator</a></span></p>
|
|
557
|
+
|
|
558
|
+
|
|
559
|
+
|
|
560
|
+
|
|
561
|
+
|
|
562
|
+
|
|
563
|
+
|
|
564
|
+
|
|
565
|
+
|
|
566
|
+
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Model.html" title="Basecamp3::Model (class)">Model</a></span></h3>
|
|
567
|
+
<p class="inherited"><span class='object_link'><a href="Model.html#initialize-instance_method" title="Basecamp3::Model#initialize (method)">#initialize</a></span></p>
|
|
568
|
+
<div id="constructor_details" class="method_details_list">
|
|
569
|
+
<h2>Constructor Details</h2>
|
|
570
|
+
|
|
571
|
+
<p class="notice">This class inherits a constructor from <span class='object_link'><a href="Model.html#initialize-instance_method" title="Basecamp3::Model#initialize (method)">Basecamp3::Model</a></span></p>
|
|
572
|
+
|
|
573
|
+
</div>
|
|
574
|
+
|
|
575
|
+
<div id="instance_attr_details" class="attr_details">
|
|
576
|
+
<h2>Instance Attribute Details</h2>
|
|
577
|
+
|
|
578
|
+
|
|
579
|
+
<span id="created_at=-instance_method"></span>
|
|
580
|
+
<div class="method_details first">
|
|
581
|
+
<h3 class="signature first" id="created_at-instance_method">
|
|
582
|
+
|
|
583
|
+
#<strong>created_at</strong> ⇒ <tt>Object</tt>
|
|
584
|
+
|
|
585
|
+
|
|
586
|
+
|
|
587
|
+
|
|
588
|
+
|
|
589
|
+
</h3><div class="docstring">
|
|
590
|
+
<div class="discussion">
|
|
591
|
+
|
|
592
|
+
<p>Returns the value of attribute created_at</p>
|
|
593
|
+
|
|
594
|
+
|
|
595
|
+
</div>
|
|
596
|
+
</div>
|
|
597
|
+
<div class="tags">
|
|
598
|
+
|
|
599
|
+
|
|
600
|
+
</div><table class="source_code">
|
|
601
|
+
<tr>
|
|
602
|
+
<td>
|
|
603
|
+
<pre class="lines">
|
|
604
|
+
|
|
605
|
+
|
|
606
|
+
9
|
|
607
|
+
10
|
|
608
|
+
11</pre>
|
|
609
|
+
</td>
|
|
610
|
+
<td>
|
|
611
|
+
<pre class="code"><span class="info file"># File 'lib/basecamp3/models/vault.rb', line 9</span>
|
|
612
|
+
|
|
613
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_created_at'>created_at</span>
|
|
614
|
+
<span class='ivar'>@created_at</span>
|
|
615
|
+
<span class='kw'>end</span></pre>
|
|
616
|
+
</td>
|
|
617
|
+
</tr>
|
|
618
|
+
</table>
|
|
619
|
+
</div>
|
|
620
|
+
|
|
621
|
+
|
|
622
|
+
<span id="documents_count=-instance_method"></span>
|
|
623
|
+
<div class="method_details ">
|
|
624
|
+
<h3 class="signature " id="documents_count-instance_method">
|
|
625
|
+
|
|
626
|
+
#<strong>documents_count</strong> ⇒ <tt>Object</tt>
|
|
627
|
+
|
|
628
|
+
|
|
629
|
+
|
|
630
|
+
|
|
631
|
+
|
|
632
|
+
</h3><div class="docstring">
|
|
633
|
+
<div class="discussion">
|
|
634
|
+
|
|
635
|
+
<p>Returns the value of attribute documents_count</p>
|
|
636
|
+
|
|
637
|
+
|
|
638
|
+
</div>
|
|
639
|
+
</div>
|
|
640
|
+
<div class="tags">
|
|
641
|
+
|
|
642
|
+
|
|
643
|
+
</div><table class="source_code">
|
|
644
|
+
<tr>
|
|
645
|
+
<td>
|
|
646
|
+
<pre class="lines">
|
|
647
|
+
|
|
648
|
+
|
|
649
|
+
9
|
|
650
|
+
10
|
|
651
|
+
11</pre>
|
|
652
|
+
</td>
|
|
653
|
+
<td>
|
|
654
|
+
<pre class="code"><span class="info file"># File 'lib/basecamp3/models/vault.rb', line 9</span>
|
|
655
|
+
|
|
656
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_documents_count'>documents_count</span>
|
|
657
|
+
<span class='ivar'>@documents_count</span>
|
|
658
|
+
<span class='kw'>end</span></pre>
|
|
659
|
+
</td>
|
|
660
|
+
</tr>
|
|
661
|
+
</table>
|
|
662
|
+
</div>
|
|
663
|
+
|
|
664
|
+
|
|
665
|
+
<span id="id=-instance_method"></span>
|
|
666
|
+
<div class="method_details ">
|
|
667
|
+
<h3 class="signature " id="id-instance_method">
|
|
668
|
+
|
|
669
|
+
#<strong>id</strong> ⇒ <tt>Object</tt>
|
|
670
|
+
|
|
671
|
+
|
|
672
|
+
|
|
673
|
+
|
|
674
|
+
|
|
675
|
+
</h3><div class="docstring">
|
|
676
|
+
<div class="discussion">
|
|
677
|
+
|
|
678
|
+
<p>Returns the value of attribute id</p>
|
|
679
|
+
|
|
680
|
+
|
|
681
|
+
</div>
|
|
682
|
+
</div>
|
|
683
|
+
<div class="tags">
|
|
684
|
+
|
|
685
|
+
|
|
686
|
+
</div><table class="source_code">
|
|
687
|
+
<tr>
|
|
688
|
+
<td>
|
|
689
|
+
<pre class="lines">
|
|
690
|
+
|
|
691
|
+
|
|
692
|
+
9
|
|
693
|
+
10
|
|
694
|
+
11</pre>
|
|
695
|
+
</td>
|
|
696
|
+
<td>
|
|
697
|
+
<pre class="code"><span class="info file"># File 'lib/basecamp3/models/vault.rb', line 9</span>
|
|
698
|
+
|
|
699
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_id'>id</span>
|
|
700
|
+
<span class='ivar'>@id</span>
|
|
701
|
+
<span class='kw'>end</span></pre>
|
|
702
|
+
</td>
|
|
703
|
+
</tr>
|
|
704
|
+
</table>
|
|
705
|
+
</div>
|
|
706
|
+
|
|
707
|
+
|
|
708
|
+
<span id="status=-instance_method"></span>
|
|
709
|
+
<div class="method_details ">
|
|
710
|
+
<h3 class="signature " id="status-instance_method">
|
|
711
|
+
|
|
712
|
+
#<strong>status</strong> ⇒ <tt>Object</tt>
|
|
713
|
+
|
|
714
|
+
|
|
715
|
+
|
|
716
|
+
|
|
717
|
+
|
|
718
|
+
</h3><div class="docstring">
|
|
719
|
+
<div class="discussion">
|
|
720
|
+
|
|
721
|
+
<p>Returns the value of attribute status</p>
|
|
722
|
+
|
|
723
|
+
|
|
724
|
+
</div>
|
|
725
|
+
</div>
|
|
726
|
+
<div class="tags">
|
|
727
|
+
|
|
728
|
+
|
|
729
|
+
</div><table class="source_code">
|
|
730
|
+
<tr>
|
|
731
|
+
<td>
|
|
732
|
+
<pre class="lines">
|
|
733
|
+
|
|
734
|
+
|
|
735
|
+
9
|
|
736
|
+
10
|
|
737
|
+
11</pre>
|
|
738
|
+
</td>
|
|
739
|
+
<td>
|
|
740
|
+
<pre class="code"><span class="info file"># File 'lib/basecamp3/models/vault.rb', line 9</span>
|
|
741
|
+
|
|
742
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_status'>status</span>
|
|
743
|
+
<span class='ivar'>@status</span>
|
|
744
|
+
<span class='kw'>end</span></pre>
|
|
745
|
+
</td>
|
|
746
|
+
</tr>
|
|
747
|
+
</table>
|
|
748
|
+
</div>
|
|
749
|
+
|
|
750
|
+
|
|
751
|
+
<span id="title=-instance_method"></span>
|
|
752
|
+
<div class="method_details ">
|
|
753
|
+
<h3 class="signature " id="title-instance_method">
|
|
754
|
+
|
|
755
|
+
#<strong>title</strong> ⇒ <tt>Object</tt>
|
|
756
|
+
|
|
757
|
+
|
|
758
|
+
|
|
759
|
+
|
|
760
|
+
|
|
761
|
+
</h3><div class="docstring">
|
|
762
|
+
<div class="discussion">
|
|
763
|
+
|
|
764
|
+
<p>Returns the value of attribute title</p>
|
|
765
|
+
|
|
766
|
+
|
|
767
|
+
</div>
|
|
768
|
+
</div>
|
|
769
|
+
<div class="tags">
|
|
770
|
+
|
|
771
|
+
|
|
772
|
+
</div><table class="source_code">
|
|
773
|
+
<tr>
|
|
774
|
+
<td>
|
|
775
|
+
<pre class="lines">
|
|
776
|
+
|
|
777
|
+
|
|
778
|
+
9
|
|
779
|
+
10
|
|
780
|
+
11</pre>
|
|
781
|
+
</td>
|
|
782
|
+
<td>
|
|
783
|
+
<pre class="code"><span class="info file"># File 'lib/basecamp3/models/vault.rb', line 9</span>
|
|
784
|
+
|
|
785
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_title'>title</span>
|
|
786
|
+
<span class='ivar'>@title</span>
|
|
787
|
+
<span class='kw'>end</span></pre>
|
|
788
|
+
</td>
|
|
789
|
+
</tr>
|
|
790
|
+
</table>
|
|
791
|
+
</div>
|
|
792
|
+
|
|
793
|
+
|
|
794
|
+
<span id="updated_at=-instance_method"></span>
|
|
795
|
+
<div class="method_details ">
|
|
796
|
+
<h3 class="signature " id="updated_at-instance_method">
|
|
797
|
+
|
|
798
|
+
#<strong>updated_at</strong> ⇒ <tt>Object</tt>
|
|
799
|
+
|
|
800
|
+
|
|
801
|
+
|
|
802
|
+
|
|
803
|
+
|
|
804
|
+
</h3><div class="docstring">
|
|
805
|
+
<div class="discussion">
|
|
806
|
+
|
|
807
|
+
<p>Returns the value of attribute updated_at</p>
|
|
808
|
+
|
|
809
|
+
|
|
810
|
+
</div>
|
|
811
|
+
</div>
|
|
812
|
+
<div class="tags">
|
|
813
|
+
|
|
814
|
+
|
|
815
|
+
</div><table class="source_code">
|
|
816
|
+
<tr>
|
|
817
|
+
<td>
|
|
818
|
+
<pre class="lines">
|
|
819
|
+
|
|
820
|
+
|
|
821
|
+
9
|
|
822
|
+
10
|
|
823
|
+
11</pre>
|
|
824
|
+
</td>
|
|
825
|
+
<td>
|
|
826
|
+
<pre class="code"><span class="info file"># File 'lib/basecamp3/models/vault.rb', line 9</span>
|
|
827
|
+
|
|
828
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_updated_at'>updated_at</span>
|
|
829
|
+
<span class='ivar'>@updated_at</span>
|
|
830
|
+
<span class='kw'>end</span></pre>
|
|
831
|
+
</td>
|
|
832
|
+
</tr>
|
|
833
|
+
</table>
|
|
834
|
+
</div>
|
|
835
|
+
|
|
836
|
+
|
|
837
|
+
<span id="uploads_count=-instance_method"></span>
|
|
838
|
+
<div class="method_details ">
|
|
839
|
+
<h3 class="signature " id="uploads_count-instance_method">
|
|
840
|
+
|
|
841
|
+
#<strong>uploads_count</strong> ⇒ <tt>Object</tt>
|
|
842
|
+
|
|
843
|
+
|
|
844
|
+
|
|
845
|
+
|
|
846
|
+
|
|
847
|
+
</h3><div class="docstring">
|
|
848
|
+
<div class="discussion">
|
|
849
|
+
|
|
850
|
+
<p>Returns the value of attribute uploads_count</p>
|
|
851
|
+
|
|
852
|
+
|
|
853
|
+
</div>
|
|
854
|
+
</div>
|
|
855
|
+
<div class="tags">
|
|
856
|
+
|
|
857
|
+
|
|
858
|
+
</div><table class="source_code">
|
|
859
|
+
<tr>
|
|
860
|
+
<td>
|
|
861
|
+
<pre class="lines">
|
|
862
|
+
|
|
863
|
+
|
|
864
|
+
9
|
|
865
|
+
10
|
|
866
|
+
11</pre>
|
|
867
|
+
</td>
|
|
868
|
+
<td>
|
|
869
|
+
<pre class="code"><span class="info file"># File 'lib/basecamp3/models/vault.rb', line 9</span>
|
|
870
|
+
|
|
871
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_uploads_count'>uploads_count</span>
|
|
872
|
+
<span class='ivar'>@uploads_count</span>
|
|
873
|
+
<span class='kw'>end</span></pre>
|
|
874
|
+
</td>
|
|
875
|
+
</tr>
|
|
876
|
+
</table>
|
|
877
|
+
</div>
|
|
878
|
+
|
|
879
|
+
|
|
880
|
+
<span id="vaults_count=-instance_method"></span>
|
|
881
|
+
<div class="method_details ">
|
|
882
|
+
<h3 class="signature " id="vaults_count-instance_method">
|
|
883
|
+
|
|
884
|
+
#<strong>vaults_count</strong> ⇒ <tt>Object</tt>
|
|
885
|
+
|
|
886
|
+
|
|
887
|
+
|
|
888
|
+
|
|
889
|
+
|
|
890
|
+
</h3><div class="docstring">
|
|
891
|
+
<div class="discussion">
|
|
892
|
+
|
|
893
|
+
<p>Returns the value of attribute vaults_count</p>
|
|
894
|
+
|
|
895
|
+
|
|
896
|
+
</div>
|
|
897
|
+
</div>
|
|
898
|
+
<div class="tags">
|
|
899
|
+
|
|
900
|
+
|
|
901
|
+
</div><table class="source_code">
|
|
902
|
+
<tr>
|
|
903
|
+
<td>
|
|
904
|
+
<pre class="lines">
|
|
905
|
+
|
|
906
|
+
|
|
907
|
+
9
|
|
908
|
+
10
|
|
909
|
+
11</pre>
|
|
910
|
+
</td>
|
|
911
|
+
<td>
|
|
912
|
+
<pre class="code"><span class="info file"># File 'lib/basecamp3/models/vault.rb', line 9</span>
|
|
913
|
+
|
|
914
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_vaults_count'>vaults_count</span>
|
|
915
|
+
<span class='ivar'>@vaults_count</span>
|
|
916
|
+
<span class='kw'>end</span></pre>
|
|
917
|
+
</td>
|
|
918
|
+
</tr>
|
|
919
|
+
</table>
|
|
920
|
+
</div>
|
|
921
|
+
|
|
922
|
+
</div>
|
|
923
|
+
|
|
924
|
+
|
|
925
|
+
<div id="class_method_details" class="method_details_list">
|
|
926
|
+
<h2>Class Method Details</h2>
|
|
927
|
+
|
|
928
|
+
|
|
929
|
+
<div class="method_details first">
|
|
930
|
+
<h3 class="signature first" id="all-class_method">
|
|
931
|
+
|
|
932
|
+
.<strong>all</strong>(bucket_id, parent_id, params = {}) ⇒ <tt>Array<<span class='object_link'><a href="" title="Basecamp3::Vault (class)">Basecamp3::Vault</a></span>></tt>
|
|
933
|
+
|
|
934
|
+
|
|
935
|
+
|
|
936
|
+
|
|
937
|
+
|
|
938
|
+
</h3><div class="docstring">
|
|
939
|
+
<div class="discussion">
|
|
940
|
+
|
|
941
|
+
<p>Returns a paginated list of active vaults.</p>
|
|
942
|
+
|
|
943
|
+
|
|
944
|
+
</div>
|
|
945
|
+
</div>
|
|
946
|
+
<div class="tags">
|
|
947
|
+
<p class="tag_title">Parameters:</p>
|
|
948
|
+
<ul class="param">
|
|
949
|
+
|
|
950
|
+
<li>
|
|
951
|
+
|
|
952
|
+
<span class='name'>params</span>
|
|
953
|
+
|
|
954
|
+
|
|
955
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
956
|
+
|
|
957
|
+
|
|
958
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
959
|
+
|
|
960
|
+
|
|
961
|
+
—
|
|
962
|
+
<div class='inline'>
|
|
963
|
+
<p>additional parameters</p>
|
|
964
|
+
</div>
|
|
965
|
+
|
|
966
|
+
</li>
|
|
967
|
+
|
|
968
|
+
</ul>
|
|
969
|
+
|
|
970
|
+
|
|
971
|
+
|
|
972
|
+
|
|
973
|
+
|
|
974
|
+
|
|
975
|
+
|
|
976
|
+
|
|
977
|
+
<p class="tag_title">Options Hash (<tt>params</tt>):</p>
|
|
978
|
+
<ul class="option">
|
|
979
|
+
|
|
980
|
+
<li>
|
|
981
|
+
<span class="name">:page</span>
|
|
982
|
+
<span class="type">(<tt>Integer</tt>)</span>
|
|
983
|
+
<span class="default">
|
|
984
|
+
|
|
985
|
+
— default:
|
|
986
|
+
<tt>optional</tt>
|
|
987
|
+
|
|
988
|
+
</span>
|
|
989
|
+
|
|
990
|
+
— <div class='inline'>
|
|
991
|
+
<p>to paginate results</p>
|
|
992
|
+
</div>
|
|
993
|
+
|
|
994
|
+
</li>
|
|
995
|
+
|
|
996
|
+
</ul>
|
|
997
|
+
|
|
998
|
+
|
|
999
|
+
<p class="tag_title">Returns:</p>
|
|
1000
|
+
<ul class="return">
|
|
1001
|
+
|
|
1002
|
+
<li>
|
|
1003
|
+
|
|
1004
|
+
|
|
1005
|
+
<span class='type'>(<tt>Array<<span class='object_link'><a href="" title="Basecamp3::Vault (class)">Basecamp3::Vault</a></span>></tt>)</span>
|
|
1006
|
+
|
|
1007
|
+
|
|
1008
|
+
|
|
1009
|
+
</li>
|
|
1010
|
+
|
|
1011
|
+
</ul>
|
|
1012
|
+
|
|
1013
|
+
</div><table class="source_code">
|
|
1014
|
+
<tr>
|
|
1015
|
+
<td>
|
|
1016
|
+
<pre class="lines">
|
|
1017
|
+
|
|
1018
|
+
|
|
1019
|
+
40
|
|
1020
|
+
41
|
|
1021
|
+
42</pre>
|
|
1022
|
+
</td>
|
|
1023
|
+
<td>
|
|
1024
|
+
<pre class="code"><span class="info file"># File 'lib/basecamp3/models/vault.rb', line 40</span>
|
|
1025
|
+
|
|
1026
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_all'>all</span><span class='lparen'>(</span><span class='id identifier rubyid_bucket_id'>bucket_id</span><span class='comma'>,</span> <span class='id identifier rubyid_parent_id'>parent_id</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
1027
|
+
<span class='const'><span class='object_link'><a href="../Basecamp3.html" title="Basecamp3 (module)">Basecamp3</a></span></span><span class='period'>.</span><span class='id identifier rubyid_request'><span class='object_link'><a href="../Basecamp3.html#request-class_method" title="Basecamp3.request (method)">request</a></span></span><span class='period'>.</span><span class='id identifier rubyid_get'><span class='object_link'><a href="Request.html#get-instance_method" title="Basecamp3::Request#get (method)">get</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/buckets/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_bucket_id'>bucket_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/vaults/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_parent_id'>parent_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/vaults</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="../Basecamp3.html" title="Basecamp3 (module)">Basecamp3</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="Basecamp3::Vault (class)">Vault</a></span></span><span class='rparen'>)</span>
|
|
1028
|
+
<span class='kw'>end</span></pre>
|
|
1029
|
+
</td>
|
|
1030
|
+
</tr>
|
|
1031
|
+
</table>
|
|
1032
|
+
</div>
|
|
1033
|
+
|
|
1034
|
+
<div class="method_details ">
|
|
1035
|
+
<h3 class="signature " id="create-class_method">
|
|
1036
|
+
|
|
1037
|
+
.<strong>create</strong>(bucket_id, parent_id, data) ⇒ <tt><span class='object_link'><a href="" title="Basecamp3::Vault (class)">Basecamp3::Vault</a></span></tt>
|
|
1038
|
+
|
|
1039
|
+
|
|
1040
|
+
|
|
1041
|
+
|
|
1042
|
+
|
|
1043
|
+
</h3><div class="docstring">
|
|
1044
|
+
<div class="discussion">
|
|
1045
|
+
|
|
1046
|
+
<p>Creates a vault</p>
|
|
1047
|
+
|
|
1048
|
+
|
|
1049
|
+
</div>
|
|
1050
|
+
</div>
|
|
1051
|
+
<div class="tags">
|
|
1052
|
+
<p class="tag_title">Parameters:</p>
|
|
1053
|
+
<ul class="param">
|
|
1054
|
+
|
|
1055
|
+
<li>
|
|
1056
|
+
|
|
1057
|
+
<span class='name'>bucket_id</span>
|
|
1058
|
+
|
|
1059
|
+
|
|
1060
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
1061
|
+
|
|
1062
|
+
|
|
1063
|
+
|
|
1064
|
+
—
|
|
1065
|
+
<div class='inline'>
|
|
1066
|
+
<p>the id of the bucket</p>
|
|
1067
|
+
</div>
|
|
1068
|
+
|
|
1069
|
+
</li>
|
|
1070
|
+
|
|
1071
|
+
<li>
|
|
1072
|
+
|
|
1073
|
+
<span class='name'>parent_id</span>
|
|
1074
|
+
|
|
1075
|
+
|
|
1076
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
1077
|
+
|
|
1078
|
+
|
|
1079
|
+
|
|
1080
|
+
—
|
|
1081
|
+
<div class='inline'>
|
|
1082
|
+
<p>the id of the parent</p>
|
|
1083
|
+
</div>
|
|
1084
|
+
|
|
1085
|
+
</li>
|
|
1086
|
+
|
|
1087
|
+
<li>
|
|
1088
|
+
|
|
1089
|
+
<span class='name'>data</span>
|
|
1090
|
+
|
|
1091
|
+
|
|
1092
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1093
|
+
|
|
1094
|
+
|
|
1095
|
+
|
|
1096
|
+
—
|
|
1097
|
+
<div class='inline'>
|
|
1098
|
+
<p>the data to create a vault with</p>
|
|
1099
|
+
</div>
|
|
1100
|
+
|
|
1101
|
+
</li>
|
|
1102
|
+
|
|
1103
|
+
<li>
|
|
1104
|
+
|
|
1105
|
+
<span class='name'>params</span>
|
|
1106
|
+
|
|
1107
|
+
|
|
1108
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1109
|
+
|
|
1110
|
+
|
|
1111
|
+
|
|
1112
|
+
—
|
|
1113
|
+
<div class='inline'>
|
|
1114
|
+
<p>a customizable set of options</p>
|
|
1115
|
+
</div>
|
|
1116
|
+
|
|
1117
|
+
</li>
|
|
1118
|
+
|
|
1119
|
+
</ul>
|
|
1120
|
+
|
|
1121
|
+
|
|
1122
|
+
|
|
1123
|
+
|
|
1124
|
+
|
|
1125
|
+
|
|
1126
|
+
|
|
1127
|
+
|
|
1128
|
+
|
|
1129
|
+
<p class="tag_title">Returns:</p>
|
|
1130
|
+
<ul class="return">
|
|
1131
|
+
|
|
1132
|
+
<li>
|
|
1133
|
+
|
|
1134
|
+
|
|
1135
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Basecamp3::Vault (class)">Basecamp3::Vault</a></span></tt>)</span>
|
|
1136
|
+
|
|
1137
|
+
|
|
1138
|
+
|
|
1139
|
+
</li>
|
|
1140
|
+
|
|
1141
|
+
</ul>
|
|
1142
|
+
|
|
1143
|
+
</div><table class="source_code">
|
|
1144
|
+
<tr>
|
|
1145
|
+
<td>
|
|
1146
|
+
<pre class="lines">
|
|
1147
|
+
|
|
1148
|
+
|
|
1149
|
+
62
|
|
1150
|
+
63
|
|
1151
|
+
64
|
|
1152
|
+
65</pre>
|
|
1153
|
+
</td>
|
|
1154
|
+
<td>
|
|
1155
|
+
<pre class="code"><span class="info file"># File 'lib/basecamp3/models/vault.rb', line 62</span>
|
|
1156
|
+
|
|
1157
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='id identifier rubyid_bucket_id'>bucket_id</span><span class='comma'>,</span> <span class='id identifier rubyid_parent_id'>parent_id</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
|
1158
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_validate_required'>validate_required</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
|
1159
|
+
<span class='const'><span class='object_link'><a href="../Basecamp3.html" title="Basecamp3 (module)">Basecamp3</a></span></span><span class='period'>.</span><span class='id identifier rubyid_request'><span class='object_link'><a href="../Basecamp3.html#request-class_method" title="Basecamp3.request (method)">request</a></span></span><span class='period'>.</span><span class='id identifier rubyid_post'><span class='object_link'><a href="Request.html#post-instance_method" title="Basecamp3::Request#post (method)">post</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/buckets/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_bucket_id'>bucket_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/vaults/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_parent_id'>parent_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/vaults</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="../Basecamp3.html" title="Basecamp3 (module)">Basecamp3</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="Basecamp3::Vault (class)">Vault</a></span></span><span class='rparen'>)</span>
|
|
1160
|
+
<span class='kw'>end</span></pre>
|
|
1161
|
+
</td>
|
|
1162
|
+
</tr>
|
|
1163
|
+
</table>
|
|
1164
|
+
</div>
|
|
1165
|
+
|
|
1166
|
+
<div class="method_details ">
|
|
1167
|
+
<h3 class="signature " id="find-class_method">
|
|
1168
|
+
|
|
1169
|
+
.<strong>find</strong>(bucket_id, id) ⇒ <tt><span class='object_link'><a href="" title="Basecamp3::Vault (class)">Basecamp3::Vault</a></span></tt>
|
|
1170
|
+
|
|
1171
|
+
|
|
1172
|
+
|
|
1173
|
+
|
|
1174
|
+
|
|
1175
|
+
</h3><div class="docstring">
|
|
1176
|
+
<div class="discussion">
|
|
1177
|
+
|
|
1178
|
+
<p>Returns the vault.</p>
|
|
1179
|
+
|
|
1180
|
+
|
|
1181
|
+
</div>
|
|
1182
|
+
</div>
|
|
1183
|
+
<div class="tags">
|
|
1184
|
+
<p class="tag_title">Parameters:</p>
|
|
1185
|
+
<ul class="param">
|
|
1186
|
+
|
|
1187
|
+
<li>
|
|
1188
|
+
|
|
1189
|
+
<span class='name'>bucket_id</span>
|
|
1190
|
+
|
|
1191
|
+
|
|
1192
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
1193
|
+
|
|
1194
|
+
|
|
1195
|
+
|
|
1196
|
+
—
|
|
1197
|
+
<div class='inline'>
|
|
1198
|
+
<p>the id of the bucket</p>
|
|
1199
|
+
</div>
|
|
1200
|
+
|
|
1201
|
+
</li>
|
|
1202
|
+
|
|
1203
|
+
<li>
|
|
1204
|
+
|
|
1205
|
+
<span class='name'>id</span>
|
|
1206
|
+
|
|
1207
|
+
|
|
1208
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
1209
|
+
|
|
1210
|
+
|
|
1211
|
+
|
|
1212
|
+
—
|
|
1213
|
+
<div class='inline'>
|
|
1214
|
+
<p>the id of the vault</p>
|
|
1215
|
+
</div>
|
|
1216
|
+
|
|
1217
|
+
</li>
|
|
1218
|
+
|
|
1219
|
+
</ul>
|
|
1220
|
+
|
|
1221
|
+
<p class="tag_title">Returns:</p>
|
|
1222
|
+
<ul class="return">
|
|
1223
|
+
|
|
1224
|
+
<li>
|
|
1225
|
+
|
|
1226
|
+
|
|
1227
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Basecamp3::Vault (class)">Basecamp3::Vault</a></span></tt>)</span>
|
|
1228
|
+
|
|
1229
|
+
|
|
1230
|
+
|
|
1231
|
+
</li>
|
|
1232
|
+
|
|
1233
|
+
</ul>
|
|
1234
|
+
|
|
1235
|
+
</div><table class="source_code">
|
|
1236
|
+
<tr>
|
|
1237
|
+
<td>
|
|
1238
|
+
<pre class="lines">
|
|
1239
|
+
|
|
1240
|
+
|
|
1241
|
+
50
|
|
1242
|
+
51
|
|
1243
|
+
52</pre>
|
|
1244
|
+
</td>
|
|
1245
|
+
<td>
|
|
1246
|
+
<pre class="code"><span class="info file"># File 'lib/basecamp3/models/vault.rb', line 50</span>
|
|
1247
|
+
|
|
1248
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='id identifier rubyid_bucket_id'>bucket_id</span><span class='comma'>,</span> <span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
|
|
1249
|
+
<span class='const'><span class='object_link'><a href="../Basecamp3.html" title="Basecamp3 (module)">Basecamp3</a></span></span><span class='period'>.</span><span class='id identifier rubyid_request'><span class='object_link'><a href="../Basecamp3.html#request-class_method" title="Basecamp3.request (method)">request</a></span></span><span class='period'>.</span><span class='id identifier rubyid_get'><span class='object_link'><a href="Request.html#get-instance_method" title="Basecamp3::Request#get (method)">get</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/buckets/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_bucket_id'>bucket_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/vaults/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="../Basecamp3.html" title="Basecamp3 (module)">Basecamp3</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="Basecamp3::Vault (class)">Vault</a></span></span><span class='rparen'>)</span>
|
|
1250
|
+
<span class='kw'>end</span></pre>
|
|
1251
|
+
</td>
|
|
1252
|
+
</tr>
|
|
1253
|
+
</table>
|
|
1254
|
+
</div>
|
|
1255
|
+
|
|
1256
|
+
<div class="method_details ">
|
|
1257
|
+
<h3 class="signature " id="update-class_method">
|
|
1258
|
+
|
|
1259
|
+
.<strong>update</strong>(bucket_id, id, data) ⇒ <tt><span class='object_link'><a href="" title="Basecamp3::Vault (class)">Basecamp3::Vault</a></span></tt>
|
|
1260
|
+
|
|
1261
|
+
|
|
1262
|
+
|
|
1263
|
+
|
|
1264
|
+
|
|
1265
|
+
</h3><div class="docstring">
|
|
1266
|
+
<div class="discussion">
|
|
1267
|
+
|
|
1268
|
+
<p>Updates the vault</p>
|
|
1269
|
+
|
|
1270
|
+
|
|
1271
|
+
</div>
|
|
1272
|
+
</div>
|
|
1273
|
+
<div class="tags">
|
|
1274
|
+
<p class="tag_title">Parameters:</p>
|
|
1275
|
+
<ul class="param">
|
|
1276
|
+
|
|
1277
|
+
<li>
|
|
1278
|
+
|
|
1279
|
+
<span class='name'>bucket_id</span>
|
|
1280
|
+
|
|
1281
|
+
|
|
1282
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
1283
|
+
|
|
1284
|
+
|
|
1285
|
+
|
|
1286
|
+
—
|
|
1287
|
+
<div class='inline'>
|
|
1288
|
+
<p>the id of the bucket</p>
|
|
1289
|
+
</div>
|
|
1290
|
+
|
|
1291
|
+
</li>
|
|
1292
|
+
|
|
1293
|
+
<li>
|
|
1294
|
+
|
|
1295
|
+
<span class='name'>id</span>
|
|
1296
|
+
|
|
1297
|
+
|
|
1298
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
1299
|
+
|
|
1300
|
+
|
|
1301
|
+
|
|
1302
|
+
—
|
|
1303
|
+
<div class='inline'>
|
|
1304
|
+
<p>the id of the vault</p>
|
|
1305
|
+
</div>
|
|
1306
|
+
|
|
1307
|
+
</li>
|
|
1308
|
+
|
|
1309
|
+
<li>
|
|
1310
|
+
|
|
1311
|
+
<span class='name'>data</span>
|
|
1312
|
+
|
|
1313
|
+
|
|
1314
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1315
|
+
|
|
1316
|
+
|
|
1317
|
+
|
|
1318
|
+
—
|
|
1319
|
+
<div class='inline'>
|
|
1320
|
+
<p>the data to update the vault with</p>
|
|
1321
|
+
</div>
|
|
1322
|
+
|
|
1323
|
+
</li>
|
|
1324
|
+
|
|
1325
|
+
<li>
|
|
1326
|
+
|
|
1327
|
+
<span class='name'>params</span>
|
|
1328
|
+
|
|
1329
|
+
|
|
1330
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1331
|
+
|
|
1332
|
+
|
|
1333
|
+
|
|
1334
|
+
—
|
|
1335
|
+
<div class='inline'>
|
|
1336
|
+
<p>a customizable set of options</p>
|
|
1337
|
+
</div>
|
|
1338
|
+
|
|
1339
|
+
</li>
|
|
1340
|
+
|
|
1341
|
+
</ul>
|
|
1342
|
+
|
|
1343
|
+
|
|
1344
|
+
|
|
1345
|
+
|
|
1346
|
+
|
|
1347
|
+
|
|
1348
|
+
|
|
1349
|
+
|
|
1350
|
+
|
|
1351
|
+
<p class="tag_title">Returns:</p>
|
|
1352
|
+
<ul class="return">
|
|
1353
|
+
|
|
1354
|
+
<li>
|
|
1355
|
+
|
|
1356
|
+
|
|
1357
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Basecamp3::Vault (class)">Basecamp3::Vault</a></span></tt>)</span>
|
|
1358
|
+
|
|
1359
|
+
|
|
1360
|
+
|
|
1361
|
+
</li>
|
|
1362
|
+
|
|
1363
|
+
</ul>
|
|
1364
|
+
|
|
1365
|
+
</div><table class="source_code">
|
|
1366
|
+
<tr>
|
|
1367
|
+
<td>
|
|
1368
|
+
<pre class="lines">
|
|
1369
|
+
|
|
1370
|
+
|
|
1371
|
+
75
|
|
1372
|
+
76
|
|
1373
|
+
77
|
|
1374
|
+
78</pre>
|
|
1375
|
+
</td>
|
|
1376
|
+
<td>
|
|
1377
|
+
<pre class="code"><span class="info file"># File 'lib/basecamp3/models/vault.rb', line 75</span>
|
|
1378
|
+
|
|
1379
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='id identifier rubyid_bucket_id'>bucket_id</span><span class='comma'>,</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
|
1380
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_validate_required'>validate_required</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
|
1381
|
+
<span class='const'><span class='object_link'><a href="../Basecamp3.html" title="Basecamp3 (module)">Basecamp3</a></span></span><span class='period'>.</span><span class='id identifier rubyid_request'><span class='object_link'><a href="../Basecamp3.html#request-class_method" title="Basecamp3.request (method)">request</a></span></span><span class='period'>.</span><span class='id identifier rubyid_put'><span class='object_link'><a href="Request.html#put-instance_method" title="Basecamp3::Request#put (method)">put</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/buckets/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_bucket_id'>bucket_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/vaults/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="../Basecamp3.html" title="Basecamp3 (module)">Basecamp3</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="Basecamp3::Vault (class)">Vault</a></span></span><span class='rparen'>)</span>
|
|
1382
|
+
<span class='kw'>end</span></pre>
|
|
1383
|
+
</td>
|
|
1384
|
+
</tr>
|
|
1385
|
+
</table>
|
|
1386
|
+
</div>
|
|
1387
|
+
|
|
1388
|
+
</div>
|
|
1389
|
+
|
|
1390
|
+
<div id="instance_method_details" class="method_details_list">
|
|
1391
|
+
<h2>Instance Method Details</h2>
|
|
1392
|
+
|
|
1393
|
+
|
|
1394
|
+
<div class="method_details first">
|
|
1395
|
+
<h3 class="signature first" id="documents-instance_method">
|
|
1396
|
+
|
|
1397
|
+
#<strong>documents</strong> ⇒ <tt>Array<<span class='object_link'><a href="Document.html" title="Basecamp3::Document (class)">Basecamp3::Document</a></span>></tt>
|
|
1398
|
+
|
|
1399
|
+
|
|
1400
|
+
|
|
1401
|
+
|
|
1402
|
+
|
|
1403
|
+
</h3><div class="docstring">
|
|
1404
|
+
<div class="discussion">
|
|
1405
|
+
|
|
1406
|
+
<p>Returns a list of related documents.</p>
|
|
1407
|
+
|
|
1408
|
+
|
|
1409
|
+
</div>
|
|
1410
|
+
</div>
|
|
1411
|
+
<div class="tags">
|
|
1412
|
+
|
|
1413
|
+
<p class="tag_title">Returns:</p>
|
|
1414
|
+
<ul class="return">
|
|
1415
|
+
|
|
1416
|
+
<li>
|
|
1417
|
+
|
|
1418
|
+
|
|
1419
|
+
<span class='type'>(<tt>Array<<span class='object_link'><a href="Document.html" title="Basecamp3::Document (class)">Basecamp3::Document</a></span>></tt>)</span>
|
|
1420
|
+
|
|
1421
|
+
|
|
1422
|
+
|
|
1423
|
+
</li>
|
|
1424
|
+
|
|
1425
|
+
</ul>
|
|
1426
|
+
|
|
1427
|
+
</div><table class="source_code">
|
|
1428
|
+
<tr>
|
|
1429
|
+
<td>
|
|
1430
|
+
<pre class="lines">
|
|
1431
|
+
|
|
1432
|
+
|
|
1433
|
+
23
|
|
1434
|
+
24
|
|
1435
|
+
25</pre>
|
|
1436
|
+
</td>
|
|
1437
|
+
<td>
|
|
1438
|
+
<pre class="code"><span class="info file"># File 'lib/basecamp3/models/vault.rb', line 23</span>
|
|
1439
|
+
|
|
1440
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_documents'>documents</span>
|
|
1441
|
+
<span class='ivar'>@mapped_documents</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../Basecamp3.html" title="Basecamp3 (module)">Basecamp3</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Document.html" title="Basecamp3::Document (class)">Document</a></span></span><span class='period'>.</span><span class='id identifier rubyid_all'><span class='object_link'><a href="Document.html#all-class_method" title="Basecamp3::Document.all (method)">all</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_bucket'>bucket</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
|
|
1442
|
+
<span class='kw'>end</span></pre>
|
|
1443
|
+
</td>
|
|
1444
|
+
</tr>
|
|
1445
|
+
</table>
|
|
1446
|
+
</div>
|
|
1447
|
+
|
|
1448
|
+
<div class="method_details ">
|
|
1449
|
+
<h3 class="signature " id="vaults-instance_method">
|
|
1450
|
+
|
|
1451
|
+
#<strong>vaults</strong> ⇒ <tt>Array<<span class='object_link'><a href="" title="Basecamp3::Vault (class)">Basecamp3::Vault</a></span>></tt>
|
|
1452
|
+
|
|
1453
|
+
|
|
1454
|
+
|
|
1455
|
+
|
|
1456
|
+
|
|
1457
|
+
</h3><div class="docstring">
|
|
1458
|
+
<div class="discussion">
|
|
1459
|
+
|
|
1460
|
+
<p>Returns a list of related vaults.</p>
|
|
1461
|
+
|
|
1462
|
+
|
|
1463
|
+
</div>
|
|
1464
|
+
</div>
|
|
1465
|
+
<div class="tags">
|
|
1466
|
+
|
|
1467
|
+
<p class="tag_title">Returns:</p>
|
|
1468
|
+
<ul class="return">
|
|
1469
|
+
|
|
1470
|
+
<li>
|
|
1471
|
+
|
|
1472
|
+
|
|
1473
|
+
<span class='type'>(<tt>Array<<span class='object_link'><a href="" title="Basecamp3::Vault (class)">Basecamp3::Vault</a></span>></tt>)</span>
|
|
1474
|
+
|
|
1475
|
+
|
|
1476
|
+
|
|
1477
|
+
</li>
|
|
1478
|
+
|
|
1479
|
+
</ul>
|
|
1480
|
+
|
|
1481
|
+
</div><table class="source_code">
|
|
1482
|
+
<tr>
|
|
1483
|
+
<td>
|
|
1484
|
+
<pre class="lines">
|
|
1485
|
+
|
|
1486
|
+
|
|
1487
|
+
30
|
|
1488
|
+
31
|
|
1489
|
+
32</pre>
|
|
1490
|
+
</td>
|
|
1491
|
+
<td>
|
|
1492
|
+
<pre class="code"><span class="info file"># File 'lib/basecamp3/models/vault.rb', line 30</span>
|
|
1493
|
+
|
|
1494
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_vaults'>vaults</span>
|
|
1495
|
+
<span class='ivar'>@mapped_vaults</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../Basecamp3.html" title="Basecamp3 (module)">Basecamp3</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="Basecamp3::Vault (class)">Vault</a></span></span><span class='period'>.</span><span class='id identifier rubyid_all'><span class='object_link'><a href="#all-class_method" title="Basecamp3::Vault.all (method)">all</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_bucket'>bucket</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
|
|
1496
|
+
<span class='kw'>end</span></pre>
|
|
1497
|
+
</td>
|
|
1498
|
+
</tr>
|
|
1499
|
+
</table>
|
|
1500
|
+
</div>
|
|
1501
|
+
|
|
1502
|
+
</div>
|
|
1503
|
+
|
|
1504
|
+
</div>
|
|
1505
|
+
|
|
1506
|
+
<div id="footer">
|
|
1507
|
+
Generated on Tue May 9 15:32:17 2017 by
|
|
1508
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1509
|
+
0.9.9 (ruby-2.2.2).
|
|
1510
|
+
</div>
|
|
1511
|
+
|
|
1512
|
+
</div>
|
|
1513
|
+
</body>
|
|
1514
|
+
</html>
|