Skip to content

Commit 810cb1b

Browse files
committed
Update docs
1 parent 9df3b4c commit 810cb1b

File tree

5 files changed

+206
-64
lines changed

5 files changed

+206
-64
lines changed

docs/Mixpanel.html

Lines changed: 166 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -440,7 +440,7 @@ <h5>Parameters:</h5>
440440

441441
<dt class="tag-source">Source:</dt>
442442
<dd class="tag-source"><ul class="dummy"><li>
443-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line266">line 266</a>
443+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line271">line 271</a>
444444
</li></ul></dd>
445445

446446

@@ -607,7 +607,7 @@ <h5>Parameters:</h5>
607607

608608
<dt class="tag-source">Source:</dt>
609609
<dd class="tag-source"><ul class="dummy"><li>
610-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line167">line 167</a>
610+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line172">line 172</a>
611611
</li></ul></dd>
612612

613613

@@ -700,7 +700,7 @@ <h4 class="name" id="clearSuperProperties"><span class="type-signature"></span>c
700700

701701
<dt class="tag-source">Source:</dt>
702702
<dd class="tag-source"><ul class="dummy"><li>
703-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line374">line 374</a>
703+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line379">line 379</a>
704704
</li></ul></dd>
705705

706706

@@ -862,7 +862,7 @@ <h5>Parameters:</h5>
862862

863863
<dt class="tag-source">Source:</dt>
864864
<dd class="tag-source"><ul class="dummy"><li>
865-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line294">line 294</a>
865+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line299">line 299</a>
866866
</li></ul></dd>
867867

868868

@@ -999,7 +999,7 @@ <h5>Parameters:</h5>
999999

10001000
<dt class="tag-source">Source:</dt>
10011001
<dd class="tag-source"><ul class="dummy"><li>
1002-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line399">line 399</a>
1002+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line404">line 404</a>
10031003
</li></ul></dd>
10041004

10051005

@@ -1115,7 +1115,7 @@ <h4 class="name" id="flush"><span class="type-signature"></span>flush<span class
11151115

11161116
<dt class="tag-source">Source:</dt>
11171117
<dd class="tag-source"><ul class="dummy"><li>
1118-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line441">line 441</a>
1118+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line446">line 446</a>
11191119
</li></ul></dd>
11201120

11211121

@@ -1211,7 +1211,7 @@ <h4 class="name" id="getDistinctId"><span class="type-signature"></span>getDisti
12111211

12121212
<dt class="tag-source">Source:</dt>
12131213
<dd class="tag-source"><ul class="dummy"><li>
1214-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line428">line 428</a>
1214+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line433">line 433</a>
12151215
</li></ul></dd>
12161216

12171217

@@ -1394,7 +1394,7 @@ <h5>Parameters:</h5>
13941394

13951395
<dt class="tag-source">Source:</dt>
13961396
<dd class="tag-source"><ul class="dummy"><li>
1397-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line256">line 256</a>
1397+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line261">line 261</a>
13981398
</li></ul></dd>
13991399

14001400

@@ -1494,7 +1494,7 @@ <h4 class="name" id="getPeople"><span class="type-signature"></span>getPeople<sp
14941494

14951495
<dt class="tag-source">Source:</dt>
14961496
<dd class="tag-source"><ul class="dummy"><li>
1497-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line206">line 206</a>
1497+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line211">line 211</a>
14981498
</li></ul></dd>
14991499

15001500

@@ -1608,7 +1608,7 @@ <h4 class="name" id="getSuperProperties"><span class="type-signature"></span>get
16081608

16091609
<dt class="tag-source">Source:</dt>
16101610
<dd class="tag-source"><ul class="dummy"><li>
1611-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line362">line 362</a>
1611+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line367">line 367</a>
16121612
</li></ul></dd>
16131613

16141614

@@ -1718,7 +1718,7 @@ <h4 class="name" id="hasOptedOutTracking"><span class="type-signature"></span>ha
17181718

17191719
<dt class="tag-source">Source:</dt>
17201720
<dd class="tag-source"><ul class="dummy"><li>
1721-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line104">line 104</a>
1721+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line109">line 109</a>
17221722
</li></ul></dd>
17231723

17241724

@@ -1889,7 +1889,7 @@ <h5>Parameters:</h5>
18891889

