]>
Commit | Line | Data |
---|---|---|
823e558b BB |
1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
2 | "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | |
3 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> | |
4 | <head> | |
5 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> | |
6 | <title> | |
7 | Class: Lyricli::Sources::Arguments | |
8 | ||
34d0bf15 | 9 | — Documentation by YARD 0.8.2.1 |
823e558b BB |
10 | |
11 | </title> | |
12 | ||
13 | <link rel="stylesheet" href="../../css/style.css" type="text/css" media="screen" charset="utf-8" /> | |
14 | ||
15 | <link rel="stylesheet" href="../../css/common.css" type="text/css" media="screen" charset="utf-8" /> | |
16 | ||
17 | <script type="text/javascript" charset="utf-8"> | |
18 | hasFrames = window.top.frames.main ? true : false; | |
19 | relpath = '../../'; | |
20 | framesUrl = "../../frames.html#!" + escape(window.location.href); | |
21 | </script> | |
22 | ||
23 | ||
24 | <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script> | |
25 | ||
26 | <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script> | |
27 | ||
28 | ||
29 | </head> | |
30 | <body> | |
31 | <div id="header"> | |
32 | <div id="menu"> | |
33 | ||
34 | <a href="../../_index.html">Index (A)</a> » | |
35 | <span class='title'><span class='object_link'><a href="../../Lyricli.html" title="Lyricli (module)">Lyricli</a></span></span> » <span class='title'><span class='object_link'><a href="../Sources.html" title="Lyricli::Sources (module)">Sources</a></span></span> | |
36 | » | |
37 | <span class="title">Arguments</span> | |
38 | ||
39 | ||
40 | <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div> | |
41 | </div> | |
42 | ||
43 | <div id="search"> | |
44 | ||
45 | <a class="full_list_link" id="class_list_link" | |
46 | href="../../class_list.html"> | |
47 | Class List | |
48 | </a> | |
49 | ||
50 | <a class="full_list_link" id="method_list_link" | |
51 | href="../../method_list.html"> | |
52 | Method List | |
53 | </a> | |
54 | ||
55 | <a class="full_list_link" id="file_list_link" | |
56 | href="../../file_list.html"> | |
57 | File List | |
58 | </a> | |
59 | ||
60 | </div> | |
61 | <div class="clear"></div> | |
62 | </div> | |
63 | ||
64 | <iframe id="search_frame"></iframe> | |
65 | ||
66 | <div id="content"><h1>Class: Lyricli::Sources::Arguments | |
67 | ||
68 | ||
69 | ||
70 | </h1> | |
71 | ||
72 | <dl class="box"> | |
73 | ||
74 | <dt class="r1">Inherits:</dt> | |
75 | <dd class="r1"> | |
76 | <span class="inheritName">Object</span> | |
77 | ||
78 | <ul class="fullTree"> | |
79 | <li>Object</li> | |
80 | ||
81 | <li class="next">Lyricli::Sources::Arguments</li> | |
82 | ||
83 | </ul> | |
84 | <a href="#" class="inheritanceTree">show all</a> | |
85 | ||
86 | </dd> | |
87 | ||
88 | ||
89 | ||
90 | ||
91 | ||
92 | ||
93 | ||
94 | ||
95 | ||
96 | <dt class="r2 last">Defined in:</dt> | |
97 | <dd class="r2 last">lib/lyricli/sources/arguments.rb</dd> | |
98 | ||
99 | </dl> | |
100 | <div class="clear"></div> | |
101 | ||
f2ec7254 BB |
102 | <h2>Overview</h2><div class="docstring"> |
103 | <div class="discussion"> | |
104 | <p> | |
105 | The arguments source. This one is special since it expects two arguments. | |
106 | It is treated specially by the SourceManager. | |
107 | </p> | |
108 | ||
109 | ||
110 | </div> | |
111 | </div> | |
112 | <div class="tags"> | |
113 | ||
823e558b | 114 | |
f2ec7254 | 115 | </div> |
823e558b BB |
116 | |
117 | ||
118 | ||
119 | <h2>Class Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2> | |
120 | <ul class="summary"> | |
121 | ||
122 | <li class="public "> | |
123 | <span class="summary_signature"> | |
124 | ||
125 | <a href="#name-class_method" title="name (class method)">+ (Object) <strong>name</strong> </a> | |
126 | ||
127 | ||
128 | ||
129 | </span> | |
130 | ||
131 | ||
132 | ||
133 | ||
134 | ||
135 | ||
136 | ||
137 | ||
138 | ||
139 | ||
140 | ||
141 | ||
142 | <span class="summary_desc"><div class='inline'><p> | |
143 | Returns the value of attribute name. | |
144 | </p> | |
145 | </div></span> | |
146 | ||
147 | </li> | |
148 | ||
149 | ||
150 | </ul> | |
151 | ||
152 | ||
153 | ||
154 | ||
155 | ||
156 | <h2> | |
157 | Class Method Summary | |
158 | <small>(<a href="#" class="summary_toggle">collapse</a>)</small> | |
159 | </h2> | |
160 | ||
161 | <ul class="summary"> | |
162 | ||
163 | <li class="public "> | |
164 | <span class="summary_signature"> | |
165 | ||
166 | <a href="#enable-class_method" title="enable (class method)">+ (Object) <strong>enable</strong> </a> | |
167 | ||
168 | ||
169 | ||
170 | </span> | |
171 | ||
172 | ||
173 | ||
174 | ||
175 | ||
176 | ||
177 | ||
178 | ||
179 | ||
180 | <span class="summary_desc"><div class='inline'><p> | |
181 | The enable method should run all of the tasks needed to validate the | |
182 | source. | |
183 | </p> | |
184 | </div></span> | |
185 | ||
186 | </li> | |
187 | ||
188 | ||
189 | <li class="public "> | |
190 | <span class="summary_signature"> | |
191 | ||
192 | <a href="#reset-class_method" title="reset (class method)">+ (Object) <strong>reset</strong> </a> | |
193 | ||
194 | ||
195 | ||
196 | </span> | |
197 | ||
198 | ||
199 | ||
200 | ||
201 | ||
202 | ||
203 | ||
204 | ||
205 | ||
206 | <span class="summary_desc"><div class='inline'><p> | |
207 | The reset method resets any configurations it may have. | |
208 | </p> | |
209 | </div></span> | |
210 | ||
211 | </li> | |
212 | ||
213 | ||
214 | </ul> | |
215 | ||
216 | <h2> | |
217 | Instance Method Summary | |
218 | <small>(<a href="#" class="summary_toggle">collapse</a>)</small> | |
219 | </h2> | |
220 | ||
221 | <ul class="summary"> | |
222 | ||
223 | <li class="public "> | |
224 | <span class="summary_signature"> | |
225 | ||
226 | <a href="#current_track-instance_method" title="#current_track (instance method)">- (Hash) <strong>current_track</strong> </a> | |
227 | ||
228 | ||
229 | ||
230 | </span> | |
231 | ||
232 | ||
233 | ||
234 | ||
235 | ||
236 | ||
237 | ||
238 | ||
239 | ||
240 | <span class="summary_desc"><div class='inline'><p> | |
241 | The current_track method should return the name of the current artist and | |
242 | song. | |
243 | </p> | |
244 | </div></span> | |
245 | ||
246 | </li> | |
247 | ||
248 | ||
249 | <li class="public "> | |
250 | <span class="summary_signature"> | |
251 | ||
252 | <a href="#initialize-instance_method" title="#initialize (instance method)">- (Arguments) <strong>initialize</strong> </a> | |
253 | ||
254 | ||
255 | ||
256 | </span> | |
257 | ||
258 | ||
259 | <span class="note title constructor">constructor</span> | |
260 | ||
261 | ||
262 | ||
263 | ||
264 | ||
265 | ||
266 | ||
267 | ||
268 | <span class="summary_desc"><div class='inline'><p> | |
269 | Instantiates everything it needs to run. | |
270 | </p> | |
271 | </div></span> | |
272 | ||
273 | </li> | |
274 | ||
275 | ||
276 | </ul> | |
277 | ||
278 | ||
279 | <div id="constructor_details" class="method_details_list"> | |
280 | <h2>Constructor Details</h2> | |
281 | ||
282 | <div class="method_details first"> | |
283 | <h3 class="signature first" id="initialize-instance_method"> | |
284 | ||
285 | - (<tt><span class='object_link'><a href="" title="Lyricli::Sources::Arguments (class)">Arguments</a></span></tt>) <strong>initialize</strong> | |
286 | ||
287 | ||
288 | ||
289 | ||
290 | ||
291 | </h3><div class="docstring"> | |
292 | <div class="discussion"> | |
293 | <p> | |
294 | Instantiates everything it needs to run. | |
295 | </p> | |
296 | ||
297 | ||
298 | </div> | |
299 | </div> | |
300 | <div class="tags"> | |
301 | ||
302 | ||
303 | </div><table class="source_code"> | |
304 | <tr> | |
305 | <td> | |
306 | <pre class="lines"> | |
307 | ||
308 | ||
f2ec7254 BB |
309 | 20 |
310 | 21 | |
311 | 22</pre> | |
823e558b BB |
312 | </td> |
313 | <td> | |
f2ec7254 | 314 | <pre class="code"><span class="info file"># File 'lib/lyricli/sources/arguments.rb', line 20</span> |
823e558b BB |
315 | |
316 | <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span> | |
317 | <span class='comment'># Nothing to do. | |
318 | </span><span class='kw'>end</span></pre> | |
319 | </td> | |
320 | </tr> | |
321 | </table> | |
322 | </div> | |
323 | ||
324 | </div> | |
325 | ||
326 | <div id="class_attr_details" class="attr_details"> | |
327 | <h2>Class Attribute Details</h2> | |
328 | ||
329 | ||
330 | <span id="name=-class_method"></span> | |
823e558b BB |
331 | <div class="method_details first"> |
332 | <h3 class="signature first" id="name-class_method"> | |
333 | ||
334 | + (<tt>Object</tt>) <strong>name</strong> | |
335 | ||
336 | ||
337 | ||
338 | ||
339 | ||
340 | </h3><div class="docstring"> | |
341 | <div class="discussion"> | |
342 | <p> | |
343 | Returns the value of attribute name | |
344 | </p> | |
345 | ||
346 | ||
347 | </div> | |
348 | </div> | |
349 | <div class="tags"> | |
350 | ||
351 | ||
352 | </div><table class="source_code"> | |
353 | <tr> | |
354 | <td> | |
355 | <pre class="lines"> | |
356 | ||
357 | ||
f2ec7254 BB |
358 | 8 |
359 | 9 | |
360 | 10</pre> | |
823e558b BB |
361 | </td> |
362 | <td> | |
f2ec7254 | 363 | <pre class="code"><span class="info file"># File 'lib/lyricli/sources/arguments.rb', line 8</span> |
823e558b BB |
364 | |
365 | <span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span> | |
366 | <span class='ivar'>@name</span> | |
367 | <span class='kw'>end</span></pre> | |
368 | </td> | |
369 | </tr> | |
370 | </table> | |
371 | </div> | |
372 | ||
373 | </div> | |
374 | ||
375 | ||
376 | <div id="class_method_details" class="method_details_list"> | |
377 | <h2>Class Method Details</h2> | |
378 | ||
379 | ||
380 | <div class="method_details first"> | |
381 | <h3 class="signature first" id="enable-class_method"> | |
382 | ||
383 | + (<tt>Object</tt>) <strong>enable</strong> | |
384 | ||
385 | ||
386 | ||
387 | ||
388 | ||
389 | </h3><div class="docstring"> | |
390 | <div class="discussion"> | |
391 | <p> | |
392 | The enable method should run all of the tasks needed to validate the | |
393 | source. In the case of Rdio it has to authenticate with OAuth. | |
394 | </p> | |
395 | ||
396 | ||
397 | </div> | |
398 | </div> | |
399 | <div class="tags"> | |
400 | ||
401 | ||
402 | </div><table class="source_code"> | |
403 | <tr> | |
404 | <td> | |
405 | <pre class="lines"> | |
406 | ||
407 | ||
f2ec7254 BB |
408 | 15 |
409 | 16 | |
410 | 17</pre> | |
823e558b BB |
411 | </td> |
412 | <td> | |
f2ec7254 | 413 | <pre class="code"><span class="info file"># File 'lib/lyricli/sources/arguments.rb', line 15</span> |
823e558b BB |
414 | |
415 | <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_enable'>enable</span> | |
416 | <span class='comment'># Nothing to do. | |
417 | </span><span class='kw'>end</span></pre> | |
418 | </td> | |
419 | </tr> | |
420 | </table> | |
421 | </div> | |
422 | ||
423 | <div class="method_details "> | |
424 | <h3 class="signature " id="reset-class_method"> | |
425 | ||
426 | + (<tt>Object</tt>) <strong>reset</strong> | |
427 | ||
428 | ||
429 | ||
430 | ||
431 | ||
432 | </h3><div class="docstring"> | |
433 | <div class="discussion"> | |
434 | <p> | |
435 | The reset method resets any configurations it may have | |
436 | </p> | |
437 | ||
438 | ||
439 | </div> | |
440 | </div> | |
441 | <div class="tags"> | |
442 | ||
443 | ||
444 | </div><table class="source_code"> | |
445 | <tr> | |
446 | <td> | |
447 | <pre class="lines"> | |
448 | ||
449 | ||
f2ec7254 BB |
450 | 34 |
451 | 35 | |
452 | 36</pre> | |
823e558b BB |
453 | </td> |
454 | <td> | |
f2ec7254 | 455 | <pre class="code"><span class="info file"># File 'lib/lyricli/sources/arguments.rb', line 34</span> |
823e558b BB |
456 | |
457 | <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_reset'>reset</span> | |
458 | <span class='comment'># Reset Code | |
459 | </span><span class='kw'>end</span></pre> | |
460 | </td> | |
461 | </tr> | |
462 | </table> | |
463 | </div> | |
464 | ||
465 | </div> | |
466 | ||
467 | <div id="instance_method_details" class="method_details_list"> | |
468 | <h2>Instance Method Details</h2> | |
469 | ||
470 | ||
471 | <div class="method_details first"> | |
472 | <h3 class="signature first" id="current_track-instance_method"> | |
473 | ||
474 | - (<tt>Hash</tt>) <strong>current_track</strong> | |
475 | ||
476 | ||
477 | ||
478 | ||
479 | ||
480 | </h3><div class="docstring"> | |
481 | <div class="discussion"> | |
482 | <p> | |
483 | The current_track method should return the name of the current artist and | |
484 | song. | |
485 | </p> | |
486 | ||
487 | ||
488 | </div> | |
489 | </div> | |
490 | <div class="tags"> | |
491 | ||
492 | <p class="tag_title">Returns:</p> | |
493 | <ul class="return"> | |
494 | ||
495 | <li> | |
496 | ||
497 | ||
498 | <span class='type'>(<tt>Hash</tt>)</span> | |
499 | ||
500 | ||
501 | ||
502 | — | |
503 | <div class='inline'><p> | |
504 | A hash containing the current `:song` and `:artist`. | |
505 | </p> | |
506 | </div> | |
507 | ||
508 | </li> | |
509 | ||
510 | </ul> | |
511 | ||
512 | </div><table class="source_code"> | |
513 | <tr> | |
514 | <td> | |
515 | <pre class="lines"> | |
516 | ||
517 | ||
823e558b BB |
518 | 27 |
519 | 28 | |
f2ec7254 BB |
520 | 29 |
521 | 30 | |
522 | 31</pre> | |
823e558b BB |
523 | </td> |
524 | <td> | |
f2ec7254 | 525 | <pre class="code"><span class="info file"># File 'lib/lyricli/sources/arguments.rb', line 27</span> |
823e558b BB |
526 | |
527 | <span class='kw'>def</span> <span class='id identifier rubyid_current_track'>current_track</span> | |
528 | <span class='id identifier rubyid_artist'>artist</span> <span class='op'>=</span> <span class='const'>ARGV</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span> | |
529 | <span class='id identifier rubyid_song'>song</span> <span class='op'>=</span> <span class='const'>ARGV</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span> | |
530 | <span class='lbrace'>{</span><span class='label'>artist:</span> <span class='id identifier rubyid_artist'>artist</span><span class='comma'>,</span> <span class='label'>song:</span> <span class='id identifier rubyid_song'>song</span><span class='rbrace'>}</span> | |
531 | <span class='kw'>end</span></pre> | |
532 | </td> | |
533 | </tr> | |
534 | </table> | |
535 | </div> | |
536 | ||
537 | </div> | |
538 | ||
539 | </div> | |
540 | ||
541 | <div id="footer"> | |
f2ec7254 | 542 | Generated on Sat Oct 6 02:34:27 2012 by |
823e558b | 543 | <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> |
34d0bf15 | 544 | 0.8.2.1 (ruby-1.9.2). |
823e558b BB |
545 | </div> |
546 | ||
547 | </body> | |
548 | </html> |