Skip to content

Commit b1ff3fd

Browse files
committed
Update docs
1 parent 0f1f2e9 commit b1ff3fd

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+128
-128
lines changed

docs/Classes.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
<a title="Classes Reference"></a>
1818
<header>
1919
<div class="content-wrapper">
20-
<p><a href="index.html">Mixpanel 3.1.4 Docs</a> (84% documented)</p>
20+
<p><a href="index.html">Mixpanel 3.1.5 Docs</a> (84% documented)</p>
2121
<p class="header-right"><a href="https://github.com/mixpanel/mixpanel-swift"><img src="img/gh.png"/>View on GitHub</a></p>
2222
<p class="header-right">
2323
<form role="search" action="search.json">
@@ -253,7 +253,7 @@ <h4>Declaration</h4>
253253
</section>
254254
</section>
255255
<section id="footer">
256-
<p>&copy; 2022 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2022-02-10)</p>
256+
<p>&copy; 2022 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2022-02-18)</p>
257257
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
258258
</section>
259259
</article>

docs/Classes/Group.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
<a title="Group Class Reference"></a>
1818
<header>
1919
<div class="content-wrapper">
20-
<p><a href="../index.html">Mixpanel 3.1.4 Docs</a> (84% documented)</p>
20+
<p><a href="../index.html">Mixpanel 3.1.5 Docs</a> (84% documented)</p>
2121
<p class="header-right"><a href="https://github.com/mixpanel/mixpanel-swift"><img src="../img/gh.png"/>View on GitHub</a></p>
2222
<p class="header-right">
2323
<form role="search" action="../search.json">
@@ -491,7 +491,7 @@ <h4>Declaration</h4>
491491
</section>
492492
</section>
493493
<section id="footer">
494-
<p>&copy; 2022 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2022-02-10)</p>
494+
<p>&copy; 2022 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2022-02-18)</p>
495495
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
496496
</section>
497497
</article>

