1
+ <!DOCTYPE html>
2
+ < html lang ="en ">
3
+ < head >
4
+ < meta charset ="utf-8 ">
5
+ < title > JSDoc: Class: Analytics</ 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: Analytics</ h1 >
21
+
22
+
23
+
24
+
25
+
26
+
27
+ < section >
28
+
29
+ < header >
30
+
31
+ < h2 > < span class ="attribs "> < span class ="type-signature "> </ span > </ span >
32
+ < span class ="ancestors "> < a href ="Parse.html "> Parse</ a > .</ span > Analytics</ h2 >
33
+
34
+
35
+ </ header >
36
+
37
+ < article >
38
+ < div class ="container-overview ">
39
+
40
+
41
+
42
+
43
+
44
+
45
+
46
+
47
+
48
+
49
+
50
+
51
+
52
+
53
+
54
+
55
+
56
+ < dl class ="details ">
57
+
58
+
59
+
60
+
61
+
62
+
63
+
64
+
65
+
66
+
67
+
68
+
69
+
70
+
71
+
72
+
73
+
74
+
75
+
76
+
77
+
78
+
79
+
80
+
81
+
82
+
83
+
84
+
85
+
86
+
87
+
88
+
89
+ </ dl >
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+
98
+
99
+
100
+
101
+
102
+
103
+
104
+
105
+
106
+
107
+
108
+
109
+ </ div >
110
+
111
+
112
+
113
+
114
+
115
+
116
+
117
+
118
+
119
+
120
+
121
+
122
+
123
+
124
+
125
+
126
+ < h3 class ="subsection-title "> Methods</ h3 >
127
+
128
+
129
+
130
+
131
+
132
+
133
+
134
+ < h4 class ="name " id =".track "> < span class ="type-signature "> (static) </ span > track< span class ="signature "> (name, dimensions, options)</ span > < span class ="type-signature "> → {< a href ="Parse.Promise.html "> Parse.Promise</ a > }</ span > </ h4 >
135
+
136
+
137
+
138
+
139
+
140
+
141
+ < div class ="description ">
142
+ Tracks the occurrence of a custom event with additional dimensions.
143
+ Parse will store a data point at the time of invocation with the given
144
+ event name.
145
+
146
+ Dimensions will allow segmentation of the occurrences of this custom
147
+ event. Keys and values should be {@code String}s, and will throw
148
+ otherwise.
149
+
150
+ To track a user signup along with additional metadata, consider the
151
+ following:
152
+ < pre >
153
+ var dimensions = {
154
+ gender: 'm',
155
+ source: 'web',
156
+ dayType: 'weekend'
157
+ };
158
+ Parse.Analytics.track('signup', dimensions);
159
+ </ pre >
160
+
161
+ There is a default limit of 8 dimensions per event tracked.
162
+ </ div >
163
+
164
+
165
+
166
+
167
+
168
+
169
+
170
+
171
+
172
+ < h5 > Parameters:</ h5 >
173
+
174
+
175
+ < table class ="params ">
176
+ < thead >
177
+ < tr >
178
+
179
+ < th > Name</ th >
180
+
181
+
182
+ < th > Type</ th >
183
+
184
+
185
+
186
+
187
+
188
+ < th class ="last "> Description</ th >
189
+ </ tr >
190
+ </ thead >
191
+
192
+ < tbody >
193
+
194
+
195
+ < tr >
196
+
197
+ < td class ="name "> < code > name</ code > </ td >
198
+
199
+
200
+ < td class ="type ">
201
+
202
+
203
+ < span class ="param-type "> String</ span >
204
+
205
+
206
+
207
+ </ td >
208
+
209
+
210
+
211
+
212
+
213
+ < td class ="description last "> The name of the custom event to report to Parse as
214
+ having happened.</ td >
215
+ </ tr >
216
+
217
+
218
+
219
+ < tr >
220
+
221
+ < td class ="name "> < code > dimensions</ code > </ td >
222
+
223
+
224
+ < td class ="type ">
225
+
226
+
227
+ < span class ="param-type "> Object</ span >
228
+
229
+
230
+
231
+ </ td >
232
+
233
+
234
+
235
+
236
+
237
+ < td class ="description last "> The dictionary of information by which to
238
+ segment this event.</ td >
239
+ </ tr >
240
+
241
+
242
+
243
+ < tr >
244
+
245
+ < td class ="name "> < code > options</ code > </ td >
246
+
247
+
248
+ < td class ="type ">
249
+
250
+
251
+ < span class ="param-type "> Object</ span >
252
+
253
+
254
+
255
+ </ td >
256
+
257
+
258
+
259
+
260
+
261
+ < td class ="description last "> A Backbone-style callback object.</ td >
262
+ </ tr >
263
+
264
+
265
+ </ tbody >
266
+ </ table >
267
+
268
+
269
+
270
+
271
+
272
+
273
+ < dl class ="details ">
274
+
275
+
276
+
277
+
278
+
279
+
280
+
281
+
282
+
283
+
284
+
285
+
286
+
287
+
288
+
289
+
290
+
291
+
292
+
293
+
294
+
295
+
296
+
297
+
298
+
299
+
300
+
301
+
302
+
303
+
304
+
305
+
306
+ </ dl >
307
+
308
+
309
+
310
+
311
+
312
+
313
+
314
+
315
+
316
+
317
+
318
+
319
+
320
+ < h5 > Returns:</ h5 >
321
+
322
+
323
+ < div class ="param-desc ">
324
+ A promise that is resolved when the round-trip
325
+ to the server completes.
326
+ </ div >
327
+
328
+
329
+
330
+ < dl >
331
+ < dt >
332
+ Type
333
+ </ dt >
334
+ < dd >
335
+
336
+ < span class ="param-type "> < a href ="Parse.Promise.html "> Parse.Promise</ a > </ span >
337
+
338
+
339
+ </ dd >
340
+ </ dl >
341
+
342
+
343
+
344
+
345
+
346
+
347
+
348
+
349
+
350
+
351
+
352
+
353
+
354
+ </ article >
355
+
356
+ </ section >
357
+
358
+
359
+
360
+
361
+ </ div >
362
+
363
+ < nav >
364
+ < h2 > < a href ="index.html "> Home</ a > </ h2 > < h3 > Classes</ h3 > < ul > < li > < a href ="Parse.html "> Parse</ a > </ li > < li > < a href ="Parse.ACL.html "> ACL</ a > </ li > < li > < a href ="Parse.Analytics.html "> Analytics</ a > </ li > < li > < a href ="Parse.Cloud.html "> Cloud</ a > </ li > < li > < a href ="Parse.Config.html "> Config</ a > </ li > < li > < a href ="Parse.Error.html "> Error</ a > </ li > < li > < a href ="Parse.FacebookUtils.html "> FacebookUtils</ a > </ li > < li > < a href ="Parse.File.html "> File</ a > </ li > < li > < a href ="Parse.GeoPoint.html "> GeoPoint</ a > </ li > < li > < a href ="Parse.LiveQuery.html "> LiveQuery</ a > </ li > < li > < a href ="Parse.LiveQueryClient.html "> LiveQueryClient</ a > </ li > < li > < a href ="Parse.LiveQuerySubscription.html "> LiveQuerySubscription</ a > </ li > < li > < a href ="Parse.Object.html "> Object</ a > </ li > < li > < a href ="Parse.Polygon.html "> Polygon</ a > </ li > < li > < a href ="Parse.Promise.html "> Promise</ a > </ li > < li > < a href ="Parse.Push.html "> Push</ a > </ li > < li > < a href ="Parse.Query.html "> Query</ a > </ li > < li > < a href ="Parse.Relation.html "> Relation</ a > </ li > < li > < a href ="Parse.Role.html "> Role</ a > </ li > < li > < a href ="Parse.Session.html "> Session</ a > </ li > < li > < a href ="Parse.User.html "> User</ a > </ li > </ ul >
365
+ </ nav >
366
+
367
+ < br class ="clear ">
368
+
369
+ < footer >
370
+ Documentation generated by < a href ="https://github.com/jsdoc3/jsdoc "> JSDoc 3.5.5</ a > on Mon Nov 27 2017 21:04:38 GMT-0500 (EST)
371
+ </ footer >
372
+
373
+ < script > prettyPrint ( ) ; </ script >
374
+ < script src ="scripts/linenumber.js "> </ script >
375
+ </ body >
376
+ </ html >
0 commit comments