retreaverjs-rails 0.2.17 → 0.2.19

Sign up to get free protection for your applications and to get access to all the features.
Files changed (31) hide show
  1. checksums.yaml +4 -4
  2. data/lib/retreaverjs/compile.rb +1 -1
  3. data/lib/retreaverjs/rails/version.rb +1 -1
  4. data/package.json +1 -1
  5. data/src/retreaver/campaign.js +49 -1
  6. data/vendor/assets/javascripts/retreaver.js +49 -1
  7. data/vendor/assets/javascripts/retreaver.min.js +2 -2
  8. data/vendor/documentation/javascript/dev/Retreaver.Campaign.html +654 -0
  9. data/vendor/documentation/javascript/dev/Retreaver.Number.html +1615 -0
  10. data/vendor/documentation/javascript/dev/Retreaver.html +330 -0
  11. data/vendor/documentation/javascript/dev/campaign.js.html +270 -0
  12. data/vendor/documentation/javascript/dev/global.html +232 -0
  13. data/vendor/documentation/javascript/dev/index.html +67 -0
  14. data/vendor/documentation/javascript/dev/number.js.html +274 -0
  15. data/vendor/documentation/javascript/dev/retreaver.js.html +84 -0
  16. data/vendor/documentation/javascript/dev/scripts/linenumber.js +17 -0
  17. data/vendor/documentation/javascript/dev/scripts/prettify/Apache-License-2.0.txt +202 -0
  18. data/vendor/documentation/javascript/dev/scripts/prettify/lang-css.js +2 -0
  19. data/vendor/documentation/javascript/dev/scripts/prettify/prettify.js +28 -0
  20. data/vendor/documentation/javascript/dev/styles/jsdoc-default.css +290 -0
  21. data/vendor/documentation/javascript/dev/styles/prettify-jsdoc.css +111 -0
  22. data/vendor/documentation/javascript/dev/styles/prettify-tomorrow.css +132 -0
  23. data/vendor/documentation/javascript/v1/Retreaver.Campaign.html +3 -3
  24. data/vendor/documentation/javascript/v1/Retreaver.Number.html +1 -1
  25. data/vendor/documentation/javascript/v1/Retreaver.html +1 -1
  26. data/vendor/documentation/javascript/v1/campaign.js.html +50 -2
  27. data/vendor/documentation/javascript/v1/global.html +2 -2
  28. data/vendor/documentation/javascript/v1/index.html +1 -1
  29. data/vendor/documentation/javascript/v1/number.js.html +1 -1
  30. data/vendor/documentation/javascript/v1/retreaver.js.html +1 -1
  31. metadata +18 -3