docs/Classes/Mixpanel.html

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
<a title="Mixpanel Class Reference"></a>
1818
<header>
1919
<div class="content-wrapper">
20-
<p><a href="../index.html">Mixpanel 3.1.4 Docs</a> (84% documented)</p>
20+
<p><a href="../index.html">Mixpanel 3.1.5 Docs</a> (84% documented)</p>
2121
<p class="header-right"><a href="https://github.com/mixpanel/mixpanel-swift"><img src="../img/gh.png"/>View on GitHub</a></p>
2222
<p class="header-right">
2323
<form role="search" action="../search.json">
@@ -144,9 +144,9 @@ <h1>Mixpanel</h1>
144144
<li class="item">
145145
<div>
146146
<code>
147-
<a name="/s:8MixpanelAAC10initialize5token13flushInterval12instanceName23optOutTrackingByDefault20trackAutomaticEvents19useUniqueDistinctId15superPropertiesAA0A8InstanceCSS_SdSSS2bSgSbSDySSAA0A4Type_pGSgtFZ"></a>
147+
<a name="/s:8MixpanelAAC10initialize5token13flushInterval12instanceName23optOutTrackingByDefault20trackAutomaticEvents19useUniqueDistinctId15superPropertiesAA0A8InstanceCSS_SdSSSgS2bSgSbSDySSAA0A4Type_pGSgtFZ"></a>
148148
<a name="//apple_ref/swift/Method/initialize(token:flushInterval:instanceName:optOutTrackingByDefault:trackAutomaticEvents:useUniqueDistinctId:superProperties:)" class="dashAnchor"></a>
149-
<a class="token" href="#/s:8MixpanelAAC10initialize5token13flushInterval12instanceName23optOutTrackingByDefault20trackAutomaticEvents19useUniqueDistinctId15superPropertiesAA0A8InstanceCSS_SdSSS2bSgSbSDySSAA0A4Type_pGSgtFZ">initialize(token:<wbr>flushInterval:<wbr>instanceName:<wbr>optOutTrackingByDefault:<wbr>trackAutomaticEvents:<wbr>useUniqueDistinctId:<wbr>superProperties:<wbr>)</a>
149+
<a class="token" href="#/s:8MixpanelAAC10initialize5token13flushInterval12instanceName23optOutTrackingByDefault20trackAutomaticEvents19useUniqueDistinctId15superPropertiesAA0A8InstanceCSS_SdSSSgS2bSgSbSDySSAA0A4Type_pGSgtFZ">initialize(token:<wbr>flushInterval:<wbr>instanceName:<wbr>optOutTrackingByDefault:<wbr>trackAutomaticEvents:<wbr>useUniqueDistinctId:<wbr>superProperties:<wbr>)</a>
150150
</code>
151151
</div>
152152
<div class="height-container">
@@ -174,7 +174,7 @@ <h4>Declaration</h4>
174174
<pre class="highlight swift"><code><span class="kd">@discardableResult</span>
175175
<span class="kd">open</span> <span class="kd">class</span> <span class="kd">func</span> <span class="nf">initialize</span><span class="p">(</span><span class="n">token</span> <span class="nv">apiToken</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span>
176176
<span class="nv">flushInterval</span><span class="p">:</span> <span class="kt">Double</span> <span class="o">=</span> <span class="mi">60</span><span class="p">,</span>
177-
<span class="nv">instanceName</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="kt">UUID</span><span class="p">()</span><span class="o">.</span><span class="n">uuidString</span><span class="p">,</span>
177+
<span class="nv">instanceName</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
178178
<span class="nv">optOutTrackingByDefault</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">false</span><span class="p">,</span>
179179
<span class="nv">trackAutomaticEvents</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
180180
<span class="nv">useUniqueDistinctId</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">false</span><span class="p">,</span>
@@ -218,7 +218,7 @@ <h4>Parameters</h4>
218218
</td>
219219
<td>
220220
<div>
221-
<p>Optional. The name you want to call this instance</p>
221+
<p>Optional. The name you want to call this instance, must be unique 1:1 for each instance&rsquo;s project token. Defaults to project token.</p>
222222
</div>
223223
</td>
224224
</tr>
@@ -249,24 +249,24 @@ <h4>Parameters</h4>
249249
<tr>
250250
<td>
251251
<code>
252-
<em>superProperties</em>
252+
<em>useUniqueDistinctId</em>
253253
</code>
254254
</td>
255255
<td>
256256
<div>
257-
<p>Optional. Super properties dictionary to register during initialization</p>
257+
<p>Optional. whether or not to use the unique device identifier as the distinct_id</p>
258258
</div>
259259
</td>
260260
</tr>
261261
<tr>
262262
<td>
263263
<code>
264-
<em>useUniqueDistinctId</em>
264+
<em>superProperties</em>
265265
</code>
266266
</td>
267267
<td>
268268
<div>
269-
<p>Optional. whether or not to use the unique device identifier as the distinct_id</p>
269+
<p>Optional. Super properties dictionary to register during initialization</p>
270270
</div>
271271
</td>
272272
</tr>
@@ -285,8 +285,8 @@ <h4>Return Value</h4>
285285
<div>
286286
<code>
287287
<a name="/"></a>
288-
<a name="//apple_ref/swift/Method/initialize(token:flushInterval:instanceName:optOutTrackingByDefault:useUniqueDistinctId:)" class="dashAnchor"></a>
289-
<a class="token" href="#/">initialize(token:<wbr>flushInterval:<wbr>instanceName:<wbr>optOutTrackingByDefault:<wbr>useUniqueDistinctId:<wbr>)</a>
288+
<a name="//apple_ref/swift/Method/initialize(token:flushInterval:instanceName:optOutTrackingByDefault:useUniqueDistinctId:superProperties:)" class="dashAnchor"></a>
289+
<a class="token" href="#/">initialize(token:<wbr>flushInterval:<wbr>instanceName:<wbr>optOutTrackingByDefault:<wbr>useUniqueDistinctId:<wbr>superProperties:<wbr>)</a>
290290
</code>
291291
</div>
292292
<div class="height-container">
@@ -490,7 +490,7 @@ <h4>Parameters</h4>
490490
</section>
491491
</section>
492492
<section id="footer">
493-
<p>&copy; 2022 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2022-02-10)</p>
493+
<p>&copy; 2022 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2022-02-18)</p>
494494
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
495495
</section>
496496
</article>

docs/Classes/MixpanelInstance.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
<a title="MixpanelInstance Class Reference"></a>
1818
<header>
1919
<div class="content-wrapper">
20-
<p><a href="../index.html">Mixpanel 3.1.4 Docs</a> (84% documented)</p>
20+
<p><a href="../index.html">Mixpanel 3.1.5 Docs</a> (84% documented)</p>
2121
<p class="header-right"><a href="https://github.com/mixpanel/mixpanel-swift"><img src="../img/gh.png"/>View on GitHub</a></p>
2222
<p class="header-right">
2323
<form role="search" action="../search.json">
@@ -1969,7 +1969,7 @@ <h4>Return Value</h4>
19691969
</section>
19701970
</section>
19711971
<section id="footer">
1972-
<p>&copy; 2022 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2022-02-10)</p>
1972+
<p>&copy; 2022 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2022-02-18)</p>
19731973
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
19741974
</section>
19751975
</article>

docs/Classes/People.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
<a title="People Class Reference"></a>
1818
<header>
1919
<div class="content-wrapper">
20-
<p><a href="../index.html">Mixpanel 3.1.4 Docs</a> (84% documented)</p>
20+
<p><a href="../index.html">Mixpanel 3.1.5 Docs</a> (84% documented)</p>
2121
<p class="header-right"><a href="https://github.com/mixpanel/mixpanel-swift"><img src="../img/gh.png"/>View on GitHub</a></p>
2222
<p class="header-right">
2323
<form role="search" action="../search.json">
@@ -785,7 +785,7 @@ <h4>Declaration</h4>
785785
</section>
786786
</section>
787787
<section id="footer">
788-
<p>&copy; 2022 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2022-02-10)</p>
788+
<p>&copy; 2022 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2022-02-18)</p>
789789
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
790790
</section>
791791
</article>

