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.
Files changed (89) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +12 -0
  3. data/.rspec +2 -0
  4. data/.travis.yml +5 -0
  5. data/Gemfile +2 -0
  6. data/LICENSE.txt +21 -0
  7. data/README.md +65 -0
  8. data/Rakefile +6 -0
  9. data/basecamp3.gemspec +38 -0
  10. data/bin/console +14 -0
  11. data/bin/setup +8 -0
  12. data/docs/Basecamp3.html +367 -0
  13. data/docs/Basecamp3/Campfire.html +901 -0
  14. data/docs/Basecamp3/CampfireLine.html +1025 -0
  15. data/docs/Basecamp3/Comment.html +1284 -0
  16. data/docs/Basecamp3/Concerns.html +117 -0
  17. data/docs/Basecamp3/Concerns/Bucketable.html +211 -0
  18. data/docs/Basecamp3/Concerns/Commentable.html +285 -0
  19. data/docs/Basecamp3/Concerns/Creatorable.html +209 -0
  20. data/docs/Basecamp3/Concerns/Parentable.html +211 -0
  21. data/docs/Basecamp3/Concerns/Recordingable.html +189 -0
  22. data/docs/Basecamp3/Concerns/Recordingable/ClassMethods.html +236 -0
  23. data/docs/Basecamp3/Document.html +1262 -0
  24. data/docs/Basecamp3/Forward.html +1070 -0
  25. data/docs/Basecamp3/Inbox.html +840 -0
  26. data/docs/Basecamp3/Message.html +1262 -0
  27. data/docs/Basecamp3/MessageBoard.html +840 -0
  28. data/docs/Basecamp3/MessageType.html +1160 -0
  29. data/docs/Basecamp3/Model.html +236 -0
  30. data/docs/Basecamp3/Person.html +1288 -0
  31. data/docs/Basecamp3/Project.html +1280 -0
  32. data/docs/Basecamp3/Question.html +1050 -0
  33. data/docs/Basecamp3/QuestionAnswer.html +887 -0
  34. data/docs/Basecamp3/Questionnaire.html +840 -0
  35. data/docs/Basecamp3/Request.html +933 -0
  36. data/docs/Basecamp3/ResponseParser.html +303 -0
  37. data/docs/Basecamp3/Schedule.html +840 -0
  38. data/docs/Basecamp3/ScheduleEntry.html +1560 -0
  39. data/docs/Basecamp3/Todo.html +1726 -0
  40. data/docs/Basecamp3/TodoList.html +1480 -0
  41. data/docs/Basecamp3/TodoSet.html +980 -0
  42. data/docs/Basecamp3/TypeMapper.html +329 -0
  43. data/docs/Basecamp3/Vault.html +1514 -0
  44. data/docs/_index.html +415 -0
  45. data/docs/class_list.html +51 -0
  46. data/docs/css/common.css +1 -0
  47. data/docs/css/full_list.css +58 -0
  48. data/docs/css/style.css +492 -0
  49. data/docs/file.README.html +157 -0
  50. data/docs/file_list.html +56 -0
  51. data/docs/frames.html +17 -0
  52. data/docs/index.html +157 -0
  53. data/docs/js/app.js +248 -0
  54. data/docs/js/full_list.js +216 -0
  55. data/docs/js/jquery.js +4 -0
  56. data/docs/method_list.html +1875 -0
  57. data/docs/top-level-namespace.html +110 -0
  58. data/lib/basecamp3.rb +61 -0
  59. data/lib/basecamp3/concerns/bucketable.rb +17 -0
  60. data/lib/basecamp3/concerns/commentable.rb +15 -0
  61. data/lib/basecamp3/concerns/creatorable.rb +16 -0
  62. data/lib/basecamp3/concerns/parentable.rb +17 -0
  63. data/lib/basecamp3/concerns/recordingable.rb +22 -0
  64. data/lib/basecamp3/model.rb +23 -0
  65. data/lib/basecamp3/models/campfire.rb +42 -0
  66. data/lib/basecamp3/models/campfire_line.rb +52 -0
  67. data/lib/basecamp3/models/comment.rb +65 -0
  68. data/lib/basecamp3/models/document.rb +71 -0
  69. data/lib/basecamp3/models/forward.rb +40 -0
  70. data/lib/basecamp3/models/inbox.rb +31 -0
  71. data/lib/basecamp3/models/message.rb +73 -0
  72. data/lib/basecamp3/models/message_board.rb +31 -0
  73. data/lib/basecamp3/models/message_type.rb +68 -0
  74. data/lib/basecamp3/models/person.rb +46 -0
  75. data/lib/basecamp3/models/project.rb +70 -0
  76. data/lib/basecamp3/models/question.rb +43 -0
  77. data/lib/basecamp3/models/question_answer.rb +35 -0
  78. data/lib/basecamp3/models/questionnaire.rb +31 -0
  79. data/lib/basecamp3/models/schedule.rb +31 -0
  80. data/lib/basecamp3/models/schedule_entry.rb +93 -0
  81. data/lib/basecamp3/models/todo.rb +108 -0
  82. data/lib/basecamp3/models/todo_list.rb +77 -0
  83. data/lib/basecamp3/models/todo_set.rb +33 -0
  84. data/lib/basecamp3/models/vault.rb +79 -0
  85. data/lib/basecamp3/request.rb +163 -0
  86. data/lib/basecamp3/response_parser.rb +44 -0
  87. data/lib/basecamp3/type_mapper.rb +53 -0
  88. data/lib/basecamp3/version.rb +3 -0
  89. metadata +202 -0