18901890
<dt class="tag-source">Source:</dt>
18911891
<dd class="tag-source"><ul class="dummy"><li>
1892-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line147">line 147</a>
1892+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line152">line 152</a>
18931893
</li></ul></dd>
18941894

18951895

@@ -1979,7 +1979,7 @@ <h4 class="name" id="optInTracking"><span class="type-signature"></span>optInTra
19791979

19801980
<dt class="tag-source">Source:</dt>
19811981
<dd class="tag-source"><ul class="dummy"><li>
1982-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line114">line 114</a>
1982+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line119">line 119</a>
19831983
</li></ul></dd>
19841984

19851985

@@ -2071,7 +2071,7 @@ <h4 class="name" id="optOutTracking"><span class="type-signature"></span>optOutT
20712071

20722072
<dt class="tag-source">Source:</dt>
20732073
<dd class="tag-source"><ul class="dummy"><li>
2074-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line125">line 125</a>
2074+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line130">line 130</a>
20752075
</li></ul></dd>
20762076

20772077

@@ -2218,7 +2218,7 @@ <h5>Parameters:</h5>
22182218

22192219
<dt class="tag-source">Source:</dt>
22202220
<dd class="tag-source"><ul class="dummy"><li>
2221-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line316">line 316</a>
2221+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line321">line 321</a>
22222222
</li></ul></dd>
22232223

22242224

@@ -2358,7 +2358,7 @@ <h5>Parameters:</h5>
23582358

23592359
<dt class="tag-source">Source:</dt>
23602360
<dd class="tag-source"><ul class="dummy"><li>
2361-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line331">line 331</a>
2361+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line336">line 336</a>
23622362
</li></ul></dd>
23632363

23642364

@@ -2518,7 +2518,7 @@ <h5>Parameters:</h5>
25182518

25192519
<dt class="tag-source">Source:</dt>
25202520
<dd class="tag-source"><ul class="dummy"><li>
2521-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line279">line 279</a>
2521+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line284">line 284</a>
25222522
</li></ul></dd>
25232523

25242524

@@ -2607,7 +2607,7 @@ <h4 class="name" id="reset"><span class="type-signature"></span>reset<span class
26072607

26082608
<dt class="tag-source">Source:</dt>
26092609
<dd class="tag-source"><ul class="dummy"><li>
2610-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line410">line 410</a>
2610+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line415">line 415</a>
26112611
</li></ul></dd>
26122612

26132613

@@ -2767,7 +2767,7 @@ <h5>Parameters:</h5>
27672767

27682768
<dt class="tag-source">Source:</dt>
27692769
<dd class="tag-source"><ul class="dummy"><li>
2770-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line240">line 240</a>
2770+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line245">line 245</a>
27712771
</li></ul></dd>
27722772

27732773

@@ -2812,8 +2812,6 @@ <h4 class="name" id="setLoggingEnabled"><span class="type-signature"></span>setL
28122812

28132813
<div class="description">
28142814
This allows enabling or disabling of all Mixpanel logs at run time.
2815-
- Note: This method will only work for iOS. For android, please refer to:
2816-
https://developer.mixpanel.com/docs/android
28172815
All logging is disabled by default. Usually, this is only required if
28182816
you are running into issues with the SDK that you want to debug
28192817
</div>
@@ -2908,7 +2906,7 @@ <h5>Parameters:</h5>
29082906

29092907
<dt class="tag-source">Source:</dt>
29102908
<dd class="tag-source"><ul class="dummy"><li>
2911-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line93">line 93</a>
2909+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line87">line 87</a>
29122910
</li></ul></dd>
29132911

29142912

@@ -2955,8 +2953,6 @@ <h4 class="name" id="setServerURL"><span class="type-signature"></span>setServer
29552953
Set the base URL used for Mixpanel API requests.
29562954
Useful if you need to proxy Mixpanel requests. Defaults to https://api.mixpanel.com.
29572955
To route data to Mixpanel's EU servers, set to https://api-eu.mixpanel.com
2958-
- Note: This method will only work for iOS. For android, please refer to:
2959-
https://developer.mixpanel.com/docs/android
29602956
</div>
29612957

29622958

@@ -3049,7 +3045,147 @@ <h5>Parameters:</h5>
30493045

