updated docs

mixpanel · Jan 8, 2018 · ee56889 · ee56889
1 parent d540a6f
commit ee56889
Show file tree

Hide file tree

Showing 5 changed files with 84 additions and 5 deletions.
diff --git a/docs/Classes/Mixpanel.html b/docs/Classes/Mixpanel.html
@@ -106,6 +106,8 @@ <h1 id="library-title">
 
 		<option value="//api/name/sharedInstanceWithToken:launchOptions:">+ sharedInstanceWithToken:launchOptions:</option>
 
+		<option value="//api/name/sharedInstanceWithToken:launchOptions:trackCrashes:automaticPushTracking:">+ sharedInstanceWithToken:launchOptions:trackCrashes:automaticPushTracking:</option>
+
 	</optgroup>
 
 
@@ -1191,6 +1193,83 @@ <h4 class="method-subtitle">Discussion</h4>
 
 
 
+			<div class="method-subsection declared-in-section">
+				<h4 class="method-subtitle">Declared In</h4>
+				<p><code class="declared-in-ref">Mixpanel.h</code></p>
+			</div>
+
+
+		</div>
+	</div>
+</div><div class="section-method">
+	<a name="//api/name/sharedInstanceWithToken:launchOptions:trackCrashes:automaticPushTracking:" title="sharedInstanceWithToken:launchOptions:trackCrashes:automaticPushTracking:"></a>
+	<h3 class="method-title"><code><a href="#//api/name/sharedInstanceWithToken:launchOptions:trackCrashes:automaticPushTracking:">+&nbsp;sharedInstanceWithToken:launchOptions:trackCrashes:automaticPushTracking:</a></code>
+</h3>
+
+	<div class="method-info">
+		<div class="pointy-thing"></div>
+
+		<div class="method-info-container">
+
+
+			<div class="method-subsection brief-description">
+				<p>Initializes a singleton instance of the API, uses it to track launchOptions information,
+and then returns it.</p>
+			</div>
+
+
+
+			<div class="method-subsection method-declaration"><code>+ (Mixpanel *)sharedInstanceWithToken:(NSString *)<em>apiToken</em> launchOptions:(NSDictionary *)<em>launchOptions</em> trackCrashes:(BOOL)<em>trackCrashes</em> automaticPushTracking:(BOOL)<em>automaticPushTracking</em></code></div>
+
+
+
+			<div class="method-subsection arguments-section parameters">
+				<h4 class="method-subtitle parameter-title">Parameters</h4>
+				<table class="argument-def parameter-def">
+
+					<tr>
+						<th scope="row" class="argument-name"><code>apiToken</code></th>
+						<td><p>your project token</p></td>
+					</tr>
+
+					<tr>
+						<th scope="row" class="argument-name"><code>launchOptions</code></th>
+						<td><p>your application delegate&rsquo;s launchOptions</p></td>
+					</tr>
+
+					<tr>
+						<th scope="row" class="argument-name"><code>trackCrashes</code></th>
+						<td><p>whether or not to track crashes in Mixpanel. may want to disable if you&rsquo;re seeing
+issues with your crash reporting for either signals or exceptions</p></td>
+					</tr>
+
+					<tr>
+						<th scope="row" class="argument-name"><code>automaticPushTracking</code></th>
+						<td><p>whether or not to automatically track pushes sent from Mixpanel</p></td>
+					</tr>
+
+				</table>
+			</div>
+
+
+
+
+
+
+
+			<div class="method-subsection discussion-section">
+				<h4 class="method-subtitle">Discussion</h4>
+				<p>This is the preferred method for creating a <a href="#//api/name/sharedInstance">sharedInstance</a> with a mixpanel
+like above. With the launchOptions parameter, Mixpanel can track referral
+information created by push notifications.</p>
+			</div>
+
+
+
+
+
+
+
 			<div class="method-subsection declared-in-section">
 				<h4 class="method-subtitle">Declared In</h4>
 				<p><code class="declared-in-ref">Mixpanel.h</code></p>
@@ -3086,7 +3165,7 @@ <h4 class="method-subtitle">Declared In</h4>
 				<footer>
 					<div class="footer-copyright">
 
-						<p class="copyright">Copyright &copy; 2017 Mixpanel. All rights reserved. Updated: 2017-12-19</p>
+						<p class="copyright">Copyright &copy; 2018 Mixpanel. All rights reserved. Updated: 2018-01-08</p>
 
 
 						<p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1334)</a>.</p>

diff --git a/docs/Classes/MixpanelPeople.html b/docs/Classes/MixpanelPeople.html
@@ -1149,7 +1149,7 @@ <h4 class="method-subtitle">Declared In</h4>
 				<footer>
 					<div class="footer-copyright">
 
-						<p class="copyright">Copyright &copy; 2017 Mixpanel. All rights reserved. Updated: 2017-12-19</p>
+						<p class="copyright">Copyright &copy; 2018 Mixpanel. All rights reserved. Updated: 2018-01-08</p>
 
 
 						<p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1334)</a>.</p>

diff --git a/docs/Protocols/MixpanelDelegate.html b/docs/Protocols/MixpanelDelegate.html
@@ -191,7 +191,7 @@ <h4 class="method-subtitle">Declared In</h4>
 				<footer>
 					<div class="footer-copyright">
 
-						<p class="copyright">Copyright &copy; 2017 Mixpanel. All rights reserved. Updated: 2017-12-19</p>
+						<p class="copyright">Copyright &copy; 2018 Mixpanel. All rights reserved. Updated: 2018-01-08</p>
 
 
 						<p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1334)</a>.</p>

diff --git a/docs/hierarchy.html b/docs/hierarchy.html
@@ -79,7 +79,7 @@ <h2 class="index-title">Protocol References</h2>
 					<footer>
 						<div class="footer-copyright">
 
-							<p class="copyright">Copyright &copy; 2017 Mixpanel. All rights reserved. Updated: 2017-12-19</p>
+							<p class="copyright">Copyright &copy; 2018 Mixpanel. All rights reserved. Updated: 2018-01-08</p>
 
 
 							<p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1334)</a>.</p>

diff --git a/docs/index.html b/docs/index.html
@@ -79,7 +79,7 @@ <h2 class="index-title">Protocol References</h2>
 					<footer>
 						<div class="footer-copyright">
 
-							<p class="copyright">Copyright &copy; 2017 Mixpanel. All rights reserved. Updated: 2017-12-19</p>
+							<p class="copyright">Copyright &copy; 2018 Mixpanel. All rights reserved. Updated: 2018-01-08</p>
 
 
 							<p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1334)</a>.</p>