@@ -0,0 +1,236 @@
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::Model
8
+
9
+ &mdash; 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::Model";
19
+ relpath = '../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="../class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="../_index.html">Index (M)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../Basecamp3.html" title="Basecamp3 (module)">Basecamp3</a></span></span>
41
+ &raquo;
42
+ <span class="title">Model</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::Model
63
+ <span class="abstract note title">Abstract</span>
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::Model</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/model.rb</dd>
98
+ </dl>
99
+
100
+ </div>
101
+
102
+ <h2>Overview</h2><div class="docstring">
103
+ <div class="discussion">
104
+ <div class="note abstract">
105
+ <strong>This class is abstract.</strong>
106
+ <div class='inline'></div>
107
+ </div>
108
+
109
+ <p>A base class for models</p>
110
+
111
+
112
+ </div>
113
+ </div>
114
+ <div class="tags">
115
+
116
+
117
+ </div><div id="subclasses">
118
+ <h2>Direct Known Subclasses</h2>
119
+ <p class="children"><span class='object_link'><a href="Campfire.html" title="Basecamp3::Campfire (class)">Campfire</a></span>, <span class='object_link'><a href="CampfireLine.html" title="Basecamp3::CampfireLine (class)">CampfireLine</a></span>, <span class='object_link'><a href="Comment.html" title="Basecamp3::Comment (class)">Comment</a></span>, <span class='object_link'><a href="Document.html" title="Basecamp3::Document (class)">Document</a></span>, <span class='object_link'><a href="Forward.html" title="Basecamp3::Forward (class)">Forward</a></span>, <span class='object_link'><a href="Inbox.html" title="Basecamp3::Inbox (class)">Inbox</a></span>, <span class='object_link'><a href="Message.html" title="Basecamp3::Message (class)">Message</a></span>, <span class='object_link'><a href="MessageBoard.html" title="Basecamp3::MessageBoard (class)">MessageBoard</a></span>, <span class='object_link'><a href="MessageType.html" title="Basecamp3::MessageType (class)">MessageType</a></span>, <span class='object_link'><a href="Person.html" title="Basecamp3::Person (class)">Person</a></span>, <span class='object_link'><a href="Project.html" title="Basecamp3::Project (class)">Project</a></span>, <span class='object_link'><a href="Question.html" title="Basecamp3::Question (class)">Question</a></span>, <span class='object_link'><a href="QuestionAnswer.html" title="Basecamp3::QuestionAnswer (class)">QuestionAnswer</a></span>, <span class='object_link'><a href="Questionnaire.html" title="Basecamp3::Questionnaire (class)">Questionnaire</a></span>, <span class='object_link'><a href="Schedule.html" title="Basecamp3::Schedule (class)">Schedule</a></span>, <span class='object_link'><a href="ScheduleEntry.html" title="Basecamp3::ScheduleEntry (class)">ScheduleEntry</a></span>, <span class='object_link'><a href="Todo.html" title="Basecamp3::Todo (class)">Todo</a></span>, <span class='object_link'><a href="TodoList.html" title="Basecamp3::TodoList (class)">TodoList</a></span>, <span class='object_link'><a href="TodoSet.html" title="Basecamp3::TodoSet (class)">TodoSet</a></span>, <span class='object_link'><a href="Vault.html" title="Basecamp3::Vault (class)">Vault</a></span></p>
120
+ </div>
121
+
122
+ <h2>Constant Summary</h2>
123
+ <dl class="constants">
124
+
125
+ <dt id="REQUIRED_FIELDS-constant" class="">REQUIRED_FIELDS =
126
+
127
+ </dt>
128
+ <dd><pre class="code"><span class='lbracket'>[</span><span class='rbracket'>]</span></pre></dd>
129
+
130
+ </dl>
131
+
132
+
133
+
134
+
135
+
136
+
137
+
138
+
139
+ <h2>
140
+ Instance Method Summary
141
+ <small><a href="#" class="summary_toggle">collapse</a></small>
142
+ </h2>
143
+
144
+ <ul class="summary">
145
+
146
+ <li class="public ">
147
+ <span class="summary_signature">
148
+
149
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(data = {}) &#x21d2; Model </a>
150
+
151
+
152
+
153
+ </span>
154
+
155
+
156
+ <span class="note title constructor">constructor</span>
157
+
158
+
159
+
160
+
161
+
162
+
163
+
164
+
165
+ <span class="summary_desc"><div class='inline'>
166
+ <p>A new instance of Model.</p>
167
+ </div></span>
168
+
169
+ </li>
170
+
171
+
172
+ </ul>
173
+
174
+
175
+ <div id="constructor_details" class="method_details_list">
176
+ <h2>Constructor Details</h2>
177
+
178
+ <div class="method_details first">
179
+ <h3 class="signature first" id="initialize-instance_method">
180
+
181
+ #<strong>initialize</strong>(data = {}) &#x21d2; <tt><span class='object_link'><a href="" title="Basecamp3::Model (class)">Model</a></span></tt>
182
+
183
+
184
+
185
+
186
+
187
+ </h3><div class="docstring">
188
+ <div class="discussion">
189
+
190
+ <p>Returns a new instance of Model</p>
191
+
192
+
193
+ </div>
194
+ </div>
195
+ <div class="tags">
196
+
197
+
198
+ </div><table class="source_code">
199
+ <tr>
200
+ <td>
201
+ <pre class="lines">
202
+
203
+
204
+ 7
205
+ 8
206
+ 9
207
+ 10
208
+ 11</pre>
209
+ </td>
210
+ <td>
211
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/model.rb', line 7</span>
212
+
213
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
214
+ <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_attr'>attr</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='op'>|</span>
215
+ <span class='id identifier rubyid_instance_variable_set'>instance_variable_set</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>@</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_attr'>attr</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
216
+ <span class='kw'>end</span>
217
+ <span class='kw'>end</span></pre>
218
+ </td>
219
+ </tr>
220
+ </table>
221
+ </div>
222
+
223
+ </div>
224
+
225
+
226
+ </div>
227
+
228
+ <div id="footer">
229
+ Generated on Tue May 9 15:32:16 2017 by
230
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
231
+ 0.9.9 (ruby-2.2.2).
232
+ </div>
233
+
234
+ </div>
235
+ </body>
236
+ </html>
@@ -0,0 +1,1288 @@
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::Person
8
+
9
+ &mdash; 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::Person";
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 (P)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../Basecamp3.html" title="Basecamp3 (module)">Basecamp3</a></span></span>
41
+ &raquo;
42
+ <span class="title">Person</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::Person
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::Person</li>
80
+
81
+ </ul>
82
+ <a href="#" class="inheritanceTree">show all</a>
83
+
84
+ </dd>
85
+ </dl>
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+ <dl>
98
+ <dt>Defined in:</dt>
99
+ <dd>lib/basecamp3/models/person.rb</dd>
100
+ </dl>
101
+
102
+ </div>
103
+
104
+ <h2>Overview</h2><div class="docstring">
105
+ <div class="discussion">
106
+
107
+ <p>A model for Basecamp&#39;s Message Person</p>
108
+
109
+ <p><a href="https://github.com/basecamp/bc3-api/blob/master/sections/people.md#people" target="_parent" title="For more information, see the official Basecamp3 API documentation for People">For more information, see the official Basecamp3 API documentation for People</a></p>
110
+
111
+
112
+ </div>
113
+ </div>
114
+ <div class="tags">
115
+
116
+
117
+ </div>
118
+
119
+
120
+ <h2>Constant Summary</h2>
121
+
122
+ <h3 class="inherited">Constants inherited
123
+ from <span class='object_link'><a href="Model.html" title="Basecamp3::Model (class)">Model</a></span></h3>
124
+ <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>
125
+
126
+
127
+ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
128
+ <ul class="summary">
129
+
130
+ <li class="public ">
131
+ <span class="summary_signature">
132
+
133
+ <a href="#admin-instance_method" title="#admin (instance method)">#<strong>admin</strong> &#x21d2; Object </a>
134
+
135
+
136
+
137
+ </span>
138
+
139
+
140
+
141
+
142
+
143
+
144
+
145
+
146
+
147
+
148
+
149
+
150
+ <span class="summary_desc"><div class='inline'>
151
+ <p>Returns the value of attribute admin.</p>
152
+ </div></span>
153
+
154
+ </li>
155
+
156
+
157
+ <li class="public ">
158
+ <span class="summary_signature">
159
+
160
+ <a href="#avatar_url-instance_method" title="#avatar_url (instance method)">#<strong>avatar_url</strong> &#x21d2; Object </a>
161
+
162
+
163
+
164
+ </span>
165
+
166
+
167
+
168
+
169
+
170
+
171
+
172
+
173
+
174
+
175
+
176
+
177
+ <span class="summary_desc"><div class='inline'>
178
+ <p>Returns the value of attribute avatar_url.</p>
179
+ </div></span>
180
+
181
+ </li>
182
+
183
+
184
+ <li class="public ">
185
+ <span class="summary_signature">
186
+
187
+ <a href="#bio-instance_method" title="#bio (instance method)">#<strong>bio</strong> &#x21d2; Object </a>
188
+
189
+
190
+
191
+ </span>
192
+
193
+
194
+
195
+
196
+
197
+
198
+
199
+
200
+
201
+
202
+
203
+
204
+ <span class="summary_desc"><div class='inline'>
205
+ <p>Returns the value of attribute bio.</p>
206
+ </div></span>
207
+
208
+ </li>
209
+
210
+
211
+ <li class="public ">
212
+ <span class="summary_signature">
213
+
214
+ <a href="#created_at-instance_method" title="#created_at (instance method)">#<strong>created_at</strong> &#x21d2; Object </a>
215
+
216
+
217
+
218
+ </span>
219
+
220
+
221
+
222
+
223
+
224
+
225
+
226
+
227
+
228
+
229
+
230
+
231
+ <span class="summary_desc"><div class='inline'>
232
+ <p>Returns the value of attribute created_at.</p>
233
+ </div></span>
234
+
235
+ </li>
236
+
237
+
238
+ <li class="public ">
239
+ <span class="summary_signature">
240
+
241
+ <a href="#email_address-instance_method" title="#email_address (instance method)">#<strong>email_address</strong> &#x21d2; Object </a>
242
+
243
+
244
+
245
+ </span>
246
+
247
+
248
+
249
+
250
+
251
+
252
+
253
+
254
+
255
+
256
+
257
+
258
+ <span class="summary_desc"><div class='inline'>
259
+ <p>Returns the value of attribute email_address.</p>
260
+ </div></span>
261
+
262
+ </li>
263
+
264
+
265
+ <li class="public ">
266
+ <span class="summary_signature">
267
+
268
+ <a href="#id-instance_method" title="#id (instance method)">#<strong>id</strong> &#x21d2; Object </a>
269
+
270
+
271
+
272
+ </span>
273
+
274
+
275
+
276
+
277
+
278
+
279
+
280
+
281
+
282
+
283
+
284
+
285
+ <span class="summary_desc"><div class='inline'>
286
+ <p>Returns the value of attribute id.</p>
287
+ </div></span>
288
+
289
+ </li>
290
+
291
+
292
+ <li class="public ">
293
+ <span class="summary_signature">
294
+
295
+ <a href="#name-instance_method" title="#name (instance method)">#<strong>name</strong> &#x21d2; Object </a>
296
+
297
+
298
+
299
+ </span>
300
+
301
+
302
+
303
+
304
+
305
+
306
+
307
+
308
+
309
+
310
+
311
+
312
+ <span class="summary_desc"><div class='inline'>
313
+ <p>Returns the value of attribute name.</p>
314
+ </div></span>
315
+
316
+ </li>
317
+
318
+
319
+ <li class="public ">
320
+ <span class="summary_signature">
321
+
322
+ <a href="#owner-instance_method" title="#owner (instance method)">#<strong>owner</strong> &#x21d2; Object </a>
323
+
324
+
325
+
326
+ </span>
327
+
328
+
329
+
330
+
331
+
332
+
333
+
334
+
335
+
336
+
337
+
338
+
339
+ <span class="summary_desc"><div class='inline'>
340
+ <p>Returns the value of attribute owner.</p>
341
+ </div></span>
342
+
343
+ </li>
344
+
345
+
346
+ <li class="public ">
347
+ <span class="summary_signature">
348
+
349
+ <a href="#time_zone-instance_method" title="#time_zone (instance method)">#<strong>time_zone</strong> &#x21d2; Object </a>
350
+
351
+
352
+
353
+ </span>
354
+
355
+
356
+
357
+
358
+
359
+
360
+
361
+
362
+
363
+
364
+
365
+
366
+ <span class="summary_desc"><div class='inline'>
367
+ <p>Returns the value of attribute time_zone.</p>
368
+ </div></span>
369
+
370
+ </li>
371
+
372
+
373
+ <li class="public ">
374
+ <span class="summary_signature">
375
+
376
+ <a href="#title-instance_method" title="#title (instance method)">#<strong>title</strong> &#x21d2; Object </a>
377
+
378
+
379
+
380
+ </span>
381
+
382
+
383
+
384
+
385
+
386
+
387
+
388
+
389
+
390
+
391
+
392
+
393
+ <span class="summary_desc"><div class='inline'>
394
+ <p>Returns the value of attribute title.</p>
395
+ </div></span>
396
+
397
+ </li>
398
+
399
+
400
+ <li class="public ">
401
+ <span class="summary_signature">
402
+
403
+ <a href="#updated_at-instance_method" title="#updated_at (instance method)">#<strong>updated_at</strong> &#x21d2; Object </a>
404
+
405
+
406
+
407
+ </span>
408
+
409
+
410
+
411
+
412
+
413
+
414
+
415
+
416
+
417
+
418
+
419
+
420
+ <span class="summary_desc"><div class='inline'>
421
+ <p>Returns the value of attribute updated_at.</p>
422
+ </div></span>
423
+
424
+ </li>
425
+
426
+
427
+ </ul>
428
+
429
+
430
+
431
+
432
+
433
+ <h2>
434
+ Class Method Summary
435
+ <small><a href="#" class="summary_toggle">collapse</a></small>
436
+ </h2>
437
+
438
+ <ul class="summary">
439
+
440
+ <li class="public ">
441
+ <span class="summary_signature">
442
+
443
+ <a href="#all-class_method" title="all (class method)">.<strong>all</strong> &#x21d2; Array&lt;Basecamp3::Person&gt; </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>Returns a list of all people visible to the current user.</p>
459
+ </div></span>
460
+
461
+ </li>
462
+
463
+
464
+ <li class="public ">
465
+ <span class="summary_signature">
466
+
467
+ <a href="#find-class_method" title="find (class method)">.<strong>find</strong>(id) &#x21d2; Basecamp3::Person </a>
468
+
469
+
470
+
471
+ </span>
472
+
473
+
474
+
475
+
476
+
477
+
478
+
479
+
480
+
481
+ <span class="summary_desc"><div class='inline'>
482
+ <p>Returns the person.</p>
483
+ </div></span>
484
+
485
+ </li>
486
+
487
+
488
+ <li class="public ">
489
+ <span class="summary_signature">
490
+
491
+ <a href="#me-class_method" title="me (class method)">.<strong>me</strong> &#x21d2; Basecamp3::Person </a>
492
+
493
+
494
+
495
+ </span>
496
+
497
+
498
+
499
+
500
+
501
+
502
+
503
+
504
+
505
+ <span class="summary_desc"><div class='inline'>
506
+ <p>Returns the current user&#39;s personal info..</p>
507
+ </div></span>
508
+
509
+ </li>
510
+
511
+
512
+ <li class="public ">
513
+ <span class="summary_signature">
514
+
515
+ <a href="#pingable-class_method" title="pingable (class method)">.<strong>pingable</strong> &#x21d2; Array&lt;Basecamp3::Person&gt; </a>
516
+
517
+
518
+
519
+ </span>
520
+
521
+
522
+
523
+
524
+
525
+
526
+
527
+
528
+
529
+ <span class="summary_desc"><div class='inline'>
530
+ <p>Returns a list of all people who can be pinged.</p>
531
+ </div></span>
532
+
533
+ </li>
534
+
535
+
536
+ </ul>
537
+
538
+
539
+
540
+
541
+
542
+
543
+
544
+
545
+
546
+
547
+
548
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Model.html" title="Basecamp3::Model (class)">Model</a></span></h3>
549
+ <p class="inherited"><span class='object_link'><a href="Model.html#initialize-instance_method" title="Basecamp3::Model#initialize (method)">#initialize</a></span></p>
550
+ <div id="constructor_details" class="method_details_list">
551
+ <h2>Constructor Details</h2>
552
+
553
+ <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>
554
+
555
+ </div>
556
+
557
+ <div id="instance_attr_details" class="attr_details">
558
+ <h2>Instance Attribute Details</h2>
559
+
560
+
561
+ <span id="admin=-instance_method"></span>
562
+ <div class="method_details first">
563
+ <h3 class="signature first" id="admin-instance_method">
564
+
565
+ #<strong>admin</strong> &#x21d2; <tt>Object</tt>
566
+
567
+
568
+
569
+
570
+
571
+ </h3><div class="docstring">
572
+ <div class="discussion">
573
+
574
+ <p>Returns the value of attribute admin</p>
575
+
576
+
577
+ </div>
578
+ </div>
579
+ <div class="tags">
580
+
581
+
582
+ </div><table class="source_code">
583
+ <tr>
584
+ <td>
585
+ <pre class="lines">
586
+
587
+
588
+ 5
589
+ 6
590
+ 7</pre>
591
+ </td>
592
+ <td>
593
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/models/person.rb', line 5</span>
594
+
595
+ <span class='kw'>def</span> <span class='id identifier rubyid_admin'>admin</span>
596
+ <span class='ivar'>@admin</span>
597
+ <span class='kw'>end</span></pre>
598
+ </td>
599
+ </tr>
600
+ </table>
601
+ </div>
602
+
603
+
604
+ <span id="avatar_url=-instance_method"></span>
605
+ <div class="method_details ">
606
+ <h3 class="signature " id="avatar_url-instance_method">
607
+
608
+ #<strong>avatar_url</strong> &#x21d2; <tt>Object</tt>
609
+
610
+
611
+
612
+
613
+
614
+ </h3><div class="docstring">
615
+ <div class="discussion">
616
+
617
+ <p>Returns the value of attribute avatar_url</p>
618
+
619
+
620
+ </div>
621
+ </div>
622
+ <div class="tags">
623
+
624
+
625
+ </div><table class="source_code">
626
+ <tr>
627
+ <td>
628
+ <pre class="lines">
629
+
630
+
631
+ 5
632
+ 6
633
+ 7</pre>
634
+ </td>
635
+ <td>
636
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/models/person.rb', line 5</span>
637
+
638
+ <span class='kw'>def</span> <span class='id identifier rubyid_avatar_url'>avatar_url</span>
639
+ <span class='ivar'>@avatar_url</span>
640
+ <span class='kw'>end</span></pre>
641
+ </td>
642
+ </tr>
643
+ </table>
644
+ </div>
645
+
646
+
647
+ <span id="bio=-instance_method"></span>
648
+ <div class="method_details ">
649
+ <h3 class="signature " id="bio-instance_method">
650
+
651
+ #<strong>bio</strong> &#x21d2; <tt>Object</tt>
652
+
653
+
654
+
655
+
656
+
657
+ </h3><div class="docstring">
658
+ <div class="discussion">
659
+
660
+ <p>Returns the value of attribute bio</p>
661
+
662
+
663
+ </div>
664
+ </div>
665
+ <div class="tags">
666
+
667
+
668
+ </div><table class="source_code">
669
+ <tr>
670
+ <td>
671
+ <pre class="lines">
672
+
673
+
674
+ 5
675
+ 6
676
+ 7</pre>
677
+ </td>
678
+ <td>
679
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/models/person.rb', line 5</span>
680
+
681
+ <span class='kw'>def</span> <span class='id identifier rubyid_bio'>bio</span>
682
+ <span class='ivar'>@bio</span>
683
+ <span class='kw'>end</span></pre>
684
+ </td>
685
+ </tr>
686
+ </table>
687
+ </div>
688
+
689
+
690
+ <span id="created_at=-instance_method"></span>
691
+ <div class="method_details ">
692
+ <h3 class="signature " id="created_at-instance_method">
693
+
694
+ #<strong>created_at</strong> &#x21d2; <tt>Object</tt>
695
+
696
+
697
+
698
+
699
+
700
+ </h3><div class="docstring">
701
+ <div class="discussion">
702
+
703
+ <p>Returns the value of attribute created_at</p>
704
+
705
+
706
+ </div>
707
+ </div>
708
+ <div class="tags">
709
+
710
+
711
+ </div><table class="source_code">
712
+ <tr>
713
+ <td>
714
+ <pre class="lines">
715
+
716
+
717
+ 5
718
+ 6
719
+ 7</pre>
720
+ </td>
721
+ <td>
722
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/models/person.rb', line 5</span>
723
+
724
+ <span class='kw'>def</span> <span class='id identifier rubyid_created_at'>created_at</span>
725
+ <span class='ivar'>@created_at</span>
726
+ <span class='kw'>end</span></pre>
727
+ </td>
728
+ </tr>
729
+ </table>
730
+ </div>
731
+
732
+
733
+ <span id="email_address=-instance_method"></span>
734
+ <div class="method_details ">
735
+ <h3 class="signature " id="email_address-instance_method">
736
+
737
+ #<strong>email_address</strong> &#x21d2; <tt>Object</tt>
738
+
739
+
740
+
741
+
742
+
743
+ </h3><div class="docstring">
744
+ <div class="discussion">
745
+
746
+ <p>Returns the value of attribute email_address</p>
747
+
748
+
749
+ </div>
750
+ </div>
751
+ <div class="tags">
752
+
753
+
754
+ </div><table class="source_code">
755
+ <tr>
756
+ <td>
757
+ <pre class="lines">
758
+
759
+
760
+ 5
761
+ 6
762
+ 7</pre>
763
+ </td>
764
+ <td>
765
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/models/person.rb', line 5</span>
766
+
767
+ <span class='kw'>def</span> <span class='id identifier rubyid_email_address'>email_address</span>
768
+ <span class='ivar'>@email_address</span>
769
+ <span class='kw'>end</span></pre>
770
+ </td>
771
+ </tr>
772
+ </table>
773
+ </div>
774
+
775
+
776
+ <span id="id=-instance_method"></span>
777
+ <div class="method_details ">
778
+ <h3 class="signature " id="id-instance_method">
779
+
780
+ #<strong>id</strong> &#x21d2; <tt>Object</tt>
781
+
782
+
783
+
784
+
785
+
786
+ </h3><div class="docstring">
787
+ <div class="discussion">
788
+
789
+ <p>Returns the value of attribute id</p>
790
+
791
+
792
+ </div>
793
+ </div>
794
+ <div class="tags">
795
+
796
+
797
+ </div><table class="source_code">
798
+ <tr>
799
+ <td>
800
+ <pre class="lines">
801
+
802
+
803
+ 5
804
+ 6
805
+ 7</pre>
806
+ </td>
807
+ <td>
808
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/models/person.rb', line 5</span>
809
+
810
+ <span class='kw'>def</span> <span class='id identifier rubyid_id'>id</span>
811
+ <span class='ivar'>@id</span>
812
+ <span class='kw'>end</span></pre>
813
+ </td>
814
+ </tr>
815
+ </table>
816
+ </div>
817
+
818
+
819
+ <span id="name=-instance_method"></span>
820
+ <div class="method_details ">
821
+ <h3 class="signature " id="name-instance_method">
822
+
823
+ #<strong>name</strong> &#x21d2; <tt>Object</tt>
824
+
825
+
826
+
827
+
828
+
829
+ </h3><div class="docstring">
830
+ <div class="discussion">
831
+
832
+ <p>Returns the value of attribute name</p>
833
+
834
+
835
+ </div>
836
+ </div>
837
+ <div class="tags">
838
+
839
+
840
+ </div><table class="source_code">
841
+ <tr>
842
+ <td>
843
+ <pre class="lines">
844
+
845
+
846
+ 5
847
+ 6
848
+ 7</pre>
849
+ </td>
850
+ <td>
851
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/models/person.rb', line 5</span>
852
+
853
+ <span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
854
+ <span class='ivar'>@name</span>
855
+ <span class='kw'>end</span></pre>
856
+ </td>
857
+ </tr>
858
+ </table>
859
+ </div>
860
+
861
+
862
+ <span id="owner=-instance_method"></span>
863
+ <div class="method_details ">
864
+ <h3 class="signature " id="owner-instance_method">
865
+
866
+ #<strong>owner</strong> &#x21d2; <tt>Object</tt>
867
+
868
+
869
+
870
+
871
+
872
+ </h3><div class="docstring">
873
+ <div class="discussion">
874
+
875
+ <p>Returns the value of attribute owner</p>
876
+
877
+
878
+ </div>
879
+ </div>
880
+ <div class="tags">
881
+
882
+
883
+ </div><table class="source_code">
884
+ <tr>
885
+ <td>
886
+ <pre class="lines">
887
+
888
+
889
+ 5
890
+ 6
891
+ 7</pre>
892
+ </td>
893
+ <td>
894
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/models/person.rb', line 5</span>
895
+
896
+ <span class='kw'>def</span> <span class='id identifier rubyid_owner'>owner</span>
897
+ <span class='ivar'>@owner</span>
898
+ <span class='kw'>end</span></pre>
899
+ </td>
900
+ </tr>
901
+ </table>
902
+ </div>
903
+
904
+
905
+ <span id="time_zone=-instance_method"></span>
906
+ <div class="method_details ">
907
+ <h3 class="signature " id="time_zone-instance_method">
908
+
909
+ #<strong>time_zone</strong> &#x21d2; <tt>Object</tt>
910
+
911
+
912
+
913
+
914
+
915
+ </h3><div class="docstring">
916
+ <div class="discussion">
917
+
918
+ <p>Returns the value of attribute time_zone</p>
919
+
920
+
921
+ </div>
922
+ </div>
923
+ <div class="tags">
924
+
925
+
926
+ </div><table class="source_code">
927
+ <tr>
928
+ <td>
929
+ <pre class="lines">
930
+
931
+
932
+ 5
933
+ 6
934
+ 7</pre>
935
+ </td>
936
+ <td>
937
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/models/person.rb', line 5</span>
938
+
939
+ <span class='kw'>def</span> <span class='id identifier rubyid_time_zone'>time_zone</span>
940
+ <span class='ivar'>@time_zone</span>
941
+ <span class='kw'>end</span></pre>
942
+ </td>
943
+ </tr>
944
+ </table>
945
+ </div>
946
+
947
+
948
+ <span id="title=-instance_method"></span>
949
+ <div class="method_details ">
950
+ <h3 class="signature " id="title-instance_method">
951
+
952
+ #<strong>title</strong> &#x21d2; <tt>Object</tt>
953
+
954
+
955
+
956
+
957
+
958
+ </h3><div class="docstring">
959
+ <div class="discussion">
960
+
961
+ <p>Returns the value of attribute title</p>
962
+
963
+
964
+ </div>
965
+ </div>
966
+ <div class="tags">
967
+
968
+
969
+ </div><table class="source_code">
970
+ <tr>
971
+ <td>
972
+ <pre class="lines">
973
+
974
+
975
+ 5
976
+ 6
977
+ 7</pre>
978
+ </td>
979
+ <td>
980
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/models/person.rb', line 5</span>
981
+
982
+ <span class='kw'>def</span> <span class='id identifier rubyid_title'>title</span>
983
+ <span class='ivar'>@title</span>
984
+ <span class='kw'>end</span></pre>
985
+ </td>
986
+ </tr>
987
+ </table>
988
+ </div>
989
+
990
+
991
+ <span id="updated_at=-instance_method"></span>
992
+ <div class="method_details ">
993
+ <h3 class="signature " id="updated_at-instance_method">
994
+
995
+ #<strong>updated_at</strong> &#x21d2; <tt>Object</tt>
996
+
997
+
998
+
999
+
1000
+
1001
+ </h3><div class="docstring">
1002
+ <div class="discussion">
1003
+
1004
+ <p>Returns the value of attribute updated_at</p>
1005
+
1006
+
1007
+ </div>
1008
+ </div>
1009
+ <div class="tags">
1010
+
1011
+
1012
+ </div><table class="source_code">
1013
+ <tr>
1014
+ <td>
1015
+ <pre class="lines">
1016
+
1017
+
1018
+ 5
1019
+ 6
1020
+ 7</pre>
1021
+ </td>
1022
+ <td>
1023
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/models/person.rb', line 5</span>
1024
+
1025
+ <span class='kw'>def</span> <span class='id identifier rubyid_updated_at'>updated_at</span>
1026
+ <span class='ivar'>@updated_at</span>
1027
+ <span class='kw'>end</span></pre>
1028
+ </td>
1029
+ </tr>
1030
+ </table>
1031
+ </div>
1032
+
1033
+ </div>
1034
+
1035
+
1036
+ <div id="class_method_details" class="method_details_list">
1037
+ <h2>Class Method Details</h2>
1038
+
1039
+
1040
+ <div class="method_details first">
1041
+ <h3 class="signature first" id="all-class_method">
1042
+
1043
+ .<strong>all</strong> &#x21d2; <tt>Array&lt;<span class='object_link'><a href="" title="Basecamp3::Person (class)">Basecamp3::Person</a></span>&gt;</tt>
1044
+
1045
+
1046
+
1047
+
1048
+
1049
+ </h3><div class="docstring">
1050
+ <div class="discussion">
1051
+
1052
+ <p>Returns a list of all people visible to the current user.</p>
1053
+
1054
+
1055
+ </div>
1056
+ </div>
1057
+ <div class="tags">
1058
+
1059
+ <p class="tag_title">Returns:</p>
1060
+ <ul class="return">
1061
+
1062
+ <li>
1063
+
1064
+
1065
+ <span class='type'>(<tt>Array&lt;<span class='object_link'><a href="" title="Basecamp3::Person (class)">Basecamp3::Person</a></span>&gt;</tt>)</span>
1066
+
1067
+
1068
+
1069
+ </li>
1070
+
1071
+ </ul>
1072
+
1073
+ </div><table class="source_code">
1074
+ <tr>
1075
+ <td>
1076
+ <pre class="lines">
1077
+
1078
+
1079
+ 20
1080
+ 21
1081
+ 22</pre>
1082
+ </td>
1083
+ <td>
1084
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/models/person.rb', line 20</span>
1085
+
1086
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_all'>all</span>
1087
+ <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'>&quot;</span><span class='tstring_content'>/people</span><span class='tstring_end'>&quot;</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::Person (class)">Person</a></span></span><span class='rparen'>)</span>
1088
+ <span class='kw'>end</span></pre>
1089
+ </td>
1090
+ </tr>
1091
+ </table>
1092
+ </div>
1093
+
1094
+ <div class="method_details ">
1095
+ <h3 class="signature " id="find-class_method">
1096
+
1097
+ .<strong>find</strong>(id) &#x21d2; <tt><span class='object_link'><a href="" title="Basecamp3::Person (class)">Basecamp3::Person</a></span></tt>
1098
+
1099
+
1100
+
1101
+
1102
+
1103
+ </h3><div class="docstring">
1104
+ <div class="discussion">
1105
+
1106
+ <p>Returns the person.</p>
1107
+
1108
+
1109
+ </div>
1110
+ </div>
1111
+ <div class="tags">
1112
+ <p class="tag_title">Parameters:</p>
1113
+ <ul class="param">
1114
+
1115
+ <li>
1116
+
1117
+ <span class='name'>id</span>
1118
+
1119
+
1120
+ <span class='type'>(<tt>Integer</tt>)</span>
1121
+
1122
+
1123
+
1124
+ &mdash;
1125
+ <div class='inline'>
1126
+ <p>the id of the person</p>
1127
+ </div>
1128
+
1129
+ </li>
1130
+
1131
+ </ul>
1132
+
1133
+ <p class="tag_title">Returns:</p>
1134
+ <ul class="return">
1135
+
1136
+ <li>
1137
+
1138
+
1139
+ <span class='type'>(<tt><span class='object_link'><a href="" title="Basecamp3::Person (class)">Basecamp3::Person</a></span></tt>)</span>
1140
+
1141
+
1142
+
1143
+ </li>
1144
+
1145
+ </ul>
1146
+
1147
+ </div><table class="source_code">
1148
+ <tr>
1149
+ <td>
1150
+ <pre class="lines">
1151
+
1152
+
1153
+ 36
1154
+ 37
1155
+ 38</pre>
1156
+ </td>
1157
+ <td>
1158
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/models/person.rb', line 36</span>
1159
+
1160
+ <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_id'>id</span><span class='rparen'>)</span>
1161
+ <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'>&quot;</span><span class='tstring_content'>/people/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</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::Person (class)">Person</a></span></span><span class='rparen'>)</span>
1162
+ <span class='kw'>end</span></pre>
1163
+ </td>
1164
+ </tr>
1165
+ </table>
1166
+ </div>
1167
+
1168
+ <div class="method_details ">
1169
+ <h3 class="signature " id="me-class_method">
1170
+
1171
+ .<strong>me</strong> &#x21d2; <tt><span class='object_link'><a href="" title="Basecamp3::Person (class)">Basecamp3::Person</a></span></tt>
1172
+
1173
+
1174
+
1175
+
1176
+
1177
+ </h3><div class="docstring">
1178
+ <div class="discussion">
1179
+
1180
+ <p>Returns the current user&#39;s personal info..</p>
1181
+
1182
+
1183
+ </div>
1184
+ </div>
1185
+ <div class="tags">
1186
+
1187
+ <p class="tag_title">Returns:</p>
1188
+ <ul class="return">
1189
+
1190
+ <li>
1191
+
1192
+
1193
+ <span class='type'>(<tt><span class='object_link'><a href="" title="Basecamp3::Person (class)">Basecamp3::Person</a></span></tt>)</span>
1194
+
1195
+
1196
+
1197
+ </li>
1198
+
1199
+ </ul>
1200
+
1201
+ </div><table class="source_code">
1202
+ <tr>
1203
+ <td>
1204
+ <pre class="lines">
1205
+
1206
+
1207
+ 43
1208
+ 44
1209
+ 45</pre>
1210
+ </td>
1211
+ <td>
1212
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/models/person.rb', line 43</span>
1213
+
1214
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_me'>me</span>
1215
+ <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'>&quot;</span><span class='tstring_content'>/my/profile</span><span class='tstring_end'>&quot;</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::Person (class)">Person</a></span></span><span class='rparen'>)</span>
1216
+ <span class='kw'>end</span></pre>
1217
+ </td>
1218
+ </tr>
1219
+ </table>
1220
+ </div>
1221
+
1222
+ <div class="method_details ">
1223
+ <h3 class="signature " id="pingable-class_method">
1224
+
1225
+ .<strong>pingable</strong> &#x21d2; <tt>Array&lt;<span class='object_link'><a href="" title="Basecamp3::Person (class)">Basecamp3::Person</a></span>&gt;</tt>
1226
+
1227
+
1228
+
1229
+
1230
+
1231
+ </h3><div class="docstring">
1232
+ <div class="discussion">
1233
+
1234
+ <p>Returns a list of all people who can be pinged.</p>
1235
+
1236
+
1237
+ </div>
1238
+ </div>
1239
+ <div class="tags">
1240
+
1241
+ <p class="tag_title">Returns:</p>
1242
+ <ul class="return">
1243
+
1244
+ <li>
1245
+
1246
+
1247
+ <span class='type'>(<tt>Array&lt;<span class='object_link'><a href="" title="Basecamp3::Person (class)">Basecamp3::Person</a></span>&gt;</tt>)</span>
1248
+
1249
+
1250
+
1251
+ </li>
1252
+
1253
+ </ul>
1254
+
1255
+ </div><table class="source_code">
1256
+ <tr>
1257
+ <td>
1258
+ <pre class="lines">
1259
+
1260
+
1261
+ 27
1262
+ 28
1263
+ 29</pre>
1264
+ </td>
1265
+ <td>
1266
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/models/person.rb', line 27</span>
1267
+
1268
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_pingable'>pingable</span>
1269
+ <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'>&quot;</span><span class='tstring_content'>/circles/people</span><span class='tstring_end'>&quot;</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::Person (class)">Person</a></span></span><span class='rparen'>)</span>
1270
+ <span class='kw'>end</span></pre>
1271
+ </td>
1272
+ </tr>
1273
+ </table>
1274
+ </div>
1275
+
1276
+ </div>
1277
+
1278
+ </div>
1279
+
1280
+ <div id="footer">
1281
+ Generated on Tue May 9 15:32:17 2017 by
1282
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1283
+ 0.9.9 (ruby-2.2.2).
1284
+ </div>
1285
+
1286
+ </div>
1287
+ </body>
1288
+ </html>