30503046
<dt class="tag-source">Source:</dt>
30513047
<dd class="tag-source"><ul class="dummy"><li>
3052-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line77">line 77</a>
3048+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line75">line 75</a>
3049+
</li></ul></dd>
3050+
3051+
3052+
3053+
3054+
3055+
3056+
3057+
</dl>
3058+
3059+
3060+
3061+
3062+
3063+
3064+
3065+
3066+
3067+
3068+
3069+
3070+
3071+
3072+
3073+
3074+
3075+
3076+
3077+
3078+
3079+
3080+
3081+
3082+
3083+
3084+
<h4 class="name" id="setUseIpAddressForGeolocation"><span class="type-signature"></span>setUseIpAddressForGeolocation<span class="signature">(useIpAddressForGeolocation)</span><span class="type-signature"></span></h4>
3085+
3086+
3087+
3088+
3089+
3090+
3091+
<div class="description">
3092+
This controls whether to automatically send the client IP Address as part of event tracking.
3093+
With an IP address, geo-location is possible down to neighborhoods within a city,
3094+
although the Mixpanel Dashboard will just show you city level location specificity.
3095+
</div>
3096+
3097+
3098+
3099+
3100+
3101+
3102+
3103+
3104+
3105+
<h5>Parameters:</h5>
3106+
3107+
3108+
<table class="params">
3109+
<thead>
3110+
<tr>
3111+
3112+
<th>Name</th>
3113+
3114+
3115+
<th>Type</th>
3116+
3117+
3118+
3119+
3120+
3121+
<th class="last">Description</th>
3122+
</tr>
3123+
</thead>
3124+
3125+
<tbody>
3126+
3127+
3128+
<tr>
3129+
3130+
<td class="name"><code>useIpAddressForGeolocation</code></td>
3131+
3132+
3133+
<td class="type">
3134+
3135+
3136+
<span class="param-type">boolean</span>
3137+
3138+
3139+
3140+
</td>
3141+
3142+
3143+
3144+
3145+
3146+
<td class="description last">whether to automatically send the client IP Address.
3147+
Defaults to true.</td>
3148+
</tr>
3149+
3150+
3151+
</tbody>
3152+
</table>
3153+
3154+
3155+
3156+
3157+
3158+
3159+
<dl class="details">
3160+
3161+
3162+
3163+
3164+
3165+
3166+
3167+
3168+
3169+
3170+
3171+
3172+
3173+
3174+
3175+
3176+
3177+
3178+
3179+
3180+
3181+
3182+
3183+
3184+
3185+
3186+
<dt class="tag-source">Source:</dt>
3187+
<dd class="tag-source"><ul class="dummy"><li>
3188+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line100">line 100</a>
30533189
</li></ul></dd>
30543190

30553191

@@ -3188,7 +3324,7 @@ <h5>Parameters:</h5>
31883324

31893325
<dt class="tag-source">Source:</dt>
31903326
<dd class="tag-source"><ul class="dummy"><li>
3191-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line385">line 385</a>
3327+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line390">line 390</a>
31923328
</li></ul></dd>
31933329

31943330

@@ -3354,7 +3490,7 @@ <h5>Parameters:</h5>
33543490

33553491
<dt class="tag-source">Source:</dt>
33563492
<dd class="tag-source"><ul class="dummy"><li>
3357-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line189">line 189</a>
3493+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line194">line 194</a>
33583494
</li></ul></dd>
33593495

33603496

@@ -3543,7 +3679,7 @@ <h5>Parameters:</h5>
35433679

35443680
<dt class="tag-source">Source:</dt>
35453681
<dd class="tag-source"><ul class="dummy"><li>
3546-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line224">line 224</a>
3682+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line229">line 229</a>
35473683
</li></ul></dd>
35483684

35493685

@@ -3684,7 +3820,7 @@ <h5>Parameters:</h5>
36843820

36853821
<dt class="tag-source">Source:</dt>
36863822
<dd class="tag-source"><ul class="dummy"><li>
3687-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line347">line 347</a>
3823+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line352">line 352</a>
36883824
</li></ul></dd>
36893825

36903826

@@ -3736,7 +3872,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Mixpanel.
37363872
<br class="clear">
37373873

37383874
<footer>
3739-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Wed Mar 17 2021 17:41:42 GMT-0700 (Pacific Daylight Time)
3875+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Mon May 03 2021 15:50:50 GMT-0700 (Pacific Daylight Time)
37403876
</footer>
37413877

37423878
<script> prettyPrint(); </script>

0 commit comments

Comments
 (0)