diff --git a/docs/Classes/Mixpanel.html b/docs/Classes/Mixpanel.html index abc997a60..811543eed 100644 --- a/docs/Classes/Mixpanel.html +++ b/docs/Classes/Mixpanel.html @@ -108,6 +108,10 @@

+ + + + @@ -132,6 +136,8 @@

+ + @@ -150,6 +156,14 @@

+ + + + + + + + @@ -1127,6 +1141,71 @@

Discussion

+
+

Declared In

+

Mixpanel.h

+
+ + + + +
+ +

+ sharedInstanceWithToken:optOutTrackingByDefault: +

+ +
+
+ +
+ + +
+

Initializes a singleton instance of the API, uses it to set whether or not to opt out tracking for +GDPR compliance, and then returns it.

+
+ + + +
+ (Mixpanel *)sharedInstanceWithToken:(NSString *)apiToken optOutTrackingByDefault:(BOOL)optOutTrackingByDefault
+ + + +
+

Parameters

+ + + + + + + + + + + + +
apiToken

your project token

optOutTrackingByDefault

whether or not to be opted out from tracking by default

+
+ + + + + + + +
+

Discussion

+

This is the preferred method for creating a sharedInstance with a mixpanel +like above. With the optOutTrackingByDefault parameter, Mixpanel tracking can be opted out by default.

+
+ + + + + + +

Declared In

Mixpanel.h

@@ -1260,8 +1339,88 @@

Parameters

Discussion

This is the preferred method for creating a sharedInstance with a mixpanel -like above. With the launchOptions parameter, Mixpanel can track referral -information created by push notifications.

+like above. With the trackCrashes and automaticPushTracking parameter, Mixpanel can track crashes and automatic push.

+
+ + + + + + + +
+

Declared In

+

Mixpanel.h

+
+ + +
+
+
+ +

+ sharedInstanceWithToken:launchOptions:trackCrashes:automaticPushTracking:optOutTrackingByDefault: +

+ +
+
+ +
+ + +
+

Initializes a singleton instance of the API, uses it to track launchOptions information, +and then returns it.

+
+ + + +
+ (Mixpanel *)sharedInstanceWithToken:(NSString *)apiToken launchOptions:(nullable NSDictionary *)launchOptions trackCrashes:(BOOL)trackCrashes automaticPushTracking:(BOOL)automaticPushTracking optOutTrackingByDefault:(BOOL)optOutTrackingByDefault
+ + + +
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
apiToken

your project token

launchOptions

your application delegate’s launchOptions

trackCrashes

whether or not to track crashes in Mixpanel. may want to disable if you’re seeing +issues with your crash reporting for either signals or exceptions

automaticPushTracking

whether or not to automatically track pushes sent from Mixpanel

optOutTrackingByDefault

whether or not to be opted out from tracking by default

+
+ + + + + + + +
+

Discussion

+

This is the preferred method for creating a sharedInstance with a mixpanel +like above. With the optOutTrackingByDefault parameter, Mixpanel tracking can be opted out by default.

@@ -2788,6 +2947,277 @@

– lib +
+

Declared In

+

Mixpanel.h

+
+ + +

+
+
+ +

– optOutTracking +

+ +
+
+ +
+ + +
+

Opt out tracking.

+
+ + + +
- (void)optOutTracking
+ + + + + + + + + +
+

Discussion

+

This method is used to opt out tracking. This causes all events and people request no longer +to be sent back to the Mixpanel server.

+
+ + + + + + + +
+

Declared In

+

Mixpanel.h

+
+ + +
+
+
+ +

– optInTracking +

+ +
+
+ +
+ + +
+

Opt in tracking.

+
+ + + +
- (void)optInTracking
+ + + + + + + + + +
+

Discussion

+

Use this method to opt in an already opted out user from tracking. People updates and track calls will be +sent to Mixpanel after using this method.

+ +

This method will internally track an opt in event to your project. If you want to identify the opt-in +event and/or pass properties to the event, See also optInTrackingForDistinctId: and +optInTrackingForDistinctId:withEventProperties:.

+
+ + + + + + + +
+

Declared In

+

Mixpanel.h

+
+ + +
+
+
+ +

– optInTrackingForDistinctID: +

+ +
+
+ +
+ + +
+

Opt in tracking.

+
+ + + +
- (void)optInTrackingForDistinctID:(nullable NSString *)distinctID
+ + + +
+

Parameters

+ + + + + + + +
distinctID

optional string to use as the distinct ID for events. This will call identify:. +If you use people profiles make sure you manually call identify: after this method.

+
+ + + + + + + +
+

Discussion

+

Use this method to opt in an already opted out user from tracking. People updates and track calls will be +sent to Mixpanel after using this method.

+ +

This method will internally track an opt in event to your project. If you want to pass properties to the event, see also +optInTrackingForDistinctId:withEventProperties:.

+
+ + + + + + + +
+

Declared In

+

Mixpanel.h

+
+ + +
+
+
+ +

– optInTrackingForDistinctID:withEventProperties: +

+ +
+
+ +
+ + +
+

Opt in tracking.

+
+ + + +
- (void)optInTrackingForDistinctID:(nullable NSString *)distinctID withEventProperties:(nullable NSDictionary *)properties
+ + + +
+

Parameters

+ + + + + + + + + + + + +
distinctID

optional string to use as the distinct ID for events. This will call identify:. +If you use people profiles make sure you manually call identify: after this method.

properties

optional properties dictionary that could be passed to add properties to the opt-in event that is sent to +Mixpanel.

+
+ + + + + + + +
+

Discussion

+

Use this method to opt in an already opted out user from tracking. People updates and track calls will be +sent to Mixpanel after using this method.

+ +

This method will internally track an opt in event to your project.See also optInTracking or +optInTrackingForDistinctId:.

+
+ + + + + + + +
+

Declared In

+

Mixpanel.h

+
+ + +
+
+
+ +

– hasOptedOutTracking +

+ +
+
+ +
+ + +
+

Returns YES if the current user has opted out tracking, NO if the current user has opted in tracking.

+
+ + + +
- (BOOL)hasOptedOutTracking
+ + + + + + + + + + + + + + +

Declared In

Mixpanel.h

@@ -3165,7 +3595,7 @@

Declared In