docs/Extensions.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
<a title="Extensions Reference"></a>
1818
<header>
1919
<div class="content-wrapper">
20-
<p><a href="index.html">Mixpanel 3.1.4 Docs</a> (84% documented)</p>
20+
<p><a href="index.html">Mixpanel 3.1.5 Docs</a> (84% documented)</p>
2121
<p class="header-right"><a href="https://github.com/mixpanel/mixpanel-swift"><img src="img/gh.png"/>View on GitHub</a></p>
2222
<p class="header-right">
2323
<form role="search" action="search.json">
@@ -544,7 +544,7 @@ <h4>Declaration</h4>
544544
</section>
545545
</section>
546546
<section id="footer">
547-
<p>&copy; 2022 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2022-02-10)</p>
547+
<p>&copy; 2022 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2022-02-18)</p>
548548
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
549549
</section>
550550
</article>

docs/Extensions/Array.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
<a title="Array Extension Reference"></a>
1818
<header>
1919
<div class="content-wrapper">
20-
<p><a href="../index.html">Mixpanel 3.1.4 Docs</a> (84% documented)</p>
20+
<p><a href="../index.html">Mixpanel 3.1.5 Docs</a> (84% documented)</p>
2121
<p class="header-right"><a href="https://github.com/mixpanel/mixpanel-swift"><img src="../img/gh.png"/>View on GitHub</a></p>
2222
<p class="header-right">
2323
<form role="search" action="../search.json">
@@ -199,7 +199,7 @@ <h4>Declaration</h4>
199199
</section>
200200
</section>
201201
<section id="footer">
202-
<p>&copy; 2022 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2022-02-10)</p>
202+
<p>&copy; 2022 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2022-02-18)</p>
203203
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
204204
</section>
205205
</article>

docs/Extensions/Bool.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
<a title="Bool Extension Reference"></a>
1818
<header>
1919
<div class="content-wrapper">
20-
<p><a href="../index.html">Mixpanel 3.1.4 Docs</a> (84% documented)</p>
20+
<p><a href="../index.html">Mixpanel 3.1.5 Docs</a> (84% documented)</p>
2121
<p class="header-right"><a href="https://github.com/mixpanel/mixpanel-swift"><img src="../img/gh.png"/>View on GitHub</a></p>
2222
<p class="header-right">
2323
<form role="search" action="../search.json">
@@ -200,7 +200,7 @@ <h4>Declaration</h4>
200200
</section>
201201
</section>
202202
<section id="footer">
203-
<p>&copy; 2022 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2022-02-10)</p>
203+
<p>&copy; 2022 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2022-02-18)</p>
204204
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
205205
</section>
206206
</article>

docs/Extensions/Date.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
<a title="Date Extension Reference"></a>
1818
<header>
1919
<div class="content-wrapper">
20-
<p><a href="../index.html">Mixpanel 3.1.4 Docs</a> (84% documented)</p>
20+
<p><a href="../index.html">Mixpanel 3.1.5 Docs</a> (84% documented)</p>
2121
<p class="header-right"><a href="https://github.com/mixpanel/mixpanel-swift"><img src="../img/gh.png"/>View on GitHub</a></p>
2222
<p class="header-right">
2323
<form role="search" action="../search.json">
@@ -200,7 +200,7 @@ <h4>Declaration</h4>
200200
</section>
201201
</section>
202202
<section id="footer">
203-
<p>&copy; 2022 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2022-02-10)</p>
203+
<p>&copy; 2022 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2022-02-18)</p>
204204
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
205205
</section>
206206
</article>

docs/Extensions/Dictionary.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
<a title="Dictionary Extension Reference"></a>
1818
<header>
1919
<div class="content-wrapper">
20-
<p><a href="../index.html">Mixpanel 3.1.4 Docs</a> (84% documented)</p>
20+
<p><a href="../index.html">Mixpanel 3.1.5 Docs</a> (84% documented)</p>
2121
<p class="header-right"><a href="https://github.com/mixpanel/mixpanel-swift"><img src="../img/gh.png"/>View on GitHub</a></p>
2222
<p class="header-right">
2323
<form role="search" action="../search.json">
@@ -199,7 +199,7 @@ <h4>Declaration</h4>
199199
</section>
200200
</section>
201201
<section id="footer">
202-
<p>&copy; 2022 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2022-02-10)</p>
202+
<p>&copy; 2022 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2022-02-18)</p>
203203
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
204204
</section>
205205
</article>

0 commit comments

Comments
 (0)