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,303 @@
|
|
|
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::ResponseParser
|
|
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::ResponseParser";
|
|
19
|
+
relpath = '../';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="../class_list.html?1"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="../_index.html">Index (R)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../Basecamp3.html" title="Basecamp3 (module)">Basecamp3</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">ResponseParser</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::ResponseParser
|
|
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::ResponseParser</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/response_parser.rb</dd>
|
|
98
|
+
</dl>
|
|
99
|
+
|
|
100
|
+
</div>
|
|
101
|
+
|
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
|
103
|
+
<div class="discussion">
|
|
104
|
+
|
|
105
|
+
<p>The basecamp response parser</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="#parse-class_method" title="parse (class method)">.<strong>parse</strong>(response, model) ⇒ Basecamp3::Model, ... </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>Parses the given response to the given wrapper model.</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="parse-class_method">
|
|
163
|
+
|
|
164
|
+
.<strong>parse</strong>(response, model) ⇒ <tt><span class='object_link'><a href="Model.html" title="Basecamp3::Model (class)">Basecamp3::Model</a></span></tt>, ...
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
</h3><div class="docstring">
|
|
171
|
+
<div class="discussion">
|
|
172
|
+
|
|
173
|
+
<p>Parses the given response to the given wrapper model.</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'>response</span>
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
—
|
|
192
|
+
<div class='inline'>
|
|
193
|
+
<p>The hash with data which should be parsed to the wrapper model</p>
|
|
194
|
+
</div>
|
|
195
|
+
|
|
196
|
+
</li>
|
|
197
|
+
|
|
198
|
+
<li>
|
|
199
|
+
|
|
200
|
+
<span class='name'>model</span>
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
<span class='type'>(<tt>Class</tt>)</span>
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
—
|
|
208
|
+
<div class='inline'>
|
|
209
|
+
<p>The class of the model</p>
|
|
210
|
+
</div>
|
|
211
|
+
|
|
212
|
+
</li>
|
|
213
|
+
|
|
214
|
+
</ul>
|
|
215
|
+
|
|
216
|
+
<p class="tag_title">Returns:</p>
|
|
217
|
+
<ul class="return">
|
|
218
|
+
|
|
219
|
+
<li>
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
<span class='type'>(<tt><span class='object_link'><a href="Model.html" title="Basecamp3::Model (class)">Basecamp3::Model</a></span></tt>, <tt>Array<<span class='object_link'><a href="Model.html" title="Basecamp3::Model (class)">Basecamp3::Model</a></span>></tt>, <tt>nil</tt>)</span>
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
</li>
|
|
227
|
+
|
|
228
|
+
</ul>
|
|
229
|
+
<p class="tag_title">Raises:</p>
|
|
230
|
+
<ul class="raise">
|
|
231
|
+
|
|
232
|
+
<li>
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
<span class='type'>(<tt>StandardError</tt>)</span>
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
—
|
|
240
|
+
<div class='inline'>
|
|
241
|
+
<p>raises an error for unsupported response type</p>
|
|
242
|
+
</div>
|
|
243
|
+
|
|
244
|
+
</li>
|
|
245
|
+
|
|
246
|
+
</ul>
|
|
247
|
+
|
|
248
|
+
</div><table class="source_code">
|
|
249
|
+
<tr>
|
|
250
|
+
<td>
|
|
251
|
+
<pre class="lines">
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
11
|
|
255
|
+
12
|
|
256
|
+
13
|
|
257
|
+
14
|
|
258
|
+
15
|
|
259
|
+
16
|
|
260
|
+
17
|
|
261
|
+
18
|
|
262
|
+
19
|
|
263
|
+
20
|
|
264
|
+
21
|
|
265
|
+
22
|
|
266
|
+
23
|
|
267
|
+
24</pre>
|
|
268
|
+
</td>
|
|
269
|
+
<td>
|
|
270
|
+
<pre class="code"><span class="info file"># File 'lib/basecamp3/response_parser.rb', line 11</span>
|
|
271
|
+
|
|
272
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='comma'>,</span> <span class='id identifier rubyid_model'>model</span><span class='rparen'>)</span>
|
|
273
|
+
<span class='kw'>case</span> <span class='id identifier rubyid_response'>response</span>
|
|
274
|
+
<span class='kw'>when</span> <span class='const'>Hash</span>
|
|
275
|
+
<span class='id identifier rubyid_map_object'>map_object</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='comma'>,</span> <span class='id identifier rubyid_model'>model</span><span class='rparen'>)</span>
|
|
276
|
+
<span class='kw'>when</span> <span class='const'>Array</span>
|
|
277
|
+
<span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_item'>item</span><span class='op'>|</span>
|
|
278
|
+
<span class='id identifier rubyid_map_object'>map_object</span><span class='lparen'>(</span><span class='id identifier rubyid_item'>item</span><span class='comma'>,</span> <span class='id identifier rubyid_model'>model</span><span class='rparen'>)</span>
|
|
279
|
+
<span class='kw'>end</span>
|
|
280
|
+
<span class='kw'>when</span> <span class='const'>NilClass</span>
|
|
281
|
+
<span class='kw'>nil</span>
|
|
282
|
+
<span class='kw'>else</span>
|
|
283
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Unsupported response type</span><span class='tstring_end'>'</span></span>
|
|
284
|
+
<span class='kw'>end</span>
|
|
285
|
+
<span class='kw'>end</span></pre>
|
|
286
|
+
</td>
|
|
287
|
+
</tr>
|
|
288
|
+
</table>
|
|
289
|
+
</div>
|
|
290
|
+
|
|
291
|
+
</div>
|
|
292
|
+
|
|
293
|
+
</div>
|
|
294
|
+
|
|
295
|
+
<div id="footer">
|
|
296
|
+
Generated on Tue May 9 15:32:18 2017 by
|
|
297
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
298
|
+
0.9.9 (ruby-2.2.2).
|
|
299
|
+
</div>
|
|
300
|
+
|
|
301
|
+
</div>
|
|
302
|
+
</body>
|
|
303
|
+
</html>
|
|
@@ -0,0 +1,840 @@
|
|
|
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::Schedule
|
|
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::Schedule";
|
|
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 (S)</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">Schedule</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::Schedule
|
|
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::Schedule</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></dd>
|
|
95
|
+
</dl>
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
<dl>
|
|
103
|
+
<dt>Defined in:</dt>
|
|
104
|
+
<dd>lib/basecamp3/models/schedule.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 Schedule</p>
|
|
113
|
+
|
|
114
|
+
<p><a href="https://github.com/basecamp/bc3-api/blob/master/sections/schedules.md#schedules" target="_parent" title="For more information, see the official Basecamp3 API documentation for Schedules">For more information, see the official Basecamp3 API documentation for Schedules</a></p>
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
</div>
|
|
118
|
+
</div>
|
|
119
|
+
<div class="tags">
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
</div>
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
<h2>Constant Summary</h2>
|
|
126
|
+
|
|
127
|
+
<h3 class="inherited">Constants inherited
|
|
128
|
+
from <span class='object_link'><a href="Model.html" title="Basecamp3::Model (class)">Model</a></span></h3>
|
|
129
|
+
<p class="inherited"><span class='object_link'><a href="Model.html#REQUIRED_FIELDS-constant" title="Basecamp3::Model::REQUIRED_FIELDS (constant)">Model::REQUIRED_FIELDS</a></span></p>
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
133
|
+
<ul class="summary">
|
|
134
|
+
|
|
135
|
+
<li class="public ">
|
|
136
|
+
<span class="summary_signature">
|
|
137
|
+
|
|
138
|
+
<a href="#created_at-instance_method" title="#created_at (instance method)">#<strong>created_at</strong> ⇒ Object </a>
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
</span>
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
<span class="summary_desc"><div class='inline'>
|
|
156
|
+
<p>Returns the value of attribute created_at.</p>
|
|
157
|
+
</div></span>
|
|
158
|
+
|
|
159
|
+
</li>
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
<li class="public ">
|
|
163
|
+
<span class="summary_signature">
|
|
164
|
+
|
|
165
|
+
<a href="#entries_count-instance_method" title="#entries_count (instance method)">#<strong>entries_count</strong> ⇒ Object </a>
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
</span>
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
<span class="summary_desc"><div class='inline'>
|
|
183
|
+
<p>Returns the value of attribute entries_count.</p>
|
|
184
|
+
</div></span>
|
|
185
|
+
|
|
186
|
+
</li>
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
<li class="public ">
|
|
190
|
+
<span class="summary_signature">
|
|
191
|
+
|
|
192
|
+
<a href="#id-instance_method" title="#id (instance method)">#<strong>id</strong> ⇒ Object </a>
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
</span>
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
<span class="summary_desc"><div class='inline'>
|
|
210
|
+
<p>Returns the value of attribute id.</p>
|
|
211
|
+
</div></span>
|
|
212
|
+
|
|
213
|
+
</li>
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
<li class="public ">
|
|
217
|
+
<span class="summary_signature">
|
|
218
|
+
|
|
219
|
+
<a href="#status-instance_method" title="#status (instance method)">#<strong>status</strong> ⇒ Object </a>
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
</span>
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
<span class="summary_desc"><div class='inline'>
|
|
237
|
+
<p>Returns the value of attribute status.</p>
|
|
238
|
+
</div></span>
|
|
239
|
+
|
|
240
|
+
</li>
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
<li class="public ">
|
|
244
|
+
<span class="summary_signature">
|
|
245
|
+
|
|
246
|
+
<a href="#title-instance_method" title="#title (instance method)">#<strong>title</strong> ⇒ Object </a>
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
</span>
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
<span class="summary_desc"><div class='inline'>
|
|
264
|
+
<p>Returns the value of attribute title.</p>
|
|
265
|
+
</div></span>
|
|
266
|
+
|
|
267
|
+
</li>
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
<li class="public ">
|
|
271
|
+
<span class="summary_signature">
|
|
272
|
+
|
|
273
|
+
<a href="#updated_at-instance_method" title="#updated_at (instance method)">#<strong>updated_at</strong> ⇒ Object </a>
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
</span>
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
<span class="summary_desc"><div class='inline'>
|
|
291
|
+
<p>Returns the value of attribute updated_at.</p>
|
|
292
|
+
</div></span>
|
|
293
|
+
|
|
294
|
+
</li>
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
</ul>
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
<h2>
|
|
304
|
+
Class Method Summary
|
|
305
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
306
|
+
</h2>
|
|
307
|
+
|
|
308
|
+
<ul class="summary">
|
|
309
|
+
|
|
310
|
+
<li class="public ">
|
|
311
|
+
<span class="summary_signature">
|
|
312
|
+
|
|
313
|
+
<a href="#find-class_method" title="find (class method)">.<strong>find</strong>(bucket_id, id) ⇒ Basecamp3::Schedule </a>
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
</span>
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
<span class="summary_desc"><div class='inline'>
|
|
328
|
+
<p>Returns the schedule.</p>
|
|
329
|
+
</div></span>
|
|
330
|
+
|
|
331
|
+
</li>
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
</ul>
|
|
335
|
+
|
|
336
|
+
<h2>
|
|
337
|
+
Instance Method Summary
|
|
338
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
339
|
+
</h2>
|
|
340
|
+
|
|
341
|
+
<ul class="summary">
|
|
342
|
+
|
|
343
|
+
<li class="public ">
|
|
344
|
+
<span class="summary_signature">
|
|
345
|
+
|
|
346
|
+
<a href="#entries-instance_method" title="#entries (instance method)">#<strong>entries</strong> ⇒ Array<Basecamp3::ScheduleEntry> </a>
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
</span>
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
|
|
360
|
+
<span class="summary_desc"><div class='inline'>
|
|
361
|
+
<p>Returns a list of related entries.</p>
|
|
362
|
+
</div></span>
|
|
363
|
+
|
|
364
|
+
</li>
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
</ul>
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
|
|
376
|
+
|
|
377
|
+
|
|
378
|
+
|
|
379
|
+
<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>
|
|
380
|
+
<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>
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
<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>
|
|
391
|
+
<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>
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
|
|
395
|
+
|
|
396
|
+
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
|
|
400
|
+
|
|
401
|
+
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Model.html" title="Basecamp3::Model (class)">Model</a></span></h3>
|
|
402
|
+
<p class="inherited"><span class='object_link'><a href="Model.html#initialize-instance_method" title="Basecamp3::Model#initialize (method)">#initialize</a></span></p>
|
|
403
|
+
<div id="constructor_details" class="method_details_list">
|
|
404
|
+
<h2>Constructor Details</h2>
|
|
405
|
+
|
|
406
|
+
<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>
|
|
407
|
+
|
|
408
|
+
</div>
|
|
409
|
+
|
|
410
|
+
<div id="instance_attr_details" class="attr_details">
|
|
411
|
+
<h2>Instance Attribute Details</h2>
|
|
412
|
+
|
|
413
|
+
|
|
414
|
+
<span id="created_at=-instance_method"></span>
|
|
415
|
+
<div class="method_details first">
|
|
416
|
+
<h3 class="signature first" id="created_at-instance_method">
|
|
417
|
+
|
|
418
|
+
#<strong>created_at</strong> ⇒ <tt>Object</tt>
|
|
419
|
+
|
|
420
|
+
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
|
|
424
|
+
</h3><div class="docstring">
|
|
425
|
+
<div class="discussion">
|
|
426
|
+
|
|
427
|
+
<p>Returns the value of attribute created_at</p>
|
|
428
|
+
|
|
429
|
+
|
|
430
|
+
</div>
|
|
431
|
+
</div>
|
|
432
|
+
<div class="tags">
|
|
433
|
+
|
|
434
|
+
|
|
435
|
+
</div><table class="source_code">
|
|
436
|
+
<tr>
|
|
437
|
+
<td>
|
|
438
|
+
<pre class="lines">
|
|
439
|
+
|
|
440
|
+
|
|
441
|
+
8
|
|
442
|
+
9
|
|
443
|
+
10</pre>
|
|
444
|
+
</td>
|
|
445
|
+
<td>
|
|
446
|
+
<pre class="code"><span class="info file"># File 'lib/basecamp3/models/schedule.rb', line 8</span>
|
|
447
|
+
|
|
448
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_created_at'>created_at</span>
|
|
449
|
+
<span class='ivar'>@created_at</span>
|
|
450
|
+
<span class='kw'>end</span></pre>
|
|
451
|
+
</td>
|
|
452
|
+
</tr>
|
|
453
|
+
</table>
|
|
454
|
+
</div>
|
|
455
|
+
|
|
456
|
+
|
|
457
|
+
<span id="entries_count=-instance_method"></span>
|
|
458
|
+
<div class="method_details ">
|
|
459
|
+
<h3 class="signature " id="entries_count-instance_method">
|
|
460
|
+
|
|
461
|
+
#<strong>entries_count</strong> ⇒ <tt>Object</tt>
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
|
|
465
|
+
|
|
466
|
+
|
|
467
|
+
</h3><div class="docstring">
|
|
468
|
+
<div class="discussion">
|
|
469
|
+
|
|
470
|
+
<p>Returns the value of attribute entries_count</p>
|
|
471
|
+
|
|
472
|
+
|
|
473
|
+
</div>
|
|
474
|
+
</div>
|
|
475
|
+
<div class="tags">
|
|
476
|
+
|
|
477
|
+
|
|
478
|
+
</div><table class="source_code">
|
|
479
|
+
<tr>
|
|
480
|
+
<td>
|
|
481
|
+
<pre class="lines">
|
|
482
|
+
|
|
483
|
+
|
|
484
|
+
8
|
|
485
|
+
9
|
|
486
|
+
10</pre>
|
|
487
|
+
</td>
|
|
488
|
+
<td>
|
|
489
|
+
<pre class="code"><span class="info file"># File 'lib/basecamp3/models/schedule.rb', line 8</span>
|
|
490
|
+
|
|
491
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_entries_count'>entries_count</span>
|
|
492
|
+
<span class='ivar'>@entries_count</span>
|
|
493
|
+
<span class='kw'>end</span></pre>
|
|
494
|
+
</td>
|
|
495
|
+
</tr>
|
|
496
|
+
</table>
|
|
497
|
+
</div>
|
|
498
|
+
|
|
499
|
+
|
|
500
|
+
<span id="id=-instance_method"></span>
|
|
501
|
+
<div class="method_details ">
|
|
502
|
+
<h3 class="signature " id="id-instance_method">
|
|
503
|
+
|
|
504
|
+
#<strong>id</strong> ⇒ <tt>Object</tt>
|
|
505
|
+
|
|
506
|
+
|
|
507
|
+
|
|
508
|
+
|
|
509
|
+
|
|
510
|
+
</h3><div class="docstring">
|
|
511
|
+
<div class="discussion">
|
|
512
|
+
|
|
513
|
+
<p>Returns the value of attribute id</p>
|
|
514
|
+
|
|
515
|
+
|
|
516
|
+
</div>
|
|
517
|
+
</div>
|
|
518
|
+
<div class="tags">
|
|
519
|
+
|
|
520
|
+
|
|
521
|
+
</div><table class="source_code">
|
|
522
|
+
<tr>
|
|
523
|
+
<td>
|
|
524
|
+
<pre class="lines">
|
|
525
|
+
|
|
526
|
+
|
|
527
|
+
8
|
|
528
|
+
9
|
|
529
|
+
10</pre>
|
|
530
|
+
</td>
|
|
531
|
+
<td>
|
|
532
|
+
<pre class="code"><span class="info file"># File 'lib/basecamp3/models/schedule.rb', line 8</span>
|
|
533
|
+
|
|
534
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_id'>id</span>
|
|
535
|
+
<span class='ivar'>@id</span>
|
|
536
|
+
<span class='kw'>end</span></pre>
|
|
537
|
+
</td>
|
|
538
|
+
</tr>
|
|
539
|
+
</table>
|
|
540
|
+
</div>
|
|
541
|
+
|
|
542
|
+
|
|
543
|
+
<span id="status=-instance_method"></span>
|
|
544
|
+
<div class="method_details ">
|
|
545
|
+
<h3 class="signature " id="status-instance_method">
|
|
546
|
+
|
|
547
|
+
#<strong>status</strong> ⇒ <tt>Object</tt>
|
|
548
|
+
|
|
549
|
+
|
|
550
|
+
|
|
551
|
+
|
|
552
|
+
|
|
553
|
+
</h3><div class="docstring">
|
|
554
|
+
<div class="discussion">
|
|
555
|
+
|
|
556
|
+
<p>Returns the value of attribute status</p>
|
|
557
|
+
|
|
558
|
+
|
|
559
|
+
</div>
|
|
560
|
+
</div>
|
|
561
|
+
<div class="tags">
|
|
562
|
+
|
|
563
|
+
|
|
564
|
+
</div><table class="source_code">
|
|
565
|
+
<tr>
|
|
566
|
+
<td>
|
|
567
|
+
<pre class="lines">
|
|
568
|
+
|
|
569
|
+
|
|
570
|
+
8
|
|
571
|
+
9
|
|
572
|
+
10</pre>
|
|
573
|
+
</td>
|
|
574
|
+
<td>
|
|
575
|
+
<pre class="code"><span class="info file"># File 'lib/basecamp3/models/schedule.rb', line 8</span>
|
|
576
|
+
|
|
577
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_status'>status</span>
|
|
578
|
+
<span class='ivar'>@status</span>
|
|
579
|
+
<span class='kw'>end</span></pre>
|
|
580
|
+
</td>
|
|
581
|
+
</tr>
|
|
582
|
+
</table>
|
|
583
|
+
</div>
|
|
584
|
+
|
|
585
|
+
|
|
586
|
+
<span id="title=-instance_method"></span>
|
|
587
|
+
<div class="method_details ">
|
|
588
|
+
<h3 class="signature " id="title-instance_method">
|
|
589
|
+
|
|
590
|
+
#<strong>title</strong> ⇒ <tt>Object</tt>
|
|
591
|
+
|
|
592
|
+
|
|
593
|
+
|
|
594
|
+
|
|
595
|
+
|
|
596
|
+
</h3><div class="docstring">
|
|
597
|
+
<div class="discussion">
|
|
598
|
+
|
|
599
|
+
<p>Returns the value of attribute title</p>
|
|
600
|
+
|
|
601
|
+
|
|
602
|
+
</div>
|
|
603
|
+
</div>
|
|
604
|
+
<div class="tags">
|
|
605
|
+
|
|
606
|
+
|
|
607
|
+
</div><table class="source_code">
|
|
608
|
+
<tr>
|
|
609
|
+
<td>
|
|
610
|
+
<pre class="lines">
|
|
611
|
+
|
|
612
|
+
|
|
613
|
+
8
|
|
614
|
+
9
|
|
615
|
+
10</pre>
|
|
616
|
+
</td>
|
|
617
|
+
<td>
|
|
618
|
+
<pre class="code"><span class="info file"># File 'lib/basecamp3/models/schedule.rb', line 8</span>
|
|
619
|
+
|
|
620
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_title'>title</span>
|
|
621
|
+
<span class='ivar'>@title</span>
|
|
622
|
+
<span class='kw'>end</span></pre>
|
|
623
|
+
</td>
|
|
624
|
+
</tr>
|
|
625
|
+
</table>
|
|
626
|
+
</div>
|
|
627
|
+
|
|
628
|
+
|
|
629
|
+
<span id="updated_at=-instance_method"></span>
|
|
630
|
+
<div class="method_details ">
|
|
631
|
+
<h3 class="signature " id="updated_at-instance_method">
|
|
632
|
+
|
|
633
|
+
#<strong>updated_at</strong> ⇒ <tt>Object</tt>
|
|
634
|
+
|
|
635
|
+
|
|
636
|
+
|
|
637
|
+
|
|
638
|
+
|
|
639
|
+
</h3><div class="docstring">
|
|
640
|
+
<div class="discussion">
|
|
641
|
+
|
|
642
|
+
<p>Returns the value of attribute updated_at</p>
|
|
643
|
+
|
|
644
|
+
|
|
645
|
+
</div>
|
|
646
|
+
</div>
|
|
647
|
+
<div class="tags">
|
|
648
|
+
|
|
649
|
+
|
|
650
|
+
</div><table class="source_code">
|
|
651
|
+
<tr>
|
|
652
|
+
<td>
|
|
653
|
+
<pre class="lines">
|
|
654
|
+
|
|
655
|
+
|
|
656
|
+
8
|
|
657
|
+
9
|
|
658
|
+
10</pre>
|
|
659
|
+
</td>
|
|
660
|
+
<td>
|
|
661
|
+
<pre class="code"><span class="info file"># File 'lib/basecamp3/models/schedule.rb', line 8</span>
|
|
662
|
+
|
|
663
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_updated_at'>updated_at</span>
|
|
664
|
+
<span class='ivar'>@updated_at</span>
|
|
665
|
+
<span class='kw'>end</span></pre>
|
|
666
|
+
</td>
|
|
667
|
+
</tr>
|
|
668
|
+
</table>
|
|
669
|
+
</div>
|
|
670
|
+
|
|
671
|
+
</div>
|
|
672
|
+
|
|
673
|
+
|
|
674
|
+
<div id="class_method_details" class="method_details_list">
|
|
675
|
+
<h2>Class Method Details</h2>
|
|
676
|
+
|
|
677
|
+
|
|
678
|
+
<div class="method_details first">
|
|
679
|
+
<h3 class="signature first" id="find-class_method">
|
|
680
|
+
|
|
681
|
+
.<strong>find</strong>(bucket_id, id) ⇒ <tt><span class='object_link'><a href="" title="Basecamp3::Schedule (class)">Basecamp3::Schedule</a></span></tt>
|
|
682
|
+
|
|
683
|
+
|
|
684
|
+
|
|
685
|
+
|
|
686
|
+
|
|
687
|
+
</h3><div class="docstring">
|
|
688
|
+
<div class="discussion">
|
|
689
|
+
|
|
690
|
+
<p>Returns the schedule.</p>
|
|
691
|
+
|
|
692
|
+
|
|
693
|
+
</div>
|
|
694
|
+
</div>
|
|
695
|
+
<div class="tags">
|
|
696
|
+
<p class="tag_title">Parameters:</p>
|
|
697
|
+
<ul class="param">
|
|
698
|
+
|
|
699
|
+
<li>
|
|
700
|
+
|
|
701
|
+
<span class='name'>bucket_id</span>
|
|
702
|
+
|
|
703
|
+
|
|
704
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
705
|
+
|
|
706
|
+
|
|
707
|
+
|
|
708
|
+
—
|
|
709
|
+
<div class='inline'>
|
|
710
|
+
<p>the id of the bucket</p>
|
|
711
|
+
</div>
|
|
712
|
+
|
|
713
|
+
</li>
|
|
714
|
+
|
|
715
|
+
<li>
|
|
716
|
+
|
|
717
|
+
<span class='name'>id</span>
|
|
718
|
+
|
|
719
|
+
|
|
720
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
721
|
+
|
|
722
|
+
|
|
723
|
+
|
|
724
|
+
—
|
|
725
|
+
<div class='inline'>
|
|
726
|
+
<p>the id of the schedule</p>
|
|
727
|
+
</div>
|
|
728
|
+
|
|
729
|
+
</li>
|
|
730
|
+
|
|
731
|
+
</ul>
|
|
732
|
+
|
|
733
|
+
<p class="tag_title">Returns:</p>
|
|
734
|
+
<ul class="return">
|
|
735
|
+
|
|
736
|
+
<li>
|
|
737
|
+
|
|
738
|
+
|
|
739
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Basecamp3::Schedule (class)">Basecamp3::Schedule</a></span></tt>)</span>
|
|
740
|
+
|
|
741
|
+
|
|
742
|
+
|
|
743
|
+
</li>
|
|
744
|
+
|
|
745
|
+
</ul>
|
|
746
|
+
|
|
747
|
+
</div><table class="source_code">
|
|
748
|
+
<tr>
|
|
749
|
+
<td>
|
|
750
|
+
<pre class="lines">
|
|
751
|
+
|
|
752
|
+
|
|
753
|
+
28
|
|
754
|
+
29
|
|
755
|
+
30</pre>
|
|
756
|
+
</td>
|
|
757
|
+
<td>
|
|
758
|
+
<pre class="code"><span class="info file"># File 'lib/basecamp3/models/schedule.rb', line 28</span>
|
|
759
|
+
|
|
760
|
+
<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>
|
|
761
|
+
<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'>/schedules/</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::Schedule (class)">Schedule</a></span></span><span class='rparen'>)</span>
|
|
762
|
+
<span class='kw'>end</span></pre>
|
|
763
|
+
</td>
|
|
764
|
+
</tr>
|
|
765
|
+
</table>
|
|
766
|
+
</div>
|
|
767
|
+
|
|
768
|
+
</div>
|
|
769
|
+
|
|
770
|
+
<div id="instance_method_details" class="method_details_list">
|
|
771
|
+
<h2>Instance Method Details</h2>
|
|
772
|
+
|
|
773
|
+
|
|
774
|
+
<div class="method_details first">
|
|
775
|
+
<h3 class="signature first" id="entries-instance_method">
|
|
776
|
+
|
|
777
|
+
#<strong>entries</strong> ⇒ <tt>Array<<span class='object_link'><a href="ScheduleEntry.html" title="Basecamp3::ScheduleEntry (class)">Basecamp3::ScheduleEntry</a></span>></tt>
|
|
778
|
+
|
|
779
|
+
|
|
780
|
+
|
|
781
|
+
|
|
782
|
+
|
|
783
|
+
</h3><div class="docstring">
|
|
784
|
+
<div class="discussion">
|
|
785
|
+
|
|
786
|
+
<p>Returns a list of related entries.</p>
|
|
787
|
+
|
|
788
|
+
|
|
789
|
+
</div>
|
|
790
|
+
</div>
|
|
791
|
+
<div class="tags">
|
|
792
|
+
|
|
793
|
+
<p class="tag_title">Returns:</p>
|
|
794
|
+
<ul class="return">
|
|
795
|
+
|
|
796
|
+
<li>
|
|
797
|
+
|
|
798
|
+
|
|
799
|
+
<span class='type'>(<tt>Array<<span class='object_link'><a href="ScheduleEntry.html" title="Basecamp3::ScheduleEntry (class)">Basecamp3::ScheduleEntry</a></span>></tt>)</span>
|
|
800
|
+
|
|
801
|
+
|
|
802
|
+
|
|
803
|
+
</li>
|
|
804
|
+
|
|
805
|
+
</ul>
|
|
806
|
+
|
|
807
|
+
</div><table class="source_code">
|
|
808
|
+
<tr>
|
|
809
|
+
<td>
|
|
810
|
+
<pre class="lines">
|
|
811
|
+
|
|
812
|
+
|
|
813
|
+
18
|
|
814
|
+
19
|
|
815
|
+
20</pre>
|
|
816
|
+
</td>
|
|
817
|
+
<td>
|
|
818
|
+
<pre class="code"><span class="info file"># File 'lib/basecamp3/models/schedule.rb', line 18</span>
|
|
819
|
+
|
|
820
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_entries'>entries</span>
|
|
821
|
+
<span class='ivar'>@mapped_entries</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="ScheduleEntry.html" title="Basecamp3::ScheduleEntry (class)">ScheduleEntry</a></span></span><span class='period'>.</span><span class='id identifier rubyid_all'><span class='object_link'><a href="ScheduleEntry.html#all-class_method" title="Basecamp3::ScheduleEntry.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>
|
|
822
|
+
<span class='kw'>end</span></pre>
|
|
823
|
+
</td>
|
|
824
|
+
</tr>
|
|
825
|
+
</table>
|
|
826
|
+
</div>
|
|
827
|
+
|
|
828
|
+
</div>
|
|
829
|
+
|
|
830
|
+
</div>
|
|
831
|
+
|
|
832
|
+
<div id="footer">
|
|
833
|
+
Generated on Tue May 9 15:32:18 2017 by
|
|
834
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
835
|
+
0.9.9 (ruby-2.2.2).
|
|
836
|
+
</div>
|
|
837
|
+
|
|
838
|
+
</div>
|
|
839
|
+
</body>
|
|
840
|
+
</html>
|