notifyhub 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,762 @@
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: NotifySet
8
+
9
+ &mdash; Documentation by YARD 0.8.6.1
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ hasFrames = window.top.frames.main ? true : false;
19
+ relpath = '';
20
+ framesUrl = "frames.html#!" + escape(window.location.href);
21
+ </script>
22
+
23
+
24
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
25
+
26
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
27
+
28
+
29
+ </head>
30
+ <body>
31
+ <div id="header">
32
+ <div id="menu">
33
+
34
+ <a href="_index.html">Index (N)</a> &raquo;
35
+
36
+
37
+ <span class="title">NotifySet</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: NotifySet
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">NotifySet</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/notifyhub.rb</dd>
98
+
99
+ </dl>
100
+ <div class="clear"></div>
101
+
102
+ <h2>Overview</h2><div class="docstring">
103
+ <div class="discussion">
104
+
105
+ <p>Notify object that includes disable/enable features.</p>
106
+
107
+
108
+ </div>
109
+ </div>
110
+ <div class="tags">
111
+
112
+
113
+ </div>
114
+
115
+
116
+
117
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
118
+ <ul class="summary">
119
+
120
+ <li class="public ">
121
+ <span class="summary_signature">
122
+
123
+ <a href="#enable-instance_method" title="#enable (instance method)">- (Object) <strong>enable</strong>(value) </a>
124
+
125
+
126
+
127
+ </span>
128
+
129
+
130
+
131
+
132
+
133
+
134
+
135
+
136
+
137
+
138
+
139
+
140
+ <span class="summary_desc"><div class='inline'>
141
+ <p>Enable/disable Notify set.</p>
142
+ </div></span>
143
+
144
+ </li>
145
+
146
+
147
+ </ul>
148
+
149
+
150
+
151
+
152
+
153
+ <h2>
154
+ Instance Method Summary
155
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
156
+ </h2>
157
+
158
+ <ul class="summary">
159
+
160
+ <li class="public ">
161
+ <span class="summary_signature">
162
+
163
+ <a href="#%5B%5D-instance_method" title="#[] (instance method)">- (Object) <strong>[]</strong>(idx) </a>
164
+
165
+
166
+
167
+ </span>
168
+
169
+
170
+
171
+
172
+
173
+
174
+
175
+
176
+
177
+ <span class="summary_desc"><div class='inline'>
178
+ <p>Get Notify by index.</p>
179
+ </div></span>
180
+
181
+ </li>
182
+
183
+
184
+ <li class="public ">
185
+ <span class="summary_signature">
186
+
187
+ <a href="#action-instance_method" title="#action (instance method)">- (Object) <strong>action</strong>(&amp;action) </a>
188
+
189
+
190
+
191
+ (also: #register, #with)
192
+
193
+ </span>
194
+
195
+
196
+
197
+
198
+
199
+
200
+
201
+
202
+
203
+ <span class="summary_desc"><div class='inline'>
204
+ <p>Register Notify.</p>
205
+ </div></span>
206
+
207
+ </li>
208
+
209
+
210
+ <li class="public ">
211
+ <span class="summary_signature">
212
+
213
+ <a href="#each-instance_method" title="#each (instance method)">- (Object) <strong>each</strong> </a>
214
+
215
+
216
+
217
+ </span>
218
+
219
+
220
+
221
+
222
+
223
+
224
+
225
+
226
+
227
+ <span class="summary_desc"><div class='inline'>
228
+ <p>Iterate over list of notifiers.</p>
229
+ </div></span>
230
+
231
+ </li>
232
+
233
+
234
+ <li class="public ">
235
+ <span class="summary_signature">
236
+
237
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (NotifySet) <strong>initialize</strong>(id = nil) </a>
238
+
239
+
240
+
241
+ </span>
242
+
243
+
244
+ <span class="note title constructor">constructor</span>
245
+
246
+
247
+
248
+
249
+
250
+
251
+
252
+
253
+ <span class="summary_desc"><div class='inline'>
254
+ <p>Instantiation.</p>
255
+ </div></span>
256
+
257
+ </li>
258
+
259
+
260
+ <li class="public ">
261
+ <span class="summary_signature">
262
+
263
+ <a href="#notify-instance_method" title="#notify (instance method)">- (Object) <strong>notify</strong>(*args) </a>
264
+
265
+
266
+
267
+ </span>
268
+
269
+
270
+
271
+
272
+
273
+
274
+
275
+
276
+
277
+ <span class="summary_desc"><div class='inline'>
278
+ <p>Run all notifiers in Notify set.</p>
279
+ </div></span>
280
+
281
+ </li>
282
+
283
+
284
+ <li class="public ">
285
+ <span class="summary_signature">
286
+
287
+ <a href="#remove-instance_method" title="#remove (instance method)">- (Object) <strong>remove</strong>(notify = nil) </a>
288
+
289
+
290
+
291
+ </span>
292
+
293
+
294
+
295
+
296
+
297
+
298
+
299
+
300
+
301
+ <span class="summary_desc"><div class='inline'>
302
+ <p>Remove all or one Notify.</p>
303
+ </div></span>
304
+
305
+ </li>
306
+
307
+
308
+ </ul>
309
+
310
+
311
+ <div id="constructor_details" class="method_details_list">
312
+ <h2>Constructor Details</h2>
313
+
314
+ <div class="method_details first">
315
+ <h3 class="signature first" id="initialize-instance_method">
316
+
317
+ - (<tt><span class='object_link'><a href="" title="NotifySet (class)">NotifySet</a></span></tt>) <strong>initialize</strong>(id = nil)
318
+
319
+
320
+
321
+
322
+
323
+ </h3><div class="docstring">
324
+ <div class="discussion">
325
+
326
+ <p>Instantiation.</p>
327
+
328
+
329
+ </div>
330
+ </div>
331
+ <div class="tags">
332
+ <p class="tag_title">Parameters:</p>
333
+ <ul class="param">
334
+
335
+ <li>
336
+
337
+ <span class='name'>id</span>
338
+
339
+
340
+ <span class='type'>(<tt>Symbol</tt>)</span>
341
+
342
+
343
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
344
+
345
+
346
+ &mdash;
347
+ <div class='inline'>
348
+ <p>Id of the set.</p>
349
+ </div>
350
+
351
+ </li>
352
+
353
+ </ul>
354
+
355
+
356
+ </div><table class="source_code">
357
+ <tr>
358
+ <td>
359
+ <pre class="lines">
360
+
361
+
362
+ 238
363
+ 239
364
+ 240
365
+ 241
366
+ 242</pre>
367
+ </td>
368
+ <td>
369
+ <pre class="code"><span class="info file"># File 'lib/notifyhub.rb', line 238</span>
370
+
371
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span> <span class='id identifier rubyid_id'>id</span> <span class='op'>=</span> <span class='kw'>nil</span> <span class='rparen'>)</span>
372
+ <span class='ivar'>@id</span> <span class='op'>=</span> <span class='id identifier rubyid_id'>id</span>
373
+ <span class='ivar'>@enable</span> <span class='op'>=</span> <span class='kw'>true</span>
374
+ <span class='ivar'>@list</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
375
+ <span class='kw'>end</span></pre>
376
+ </td>
377
+ </tr>
378
+ </table>
379
+ </div>
380
+
381
+ </div>
382
+
383
+ <div id="instance_attr_details" class="attr_details">
384
+ <h2>Instance Attribute Details</h2>
385
+
386
+
387
+ <span id="enable=-instance_method"></span>
388
+ <div class="method_details first">
389
+ <h3 class="signature first" id="enable-instance_method">
390
+
391
+ - (<tt>Object</tt>) <strong>enable</strong>(value)
392
+
393
+
394
+
395
+
396
+
397
+ </h3><div class="docstring">
398
+ <div class="discussion">
399
+
400
+ <p>Enable/disable Notify set.</p>
401
+
402
+
403
+ </div>
404
+ </div>
405
+ <div class="tags">
406
+ <p class="tag_title">Parameters:</p>
407
+ <ul class="param">
408
+
409
+ <li>
410
+
411
+ <span class='name'>value</span>
412
+
413
+
414
+ <span class='type'>(<tt>Boolean</tt>)</span>
415
+
416
+
417
+
418
+ &mdash;
419
+ <div class='inline'>
420
+ <p>Enable with true and disable with false.</p>
421
+ </div>
422
+
423
+ </li>
424
+
425
+ </ul>
426
+
427
+
428
+ </div><table class="source_code">
429
+ <tr>
430
+ <td>
431
+ <pre class="lines">
432
+
433
+
434
+ 232
435
+ 233
436
+ 234</pre>
437
+ </td>
438
+ <td>
439
+ <pre class="code"><span class="info file"># File 'lib/notifyhub.rb', line 232</span>
440
+
441
+ <span class='kw'>def</span> <span class='id identifier rubyid_enable'>enable</span>
442
+ <span class='ivar'>@enable</span>
443
+ <span class='kw'>end</span></pre>
444
+ </td>
445
+ </tr>
446
+ </table>
447
+ </div>
448
+
449
+ </div>
450
+
451
+
452
+ <div id="instance_method_details" class="method_details_list">
453
+ <h2>Instance Method Details</h2>
454
+
455
+
456
+ <div class="method_details first">
457
+ <h3 class="signature first" id="[]-instance_method">
458
+
459
+ - (<tt>Object</tt>) <strong>[]</strong>(idx)
460
+
461
+
462
+
463
+
464
+
465
+ </h3><div class="docstring">
466
+ <div class="discussion">
467
+
468
+ <p>Get Notify by index.</p>
469
+
470
+
471
+ </div>
472
+ </div>
473
+ <div class="tags">
474
+
475
+
476
+ </div><table class="source_code">
477
+ <tr>
478
+ <td>
479
+ <pre class="lines">
480
+
481
+
482
+ 298
483
+ 299
484
+ 300</pre>
485
+ </td>
486
+ <td>
487
+ <pre class="code"><span class="info file"># File 'lib/notifyhub.rb', line 298</span>
488
+
489
+ <span class='kw'>def</span> <span class='op'>[]</span><span class='lparen'>(</span> <span class='id identifier rubyid_idx'>idx</span> <span class='rparen'>)</span>
490
+ <span class='ivar'>@list</span><span class='lbracket'>[</span> <span class='id identifier rubyid_idx'>idx</span> <span class='rbracket'>]</span>
491
+ <span class='kw'>end</span></pre>
492
+ </td>
493
+ </tr>
494
+ </table>
495
+ </div>
496
+
497
+ <div class="method_details ">
498
+ <h3 class="signature " id="action-instance_method">
499
+
500
+ - (<tt>Object</tt>) <strong>action</strong>(&amp;action)
501
+
502
+
503
+
504
+ <span class="aliases">Also known as:
505
+ <span class="names"><span id='register-instance_method'>register</span>, <span id='with-instance_method'>with</span></span>
506
+ </span>
507
+
508
+
509
+
510
+ </h3><div class="docstring">
511
+ <div class="discussion">
512
+
513
+ <p>Register Notify.</p>
514
+
515
+
516
+ </div>
517
+ </div>
518
+ <div class="tags">
519
+ <p class="tag_title">Parameters:</p>
520
+ <ul class="param">
521
+
522
+ <li>
523
+
524
+ <span class='name'>action</span>
525
+
526
+
527
+ <span class='type'>(<tt>Block</tt>)</span>
528
+
529
+
530
+
531
+ &mdash;
532
+ <div class='inline'>
533
+ <p>Notify action.</p>
534
+ </div>
535
+
536
+ </li>
537
+
538
+ </ul>
539
+
540
+
541
+ </div><table class="source_code">
542
+ <tr>
543
+ <td>
544
+ <pre class="lines">
545
+
546
+
547
+ 256
548
+ 257
549
+ 258
550
+ 259
551
+ 260</pre>
552
+ </td>
553
+ <td>
554
+ <pre class="code"><span class="info file"># File 'lib/notifyhub.rb', line 256</span>
555
+
556
+ <span class='kw'>def</span> <span class='id identifier rubyid_action'>action</span><span class='lparen'>(</span> <span class='op'>&amp;</span><span class='id identifier rubyid_action'>action</span> <span class='rparen'>)</span>
557
+ <span class='id identifier rubyid_n'>n</span> <span class='op'>=</span> <span class='const'>Notify</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span> <span class='op'>&amp;</span><span class='id identifier rubyid_action'>action</span> <span class='rparen'>)</span>
558
+ <span class='ivar'>@list</span><span class='period'>.</span><span class='id identifier rubyid_push'>push</span> <span class='id identifier rubyid_n'>n</span>
559
+ <span class='id identifier rubyid_n'>n</span>
560
+ <span class='kw'>end</span></pre>
561
+ </td>
562
+ </tr>
563
+ </table>
564
+ </div>
565
+
566
+ <div class="method_details ">
567
+ <h3 class="signature " id="each-instance_method">
568
+
569
+ - (<tt>Object</tt>) <strong>each</strong>
570
+
571
+
572
+
573
+
574
+
575
+ </h3><div class="docstring">
576
+ <div class="discussion">
577
+
578
+ <p>Iterate over list of notifiers.</p>
579
+
580
+
581
+ </div>
582
+ </div>
583
+ <div class="tags">
584
+
585
+
586
+ </div><table class="source_code">
587
+ <tr>
588
+ <td>
589
+ <pre class="lines">
590
+
591
+
592
+ 290
593
+ 291
594
+ 292
595
+ 293
596
+ 294</pre>
597
+ </td>
598
+ <td>
599
+ <pre class="code"><span class="info file"># File 'lib/notifyhub.rb', line 290</span>
600
+
601
+ <span class='kw'>def</span> <span class='id identifier rubyid_each'>each</span>
602
+ <span class='ivar'>@list</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_n'>n</span><span class='op'>|</span>
603
+ <span class='kw'>yield</span> <span class='id identifier rubyid_n'>n</span>
604
+ <span class='kw'>end</span>
605
+ <span class='kw'>end</span></pre>
606
+ </td>
607
+ </tr>
608
+ </table>
609
+ </div>
610
+
611
+ <div class="method_details ">
612
+ <h3 class="signature " id="notify-instance_method">
613
+
614
+ - (<tt>Object</tt>) <strong>notify</strong>(*args)
615
+
616
+
617
+
618
+
619
+
620
+ </h3><div class="docstring">
621
+ <div class="discussion">
622
+
623
+ <p>Run all notifiers in Notify set.</p>
624
+
625
+
626
+ </div>
627
+ </div>
628
+ <div class="tags">
629
+ <p class="tag_title">Parameters:</p>
630
+ <ul class="param">
631
+
632
+ <li>
633
+
634
+ <span class='name'>args</span>
635
+
636
+
637
+ <span class='type'>(<tt>Array&lt;Object&gt;</tt>)</span>
638
+
639
+
640
+
641
+ &mdash;
642
+ <div class='inline'>
643
+ <p>Arguments for notifiers.</p>
644
+ </div>
645
+
646
+ </li>
647
+
648
+ </ul>
649
+
650
+
651
+ </div><table class="source_code">
652
+ <tr>
653
+ <td>
654
+ <pre class="lines">
655
+
656
+
657
+ 280
658
+ 281
659
+ 282
660
+ 283
661
+ 284
662
+ 285
663
+ 286</pre>
664
+ </td>
665
+ <td>
666
+ <pre class="code"><span class="info file"># File 'lib/notifyhub.rb', line 280</span>
667
+
668
+ <span class='kw'>def</span> <span class='id identifier rubyid_notify'>notify</span><span class='lparen'>(</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span> <span class='rparen'>)</span>
669
+ <span class='kw'>if</span> <span class='ivar'>@enable</span>
670
+ <span class='ivar'>@list</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_n'>n</span><span class='op'>|</span>
671
+ <span class='id identifier rubyid_n'>n</span><span class='period'>.</span><span class='id identifier rubyid_notify'>notify</span><span class='lparen'>(</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span> <span class='rparen'>)</span>
672
+ <span class='kw'>end</span>
673
+ <span class='kw'>end</span>
674
+ <span class='kw'>end</span></pre>
675
+ </td>
676
+ </tr>
677
+ </table>
678
+ </div>
679
+
680
+ <div class="method_details ">
681
+ <h3 class="signature " id="remove-instance_method">
682
+
683
+ - (<tt>Object</tt>) <strong>remove</strong>(notify = nil)
684
+
685
+
686
+
687
+
688
+
689
+ </h3><div class="docstring">
690
+ <div class="discussion">
691
+
692
+ <p>Remove all or one Notify.</p>
693
+
694
+
695
+ </div>
696
+ </div>
697
+ <div class="tags">
698
+ <p class="tag_title">Parameters:</p>
699
+ <ul class="param">
700
+
701
+ <li>
702
+
703
+ <span class='name'>notify</span>
704
+
705
+
706
+ <span class='type'>(<tt><span class='object_link'><a href="Notify.html" title="Notify (class)">Notify</a></span></tt>)</span>
707
+
708
+
709
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
710
+
711
+
712
+ &mdash;
713
+ <div class='inline'>
714
+ <p>Notify to remove (all if not given).</p>
715
+ </div>
716
+
717
+ </li>
718
+
719
+ </ul>
720
+
721
+
722
+ </div><table class="source_code">
723
+ <tr>
724
+ <td>
725
+ <pre class="lines">
726
+
727
+
728
+ 269
729
+ 270
730
+ 271
731
+ 272
732
+ 273
733
+ 274
734
+ 275</pre>
735
+ </td>
736
+ <td>
737
+ <pre class="code"><span class="info file"># File 'lib/notifyhub.rb', line 269</span>
738
+
739
+ <span class='kw'>def</span> <span class='id identifier rubyid_remove'>remove</span><span class='lparen'>(</span> <span class='id identifier rubyid_notify'>notify</span> <span class='op'>=</span> <span class='kw'>nil</span> <span class='rparen'>)</span>
740
+ <span class='kw'>if</span> <span class='id identifier rubyid_notify'>notify</span>
741
+ <span class='ivar'>@list</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span> <span class='id identifier rubyid_notify'>notify</span> <span class='rparen'>)</span>
742
+ <span class='kw'>else</span>
743
+ <span class='ivar'>@list</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
744
+ <span class='kw'>end</span>
745
+ <span class='kw'>end</span></pre>
746
+ </td>
747
+ </tr>
748
+ </table>
749
+ </div>
750
+
751
+ </div>
752
+
753
+ </div>
754
+
755
+ <div id="footer">
756
+ Generated on Sun Jan 19 21:55:11 2014 by
757
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
758
+ 0.8.6.1 (ruby-1.9.3).
759
+ </div>
760
+
761
+ </body>
762
+ </html>