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: Namespace: Retreaver</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,77 +16,83 @@
|
|
|
16
16
|
<body>
|
|
17
17
|
|
|
18
18
|
<div id="main">
|
|
19
|
-
|
|
19
|
+
|
|
20
20
|
<h1 class="page-title">Namespace: Retreaver</h1>
|
|
21
|
+
|
|
21
22
|
|
|
22
|
-
|
|
23
|
+
|
|
23
24
|
|
|
24
25
|
|
|
25
26
|
|
|
26
27
|
<section>
|
|
27
|
-
|
|
28
|
+
|
|
28
29
|
<header>
|
|
29
|
-
<h2>
|
|
30
|
-
Retreaver
|
|
31
|
-
</h2>
|
|
32
30
|
|
|
33
|
-
</
|
|
31
|
+
<h2>Retreaver</h2>
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
</header>
|
|
34
35
|
|
|
35
36
|
<article>
|
|
36
37
|
<div class="container-overview">
|
|
37
38
|
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
39
|
|
|
40
|
+
|
|
42
41
|
|
|
42
|
+
|
|
43
|
+
|
|
43
44
|
<dl class="details">
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
45
|
|
|
50
46
|
|
|
47
|
+
|
|
51
48
|
|
|
49
|
+
|
|
52
50
|
|
|
51
|
+
|
|
53
52
|
|
|
53
|
+
|
|
54
54
|
|
|
55
|
+
|
|
55
56
|
|
|
57
|
+
|
|
56
58
|
|
|
59
|
+
|
|
57
60
|
|
|
61
|
+
|
|
58
62
|
|
|
63
|
+
|
|
59
64
|
|
|
65
|
+
|
|
60
66
|
|
|
67
|
+
|
|
61
68
|
|
|
69
|
+
|
|
62
70
|
|
|
63
71
|
<dt class="tag-source">Source:</dt>
|
|
64
72
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
65
73
|
<a href="retreaver.js.html">retreaver.js</a>, <a href="retreaver.js.html#line2">line 2</a>
|
|
66
74
|
</li></ul></dd>
|
|
67
75
|
|
|
76
|
+
|
|
68
77
|
|
|
78
|
+
|
|
69
79
|
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
80
|
+
|
|
73
81
|
|
|
74
82
|
</dl>
|
|
75
83
|
|
|
76
|
-
|
|
84
|
+
|
|
77
85
|
|
|
78
86
|
|
|
79
87
|
</div>
|
|
88
|
+
|
|
80
89
|
|
|
90
|
+
|
|
81
91
|
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
92
|
+
|
|
87
93
|
|
|
88
94
|
<h3 class="subsection-title">Classes</h3>
|
|
89
|
-
|
|
95
|
+
|
|
90
96
|
<dl>
|
|
91
97
|
<dt><a href="Retreaver.Campaign.html">Campaign</a></dt>
|
|
92
98
|
<dd></dd>
|
|
@@ -95,62 +101,67 @@
|
|
|
95
101
|
<dd></dd>
|
|
96
102
|
</dl>
|
|
97
103
|
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
|
|
98
107
|
|
|
108
|
+
|
|
99
109
|
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
110
|
+
|
|
103
111
|
|
|
104
112
|
<h3 class="subsection-title">Methods</h3>
|
|
113
|
+
|
|
105
114
|
|
|
106
|
-
<dl>
|
|
107
115
|
|
|
108
|
-
<dt>
|
|
109
|
-
<h4 class="name" id="configure"><span class="type-signature"><static> </span>configure<span class="signature">(options)</span><span class="type-signature"></span></h4>
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
</dt>
|
|
113
|
-
<dd>
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
<div class="description">
|
|
117
|
-
Configure the retreaver client library.
|
|
118
|
-
</div>
|
|
119
|
-
|
|
120
116
|
|
|
121
117
|
|
|
118
|
+
|
|
119
|
+
<h4 class="name" id=".configure"><span class="type-signature">(static) </span>configure<span class="signature">(options)</span><span class="type-signature"></span></h4>
|
|
120
|
+
|
|
122
121
|
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
<div class="description">
|
|
126
|
+
Configure the retreaver client library.
|
|
127
|
+
</div>
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
<h5>Parameters:</h5>
|
|
123
138
|
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
<h5>Parameters:</h5>
|
|
127
|
-
|
|
128
139
|
|
|
129
140
|
<table class="params">
|
|
130
141
|
<thead>
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
142
|
+
<tr>
|
|
143
|
+
|
|
144
|
+
<th>Name</th>
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
<th>Type</th>
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
<th class="last">Description</th>
|
|
154
|
+
</tr>
|
|
155
|
+
</thead>
|
|
156
|
+
|
|
157
|
+
<tbody>
|
|
158
|
+
|
|
159
|
+
|
|
149
160
|
<tr>
|
|
150
161
|
|
|
151
162
|
<td class="name"><code>options</code></td>
|
|
152
163
|
|
|
153
|
-
|
|
164
|
+
|
|
154
165
|
<td class="type">
|
|
155
166
|
|
|
156
167
|
|
|
@@ -159,40 +170,40 @@
|
|
|
159
170
|
|
|
160
171
|
|
|
161
172
|
</td>
|
|
173
|
+
|
|
162
174
|
|
|
175
|
+
|
|
163
176
|
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
177
|
+
|
|
167
178
|
<td class="description last">
|
|
168
179
|
<h6>Properties</h6>
|
|
169
180
|
|
|
170
181
|
|
|
171
182
|
<table class="params">
|
|
172
183
|
<thead>
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
184
|
+
<tr>
|
|
185
|
+
|
|
186
|
+
<th>Name</th>
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
<th>Type</th>
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
<th class="last">Description</th>
|
|
196
|
+
</tr>
|
|
197
|
+
</thead>
|
|
198
|
+
|
|
199
|
+
<tbody>
|
|
200
|
+
|
|
201
|
+
|
|
191
202
|
<tr>
|
|
192
203
|
|
|
193
204
|
<td class="name"><code>host</code></td>
|
|
194
205
|
|
|
195
|
-
|
|
206
|
+
|
|
196
207
|
<td class="type">
|
|
197
208
|
|
|
198
209
|
|
|
@@ -201,21 +212,21 @@
|
|
|
201
212
|
|
|
202
213
|
|
|
203
214
|
</td>
|
|
215
|
+
|
|
204
216
|
|
|
217
|
+
|
|
205
218
|
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
219
|
+
|
|
209
220
|
<td class="description last">Retreaver API Host</td>
|
|
210
221
|
</tr>
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
|
|
214
225
|
<tr>
|
|
215
226
|
|
|
216
227
|
<td class="name"><code>prefix</code></td>
|
|
217
228
|
|
|
218
|
-
|
|
229
|
+
|
|
219
230
|
<td class="type">
|
|
220
231
|
|
|
221
232
|
|
|
@@ -224,87 +235,99 @@
|
|
|
224
235
|
|
|
225
236
|
|
|
226
237
|
</td>
|
|
238
|
+
|
|
227
239
|
|
|
240
|
+
|
|
228
241
|
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
242
|
+
|
|
232
243
|
<td class="description last">http or https</td>
|
|
233
244
|
</tr>
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
</tbody>
|
|
237
248
|
</table>
|
|
249
|
+
|
|
238
250
|
</td>
|
|
239
251
|
</tr>
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
</tbody>
|
|
243
|
-
</table>
|
|
244
|
-
|
|
245
|
-
|
|
252
|
+
|
|
246
253
|
|
|
254
|
+
</tbody>
|
|
255
|
+
</table>
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
|
|
247
262
|
<dl class="details">
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
263
|
|
|
254
264
|
|
|
265
|
+
|
|
255
266
|
|
|
267
|
+
|
|
256
268
|
|
|
269
|
+
|
|
257
270
|
|
|
271
|
+
|
|
258
272
|
|
|
273
|
+
|
|
259
274
|
|
|
275
|
+
|
|
260
276
|
|
|
277
|
+
|
|
261
278
|
|
|
279
|
+
|
|
262
280
|
|
|
281
|
+
|
|
263
282
|
|
|
283
|
+
|
|
264
284
|
|
|
285
|
+
|
|
265
286
|
|
|
287
|
+
|
|
266
288
|
|
|
267
289
|
<dt class="tag-source">Source:</dt>
|
|
268
290
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
269
291
|
<a href="retreaver.js.html">retreaver.js</a>, <a href="retreaver.js.html#line7">line 7</a>
|
|
270
292
|
</li></ul></dd>
|
|
271
293
|
|
|
294
|
+
|
|
272
295
|
|
|
296
|
+
|
|
273
297
|
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
298
|
+
|
|
277
299
|
|
|
278
300
|
</dl>
|
|
279
301
|
|
|
280
|
-
|
|
281
|
-
|
|
282
302
|
|
|
283
|
-
|
|
284
303
|
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
<h5>Example</h5>
|
|
285
317
|
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
<h5>Example</h5>
|
|
293
|
-
|
|
294
318
|
<pre class="prettyprint"><code>Retreaver.configure({host: 'api.rtvrapi.com', prefix: 'https'});</code></pre>
|
|
295
319
|
|
|
296
|
-
|
|
297
|
-
</dd>
|
|
298
320
|
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
321
|
+
|
|
322
|
+
|
|
302
323
|
|
|
324
|
+
|
|
303
325
|
|
|
326
|
+
|
|
304
327
|
|
|
305
328
|
</article>
|
|
306
329
|
|
|
307
|
-
</section>
|
|
330
|
+
</section>
|
|
308
331
|
|
|
309
332
|
|
|
310
333
|
|
|
@@ -312,13 +335,13 @@
|
|
|
312
335
|
</div>
|
|
313
336
|
|
|
314
337
|
<nav>
|
|
315
|
-
<h2><a href="index.html">
|
|
338
|
+
<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>
|
|
316
339
|
</nav>
|
|
317
340
|
|
|
318
|
-
<br
|
|
341
|
+
<br class="clear">
|
|
319
342
|
|
|
320
343
|
<footer>
|
|
321
|
-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.
|
|
344
|
+
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)
|
|
322
345
|
</footer>
|
|
323
346
|
|
|
324
347
|
<script> prettyPrint(); </script>
|