@@ -0,0 +1,1615 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <title>JSDoc: Class: Number</title>
6
+
7
+ <script src="scripts/prettify/prettify.js"> </script>
8
+ <script src="scripts/prettify/lang-css.js"> </script>
9
+ <!--[if lt IE 9]>
10
+ <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
11
+ <![endif]-->
12
+ <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
13
+ <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
14
+ </head>
15
+
16
+ <body>
17
+
18
+ <div id="main">
19
+
20
+ <h1 class="page-title">Class: Number</h1>
21
+
22
+
23
+
24
+
25
+
26
+ <section>
27
+
28
+ <header>
29
+ <h2>
30
+ <span class="ancestors"><a href="Retreaver.html">Retreaver</a>.</span>
31
+
32
+ Number
33
+ </h2>
34
+
35
+ </header>
36
+
37
+ <article>
38
+ <div class="container-overview">
39
+
40
+
41
+
42
+
43
+ <dt>
44
+ <h4 class="name" id="Number"><span class="type-signature"></span>new Number<span class="signature">(attributes)</span><span class="type-signature"></span></h4>
45
+
46
+
47
+ </dt>
48
+ <dd>
49
+
50
+
51
+
52
+
53
+
54
+
55
+
56
+
57
+ <h5>Parameters:</h5>
58
+
59
+
60
+ <table class="params">
61
+ <thead>
62
+ <tr>
63
+
64
+ <th>Name</th>
65
+
66
+
67
+ <th>Type</th>
68
+
69
+
70
+
71
+
72
+
73
+ <th class="last">Description</th>
74
+ </tr>
75
+ </thead>
76
+
77
+ <tbody>
78
+
79
+
80
+ <tr>
81
+
82
+ <td class="name"><code>attributes</code></td>
83
+
84
+
85
+ <td class="type">
86
+
87
+
88
+ <span class="param-type">Object</span>
89
+
90
+
91
+
92
+ </td>
93
+
94
+
95
+
96
+
97
+
98
+ <td class="description last">Attributes</td>
99
+ </tr>
100
+
101
+
102
+ </tbody>
103
+ </table>
104
+
105
+
106
+
107
+ <dl class="details">
108
+
109
+
110
+ <h5 class="subsection-title">Properties:</h5>
111
+
112
+ <dl>
113
+
114
+ <table class="props">
115
+ <thead>
116
+ <tr>
117
+
118
+ <th>Name</th>
119
+
120
+
121
+ <th>Type</th>
122
+
123
+
124
+
125
+
126
+
127
+ <th class="last">Description</th>
128
+ </tr>
129
+ </thead>
130
+
131
+ <tbody>
132
+
133
+
134
+ <tr>
135
+
136
+ <td class="name"><code>attributes</code></td>
137
+
138
+
139
+ <td class="type">
140
+
141
+
142
+ <span class="param-type">Object</span>
143
+
144
+
145
+
146
+ </td>
147
+
148
+
149
+
150
+
151
+
152
+ <td class="description last">
153
+ <h6>Properties</h6>
154
+
155
+ <table class="props">
156
+ <thead>
157
+ <tr>
158
+
159
+ <th>Name</th>
160
+
161
+
162
+ <th>Type</th>
163
+
164
+
165
+
166
+
167
+
168
+ <th class="last">Description</th>
169
+ </tr>
170
+ </thead>
171
+
172
+ <tbody>
173
+
174
+
175
+ <tr>
176
+
177
+ <td class="name"><code>id</code></td>
178
+
179
+
180
+ <td class="type">
181
+
182
+
183
+ <span class="param-type">Number</span>
184
+
185
+
186
+
187
+ </td>
188
+
189
+
190
+
191
+
192
+
193
+ <td class="description last">The CallPixels internal number ID.</td>
194
+ </tr>
195
+
196
+
197
+
198
+ <tr>
199
+
200
+ <td class="name"><code>formatted_number</code></td>
201
+
202
+
203
+ <td class="type">
204
+
205
+
206
+ <span class="param-type">String</span>
207
+
208
+
209
+
210
+ </td>
211
+
212
+
213
+
214
+
215
+
216
+ <td class="description last">Nationally formatted phone number.</td>
217
+ </tr>
218
+
219
+
220
+
221
+ <tr>
222
+
223
+ <td class="name"><code>number</code></td>
224
+
225
+
226
+ <td class="type">
227
+
228
+
229
+ <span class="param-type">String</span>
230
+
231
+
232
+
233
+ </td>
234
+
235
+
236
+
237
+
238
+
239
+ <td class="description last">E.164 formatted phone number.</td>
240
+ </tr>
241
+
242
+
243
+
244
+ <tr>
245
+
246
+ <td class="name"><code>extension</code></td>
247
+
248
+
249
+ <td class="type">
250
+
251
+
252
+ <span class="param-type">String</span>
253
+
254
+
255
+
256
+ </td>
257
+
258
+
259
+
260
+
261
+
262
+ <td class="description last">The extension number.</td>
263
+ </tr>
264
+
265
+
266
+
267
+ <tr>
268
+
269
+ <td class="name"><code>plain_number</code></td>
270
+
271
+
272
+ <td class="type">
273
+
274
+
275
+ <span class="param-type">String</span>
276
+
277
+
278
+
279
+ </td>
280
+
281
+
282
+
283
+
284
+
285
+ <td class="description last">The unformatted phone number digits.</td>
286
+ </tr>
287
+
288
+
289
+
290
+ <tr>
291
+
292
+ <td class="name"><code>number_extension</code></td>
293
+
294
+
295
+ <td class="type">
296
+
297
+
298
+ <span class="param-type">String</span>
299
+
300
+
301
+
302
+ </td>
303
+
304
+
305
+
306
+
307
+
308
+ <td class="description last">The phone number digits with extension.</td>
309
+ </tr>
310
+
311
+
312
+
313
+ <tr>
314
+
315
+ <td class="name"><code>target_open</code></td>
316
+
317
+
318
+ <td class="type">
319
+
320
+
321
+ <span class="param-type">Boolean</span>
322
+
323
+
324
+
325
+ </td>
326
+
327
+
328
+
329
+
330
+
331
+ <td class="description last">Whether there is an open, available target.</td>
332
+ </tr>
333
+
334
+
335
+ </tbody>
336
+ </table>
337
+ </td>
338
+ </tr>
339
+
340
+
341
+ </tbody>
342
+ </table></dl>
343
+
344
+
345
+
346
+
347
+
348
+
349
+
350
+
351
+
352
+
353
+
354
+
355
+
356
+
357
+
358
+
359
+
360
+
361
+
362
+
363
+ <dt class="tag-source">Source:</dt>
364
+ <dd class="tag-source"><ul class="dummy"><li>
365
+ <a href="number.js.html">retreaver/number.js</a>, <a href="number.js.html#line18">line 18</a>
366
+ </li></ul></dd>
367
+
368
+
369
+
370
+
371
+
372
+
373
+
374
+ </dl>
375
+
376
+
377
+
378
+
379
+
380
+
381
+
382
+
383
+
384
+
385
+
386
+
387
+
388
+ </dd>
389
+
390
+
391
+ </div>
392
+
393
+
394
+
395
+
396
+
397
+
398
+
399
+
400
+
401
+
402
+
403
+
404
+
405
+
406
+ <h3 class="subsection-title">Methods</h3>
407
+
408
+ <dl>
409
+
410
+ <dt>
411
+ <h4 class="name" id="add_tags"><span class="type-signature"></span>add_tags<span class="signature">(tags, callback)</span><span class="type-signature"></span></h4>
412
+
413
+
414
+ </dt>
415
+ <dd>
416
+
417
+
418
+ <div class="description">
419
+ Add tags to a number.
420
+ </div>
421
+
422
+
423
+
424
+
425
+
426
+
427
+
428
+ <h5>Parameters:</h5>
429
+
430
+
431
+ <table class="params">
432
+ <thead>
433
+ <tr>
434
+
435
+ <th>Name</th>
436
+
437
+
438
+ <th>Type</th>
439
+
440
+
441
+
442
+
443
+
444
+ <th class="last">Description</th>
445
+ </tr>
446
+ </thead>
447
+
448
+ <tbody>
449
+
450
+
451
+ <tr>
452
+
453
+ <td class="name"><code>tags</code></td>
454
+
455
+
456
+ <td class="type">
457
+
458
+
459
+ <span class="param-type">Object</span>
460
+
461
+
462
+
463
+ </td>
464
+
465
+
466
+
467
+
468
+
469
+ <td class="description last">A collection of tags {key: 'value', tag2: 'value2'}</td>
470
+ </tr>
471
+
472
+
473
+
474
+ <tr>
475
+
476
+ <td class="name"><code>callback</code></td>
477
+
478
+
479
+ <td class="type">
480
+
481
+
482
+ <span class="param-type">function</span>
483
+
484
+
485
+
486
+ </td>
487
+
488
+
489
+
490
+
491
+
492
+ <td class="description last">Callback that will be fired after request.</td>
493
+ </tr>
494
+
495
+
496
+ </tbody>
497
+ </table>
498
+
499
+
500
+
501
+ <dl class="details">
502
+
503
+
504
+
505
+
506
+
507
+
508
+
509
+
510
+
511
+
512
+
513
+
514
+
515
+
516
+
517
+
518
+
519
+
520
+
521
+ <dt class="tag-source">Source:</dt>
522
+ <dd class="tag-source"><ul class="dummy"><li>
523
+ <a href="number.js.html">retreaver/number.js</a>, <a href="number.js.html#line28">line 28</a>
524
+ </li></ul></dd>
525
+
526
+
527
+
528
+
529
+
530
+
531
+
532
+ </dl>
533
+
534
+
535
+
536
+
537
+
538
+
539
+
540
+
541
+
542
+ <h5>Throws:</h5>
543
+
544
+
545
+
546
+ <div class="param-desc">
547
+
548
+ Will throw an error if attempting to modify tags on a number that doesn't belong to a number pool
549
+ with per-visitor numbers enabled.
550
+
551
+ </div>
552
+
553
+
554
+
555
+
556
+
557
+
558
+
559
+ </dd>
560
+
561
+
562
+
563
+ <dt>
564
+ <h4 class="name" id="clear_tags"><span class="type-signature"></span>clear_tags<span class="signature">(callback)</span><span class="type-signature"></span></h4>
565
+
566
+
567
+ </dt>
568
+ <dd>
569
+
570
+
571
+ <div class="description">
572
+ Clear all tags from a number.
573
+ </div>
574
+
575
+
576
+
577
+
578
+
579
+
580
+
581
+ <h5>Parameters:</h5>
582
+
583
+
584
+ <table class="params">
585
+ <thead>
586
+ <tr>
587
+
588
+ <th>Name</th>
589
+
590
+
591
+ <th>Type</th>
592
+
593
+
594
+
595
+
596
+
597
+ <th class="last">Description</th>
598
+ </tr>
599
+ </thead>
600
+
601
+ <tbody>
602
+
603
+
604
+ <tr>
605
+
606
+ <td class="name"><code>callback</code></td>
607
+
608
+
609
+ <td class="type">
610
+
611
+
612
+ <span class="param-type">function</span>
613
+
614
+
615
+
616
+ </td>
617
+
618
+
619
+
620
+
621
+
622
+ <td class="description last">Callback that will be fired after request.</td>
623
+ </tr>
624
+
625
+
626
+ </tbody>
627
+ </table>
628
+
629
+
630
+
631
+ <dl class="details">
632
+
633
+
634
+
635
+
636
+
637
+
638
+
639
+
640
+
641
+
642
+
643
+
644
+
645
+
646
+
647
+
648
+
649
+
650
+
651
+ <dt class="tag-source">Source:</dt>
652
+ <dd class="tag-source"><ul class="dummy"><li>
653
+ <a href="number.js.html">retreaver/number.js</a>, <a href="number.js.html#line95">line 95</a>
654
+ </li></ul></dd>
655
+
656
+
657
+
658
+
659
+
660
+
661
+
662
+ </dl>
663
+
664
+
665
+
666
+
667
+
668
+
669
+
670
+
671
+
672
+ <h5>Throws:</h5>
673
+
674
+
675
+
676
+ <div class="param-desc">
677
+
678
+ Will throw an error if attempting to modify tags on a number that doesn't belong to a number pool
679
+ with per-visitor numbers enabled.
680
+
681
+ </div>
682
+
683
+
684
+
685
+
686
+
687
+
688
+
689
+ </dd>
690
+
691
+
692
+
693
+ <dt>
694
+ <h4 class="name" id="initiate_call"><span class="type-signature"></span>initiate_call<span class="signature">(dial, payload, callback)</span><span class="type-signature"></span></h4>
695
+
696
+
697
+ </dt>
698
+ <dd>
699
+
700
+
701
+ <div class="description">
702
+ Start a call immediately by having a campaign target dial the visitor.
703
+ </div>
704
+
705
+
706
+
707
+
708
+
709
+
710
+
711
+ <h5>Parameters:</h5>
712
+
713
+
714
+ <table class="params">
715
+ <thead>
716
+ <tr>
717
+
718
+ <th>Name</th>
719
+
720
+
721
+ <th>Type</th>
722
+
723
+
724
+
725
+
726
+
727
+ <th class="last">Description</th>
728
+ </tr>
729
+ </thead>
730
+
731
+ <tbody>
732
+
733
+
734
+ <tr>
735
+
736
+ <td class="name"><code>dial</code></td>
737
+
738
+
739
+ <td class="type">
740
+
741
+
742
+ <span class="param-type">String</span>
743
+
744
+
745
+
746
+ </td>
747
+
748
+
749
+
750
+
751
+
752
+ <td class="description last">The number to call.</td>
753
+ </tr>
754
+
755
+
756
+
757
+ <tr>
758
+
759
+ <td class="name"><code>payload</code></td>
760
+
761
+
762
+ <td class="type">
763
+
764
+
765
+ <span class="param-type">Object</span>
766
+
767
+
768
+
769
+ </td>
770
+
771
+
772
+
773
+
774
+
775
+ <td class="description last">A collection of tags as key-value pairs and optional secure override properties.
776
+ <h6>Properties</h6>
777
+
778
+
779
+ <table class="params">
780
+ <thead>
781
+ <tr>
782
+
783
+ <th>Name</th>
784
+
785
+
786
+ <th>Type</th>
787
+
788
+
789
+ <th>Argument</th>
790
+
791
+
792
+
793
+
794
+ <th class="last">Description</th>
795
+ </tr>
796
+ </thead>
797
+
798
+ <tbody>
799
+
800
+
801
+ <tr>
802
+
803
+ <td class="name"><code>target_map</code></td>
804
+
805
+
806
+ <td class="type">
807
+
808
+
809
+ <span class="param-type">string</span>
810
+
811
+
812
+
813
+ </td>
814
+
815
+
816
+ <td class="attributes">
817
+
818
+ &lt;optional><br>
819
+
820
+
821
+
822
+
823
+
824
+ </td>
825
+
826
+
827
+
828
+
829
+ <td class="description last">A string mapping a placeholder number to a phone number.</td>
830
+ </tr>
831
+
832
+
833
+
834
+ <tr>
835
+
836
+ <td class="name"><code>target_map_cs</code></td>
837
+
838
+
839
+ <td class="type">
840
+
841
+
842
+ <span class="param-type">string</span>
843
+
844
+
845
+
846
+ </td>
847
+
848
+
849
+ <td class="attributes">
850
+
851
+ &lt;optional><br>
852
+
853
+
854
+
855
+
856
+
857
+ </td>
858
+
859
+
860
+
861
+
862
+ <td class="description last">A SHA1 checksum of the target_map concatenated with your CallPixels API
863
+ key.</td>
864
+ </tr>
865
+
866
+
867
+
868
+ <tr>
869
+
870
+ <td class="name"><code>timer_offset</code></td>
871
+
872
+
873
+ <td class="type">
874
+
875
+
876
+ <span class="param-type">number</span>
877
+
878
+
879
+
880
+ </td>
881
+
882
+
883
+ <td class="attributes">
884
+
885
+ &lt;optional><br>
886
+
887
+
888
+
889
+
890
+
891
+ </td>
892
+
893
+
894
+
895
+
896
+ <td class="description last">Number of seconds to offset the "connect" duration timers by.</td>
897
+ </tr>
898
+
899
+
900
+
901
+ <tr>
902
+
903
+ <td class="name"><code>timer_offset_cs</code></td>
904
+
905
+
906
+ <td class="type">
907
+
908
+
909
+ <span class="param-type">string</span>
910
+
911
+
912
+
913
+ </td>
914
+
915
+
916
+ <td class="attributes">
917
+
918
+ &lt;optional><br>
919
+
920
+
921
+
922
+
923
+
924
+ </td>
925
+
926
+
927
+
928
+
929
+ <td class="description last">An SHA1 checksum of the timer_offset concatenated with your
930
+ CallPixels API key.</td>
931
+ </tr>
932
+
933
+
934
+
935
+ <tr>
936
+
937
+ <td class="name"><code>*</code></td>
938
+
939
+
940
+ <td class="type">
941
+
942
+
943
+ <span class="param-type">string</span>
944
+ |
945
+
946
+ <span class="param-type">number</span>
947
+
948
+
949
+
950
+ </td>
951
+
952
+
953
+ <td class="attributes">
954
+
955
+ &lt;optional><br>
956
+
957
+
958
+
959
+
960
+
961
+ </td>
962
+
963
+
964
+
965
+
966
+ <td class="description last">Key value pairs treated as tags.</td>
967
+ </tr>
968
+
969
+
970
+ </tbody>
971
+ </table>
972
+ </td>
973
+ </tr>
974
+
975
+
976
+
977
+ <tr>
978
+
979
+ <td class="name"><code>callback</code></td>
980
+
981
+
982
+ <td class="type">
983
+
984
+
985
+ <span class="param-type">function</span>
986
+
987
+
988
+
989
+ </td>
990
+
991
+
992
+
993
+
994
+
995
+ <td class="description last">Callback that will be fired after request.</td>
996
+ </tr>
997
+
998
+
999
+ </tbody>
1000
+ </table>
1001
+
1002
+
1003
+
1004
+ <dl class="details">
1005
+
1006
+
1007
+
1008
+
1009
+
1010
+
1011
+
1012
+
1013
+
1014
+
1015
+
1016
+
1017
+
1018
+
1019
+
1020
+
1021
+
1022
+
1023
+
1024
+ <dt class="tag-source">Source:</dt>
1025
+ <dd class="tag-source"><ul class="dummy"><li>
1026
+ <a href="number.js.html">retreaver/number.js</a>, <a href="number.js.html#line124">line 124</a>
1027
+ </li></ul></dd>
1028
+
1029
+
1030
+
1031
+
1032
+
1033
+
1034
+
1035
+ </dl>
1036
+
1037
+
1038
+
1039
+
1040
+
1041
+
1042
+
1043
+
1044
+
1045
+
1046
+
1047
+
1048
+
1049
+ <h5>Example</h5>
1050
+
1051
+ <pre class="prettyprint"><code>number.initiate_call('4166686980', {company_name: 'CallPixels'}, function (call) {
1052
+ alert('Call started with UUID ' + call.uuid)
1053
+ });</code></pre>
1054
+
1055
+
1056
+ </dd>
1057
+
1058
+
1059
+
1060
+ <dt>
1061
+ <h4 class="name" id="release"><span class="type-signature"></span>release<span class="signature">()</span><span class="type-signature"></span></h4>
1062
+
1063
+
1064
+ </dt>
1065
+ <dd>
1066
+
1067
+
1068
+ <div class="description">
1069
+ Release number back to pool.
1070
+ </div>
1071
+
1072
+
1073
+
1074
+
1075
+
1076
+
1077
+
1078
+
1079
+
1080
+ <dl class="details">
1081
+
1082
+
1083
+
1084
+
1085
+
1086
+
1087
+
1088
+
1089
+
1090
+
1091
+
1092
+
1093
+
1094
+
1095
+
1096
+
1097
+
1098
+
1099
+
1100
+ <dt class="tag-source">Source:</dt>
1101
+ <dd class="tag-source"><ul class="dummy"><li>
1102
+ <a href="number.js.html">retreaver/number.js</a>, <a href="number.js.html#line114">line 114</a>
1103
+ </li></ul></dd>
1104
+
1105
+
1106
+
1107
+
1108
+
1109
+
1110
+
1111
+ </dl>
1112
+
1113
+
1114
+
1115
+
1116
+
1117
+
1118
+
1119
+
1120
+
1121
+
1122
+
1123
+
1124
+
1125
+ </dd>
1126
+
1127
+
1128
+
1129
+ <dt>
1130
+ <h4 class="name" id="remove_tags"><span class="type-signature"></span>remove_tags<span class="signature">(tags, callback)</span><span class="type-signature"></span></h4>
1131
+
1132
+
1133
+ </dt>
1134
+ <dd>
1135
+
1136
+
1137
+ <div class="description">
1138
+ Remove tags from a number.
1139
+ </div>
1140
+
1141
+
1142
+
1143
+
1144
+
1145
+
1146
+
1147
+ <h5>Parameters:</h5>
1148
+
1149
+
1150
+ <table class="params">
1151
+ <thead>
1152
+ <tr>
1153
+
1154
+ <th>Name</th>
1155
+
1156
+
1157
+ <th>Type</th>
1158
+
1159
+
1160
+
1161
+
1162
+
1163
+ <th class="last">Description</th>
1164
+ </tr>
1165
+ </thead>
1166
+
1167
+ <tbody>
1168
+
1169
+
1170
+ <tr>
1171
+
1172
+ <td class="name"><code>tags</code></td>
1173
+
1174
+
1175
+ <td class="type">
1176
+
1177
+
1178
+ <span class="param-type">Object</span>
1179
+
1180
+
1181
+
1182
+ </td>
1183
+
1184
+
1185
+
1186
+
1187
+
1188
+ <td class="description last">A collection of tags {key: 'value', tag2: 'value2'}</td>
1189
+ </tr>
1190
+
1191
+
1192
+
1193
+ <tr>
1194
+
1195
+ <td class="name"><code>callback</code></td>
1196
+
1197
+
1198
+ <td class="type">
1199
+
1200
+
1201
+ <span class="param-type">function</span>
1202
+
1203
+
1204
+
1205
+ </td>
1206
+
1207
+
1208
+
1209
+
1210
+
1211
+ <td class="description last">Callback that will be fired after request.</td>
1212
+ </tr>
1213
+
1214
+
1215
+ </tbody>
1216
+ </table>
1217
+
1218
+
1219
+
1220
+ <dl class="details">
1221
+
1222
+
1223
+
1224
+
1225
+
1226
+
1227
+
1228
+
1229
+
1230
+
1231
+
1232
+
1233
+
1234
+
1235
+
1236
+
1237
+
1238
+
1239
+
1240
+ <dt class="tag-source">Source:</dt>
1241
+ <dd class="tag-source"><ul class="dummy"><li>
1242
+ <a href="number.js.html">retreaver/number.js</a>, <a href="number.js.html#line59">line 59</a>
1243
+ </li></ul></dd>
1244
+
1245
+
1246
+
1247
+
1248
+
1249
+
1250
+
1251
+ </dl>
1252
+
1253
+
1254
+
1255
+
1256
+
1257
+
1258
+
1259
+
1260
+
1261
+ <h5>Throws:</h5>
1262
+
1263
+
1264
+
1265
+ <div class="param-desc">
1266
+
1267
+ Will throw an error if attempting to modify tags on a number that doesn't belong to a number pool
1268
+ with per-visitor numbers enabled.
1269
+
1270
+ </div>
1271
+
1272
+
1273
+
1274
+
1275
+
1276
+
1277
+
1278
+ </dd>
1279
+
1280
+
1281
+
1282
+ <dt>
1283
+ <h4 class="name" id="remove_tags_by_keys"><span class="type-signature"></span>remove_tags_by_keys<span class="signature">(keys, callback)</span><span class="type-signature"></span></h4>
1284
+
1285
+
1286
+ </dt>
1287
+ <dd>
1288
+
1289
+
1290
+ <div class="description">
1291
+ Removes all tags with given keys from a number.
1292
+ </div>
1293
+
1294
+
1295
+
1296
+
1297
+
1298
+
1299
+
1300
+ <h5>Parameters:</h5>
1301
+
1302
+
1303
+ <table class="params">
1304
+ <thead>
1305
+ <tr>
1306
+
1307
+ <th>Name</th>
1308
+
1309
+
1310
+ <th>Type</th>
1311
+
1312
+
1313
+
1314
+
1315
+
1316
+ <th class="last">Description</th>
1317
+ </tr>
1318
+ </thead>
1319
+
1320
+ <tbody>
1321
+
1322
+
1323
+ <tr>
1324
+
1325
+ <td class="name"><code>keys</code></td>
1326
+
1327
+
1328
+ <td class="type">
1329
+
1330
+
1331
+ <span class="param-type">Array</span>
1332
+
1333
+
1334
+
1335
+ </td>
1336
+
1337
+
1338
+
1339
+
1340
+
1341
+ <td class="description last">An array of keys to remove. eg: ['key1', 'key2']</td>
1342
+ </tr>
1343
+
1344
+
1345
+
1346
+ <tr>
1347
+
1348
+ <td class="name"><code>callback</code></td>
1349
+
1350
+
1351
+ <td class="type">
1352
+
1353
+
1354
+ <span class="param-type">function</span>
1355
+
1356
+
1357
+
1358
+ </td>
1359
+
1360
+
1361
+
1362
+
1363
+
1364
+ <td class="description last">Callback that will be fired after request.</td>
1365
+ </tr>
1366
+
1367
+
1368
+ </tbody>
1369
+ </table>
1370
+
1371
+
1372
+
1373
+ <dl class="details">
1374
+
1375
+
1376
+
1377
+
1378
+
1379
+
1380
+
1381
+
1382
+
1383
+
1384
+
1385
+
1386
+
1387
+
1388
+
1389
+
1390
+
1391
+
1392
+
1393
+ <dt class="tag-source">Source:</dt>
1394
+ <dd class="tag-source"><ul class="dummy"><li>
1395
+ <a href="number.js.html">retreaver/number.js</a>, <a href="number.js.html#line74">line 74</a>
1396
+ </li></ul></dd>
1397
+
1398
+
1399
+
1400
+
1401
+
1402
+
1403
+
1404
+ </dl>
1405
+
1406
+
1407
+
1408
+
1409
+
1410
+
1411
+
1412
+
1413
+
1414
+ <h5>Throws:</h5>
1415
+
1416
+
1417
+
1418
+ <div class="param-desc">
1419
+
1420
+ Will throw an error if attempting to modify tags on a number that doesn't belong to a number pool
1421
+ with per-visitor numbers enabled.
1422
+
1423
+ </div>
1424
+
1425
+
1426
+
1427
+
1428
+
1429
+
1430
+
1431
+ </dd>
1432
+
1433
+
1434
+
1435
+ <dt>
1436
+ <h4 class="name" id="replace_tags"><span class="type-signature"></span>replace_tags<span class="signature">(tags, callback)</span><span class="type-signature"></span></h4>
1437
+
1438
+
1439
+ </dt>
1440
+ <dd>
1441
+
1442
+
1443
+ <div class="description">
1444
+ Replace tags on a number. Any tags that already exist on the number that match the given keys will be
1445
+ removed. This can be used instead of calling remove_tags and then add_tags.
1446
+ </div>
1447
+
1448
+
1449
+
1450
+
1451
+
1452
+
1453
+
1454
+ <h5>Parameters:</h5>
1455
+
1456
+
1457
+ <table class="params">
1458
+ <thead>
1459
+ <tr>
1460
+
1461
+ <th>Name</th>
1462
+
1463
+
1464
+ <th>Type</th>
1465
+
1466
+
1467
+
1468
+
1469
+
1470
+ <th class="last">Description</th>
1471
+ </tr>
1472
+ </thead>
1473
+
1474
+ <tbody>
1475
+
1476
+
1477
+ <tr>
1478
+
1479
+ <td class="name"><code>tags</code></td>
1480
+
1481
+
1482
+ <td class="type">
1483
+
1484
+
1485
+ <span class="param-type">Object</span>
1486
+
1487
+
1488
+
1489
+ </td>
1490
+
1491
+
1492
+
1493
+
1494
+
1495
+ <td class="description last">A collection of tags {key: 'value', tag2: 'value2'}</td>
1496
+ </tr>
1497
+
1498
+
1499
+
1500
+ <tr>
1501
+
1502
+ <td class="name"><code>callback</code></td>
1503
+
1504
+
1505
+ <td class="type">
1506
+
1507
+
1508
+ <span class="param-type">function</span>
1509
+
1510
+
1511
+
1512
+ </td>
1513
+
1514
+
1515
+
1516
+
1517
+
1518
+ <td class="description last">Callback that will be fired after request.</td>
1519
+ </tr>
1520
+
1521
+
1522
+ </tbody>
1523
+ </table>
1524
+
1525
+
1526
+
1527
+ <dl class="details">
1528
+
1529
+
1530
+
1531
+
1532
+
1533
+
1534
+
1535
+
1536
+
1537
+
1538
+
1539
+
1540
+
1541
+
1542
+
1543
+
1544
+
1545
+
1546
+
1547
+ <dt class="tag-source">Source:</dt>
1548
+ <dd class="tag-source"><ul class="dummy"><li>
1549
+ <a href="number.js.html">retreaver/number.js</a>, <a href="number.js.html#line43">line 43</a>
1550
+ </li></ul></dd>
1551
+
1552
+
1553
+
1554
+
1555
+
1556
+
1557
+
1558
+ </dl>
1559
+
1560
+
1561
+
1562
+
1563
+
1564
+
1565
+
1566
+
1567
+
1568
+ <h5>Throws:</h5>
1569
+
1570
+
1571
+
1572
+ <div class="param-desc">
1573
+
1574
+ Will throw an error if attempting to modify tags on a number that doesn't belong to a number pool
1575
+ with per-visitor numbers enabled.
1576
+
1577
+ </div>
1578
+
1579
+
1580
+
1581
+
1582
+
1583
+
1584
+
1585
+ </dd>
1586
+
1587
+ </dl>
1588
+
1589
+
1590
+
1591
+
1592
+
1593
+ </article>
1594
+
1595
+ </section>
1596
+
1597
+
1598
+
1599
+
1600
+ </div>
1601
+
1602
+ <nav>
1603
+ <h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="Retreaver.Campaign.html">Campaign</a></li><li><a href="Retreaver.Number.html">Number</a></li></ul><h3>Namespaces</h3><ul><li><a href="Retreaver.html">Retreaver</a></li></ul><h3><a href="global.html">Global</a></h3>
1604
+ </nav>
1605
+
1606
+ <br clear="both">
1607
+
1608
+ <footer>
1609
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Mon Jun 17 2024 14:31:16 GMT+0300 (EEST)
1610
+ </footer>
1611
+
1612
+ <script> prettyPrint(); </script>
1613
+ <script src="scripts/linenumber.js"> </script>
1614
+ </body>
1615
+ </html>