Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@zihejia
zihejia committed Aug 14, 2021
1 parent 587211f commit 15dbfba
Show file tree
Hide file tree
Showing 85 changed files with 447 additions and 451 deletions.
4 changes: 2 additions & 2 deletions docs/Classes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="Classes Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html">Mixpanel 2.10.2 Docs</a> (87% documented)</p>
<p><a href="index.html">Mixpanel 2.10.3 Docs</a> (87% documented)</p>
<p class="header-right"><a href="https://github.com/mixpanel/mixpanel-swift"><img src="img/gh.png"/>View on GitHub</a></p>
<p class="header-right">
<form role="search" action="search.json">
Expand Down Expand Up @@ -393,7 +393,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2021-06-11)</p>
<p>&copy; 2021 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2021-08-13)</p>
<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>
</section>
</article>
Expand Down
4 changes: 2 additions & 2 deletions docs/Classes/Group.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="Group Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">Mixpanel 2.10.2 Docs</a> (87% documented)</p>
<p><a href="../index.html">Mixpanel 2.10.3 Docs</a> (87% documented)</p>
<p class="header-right"><a href="https://github.com/mixpanel/mixpanel-swift"><img src="../img/gh.png"/>View on GitHub</a></p>
<p class="header-right">
<form role="search" action="../search.json">
Expand Down Expand Up @@ -548,7 +548,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2021-06-11)</p>
<p>&copy; 2021 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2021-08-13)</p>
<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>
</section>
</article>
Expand Down
4 changes: 2 additions & 2 deletions docs/Classes/Mixpanel.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="Mixpanel Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">Mixpanel 2.10.2 Docs</a> (87% documented)</p>
<p><a href="../index.html">Mixpanel 2.10.3 Docs</a> (87% documented)</p>
<p class="header-right"><a href="https://github.com/mixpanel/mixpanel-swift"><img src="../img/gh.png"/>View on GitHub</a></p>
<p class="header-right">
<form role="search" action="../search.json">
Expand Down Expand Up @@ -522,7 +522,7 @@ <h4>Parameters</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2021-06-11)</p>
<p>&copy; 2021 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2021-08-13)</p>
<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>
</section>
</article>
Expand Down
73 changes: 58 additions & 15 deletions docs/Classes/MixpanelInstance.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="MixpanelInstance Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">Mixpanel 2.10.2 Docs</a> (87% documented)</p>
<p><a href="../index.html">Mixpanel 2.10.3 Docs</a> (87% documented)</p>
<p class="header-right"><a href="https://github.com/mixpanel/mixpanel-swift"><img src="../img/gh.png"/>View on GitHub</a></p>
<p class="header-right">
<form role="search" action="../search.json">
Expand Down Expand Up @@ -888,9 +888,9 @@ <h3 class="section-name"><p>Identity</p>
<li class="item">
<div>
<code>
<a name="/s:8Mixpanel0A8InstanceC8identify10distinctId9usePeopleySS_SbtF"></a>
<a name="//apple_ref/swift/Method/identify(distinctId:usePeople:)" class="dashAnchor"></a>
<a class="token" href="#/s:8Mixpanel0A8InstanceC8identify10distinctId9usePeopleySS_SbtF">identify(distinctId:<wbr>usePeople:<wbr>)</a>
<a name="/s:8Mixpanel0A8InstanceC8identify10distinctId9usePeople10completionySS_SbyycSgtF"></a>
<a name="//apple_ref/swift/Method/identify(distinctId:usePeople:completion:)" class="dashAnchor"></a>
<a class="token" href="#/s:8Mixpanel0A8InstanceC8identify10distinctId9usePeople10completionySS_SbyycSgtF">identify(distinctId:<wbr>usePeople:<wbr>completion:<wbr>)</a>
</code>
</div>
<div class="height-container">
Expand Down Expand Up @@ -925,7 +925,7 @@ <h3 class="section-name"><p>Identity</p>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">identify</span><span class="p">(</span><span class="nv">distinctId</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">usePeople</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">true</span><span class="p">)</span></code></pre>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">identify</span><span class="p">(</span><span class="nv">distinctId</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">usePeople</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">true</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="p">(()</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>

</div>
</div>
Expand Down Expand Up @@ -958,6 +958,18 @@ <h4>Parameters</h4>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>completion</em>
</code>
</td>
<td>
<div>
<p>an optional completion handler for when the identify has completed.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
Expand All @@ -967,9 +979,9 @@ <h4>Parameters</h4>
<li class="item">
<div>
<code>
<a name="/s:8Mixpanel0A8InstanceC11createAlias_10distinctId9usePeopleySS_SSSbtF"></a>
<a name="//apple_ref/swift/Method/createAlias(_:distinctId:usePeople:)" class="dashAnchor"></a>
<a class="token" href="#/s:8Mixpanel0A8InstanceC11createAlias_10distinctId9usePeopleySS_SSSbtF">createAlias(_:<wbr>distinctId:<wbr>usePeople:<wbr>)</a>
<a name="/s:8Mixpanel0A8InstanceC11createAlias_10distinctId9usePeople10completionySS_SSSbyycSgtF"></a>
<a name="//apple_ref/swift/Method/createAlias(_:distinctId:usePeople:completion:)" class="dashAnchor"></a>
<a class="token" href="#/s:8Mixpanel0A8InstanceC11createAlias_10distinctId9usePeople10completionySS_SSSbyycSgtF">createAlias(_:<wbr>distinctId:<wbr>usePeople:<wbr>completion:<wbr>)</a>
</code>
</div>
<div class="height-container">
Expand All @@ -991,7 +1003,7 @@ <h4>Parameters</h4>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">createAlias</span><span class="p">(</span><span class="n">_</span> <span class="nv">alias</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">distinctId</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">usePeople</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">true</span><span class="p">)</span></code></pre>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">createAlias</span><span class="p">(</span><span class="n">_</span> <span class="nv">alias</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">distinctId</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">usePeople</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">true</span><span class="p">,</span> <span class="nv">completion</span><span class="p">:</span> <span class="p">(()</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>

</div>
</div>
Expand Down Expand Up @@ -1031,7 +1043,19 @@ <h4>Parameters</h4>
</td>
<td>
<div>
<p>boolean that controls whether or not to set the people distinctId to the event distinctId.
<p>boolean that controls whether or not to set the people distinctId to the event distinctId.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>completion</em>
</code>
</td>
<td>
<div>
<p>an optional completion handler for when the createAlias has completed.
This should only be set to false if you wish to prevent people profile updates for that user.</p>
</div>
</td>
Expand All @@ -1045,9 +1069,9 @@ <h4>Parameters</h4>
<li class="item">
<div>
<code>
<a name="/s:8Mixpanel0A8InstanceC5resetyyF"></a>
<a name="//apple_ref/swift/Method/reset()" class="dashAnchor"></a>
<a class="token" href="#/s:8Mixpanel0A8InstanceC5resetyyF">reset()</a>
<a name="/s:8Mixpanel0A8InstanceC5reset10completionyyycSg_tF"></a>
<a name="//apple_ref/swift/Method/reset(completion:)" class="dashAnchor"></a>
<a class="token" href="#/s:8Mixpanel0A8InstanceC5reset10completionyyycSg_tF">reset(completion:<wbr>)</a>
</code>
</div>
<div class="height-container">
Expand All @@ -1063,10 +1087,29 @@ <h4>Parameters</h4>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">reset</span><span class="p">()</span></code></pre>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">reset</span><span class="p">(</span><span class="nv">completion</span><span class="p">:</span> <span class="p">(()</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>

</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>completion</em>
</code>
</td>
<td>
<div>
<p>an optional completion handler for when the reset has completed.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
Expand Down Expand Up @@ -2408,7 +2451,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2021-06-11)</p>
<p>&copy; 2021 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2021-08-13)</p>
<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>
</section>
</article>
Expand Down
4 changes: 2 additions & 2 deletions docs/Classes/MixpanelNotificationServiceExtension.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="MixpanelNotificationServiceExtension Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">Mixpanel 2.10.2 Docs</a> (87% documented)</p>
<p><a href="../index.html">Mixpanel 2.10.3 Docs</a> (87% documented)</p>
<p class="header-right"><a href="https://github.com/mixpanel/mixpanel-swift"><img src="../img/gh.png"/>View on GitHub</a></p>
<p class="header-right">
<form role="search" action="../search.json">
Expand Down Expand Up @@ -257,7 +257,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2021-06-11)</p>
<p>&copy; 2021 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2021-08-13)</p>
<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>
</section>
</article>
Expand Down
4 changes: 2 additions & 2 deletions docs/Classes/MixpanelPushNotifications.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="MixpanelPushNotifications Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">Mixpanel 2.10.2 Docs</a> (87% documented)</p>
<p><a href="../index.html">Mixpanel 2.10.3 Docs</a> (87% documented)</p>
<p class="header-right"><a href="https://github.com/mixpanel/mixpanel-swift"><img src="../img/gh.png"/>View on GitHub</a></p>
<p class="header-right">
<form role="search" action="../search.json">
Expand Down Expand Up @@ -257,7 +257,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2021-06-11)</p>
<p>&copy; 2021 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2021-08-13)</p>
<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>
</section>
</article>
Expand Down
4 changes: 2 additions & 2 deletions docs/Classes/People.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="People Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">Mixpanel 2.10.2 Docs</a> (87% documented)</p>
<p><a href="../index.html">Mixpanel 2.10.3 Docs</a> (87% documented)</p>
<p class="header-right"><a href="https://github.com/mixpanel/mixpanel-swift"><img src="../img/gh.png"/>View on GitHub</a></p>
<p class="header-right">
<form role="search" action="../search.json">
Expand Down Expand Up @@ -975,7 +975,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2021-06-11)</p>
<p>&copy; 2021 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2021-08-13)</p>
<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>
</section>
</article>
Expand Down
4 changes: 2 additions & 2 deletions docs/Enums.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="Enumerations Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html">Mixpanel 2.10.2 Docs</a> (87% documented)</p>
<p><a href="index.html">Mixpanel 2.10.3 Docs</a> (87% documented)</p>
<p class="header-right"><a href="https://github.com/mixpanel/mixpanel-swift"><img src="img/gh.png"/>View on GitHub</a></p>
<p class="header-right">
<form role="search" action="search.json">
Expand Down Expand Up @@ -230,7 +230,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2021-06-11)</p>
<p>&copy; 2021 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2021-08-13)</p>
<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>
</section>
</article>
Expand Down
Loading

0 comments on commit 15dbfba

Please sign in to comment.