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