Mixpanel 4.1.2 Docs (83% documented)
+Mixpanel 4.1.3 Docs (0% documented)
Swift
-open class Mixpanel
-
-
-
+
- MixpanelInstance
+ MixpanelInstance
Swift
-open class MixpanelInstance : CustomDebugStringConvertible, FlushDelegate, AEDelegate
-
- Swift
-open class People
-
- Mixpanel 4.1.2 Docs (83% documented)
+Mixpanel 4.1.3 Docs (0% documented)
-
+
- set(property:to:)
+ set(property:to:)
Swift
-open func set(property: String, to: MixpanelType)
-
-
-
- property
-
- |
-
-
-
- property name - |
-
-
- to
-
- |
-
-
-
- property value - |
-
Swift
-open func setOnce(properties: Properties)
-
-
-
- properties
-
- |
-
-
-
- properties dictionary - |
-
-
+
- unset(property:)
+ unset(property:)
For properties that don’t exist there will be no effect.
Swift
-open func unset(property: String)
-
-
-
- property
-
- |
-
-
-
- name of the property to unset - |
-
-
+
- remove(key:value:)
+ remove(key:value:)
Swift
-open func remove(key: String, value: MixpanelType)
-
-
-
- properties
-
- |
-
-
-
- mapping of list property names to values to remove - |
-
-
+
- union(key:values:)
+ union(key:values:)
Property values must be array objects.
Swift
-open func union(key: String, values: [MixpanelType])
-
-
-
- properties
-
- |
-
-
-
- mapping of list property names to lists to union - |
-
-
+
- deleteGroup()
+ deleteGroup()
Delete group’s record from Mixpanel Groups.
Swift
-open func deleteGroup()
-
- Mixpanel 4.1.2 Docs (83% documented)
+Mixpanel 4.1.3 Docs (0% documented)
Swift
-@discardableResult
-open class func initialize(token apiToken: String,
- trackAutomaticEvents: Bool,
- flushInterval: Double = 60,
- instanceName: String? = nil,
- optOutTrackingByDefault: Bool = false,
- useUniqueDistinctId: Bool = false,
- superProperties: Properties? = nil,
- serverURL: String? = nil) -> MixpanelInstance
-
-
-
- token
-
- |
-
-
-
- your project token - |
-
-
- trackAutomaticEvents
-
- |
-
-
-
- Whether or not to collect common mobile events - |
-
-
- flushInterval
-
- |
-
-
-
- Optional. Interval to run background flushing - |
-
-
- instanceName
-
- |
-
-
-
- Optional. The name you want to uniquely identify the Mixpanel Instance. -It is useful when you want more than one Mixpanel instance under the same project token. - |
-
-
- optOutTrackingByDefault
-
- |
-
-
-
- Optional. Whether or not to be opted out from tracking by default - |
-
-
- useUniqueDistinctId
-
- |
-
-
-
- Optional. whether or not to use the unique device identifier as the distinct_id - |
-
-
- superProperties
-
- |
-
-
-
- Optional. Super properties dictionary to register during initialization - |
-
-
- serverURL
-
- |
-
-
-
- Optional. Mixpanel cluster URL - |
-
returns a mixpanel instance if needed to keep throughout the project. -You can always get the instance by calling getInstance(name)
-
-
+
- getInstance(name:)
+ getInstance(name:)
Gets the mixpanel instance with the given name
Swift
-open class func getInstance(name: String) -> MixpanelInstance?
-
-
-
- name
-
- |
-
-
-
- the instance name - |
-
returns the mixpanel instance
-
-
+
- mainInstance()
+ mainInstance()
If not specified explicitly, the main instance is always the last instance added
Swift
-open class func mainInstance() -> MixpanelInstance
-
- returns the main Mixpanel instance
-Sets the main instance based on the instance name
Swift
-open class func setMainInstance(name: String)
-
-
-
- name
-
- |
-
-
-
- the instance name - |
-
Removes an unneeded Mixpanel instance based on its name
Swift
-open class func removeInstance(name: String)
-
-
-
- name
-
- |
-
-
-
- the instance name - |
-
Mixpanel 4.1.2 Docs (83% documented)
+Mixpanel 4.1.3 Docs (0% documented)
The a MixpanelDelegate object that gives control over Mixpanel network activity.
Swift
-open weak var delegate: MixpanelDelegate?
-
-
-
+
- distinctId
+ distinctId
distinctId string that uniquely identifies the current user.
Swift
-open var distinctId: String
-
-
-
+
- anonymousId
+ anonymousId
anonymousId string that uniquely identifies the device.
Swift
-open var anonymousId: String?
-
- userId string that identify is called with.
Swift
-open var userId: String?
-
- Swift
-open var hadPersistedDistinctId: Bool?
-
- alias string that uniquely identifies the current user.
Swift
-open var alias: String?
-
- Accessor to the Mixpanel People API object.
Swift
-open var people: People!
-
- Swift
-open var showNetworkActivityIndicator: Bool
-
- This allows enabling or disabling collecting common mobile events,
Swift
-open var trackAutomaticEventsEnabled: Bool
-
-
-
+
- flushInterval
+ flushInterval
Swift
-open var flushInterval: Double { get set }
-
-
-
+
- flushOnBackground
+ flushOnBackground
Swift
-open var flushOnBackground: Bool { get set }
-
- Swift
-open var useIPAddressForGeoLocation: Bool { get set }
-
- Swift
-open var serverURL: String { get set }
-
-
-
+
- debugDescription
+ debugDescription
Swift
-open var debugDescription: String { get }
-
-
-
+
- loggingEnabled
+ loggingEnabled
Swift
-open var loggingEnabled: Bool { get set }
-
- A unique identifier for this MixpanelInstance
Swift
-public let name: String
-
- Undocumented
- -Swift
-open var minimumSessionDuration: UInt64 { get set }
+ The minimum session duration (ms) that is tracked in automatic events. +The default value is 10000 (10 seconds).
-Swift
-open var maximumSessionDuration: UInt64 { get set }
-
- mixpanelInstance.identify(mixpanelInstance.distinctId)
.
Swift
-public func identify(distinctId: String, usePeople: Bool = true, completion: (() -> Void)? = nil)
-
-
-
- distinctId
-
- |
-
-
-
- string that uniquely identifies the current user - |
-
-
- usePeople
-
- |
-
-
-
- boolean that controls whether or not to set the people distinctId to the event distinctId. -This should only be set to false if you wish to prevent people profile updates for that user. - |
-
-
- completion
-
- |
-
-
-
- an optional completion handler for when the identify has completed. - |
-
-
+
- createAlias(_:distinctId:usePeople:andIdentify:completion:)
+ createAlias(_:distinctId:usePeople:andIdentify:completion:)
mixpanelInstance.createAlias("Newer ID", distinctId: mixpanelInstance.distinctId)
Swift
-public func createAlias(_ alias: String, distinctId: String, usePeople: Bool = true, andIdentify: Bool = true, completion: (() -> Void)? = nil)
-
-
-
- alias
-
- |
-
-
-
- A unique identifier that you want to use as an identifier for this user. - |
-
-
- distinctId
-
- |
-
-
-
- The current user identifier. - |
-
-
- usePeople
-
- |
-
-
-
- boolean that controls whether or not to set the people distinctId to the event distinctId. - |
-
-
- andIdentify
-
- |
-
-
-
- an optional boolean that controls whether or not to call ‘identify’ with your current -user identifier(not alias). Default to true for keeping your signup funnels working correctly in most cases. - |
-
-
- completion
-
- |
-
-
-
- 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. - |
-
-
+
- reset(completion:)
+ reset(completion:)
Swift
-public func reset(completion: (() -> Void)? = nil)
-
-
-
- completion
-
- |
-
-
-
- an optional completion handler for when the reset has completed. - |
-
Undocumented
- -Swift
-public func archive()
-
- Uploads queued data to the Mixpanel server.
By default, queued data is flushed to the Mixpanel servers every minute (the
-default for flushInterval
), and on background (since
-flushOnBackground
is on by default). You only need to call this
+default for flushInterval
), and on background (since
+flushOnBackground
is on by default). You only need to call this
method manually if you want to force a flush at a particular moment.
Swift
-public func flush(performFullFlush: Bool = false, completion: (() -> Void)? = nil)
-
-
-
- performFullFlush
-
- |
-
-
-
- A optional boolean value indicating whether a full flush should be performed. If |
-
-
- completion
-
- |
-
-
-
- an optional completion handler for when the flush has completed. - |
-
Swift
-public func track(event: String?, properties: Properties? = nil)
-
-
-
- event
-
- |
-
-
-
- event name - |
-
-
- properties
-
- |
-
-
-
- properties dictionary - |
-
Swift
-public func trackWithGroups(event: String?, properties: Properties? = nil, groups: Properties?)
-
-
-
- event
-
- |
-
-
-
- event name - |
-
-
- properties
-
- |
-
-
-
- properties dictionary - |
-
-
- groups
-
- |
-
-
-
- groups dictionary - |
-
Undocumented
- -Swift
-public func getGroup(groupKey: String, groupID: MixpanelType) -> Group
-
-
-
+
- time(event:)
+ time(event:)
Swift
-public func time(event: String)
-
-
-
- event
-
- |
-
-
-
- the event name to be timed - |
-
Retrieves the time elapsed for the named event since time(event:) was called.
Swift
-public func eventElapsedTime(event: String) -> Double
-
-
-
- event
-
- |
-
-
-
- the name of the event to be tracked that was passed to time(event:) - |
-
-
+
- clearTimedEvents()
+ clearTimedEvents()
Clears all current event timers.
Swift
-public func clearTimedEvents()
-
- Clears the event timer for the named event.
Swift
-public func clearTimedEvent(event: String)
-
-
-
- event
-
- |
-
-
-
- the name of the event to clear the timer for - |
-
Returns the currently set super properties.
Swift
-public func currentSuperProperties() -> [String : Any]
-
- the current super properties
-Clears all currently set super properties.
Swift
-public func clearSuperProperties()
-
- Swift
-public func registerSuperProperties(_ properties: Properties)
-
-
-
- properties
-
- |
-
-
-
- properties dictionary - |
-
Swift
-public func registerSuperPropertiesOnce(_ properties: Properties,
- defaultValue: MixpanelType? = nil)
-
-
-
- properties
-
- |
-
-
-
- properties dictionary - |
-
-
- defaultValue
-
- |
-
-
-
- Optional. overwrite existing properties that have this value - |
-
Swift
-public func unregisterSuperProperty(_ propertyName: String)
-
-
-
- propertyName
-
- |
-
-
-
- array of property name strings to remove - |
-
Convenience method to set a single group the user belongs to.
Swift
-public func setGroup(groupKey: String, groupID: MixpanelType)
-
-
-
- groupKey
-
- |
-
-
-
- The property name associated with this group type (must already have been set up). - |
-
-
- groupID
-
- |
-
-
-
- The group the user belongs to. - |
-
Set the groups this user belongs to.
Swift
-public func setGroup(groupKey: String, groupIDs: [MixpanelType])
-
-
-
- groupKey
-
- |
-
-
-
- The property name associated with this group type (must already have been set up). - |
-
-
- groupIDs
-
- |
-
-
-
- The list of groups the user belongs to. - |
-
Add a group to this user’s membership for a particular group key
Swift
-public func addGroup(groupKey: String, groupID: MixpanelType)
-
-
-
- groupKey
-
- |
-
-
-
- The property name associated with this group type (must already have been set up). - |
-
-
- groupID
-
- |
-
-
-
- The new group the user belongs to. - |
-
Remove a group from this user’s membership for a particular group key
Swift
-public func removeGroup(groupKey: String, groupID: MixpanelType)
-
-
-
- groupKey
-
- |
-
-
-
- The property name associated with this group type (must already have been set up). - |
-
-
- groupID
-
- |
-
-
-
- The group value to remove. - |
-
-
+
- optOutTracking()
+ optOutTracking()
Swift
-public func optOutTracking()
-
- This method will internally track an opt in event to your project.
Swift
-public func optInTracking(distinctId: String? = nil, properties: Properties? = nil)
-
-
-
- distintId
-
- |
-
-
-
- an optional string to use as the distinct ID for events - |
-
-
- properties
-
- |
-
-
-
- an optional properties dictionary that could be passed to add properties to the opt-in event -that is sent to Mixpanel - |
-
Returns if the current user has opted out tracking.
Swift
-public func hasOptedOutTracking() -> Bool
-
- the current super opted out tracking status
-Mixpanel 4.1.2 Docs (83% documented)
+Mixpanel 4.1.3 Docs (0% documented)
-
+
- set(properties:)
+ set(properties:)
Swift
-open func set(properties: Properties)
-
-
-
- properties
-
- |
-
-
-
- properties dictionary - |
-
-
+
- set(property:to:)
+ set(property:to:)
Swift
-open func set(property: String, to: MixpanelType)
-
-
-
- property
-
- |
-
-
-
- property name - |
-
-
- to
-
- |
-
-
-
- property value - |
-
Swift
-open func setOnce(properties: Properties)
-
-
-
- properties
-
- |
-
-
-
- properties dictionary - |
-
-
+
- unset(properties:)
+ unset(properties:)
Swift
-open func unset(properties: [String])
-
-
-
- properties
-
- |
-
-
-
- properties array - |
-
Swift
-open func increment(properties: Properties)
-
-
-
- properties
-
- |
-
-
-
- properties array - |
-
Swift
-open func increment(property: String, by: Double)
-
-
-
- property
-
- |
-
-
-
- property name - |
-
-
- by
-
- |
-
-
-
- amount to increment by - |
-
Swift
-open func append(properties: Properties)
-
-
-
- properties
-
- |
-
-
-
- mapping of list property names to values to append - |
-
Swift
-open func remove(properties: Properties)
-
-
-
- properties
-
- |
-
-
-
- mapping of list property names to values to remove - |
-
-
+
- union(properties:)
+ union(properties:)
Property values must be array objects.
Swift
-open func union(properties: Properties)
-
-
-
- properties
-
- |
-
-
-
- mapping of list property names to lists to union - |
-
Swift
-open func trackCharge(amount: Double, properties: Properties? = nil)
-
-
-
- amount
-
- |
-
-
-
- amount of revenue received - |
-
-
- properties
-
- |
-
-
-
- Optional. properties dictionary - |
-
-
+
- clearCharges()
+ clearCharges()
Delete current user’s revenue history.
Swift
-open func clearCharges()
-
-
-
+
- deleteUser()
+ deleteUser()
Delete current user’s record from Mixpanel People.
Swift
-open func deleteUser()
-
- Mixpanel 4.1.2 Docs (83% documented)
+Mixpanel 4.1.3 Docs (0% documented)
Swift
-extension String: MixpanelType
-
- Swift
-extension NSString: MixpanelType
-
- Swift
-extension NSNumber: MixpanelType
-
- Swift
-extension Int: MixpanelType
-
- Swift
-extension UInt: MixpanelType
-
- Swift
-extension Double: MixpanelType
-
- Swift
-extension Float: MixpanelType
-
- Swift
-extension Bool: MixpanelType
-
- Swift
-extension Date: MixpanelType
-
- Swift
-extension URL: MixpanelType
-
- Swift
-extension NSNull: MixpanelType
-
- Swift
-extension Array: MixpanelType
-
- Swift
-extension NSArray: MixpanelType
-
-
-
+
- Dictionary
+ Dictionary
Swift
-extension Dictionary: MixpanelType
-
- Mixpanel 4.1.2 Docs (83% documented)
+Mixpanel 4.1.3 Docs (0% documented)
-
+
- equals(rhs:)
+ equals(rhs:)
Undocumented
- -Swift
-public func equals(rhs: MixpanelType) -> Bool
-
- Mixpanel 4.1.2 Docs (83% documented)
+Mixpanel 4.1.3 Docs (0% documented)
-
+
- equals(rhs:)
+ equals(rhs:)
Undocumented
- -Swift
-public func equals(rhs: MixpanelType) -> Bool
-
- Mixpanel 4.1.2 Docs (83% documented)
+Mixpanel 4.1.3 Docs (0% documented)
-
+
- equals(rhs:)
+ equals(rhs:)
Undocumented
- -Swift
-public func equals(rhs: MixpanelType) -> Bool
-
- Mixpanel 4.1.2 Docs (83% documented)
+Mixpanel 4.1.3 Docs (0% documented)
-
+
- equals(rhs:)
+ equals(rhs:)
Undocumented
- -Swift
-public func equals(rhs: MixpanelType) -> Bool
-
- Mixpanel 4.1.2 Docs (83% documented)
+Mixpanel 4.1.3 Docs (0% documented)
-
+
- equals(rhs:)
+ equals(rhs:)
Undocumented
- -Swift
-public func equals(rhs: MixpanelType) -> Bool
-
- Mixpanel 4.1.2 Docs (83% documented)
+Mixpanel 4.1.3 Docs (0% documented)
-
+
- equals(rhs:)
+ equals(rhs:)
Undocumented
- -Swift
-public func equals(rhs: MixpanelType) -> Bool
-
- Mixpanel 4.1.2 Docs (83% documented)
+Mixpanel 4.1.3 Docs (0% documented)
-
+
- equals(rhs:)
+ equals(rhs:)
Undocumented
- -Swift
-public func equals(rhs: MixpanelType) -> Bool
-
- Mixpanel 4.1.2 Docs (83% documented)
+Mixpanel 4.1.3 Docs (0% documented)
-
+
- equals(rhs:)
+ equals(rhs:)
Undocumented
- -Swift
-public func equals(rhs: MixpanelType) -> Bool
-
- Mixpanel 4.1.2 Docs (83% documented)
+Mixpanel 4.1.3 Docs (0% documented)
-
+
- equals(rhs:)
+ equals(rhs:)
Undocumented
- -Swift
-public func equals(rhs: MixpanelType) -> Bool
-
- Mixpanel 4.1.2 Docs (83% documented)
+Mixpanel 4.1.3 Docs (0% documented)
-
+
- equals(rhs:)
+ equals(rhs:)
Undocumented
- -Swift
-public func equals(rhs: MixpanelType) -> Bool
-
- Mixpanel 4.1.2 Docs (83% documented)
+Mixpanel 4.1.3 Docs (0% documented)
-
+
- equals(rhs:)
+ equals(rhs:)
Undocumented
- -Swift
-public func equals(rhs: MixpanelType) -> Bool
-
- Mixpanel 4.1.2 Docs (83% documented)
+Mixpanel 4.1.3 Docs (0% documented)
-
+
- equals(rhs:)
+ equals(rhs:)
Undocumented
- -Swift
-public func equals(rhs: MixpanelType) -> Bool
-
- Mixpanel 4.1.2 Docs (83% documented)
+Mixpanel 4.1.3 Docs (0% documented)
-
+
- equals(rhs:)
+ equals(rhs:)
Undocumented
- -Swift
-public func equals(rhs: MixpanelType) -> Bool
-
- Mixpanel 4.1.2 Docs (83% documented)
+Mixpanel 4.1.3 Docs (0% documented)
-
+
- equals(rhs:)
+ equals(rhs:)
Undocumented
- -Swift
-public func equals(rhs: MixpanelType) -> Bool
-
- Mixpanel 4.1.2 Docs (83% documented)
+Mixpanel 4.1.3 Docs (0% documented)
-
+
- equals(rhs:)
+ equals(rhs:)
Undocumented
- -Swift
-public func equals(rhs: MixpanelType) -> Bool
-
- Mixpanel 4.1.2 Docs (83% documented)
+Mixpanel 4.1.3 Docs (0% documented)
-
+
- MixpanelType
+ MixpanelType
Swift
-public protocol MixpanelType
-
- Mixpanel 4.1.2 Docs (83% documented)
+Mixpanel 4.1.3 Docs (0% documented)
Mixpanel 4.1.2 Docs (83% documented)
+Mixpanel 4.1.3 Docs (0% documented)
-
+
- equals(rhs:)
+ equals(rhs:)
Undocumented
- -Swift
-func equals(rhs: MixpanelType) -> Bool
-
- Mixpanel 4.1.2 Docs (83% documented)
+Mixpanel 4.1.3 Docs (0% documented)
Swift
-open class People
-
- Mixpanel 4.1.2 Docs (83% documented)
+Mixpanel 4.1.3 Docs (0% documented)
open class Group
-
- Access to the Mixpanel Groups API, available through the getGroup function from the main Mixpanel instance.
@@ -154,9 +147,9 @@
-
+
- set(properties:)
+ set(properties:)
Swift
-open func set(properties: Properties)
-
-
-
- properties
-
- |
-
-
-
- properties dictionary - |
-
-
+
- set(property:to:)
+ set(property:to:)
Swift
-open func set(property: String, to: MixpanelType)
-
-
-
- property
-
- |
-
-
-
- property name - |
-
-
- to
-
- |
-
-
-
- property value - |
-
Swift
-open func setOnce(properties: Properties)
-
-
-
- properties
-
- |
-
-
-
- properties dictionary - |
-
-
+
- unset(property:)
+ unset(property:)
For properties that don’t exist there will be no effect.
Swift
-open func unset(property: String)
-
-
-
- property
-
- |
-
-
-
- name of the property to unset - |
-
-
+
- remove(key:value:)
+ remove(key:value:)
Swift
-open func remove(key: String, value: MixpanelType)
-
-
-
- properties
-
- |
-
-
-
- mapping of list property names to values to remove - |
-
-
+
- union(key:values:)
+ union(key:values:)
Property values must be array objects.
Swift
-open func union(key: String, values: [MixpanelType])
-
-
-
- properties
-
- |
-
-
-
- mapping of list property names to lists to union - |
-
-
+
- deleteGroup()
+ deleteGroup()
Delete group’s record from Mixpanel Groups.
Swift
-open func deleteGroup()
-
- Mixpanel 4.1.2 Docs (83% documented)
+Mixpanel 4.1.3 Docs (0% documented)
open class Mixpanel
-
- The primary class for integrating Mixpanel with your app.
-
+
- initialize(token:trackAutomaticEvents:flushInterval:instanceName:optOutTrackingByDefault:useUniqueDistinctId:superProperties:serverURL:)
+ initialize(token:trackAutomaticEvents:flushInterval:instanceName:optOutTrackingByDefault:useUniqueDistinctId:superProperties:serverURL:)
Swift
-@discardableResult
-open class func initialize(token apiToken: String,
- trackAutomaticEvents: Bool,
- flushInterval: Double = 60,
- instanceName: String? = nil,
- optOutTrackingByDefault: Bool = false,
- useUniqueDistinctId: Bool = false,
- superProperties: Properties? = nil,
- serverURL: String? = nil) -> MixpanelInstance
-
-
-
- token
-
- |
-
-
-
- your project token - |
-
-
- trackAutomaticEvents
-
- |
-
-
-
- Whether or not to collect common mobile events - |
-
-
- flushInterval
-
- |
-
-
-
- Optional. Interval to run background flushing - |
-
-
- instanceName
-
- |
-
-
-
- Optional. The name you want to uniquely identify the Mixpanel Instance. -It is useful when you want more than one Mixpanel instance under the same project token. - |
-
-
- optOutTrackingByDefault
-
- |
-
-
-
- Optional. Whether or not to be opted out from tracking by default - |
-
-
- useUniqueDistinctId
-
- |
-
-
-
- Optional. whether or not to use the unique device identifier as the distinct_id - |
-
-
- superProperties
-
- |
-
-
-
- Optional. Super properties dictionary to register during initialization - |
-
-
- serverURL
-
- |
-
-
-
- Optional. Mixpanel cluster URL - |
-
returns a mixpanel instance if needed to keep throughout the project. -You can always get the instance by calling getInstance(name)
-
-
+
- getInstance(name:)
+ getInstance(name:)
Gets the mixpanel instance with the given name
Swift
-open class func getInstance(name: String) -> MixpanelInstance?
-
-
-
- name
-
- |
-
-
-
- the instance name - |
-
returns the mixpanel instance
-
-
+
- mainInstance()
+ mainInstance()
If not specified explicitly, the main instance is always the last instance added
Swift
-open class func mainInstance() -> MixpanelInstance
-
- returns the main Mixpanel instance
-Sets the main instance based on the instance name
Swift
-open class func setMainInstance(name: String)
-
-
-
- name
-
- |
-
-
-
- the instance name - |
-
Removes an unneeded Mixpanel instance based on its name
Swift
-open class func removeInstance(name: String)
-
-
-
- name
-
- |
-
-
-
- the instance name - |
-
Mixpanel 4.1.2 Docs (83% documented)
+Mixpanel 4.1.3 Docs (0% documented)
open class MixpanelInstance : CustomDebugStringConvertible, FlushDelegate, AEDelegate
-
- The class that represents the Mixpanel Instance
apiToken string that identifies the project to track data to
Swift
-open var apiToken: String
-
- The a MixpanelDelegate object that gives control over Mixpanel network activity.
Swift
-open weak var delegate: MixpanelDelegate?
-
-
-
+
- distinctId
+ distinctId
distinctId string that uniquely identifies the current user.
Swift
-open var distinctId: String
-
-
-
+
- anonymousId
+ anonymousId
anonymousId string that uniquely identifies the device.
Swift
-open var anonymousId: String?
-
- userId string that identify is called with.
Swift
-open var userId: String?
-
- Swift
-open var hadPersistedDistinctId: Bool?
-
- alias string that uniquely identifies the current user.
Swift
-open var alias: String?
-
- Accessor to the Mixpanel People API object.
Swift
-open var people: People!
-
- Swift
-open var showNetworkActivityIndicator: Bool
-
- This allows enabling or disabling collecting common mobile events,
Swift
-open var trackAutomaticEventsEnabled: Bool
-
-
-
+
- flushInterval
+ flushInterval
Swift
-open var flushInterval: Double { get set }
-
-
-
+
- flushOnBackground
+ flushOnBackground
Swift
-open var flushOnBackground: Bool { get set }
-
- Swift
-open var useIPAddressForGeoLocation: Bool { get set }
-
- Swift
-open var serverURL: String { get set }
-
-
-
+
- debugDescription
+ debugDescription
Swift
-open var debugDescription: String { get }
-
-
-
+
- loggingEnabled
+ loggingEnabled
Swift
-open var loggingEnabled: Bool { get set }
-
- A unique identifier for this MixpanelInstance
Swift
-public let name: String
-
- Undocumented
- -Swift
-open var minimumSessionDuration: UInt64 { get set }
+ The minimum session duration (ms) that is tracked in automatic events. +The default value is 10000 (10 seconds).
-Swift
-open var maximumSessionDuration: UInt64 { get set }
-
- mixpanelInstance.identify(mixpanelInstance.distinctId)
.
Swift
-public func identify(distinctId: String, usePeople: Bool = true, completion: (() -> Void)? = nil)
-
-
-
- distinctId
-
- |
-
-
-
- string that uniquely identifies the current user - |
-
-
- usePeople
-
- |
-
-
-
- boolean that controls whether or not to set the people distinctId to the event distinctId. -This should only be set to false if you wish to prevent people profile updates for that user. - |
-
-
- completion
-
- |
-
-
-
- an optional completion handler for when the identify has completed. - |
-
-
+
- createAlias(_:distinctId:usePeople:andIdentify:completion:)
+ createAlias(_:distinctId:usePeople:andIdentify:completion:)
mixpanelInstance.createAlias("Newer ID", distinctId: mixpanelInstance.distinctId)
Swift
-public func createAlias(_ alias: String, distinctId: String, usePeople: Bool = true, andIdentify: Bool = true, completion: (() -> Void)? = nil)
-
-
-
- alias
-
- |
-
-
-
- A unique identifier that you want to use as an identifier for this user. - |
-
-
- distinctId
-
- |
-
-
-
- The current user identifier. - |
-
-
- usePeople
-
- |
-
-
-
- boolean that controls whether or not to set the people distinctId to the event distinctId. - |
-
-
- andIdentify
-
- |
-
-
-
- an optional boolean that controls whether or not to call ‘identify’ with your current -user identifier(not alias). Default to true for keeping your signup funnels working correctly in most cases. - |
-
-
- completion
-
- |
-
-
-
- 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. - |
-
-
+
- reset(completion:)
+ reset(completion:)
Swift
-public func reset(completion: (() -> Void)? = nil)
-
-
-
- completion
-
- |
-
-
-
- an optional completion handler for when the reset has completed. - |
-
Undocumented
- -Swift
-public func archive()
-
- Uploads queued data to the Mixpanel server.
By default, queued data is flushed to the Mixpanel servers every minute (the
-default for flushInterval
), and on background (since
-flushOnBackground
is on by default). You only need to call this
+default for flushInterval
), and on background (since
+flushOnBackground
is on by default). You only need to call this
method manually if you want to force a flush at a particular moment.
Swift
-public func flush(performFullFlush: Bool = false, completion: (() -> Void)? = nil)
-
-
-
- performFullFlush
-
- |
-
-
-
- A optional boolean value indicating whether a full flush should be performed. If |
-
-
- completion
-
- |
-
-
-
- an optional completion handler for when the flush has completed. - |
-
Swift
-public func track(event: String?, properties: Properties? = nil)
-
-
-
- event
-
- |
-
-
-
- event name - |
-
-
- properties
-
- |
-
-
-
- properties dictionary - |
-
Swift
-public func trackWithGroups(event: String?, properties: Properties? = nil, groups: Properties?)
-
-
-
- event
-
- |
-
-
-
- event name - |
-
-
- properties
-
- |
-
-
-
- properties dictionary - |
-
-
- groups
-
- |
-
-
-
- groups dictionary - |
-
Undocumented
- -Swift
-public func getGroup(groupKey: String, groupID: MixpanelType) -> Group
-
-
-
+
- time(event:)
+ time(event:)
Swift
-public func time(event: String)
-
-
-
- event
-
- |
-
-
-
- the event name to be timed - |
-
Retrieves the time elapsed for the named event since time(event:) was called.
Swift
-public func eventElapsedTime(event: String) -> Double
-
-
-
- event
-
- |
-
-
-
- the name of the event to be tracked that was passed to time(event:) - |
-
-
+
- clearTimedEvents()
+ clearTimedEvents()
Clears all current event timers.
Swift
-public func clearTimedEvents()
-
- Clears the event timer for the named event.
Swift
-public func clearTimedEvent(event: String)
-
-
-
- event
-
- |
-
-
-
- the name of the event to clear the timer for - |
-
Returns the currently set super properties.
Swift
-public func currentSuperProperties() -> [String : Any]
-
- the current super properties
-Clears all currently set super properties.
Swift
-public func clearSuperProperties()
-
- Swift
-public func registerSuperProperties(_ properties: Properties)
-
-
-
- properties
-
- |
-
-
-
- properties dictionary - |
-
Swift
-public func registerSuperPropertiesOnce(_ properties: Properties,
- defaultValue: MixpanelType? = nil)
-
-
-
- properties
-
- |
-
-
-
- properties dictionary - |
-
-
- defaultValue
-
- |
-
-
-
- Optional. overwrite existing properties that have this value - |
-
Swift
-public func unregisterSuperProperty(_ propertyName: String)
-
-
-
- propertyName
-
- |
-
-
-
- array of property name strings to remove - |
-
Convenience method to set a single group the user belongs to.
Swift
-public func setGroup(groupKey: String, groupID: MixpanelType)
-
-
-
- groupKey
-
- |
-
-
-
- The property name associated with this group type (must already have been set up). - |
-
-
- groupID
-
- |
-
-
-
- The group the user belongs to. - |
-
Set the groups this user belongs to.
Swift
-public func setGroup(groupKey: String, groupIDs: [MixpanelType])
-
-
-
- groupKey
-
- |
-
-
-
- The property name associated with this group type (must already have been set up). - |
-
-
- groupIDs
-
- |
-
-
-
- The list of groups the user belongs to. - |
-
Add a group to this user’s membership for a particular group key
Swift
-public func addGroup(groupKey: String, groupID: MixpanelType)
-
-
-
- groupKey
-
- |
-
-
-
- The property name associated with this group type (must already have been set up). - |
-
-
- groupID
-
- |
-
-
-
- The new group the user belongs to. - |
-
Remove a group from this user’s membership for a particular group key
Swift
-public func removeGroup(groupKey: String, groupID: MixpanelType)
-
-
-
- groupKey
-
- |
-
-
-
- The property name associated with this group type (must already have been set up). - |
-
-
- groupID
-
- |
-
-
-
- The group value to remove. - |
-
-
+
- optOutTracking()
+ optOutTracking()
Swift
-public func optOutTracking()
-
- This method will internally track an opt in event to your project.
Swift
-public func optInTracking(distinctId: String? = nil, properties: Properties? = nil)
-
-
-
- distintId
-
- |
-
-
-
- an optional string to use as the distinct ID for events - |
-
-
- properties
-
- |
-
-
-
- an optional properties dictionary that could be passed to add properties to the opt-in event -that is sent to Mixpanel - |
-
Returns if the current user has opted out tracking.
Swift
-public func hasOptedOutTracking() -> Bool
-
- the current super opted out tracking status
-Mixpanel 4.1.2 Docs (83% documented)
+Mixpanel 4.1.3 Docs (0% documented)
open class People
-
- Access to the Mixpanel People API, available as an accessible variable from the main Mixpanel instance.
@@ -145,9 +138,9 @@
-
+
- ignoreTime
+ ignoreTime
Swift
-open var ignoreTime: Bool
-
-
-
+
- set(properties:)
+ set(properties:)
Swift
-open func set(properties: Properties)
-
-
-
- properties
-
- |
-
-
-
- properties dictionary - |
-
-
+
- set(property:to:)
+ set(property:to:)
Swift
-open func set(property: String, to: MixpanelType)
-
-
-
- property
-
- |
-
-
-
- property name - |
-
-
- to
-
- |
-
-
-
- property value - |
-
Swift
-open func setOnce(properties: Properties)
-
-
-
- properties
-
- |
-
-
-
- properties dictionary - |
-
-
+
- unset(properties:)
+ unset(properties:)
Swift
-open func unset(properties: [String])
-
-
-
- properties
-
- |
-
-
-
- properties array - |
-
Swift
-open func increment(properties: Properties)
-
-
-
- properties
-
- |
-
-
-
- properties array - |
-
Swift
-open func increment(property: String, by: Double)
-
-
-
- property
-
- |
-
-
-
- property name - |
-
-
- by
-
- |
-
-
-
- amount to increment by - |
-
Swift
-open func append(properties: Properties)
-
-
-
- properties
-
- |
-
-
-
- mapping of list property names to values to append - |
-
Swift
-open func remove(properties: Properties)
-
-
-
- properties
-
- |
-
-
-
- mapping of list property names to values to remove - |
-
-
+
- union(properties:)
+ union(properties:)
Property values must be array objects.
Swift
-open func union(properties: Properties)
-
-
-
- properties
-
- |
-
-
-
- mapping of list property names to lists to union - |
-
Swift
-open func trackCharge(amount: Double, properties: Properties? = nil)
-
-
-
- amount
-
- |
-
-
-
- amount of revenue received - |
-
-
- properties
-
- |
-
-
-
- Optional. properties dictionary - |
-
-
+
- clearCharges()
+ clearCharges()
Delete current user’s revenue history.
Swift
-open func clearCharges()
-
-
-
+
- deleteUser()
+ deleteUser()
Delete current user’s record from Mixpanel People.
Swift
-open func deleteUser()
-
- Mixpanel 4.1.2 Docs (83% documented)
+Mixpanel 4.1.3 Docs (0% documented)
Swift
-extension Optional: MixpanelType
-
- Swift
-extension String: MixpanelType
-
- Swift
-extension NSString: MixpanelType
-
- Swift
-extension NSNumber: MixpanelType
-
- Swift
-extension Int: MixpanelType
-
- Swift
-extension UInt: MixpanelType
-
- Swift
-extension Double: MixpanelType
-
- Swift
-extension Float: MixpanelType
-
- Swift
-extension Bool: MixpanelType
-
- Swift
-extension Date: MixpanelType
-
- Swift
-extension URL: MixpanelType
-
- Swift
-extension NSNull: MixpanelType
-
- Swift
-extension Array: MixpanelType
-
- Swift
-extension NSArray: MixpanelType
-
-
-
+
- Dictionary
+ Dictionary
Swift
-extension Dictionary: MixpanelType
-
- Mixpanel 4.1.2 Docs (83% documented)
+Mixpanel 4.1.3 Docs (0% documented)
extension Array: MixpanelType
-
- Checks if this object has nested object types that Mixpanel supports.
Swift
-public func isValidNestedTypeAndValue() -> Bool
-
-
-
+
- equals(rhs:)
+ equals(rhs:)
Undocumented
- -Swift
-public func equals(rhs: MixpanelType) -> Bool
-
- Mixpanel 4.1.2 Docs (83% documented)
+Mixpanel 4.1.3 Docs (0% documented)
extension Bool: MixpanelType
-
- Swift
-public func isValidNestedTypeAndValue() -> Bool
-
-
-
+
- equals(rhs:)
+ equals(rhs:)
Undocumented
- -Swift
-public func equals(rhs: MixpanelType) -> Bool
-
- Mixpanel 4.1.2 Docs (83% documented)
+Mixpanel 4.1.3 Docs (0% documented)
extension Date: MixpanelType
-
- Swift
-public func isValidNestedTypeAndValue() -> Bool
-
-
-
+
- equals(rhs:)
+ equals(rhs:)
Undocumented
- -Swift
-public func equals(rhs: MixpanelType) -> Bool
-
- Mixpanel 4.1.2 Docs (83% documented)
+Mixpanel 4.1.3 Docs (0% documented)
extension Dictionary: MixpanelType
-
- Checks if this object has nested object types that Mixpanel supports.
Swift
-public func isValidNestedTypeAndValue() -> Bool
-
-
-
+
- equals(rhs:)
+ equals(rhs:)
Undocumented
- -Swift
-public func equals(rhs: MixpanelType) -> Bool
-
- Mixpanel 4.1.2 Docs (83% documented)
+Mixpanel 4.1.3 Docs (0% documented)
extension Double: MixpanelType
-
- Swift
-public func isValidNestedTypeAndValue() -> Bool
-
-
-
+
- equals(rhs:)
+ equals(rhs:)
Undocumented
- -Swift
-public func equals(rhs: MixpanelType) -> Bool
-
- Mixpanel 4.1.2 Docs (83% documented)
+Mixpanel 4.1.3 Docs (0% documented)
extension Float: MixpanelType
-
- Swift
-public func isValidNestedTypeAndValue() -> Bool
-
-
-
+
- equals(rhs:)
+ equals(rhs:)
Undocumented
- -Swift
-public func equals(rhs: MixpanelType) -> Bool
-
- Mixpanel 4.1.2 Docs (83% documented)
+Mixpanel 4.1.3 Docs (0% documented)
extension Int: MixpanelType
-
- Swift
-public func isValidNestedTypeAndValue() -> Bool
-
-
-
+
- equals(rhs:)
+ equals(rhs:)
Undocumented
- -Swift
-public func equals(rhs: MixpanelType) -> Bool
-
- Mixpanel 4.1.2 Docs (83% documented)
+Mixpanel 4.1.3 Docs (0% documented)
extension NSArray: MixpanelType
-
- Checks if this object has nested object types that Mixpanel supports.
Swift
-public func isValidNestedTypeAndValue() -> Bool
-
-
-
+
- equals(rhs:)
+ equals(rhs:)
Undocumented
- -Swift
-public func equals(rhs: MixpanelType) -> Bool
-
- Mixpanel 4.1.2 Docs (83% documented)
+Mixpanel 4.1.3 Docs (0% documented)
extension NSNull: MixpanelType
-
- Swift
-public func isValidNestedTypeAndValue() -> Bool
-
-
-
+
- equals(rhs:)
+ equals(rhs:)
Undocumented
- -Swift
-public func equals(rhs: MixpanelType) -> Bool
-
- Mixpanel 4.1.2 Docs (83% documented)
+Mixpanel 4.1.3 Docs (0% documented)
extension NSNumber: MixpanelType
-
- Swift
-public func isValidNestedTypeAndValue() -> Bool
-
-
-
+
- equals(rhs:)
+ equals(rhs:)
Undocumented
- -Swift
-public func equals(rhs: MixpanelType) -> Bool
-
- Mixpanel 4.1.2 Docs (83% documented)
+Mixpanel 4.1.3 Docs (0% documented)
extension NSString: MixpanelType
-
- Swift
-public func isValidNestedTypeAndValue() -> Bool
-
-
-
+
- equals(rhs:)
+ equals(rhs:)
Undocumented
- -Swift
-public func equals(rhs: MixpanelType) -> Bool
-
- Mixpanel 4.1.2 Docs (83% documented)
+Mixpanel 4.1.3 Docs (0% documented)
extension Optional: MixpanelType
-
- Checks if this object has nested object types that Mixpanel supports.
Swift
-public func isValidNestedTypeAndValue() -> Bool
-
-
-
+
- equals(rhs:)
+ equals(rhs:)
Undocumented
- -Swift
-public func equals(rhs: MixpanelType) -> Bool
-
- Mixpanel 4.1.2 Docs (83% documented)
+Mixpanel 4.1.3 Docs (0% documented)
extension String: MixpanelType
-
- Swift
-public func isValidNestedTypeAndValue() -> Bool
-
-
-
+
- equals(rhs:)
+ equals(rhs:)
Undocumented
- -Swift
-public func equals(rhs: MixpanelType) -> Bool
-
- Mixpanel 4.1.2 Docs (83% documented)
+Mixpanel 4.1.3 Docs (0% documented)
extension UInt: MixpanelType
-
- Swift
-public func isValidNestedTypeAndValue() -> Bool
-
-
-
+
- equals(rhs:)
+ equals(rhs:)
Undocumented
- -Swift
-public func equals(rhs: MixpanelType) -> Bool
-
- Mixpanel 4.1.2 Docs (83% documented)
+Mixpanel 4.1.3 Docs (0% documented)
extension URL: MixpanelType
-
- Swift
-public func isValidNestedTypeAndValue() -> Bool
-
-
-
+
- equals(rhs:)
+ equals(rhs:)
Undocumented
- -Swift
-public func equals(rhs: MixpanelType) -> Bool
-
- Mixpanel 4.1.2 Docs (83% documented)
+Mixpanel 4.1.3 Docs (0% documented)
-
+
- MixpanelDelegate
+ MixpanelDelegate
Swift
-public protocol MixpanelDelegate : AnyObject
-
-
-
+
- MixpanelType
+ MixpanelType
Swift
-public protocol MixpanelType
-
- Mixpanel 4.1.2 Docs (83% documented)
+Mixpanel 4.1.3 Docs (0% documented)
public protocol MixpanelDelegate : AnyObject
-
- Delegate protocol for controlling the Mixpanel API’s network behavior.
Asks the delegate if data should be uploaded to the server.
Swift
-func mixpanelWillFlush(_ mixpanel: MixpanelInstance) -> Bool
-
-
-
- mixpanel
-
- |
-
-
-
- The mixpanel instance - |
-
return true to upload now or false to defer until later
-Mixpanel 4.1.2 Docs (83% documented)
+Mixpanel 4.1.3 Docs (0% documented)
public protocol MixpanelType
-
- Property keys must be String objects and the supported value types need to conform to MixpanelType. MixpanelType can be either String, Int, UInt, Double, Float, Bool, [MixpanelType], [String: MixpanelType], Date, URL, or NSNull. Numbers are not NaN or infinity
@@ -146,9 +139,9 @@Checks if this object has nested object types that Mixpanel supports.
Swift
-func isValidNestedTypeAndValue() -> Bool
-
-
-
+
- equals(rhs:)
+ equals(rhs:)
Undocumented
- -Swift
-func equals(rhs: MixpanelType) -> Bool
-
- Mixpanel 4.1.2 Docs (83% documented)
+Mixpanel 4.1.3 Docs (0% documented)
-
+
- Properties
+ Properties
Undocumented
- -Swift
-public typealias Properties = [String : MixpanelType]
-
- Mixpanel 4.1.2 Docs (83% documented)
+Mixpanel 4.1.3 Docs (0% documented)
Why aren’t my events showing up?
-To preserve battery life and customer bandwidth, the Mixpanel library doesn’t send the events you record immediately. Instead, it sends batches to the Mixpanel servers every 60 seconds while your application is running, as well as when the application transitions to the background. You can call flush() manually if you want to force a flush at a particular moment.
+First, make sure your test device has internet access. To preserve battery life and customer bandwidth, the Mixpanel library doesn’t send the events you record immediately. Instead, it sends batches to the Mixpanel servers every 60 seconds while your application is running, as well as when the application transitions to the background. You can call flush() manually if you want to force a flush at a particular moment.
Mixpanel.mainInstance().flush()
@@ -288,7 +288,7 @@ Undocumented
"},"Protocols/MixpanelType.html#/s:8Mixpanel0A4TypeP013isValidNestedB8AndValueSbyF":{"name":"isValidNestedTypeAndValue()","abstract":"Checks if this object has nested object types that Mixpanel supports.
","parent_name":"MixpanelType"},"Protocols/MixpanelType.html#/s:8Mixpanel0A4TypeP6equals3rhsSbAaB_p_tF":{"name":"equals(rhs:)","abstract":"Undocumented
","parent_name":"MixpanelType"},"Protocols/MixpanelDelegate.html#/s:8Mixpanel0A8DelegateP17mixpanelWillFlushySbAA0A8InstanceCF":{"name":"mixpanelWillFlush(_:)","abstract":"Asks the delegate if data should be uploaded to the server.
","parent_name":"MixpanelDelegate"},"Protocols/MixpanelDelegate.html":{"name":"MixpanelDelegate","abstract":"Delegate protocol for controlling the Mixpanel API’s network behavior.
"},"Protocols/MixpanelType.html":{"name":"MixpanelType","abstract":"Property keys must be String objects and the supported value types need to conform to MixpanelType."},"Extensions/Dictionary.html#/s:SD8MixpanelE25isValidNestedTypeAndValueSbyF":{"name":"isValidNestedTypeAndValue()","abstract":"
Checks if this object has nested object types that Mixpanel supports.
","parent_name":"Dictionary"},"Extensions/Dictionary.html#/s:SD8MixpanelE6equals3rhsSbAA0A4Type_p_tF":{"name":"equals(rhs:)","abstract":"Undocumented
","parent_name":"Dictionary"},"Extensions/NSArray.html#/s:So7NSArrayC8MixpanelE25isValidNestedTypeAndValueSbyF":{"name":"isValidNestedTypeAndValue()","abstract":"Checks if this object has nested object types that Mixpanel supports.
","parent_name":"NSArray"},"Extensions/NSArray.html#/s:So7NSArrayC8MixpanelE6equals3rhsSbAC0B4Type_p_tF":{"name":"equals(rhs:)","abstract":"Undocumented
","parent_name":"NSArray"},"Extensions/Array.html#/s:Sa8MixpanelE25isValidNestedTypeAndValueSbyF":{"name":"isValidNestedTypeAndValue()","abstract":"Checks if this object has nested object types that Mixpanel supports.
","parent_name":"Array"},"Extensions/Array.html#/s:Sa8MixpanelE6equals3rhsSbAA0A4Type_p_tF":{"name":"equals(rhs:)","abstract":"Undocumented
","parent_name":"Array"},"Extensions/NSNull.html#/s:So6NSNullC8MixpanelE25isValidNestedTypeAndValueSbyF":{"name":"isValidNestedTypeAndValue()","abstract":"Checks if this object has nested object types that Mixpanel supports.","parent_name":"NSNull"},"Extensions/NSNull.html#/s:So6NSNullC8MixpanelE6equals3rhsSbAC0B4Type_p_tF":{"name":"equals(rhs:)","abstract":"
Undocumented
","parent_name":"NSNull"},"Extensions/URL.html#/s:10Foundation3URLV8MixpanelE25isValidNestedTypeAndValueSbyF":{"name":"isValidNestedTypeAndValue()","abstract":"Checks if this object has nested object types that Mixpanel supports.","parent_name":"URL"},"Extensions/URL.html#/s:10Foundation3URLV8MixpanelE6equals3rhsSbAD0C4Type_p_tF":{"name":"equals(rhs:)","abstract":"
Undocumented
","parent_name":"URL"},"Extensions/Date.html#/s:10Foundation4DateV8MixpanelE25isValidNestedTypeAndValueSbyF":{"name":"isValidNestedTypeAndValue()","abstract":"Checks if this object has nested object types that Mixpanel supports.","parent_name":"Date"},"Extensions/Date.html#/s:10Foundation4DateV8MixpanelE6equals3rhsSbAD0C4Type_p_tF":{"name":"equals(rhs:)","abstract":"
Undocumented
","parent_name":"Date"},"Extensions/Bool.html#/s:Sb8MixpanelE25isValidNestedTypeAndValueSbyF":{"name":"isValidNestedTypeAndValue()","abstract":"Checks if this object has nested object types that Mixpanel supports.","parent_name":"Bool"},"Extensions/Bool.html#/s:Sb8MixpanelE6equals3rhsSbAA0A4Type_p_tF":{"name":"equals(rhs:)","abstract":"
Undocumented
","parent_name":"Bool"},"Extensions/Float.html#/s:Sf8MixpanelE25isValidNestedTypeAndValueSbyF":{"name":"isValidNestedTypeAndValue()","abstract":"Checks if this object has nested object types that Mixpanel supports.","parent_name":"Float"},"Extensions/Float.html#/s:Sf8MixpanelE6equals3rhsSbAA0A4Type_p_tF":{"name":"equals(rhs:)","abstract":"
Undocumented
","parent_name":"Float"},"Extensions/Double.html#/s:Sd8MixpanelE25isValidNestedTypeAndValueSbyF":{"name":"isValidNestedTypeAndValue()","abstract":"Checks if this object has nested object types that Mixpanel supports.","parent_name":"Double"},"Extensions/Double.html#/s:Sd8MixpanelE6equals3rhsSbAA0A4Type_p_tF":{"name":"equals(rhs:)","abstract":"
Undocumented
","parent_name":"Double"},"Extensions/UInt.html#/s:Su8MixpanelE25isValidNestedTypeAndValueSbyF":{"name":"isValidNestedTypeAndValue()","abstract":"Checks if this object has nested object types that Mixpanel supports.","parent_name":"UInt"},"Extensions/UInt.html#/s:Su8MixpanelE6equals3rhsSbAA0A4Type_p_tF":{"name":"equals(rhs:)","abstract":"
Undocumented
","parent_name":"UInt"},"Extensions/Int.html#/s:Si8MixpanelE25isValidNestedTypeAndValueSbyF":{"name":"isValidNestedTypeAndValue()","abstract":"Checks if this object has nested object types that Mixpanel supports.","parent_name":"Int"},"Extensions/Int.html#/s:Si8MixpanelE6equals3rhsSbAA0A4Type_p_tF":{"name":"equals(rhs:)","abstract":"
Undocumented
","parent_name":"Int"},"Extensions/NSNumber.html#/s:So8NSNumberC8MixpanelE25isValidNestedTypeAndValueSbyF":{"name":"isValidNestedTypeAndValue()","abstract":"Checks if this object has nested object types that Mixpanel supports.","parent_name":"NSNumber"},"Extensions/NSNumber.html#/s:So8NSNumberC8MixpanelE6equals3rhsSbAC0B4Type_p_tF":{"name":"equals(rhs:)","abstract":"
Undocumented
","parent_name":"NSNumber"},"Extensions/NSString.html#/s:So8NSStringC8MixpanelE25isValidNestedTypeAndValueSbyF":{"name":"isValidNestedTypeAndValue()","abstract":"Checks if this object has nested object types that Mixpanel supports.","parent_name":"NSString"},"Extensions/NSString.html#/s:So8NSStringC8MixpanelE6equals3rhsSbAC0B4Type_p_tF":{"name":"equals(rhs:)","abstract":"
Undocumented
","parent_name":"NSString"},"Extensions/String.html#/s:SS8MixpanelE25isValidNestedTypeAndValueSbyF":{"name":"isValidNestedTypeAndValue()","abstract":"Checks if this object has nested object types that Mixpanel supports.","parent_name":"String"},"Extensions/String.html#/s:SS8MixpanelE6equals3rhsSbAA0A4Type_p_tF":{"name":"equals(rhs:)","abstract":"
Undocumented
","parent_name":"String"},"Extensions/Optional.html#/s:Sq8MixpanelE25isValidNestedTypeAndValueSbyF":{"name":"isValidNestedTypeAndValue()","abstract":"Checks if this object has nested object types that Mixpanel supports.
","parent_name":"Optional"},"Extensions/Optional.html#/s:Sq8MixpanelE6equals3rhsSbAA0A4Type_p_tF":{"name":"equals(rhs:)","abstract":"Undocumented
","parent_name":"Optional"},"Extensions/Optional.html":{"name":"Optional"},"Extensions/String.html":{"name":"String"},"Extensions/NSString.html":{"name":"NSString"},"Extensions/NSNumber.html":{"name":"NSNumber"},"Extensions/Int.html":{"name":"Int"},"Extensions/UInt.html":{"name":"UInt"},"Extensions/Double.html":{"name":"Double"},"Extensions/Float.html":{"name":"Float"},"Extensions/Bool.html":{"name":"Bool"},"Extensions/Date.html":{"name":"Date"},"Extensions/URL.html":{"name":"URL"},"Extensions/NSNull.html":{"name":"NSNull"},"Extensions/Array.html":{"name":"Array"},"Extensions/NSArray.html":{"name":"NSArray"},"Extensions/Dictionary.html":{"name":"Dictionary"},"Classes/People.html#/s:8Mixpanel6PeopleC10ignoreTimeSbvp":{"name":"ignoreTime","abstract":"controls the $ignore_time property in any subsequent MixpanelPeople operation.","parent_name":"People"},"Classes/People.html#/s:8Mixpanel6PeopleC3set10propertiesySDySSAA0A4Type_pG_tF":{"name":"set(properties:)","abstract":"
Set properties on the current user in Mixpanel People.
","parent_name":"People"},"Classes/People.html#/s:8Mixpanel6PeopleC3set8property2toySS_AA0A4Type_ptF":{"name":"set(property:to:)","abstract":"Convenience method for setting a single property in Mixpanel People.
","parent_name":"People"},"Classes/People.html#/s:8Mixpanel6PeopleC7setOnce10propertiesySDySSAA0A4Type_pG_tF":{"name":"setOnce(properties:)","abstract":"Set properties on the current user in Mixpanel People, but doesn’t overwrite if","parent_name":"People"},"Classes/People.html#/s:8Mixpanel6PeopleC5unset10propertiesySaySSG_tF":{"name":"unset(properties:)","abstract":"
Remove a list of properties and their values from the current user’s profile","parent_name":"People"},"Classes/People.html#/s:8Mixpanel6PeopleC9increment10propertiesySDySSAA0A4Type_pG_tF":{"name":"increment(properties:)","abstract":"
Increment the given numeric properties by the given values.
","parent_name":"People"},"Classes/People.html#/s:8Mixpanel6PeopleC9increment8property2byySS_SdtF":{"name":"increment(property:by:)","abstract":"Convenience method for incrementing a single numeric property by the specified","parent_name":"People"},"Classes/People.html#/s:8Mixpanel6PeopleC6append10propertiesySDySSAA0A4Type_pG_tF":{"name":"append(properties:)","abstract":"
Append values to list properties.
","parent_name":"People"},"Classes/People.html#/s:8Mixpanel6PeopleC6remove10propertiesySDySSAA0A4Type_pG_tF":{"name":"remove(properties:)","abstract":"Removes list properties.
","parent_name":"People"},"Classes/People.html#/s:8Mixpanel6PeopleC5union10propertiesySDySSAA0A4Type_pG_tF":{"name":"union(properties:)","abstract":"Union list properties.
","parent_name":"People"},"Classes/People.html#/s:8Mixpanel6PeopleC11trackCharge6amount10propertiesySd_SDySSAA0A4Type_pGSgtF":{"name":"trackCharge(amount:properties:)","abstract":"Track money spent by the current user for revenue analytics and associate","parent_name":"People"},"Classes/People.html#/s:8Mixpanel6PeopleC12clearChargesyyF":{"name":"clearCharges()","abstract":"
Delete current user’s revenue history.
","parent_name":"People"},"Classes/People.html#/s:8Mixpanel6PeopleC10deleteUseryyF":{"name":"deleteUser()","abstract":"Delete current user’s record from Mixpanel People.
","parent_name":"People"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC8apiTokenSSvp":{"name":"apiToken","abstract":"apiToken string that identifies the project to track data to
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC8delegateAA0A8Delegate_pSgvp":{"name":"delegate","abstract":"The a MixpanelDelegate object that gives control over Mixpanel network activity.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC10distinctIdSSvp":{"name":"distinctId","abstract":"distinctId string that uniquely identifies the current user.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC11anonymousIdSSSgvp":{"name":"anonymousId","abstract":"anonymousId string that uniquely identifies the device.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC6userIdSSSgvp":{"name":"userId","abstract":"userId string that identify is called with.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC22hadPersistedDistinctIdSbSgvp":{"name":"hadPersistedDistinctId","abstract":"hadPersistedDistinctId is a boolean value which specifies that the stored distinct_id","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC5aliasSSSgvp":{"name":"alias","abstract":"
alias string that uniquely identifies the current user.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC6peopleAA6PeopleCSgvp":{"name":"people","abstract":"Accessor to the Mixpanel People API object.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC28showNetworkActivityIndicatorSbvp":{"name":"showNetworkActivityIndicator","abstract":"Controls whether to show spinning network activity indicator when flushing","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC27trackAutomaticEventsEnabledSbvp":{"name":"trackAutomaticEventsEnabled","abstract":"
This allows enabling or disabling collecting common mobile events,
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC13flushIntervalSdvp":{"name":"flushInterval","abstract":"Flush timer’s interval.","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC17flushOnBackgroundSbvp":{"name":"flushOnBackground","abstract":"
Control whether the library should flush data to Mixpanel when the app","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC26useIPAddressForGeoLocationSbvp":{"name":"useIPAddressForGeoLocation","abstract":"
Controls whether to automatically send the client IP Address as part of","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC9serverURLSSvp":{"name":"serverURL","abstract":"
The base URL used for Mixpanel API requests.","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:s28CustomDebugStringConvertibleP16debugDescriptionSSvp":{"name":"debugDescription","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC14loggingEnabledSbvp":{"name":"loggingEnabled","abstract":"
This allows enabling or disabling of all Mixpanel logs at run time.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC4nameSSvp":{"name":"name","abstract":"A unique identifier for this MixpanelInstance
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC22minimumSessionDurations6UInt64Vvp":{"name":"minimumSessionDuration","abstract":"Undocumented
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC22maximumSessionDurations6UInt64Vvp":{"name":"maximumSessionDuration","abstract":"The maximum session duration (ms) that is tracked in automatic events.","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC8identify10distinctId9usePeople10completionySS_SbyycSgtF":{"name":"identify(distinctId:usePeople:completion:)","abstract":"
Sets the distinct ID of the current user.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC11createAlias_10distinctId9usePeople11andIdentify10completionySS_SSS2byycSgtF":{"name":"createAlias(_:distinctId:usePeople:andIdentify:completion:)","abstract":"The alias method creates an alias which Mixpanel will use to remap one id to another.","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC5reset10completionyyycSg_tF":{"name":"reset(completion:)","abstract":"
Clears all stored properties including the distinct Id.","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC7archiveyyF":{"name":"archive()","abstract":"
Undocumented
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC5flush16performFullFlush10completionySb_yycSgtF":{"name":"flush(performFullFlush:completion:)","abstract":"Uploads queued data to the Mixpanel server.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC5track5event10propertiesySSSg_SDySSAA0A4Type_pGSgtF":{"name":"track(event:properties:)","abstract":"Tracks an event with properties.","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC15trackWithGroups5event10properties6groupsySSSg_SDySSAA0A4Type_pGSgAKtF":{"name":"trackWithGroups(event:properties:groups:)","abstract":"
Tracks an event with properties and to specific groups.","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC8getGroup8groupKey0E2IDAA0D0CSS_AA0A4Type_ptF":{"name":"getGroup(groupKey:groupID:)","abstract":"
Undocumented
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC4time5eventySS_tF":{"name":"time(event:)","abstract":"Starts a timer that will be stopped and added as a property when a","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC16eventElapsedTime0C0SdSS_tF":{"name":"eventElapsedTime(event:)","abstract":"
Retrieves the time elapsed for the named event since time(event:) was called.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC16clearTimedEventsyyF":{"name":"clearTimedEvents()","abstract":"Clears all current event timers.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC15clearTimedEvent5eventySS_tF":{"name":"clearTimedEvent(event:)","abstract":"Clears the event timer for the named event.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC22currentSuperPropertiesSDySSypGyF":{"name":"currentSuperProperties()","abstract":"Returns the currently set super properties.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC20clearSuperPropertiesyyF":{"name":"clearSuperProperties()","abstract":"Clears all currently set super properties.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC23registerSuperPropertiesyySDySSAA0A4Type_pGF":{"name":"registerSuperProperties(_:)","abstract":"Registers super properties, overwriting ones that have already been set.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC27registerSuperPropertiesOnce_12defaultValueySDySSAA0A4Type_pG_AaF_pSgtF":{"name":"registerSuperPropertiesOnce(_:defaultValue:)","abstract":"Registers super properties without overwriting ones that have already been set,","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC23unregisterSuperPropertyyySSF":{"name":"unregisterSuperProperty(_:)","abstract":"
Removes a previously registered super property.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC8setGroup8groupKey0E2IDySS_AA0A4Type_ptF":{"name":"setGroup(groupKey:groupID:)","abstract":"Convenience method to set a single group the user belongs to.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC8setGroup8groupKey0E3IDsySS_SayAA0A4Type_pGtF":{"name":"setGroup(groupKey:groupIDs:)","abstract":"Set the groups this user belongs to.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC8addGroup8groupKey0E2IDySS_AA0A4Type_ptF":{"name":"addGroup(groupKey:groupID:)","abstract":"Add a group to this user’s membership for a particular group key
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC11removeGroup8groupKey0E2IDySS_AA0A4Type_ptF":{"name":"removeGroup(groupKey:groupID:)","abstract":"Remove a group from this user’s membership for a particular group key
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC14optOutTrackingyyF":{"name":"optOutTracking()","abstract":"Opt out tracking.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC13optInTracking10distinctId10propertiesySSSg_SDySSAA0A4Type_pGSgtF":{"name":"optInTracking(distinctId:properties:)","abstract":"Opt in tracking.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC19hasOptedOutTrackingSbyF":{"name":"hasOptedOutTracking()","abstract":"Returns if the current user has opted out tracking.
","parent_name":"MixpanelInstance"},"Classes/Mixpanel.html#/s:8MixpanelAAC10initialize5token20trackAutomaticEvents13flushInterval12instanceName23optOutTrackingByDefault19useUniqueDistinctId15superProperties9serverURLAA0A8InstanceCSS_SbSdSSSgS2bSDySSAA0A4Type_pGSgANtFZ":{"name":"initialize(token:trackAutomaticEvents:flushInterval:instanceName:optOutTrackingByDefault:useUniqueDistinctId:superProperties:serverURL:)","abstract":"Initializes an instance of the API with the given project token.
","parent_name":"Mixpanel"},"Classes/Mixpanel.html#/initialize(token:flushInterval:instanceName:optOutTrackingByDefault:useUniqueDistinctId:superProperties:serverURL:)":{"name":"initialize(token:flushInterval:instanceName:optOutTrackingByDefault:useUniqueDistinctId:superProperties:serverURL:)","abstract":"Initializes an instance of the API with the given project token (MAC OS ONLY).
","parent_name":"Mixpanel"},"Classes/Mixpanel.html#/s:8MixpanelAAC11getInstance4nameAA0aC0CSgSS_tFZ":{"name":"getInstance(name:)","abstract":"Gets the mixpanel instance with the given name
","parent_name":"Mixpanel"},"Classes/Mixpanel.html#/s:8MixpanelAAC12mainInstanceAA0aC0CyFZ":{"name":"mainInstance()","abstract":"Returns the main instance that was initialized.
","parent_name":"Mixpanel"},"Classes/Mixpanel.html#/s:8MixpanelAAC15setMainInstance4nameySS_tFZ":{"name":"setMainInstance(name:)","abstract":"Sets the main instance based on the instance name
","parent_name":"Mixpanel"},"Classes/Mixpanel.html#/s:8MixpanelAAC14removeInstance4nameySS_tFZ":{"name":"removeInstance(name:)","abstract":"Removes an unneeded Mixpanel instance based on its name
","parent_name":"Mixpanel"},"Classes/Group.html#/s:8Mixpanel5GroupC3set10propertiesySDySSAA0A4Type_pG_tF":{"name":"set(properties:)","abstract":"Sets properties on this group.
","parent_name":"Group"},"Classes/Group.html#/s:8Mixpanel5GroupC3set8property2toySS_AA0A4Type_ptF":{"name":"set(property:to:)","abstract":"Convenience method for setting a single property in Mixpanel Groups.
","parent_name":"Group"},"Classes/Group.html#/s:8Mixpanel5GroupC7setOnce10propertiesySDySSAA0A4Type_pG_tF":{"name":"setOnce(properties:)","abstract":"Sets properties on the current Mixpanel Group, but doesn’t overwrite if","parent_name":"Group"},"Classes/Group.html#/s:8Mixpanel5GroupC5unset8propertyySS_tF":{"name":"unset(property:)","abstract":"
Remove a property and its value from a group’s profile in Mixpanel Groups.
","parent_name":"Group"},"Classes/Group.html#/s:8Mixpanel5GroupC6remove3key5valueySS_AA0A4Type_ptF":{"name":"remove(key:value:)","abstract":"Removes list properties.
","parent_name":"Group"},"Classes/Group.html#/s:8Mixpanel5GroupC5union3key6valuesySS_SayAA0A4Type_pGtF":{"name":"union(key:values:)","abstract":"Union list properties.
","parent_name":"Group"},"Classes/Group.html#/s:8Mixpanel5GroupC06deleteB0yyF":{"name":"deleteGroup()","abstract":"Delete group’s record from Mixpanel Groups.
","parent_name":"Group"},"Classes/Group.html":{"name":"Group","abstract":"Access to the Mixpanel Groups API, available through the getGroup function from"},"Classes/Mixpanel.html":{"name":"Mixpanel","abstract":"
The primary class for integrating Mixpanel with your app.
"},"Classes/MixpanelInstance.html":{"name":"MixpanelInstance","abstract":"The class that represents the Mixpanel Instance
"},"Classes/People.html":{"name":"People","abstract":"Access to the Mixpanel People API, available as an accessible variable from"},"Classes.html":{"name":"Classes","abstract":"
The following classes are available globally.
"},"Extensions.html":{"name":"Extensions","abstract":"The following extensions are available globally.
"},"Protocols.html":{"name":"Protocols","abstract":"The following protocols are available globally.
"},"Typealiases.html":{"name":"Type Aliases","abstract":"The following type aliases are available globally.
"}} \ No newline at end of file +{"Typealiases.html#/Properties":{"name":"Properties"},"Protocols/MixpanelType.html#/isValidNestedTypeAndValue()":{"name":"isValidNestedTypeAndValue()","abstract":"Checks if this object has nested object types that Mixpanel supports.
","parent_name":"MixpanelType"},"Protocols/MixpanelType.html#/equals(rhs:)":{"name":"equals(rhs:)","parent_name":"MixpanelType"},"Protocols/MixpanelDelegate.html#/mixpanelWillFlush(_:)":{"name":"mixpanelWillFlush(_:)","abstract":"Asks the delegate if data should be uploaded to the server.
","parent_name":"MixpanelDelegate"},"Protocols/MixpanelDelegate.html":{"name":"MixpanelDelegate","abstract":"Delegate protocol for controlling the Mixpanel API’s network behavior.
"},"Protocols/MixpanelType.html":{"name":"MixpanelType","abstract":"Property keys must be String objects and the supported value types need to conform to MixpanelType."},"Extensions/Dictionary.html#/isValidNestedTypeAndValue()":{"name":"isValidNestedTypeAndValue()","abstract":"
Checks if this object has nested object types that Mixpanel supports.
","parent_name":"Dictionary"},"Extensions/Dictionary.html#/equals(rhs:)":{"name":"equals(rhs:)","parent_name":"Dictionary"},"Extensions/NSArray.html#/isValidNestedTypeAndValue()":{"name":"isValidNestedTypeAndValue()","abstract":"Checks if this object has nested object types that Mixpanel supports.
","parent_name":"NSArray"},"Extensions/NSArray.html#/equals(rhs:)":{"name":"equals(rhs:)","parent_name":"NSArray"},"Extensions/Array.html#/isValidNestedTypeAndValue()":{"name":"isValidNestedTypeAndValue()","abstract":"Checks if this object has nested object types that Mixpanel supports.
","parent_name":"Array"},"Extensions/Array.html#/equals(rhs:)":{"name":"equals(rhs:)","parent_name":"Array"},"Extensions/NSNull.html#/isValidNestedTypeAndValue()":{"name":"isValidNestedTypeAndValue()","abstract":"Checks if this object has nested object types that Mixpanel supports.","parent_name":"NSNull"},"Extensions/NSNull.html#/equals(rhs:)":{"name":"equals(rhs:)","parent_name":"NSNull"},"Extensions/URL.html#/isValidNestedTypeAndValue()":{"name":"isValidNestedTypeAndValue()","abstract":"
Checks if this object has nested object types that Mixpanel supports.","parent_name":"URL"},"Extensions/URL.html#/equals(rhs:)":{"name":"equals(rhs:)","parent_name":"URL"},"Extensions/Date.html#/isValidNestedTypeAndValue()":{"name":"isValidNestedTypeAndValue()","abstract":"
Checks if this object has nested object types that Mixpanel supports.","parent_name":"Date"},"Extensions/Date.html#/equals(rhs:)":{"name":"equals(rhs:)","parent_name":"Date"},"Extensions/Bool.html#/isValidNestedTypeAndValue()":{"name":"isValidNestedTypeAndValue()","abstract":"
Checks if this object has nested object types that Mixpanel supports.","parent_name":"Bool"},"Extensions/Bool.html#/equals(rhs:)":{"name":"equals(rhs:)","parent_name":"Bool"},"Extensions/Float.html#/isValidNestedTypeAndValue()":{"name":"isValidNestedTypeAndValue()","abstract":"
Checks if this object has nested object types that Mixpanel supports.","parent_name":"Float"},"Extensions/Float.html#/equals(rhs:)":{"name":"equals(rhs:)","parent_name":"Float"},"Extensions/Double.html#/isValidNestedTypeAndValue()":{"name":"isValidNestedTypeAndValue()","abstract":"
Checks if this object has nested object types that Mixpanel supports.","parent_name":"Double"},"Extensions/Double.html#/equals(rhs:)":{"name":"equals(rhs:)","parent_name":"Double"},"Extensions/UInt.html#/isValidNestedTypeAndValue()":{"name":"isValidNestedTypeAndValue()","abstract":"
Checks if this object has nested object types that Mixpanel supports.","parent_name":"UInt"},"Extensions/UInt.html#/equals(rhs:)":{"name":"equals(rhs:)","parent_name":"UInt"},"Extensions/Int.html#/isValidNestedTypeAndValue()":{"name":"isValidNestedTypeAndValue()","abstract":"
Checks if this object has nested object types that Mixpanel supports.","parent_name":"Int"},"Extensions/Int.html#/equals(rhs:)":{"name":"equals(rhs:)","parent_name":"Int"},"Extensions/NSNumber.html#/isValidNestedTypeAndValue()":{"name":"isValidNestedTypeAndValue()","abstract":"
Checks if this object has nested object types that Mixpanel supports.","parent_name":"NSNumber"},"Extensions/NSNumber.html#/equals(rhs:)":{"name":"equals(rhs:)","parent_name":"NSNumber"},"Extensions/NSString.html#/isValidNestedTypeAndValue()":{"name":"isValidNestedTypeAndValue()","abstract":"
Checks if this object has nested object types that Mixpanel supports.","parent_name":"NSString"},"Extensions/NSString.html#/equals(rhs:)":{"name":"equals(rhs:)","parent_name":"NSString"},"Extensions/String.html#/isValidNestedTypeAndValue()":{"name":"isValidNestedTypeAndValue()","abstract":"
Checks if this object has nested object types that Mixpanel supports.","parent_name":"String"},"Extensions/String.html#/equals(rhs:)":{"name":"equals(rhs:)","parent_name":"String"},"Extensions/Optional.html#/isValidNestedTypeAndValue()":{"name":"isValidNestedTypeAndValue()","abstract":"
Checks if this object has nested object types that Mixpanel supports.
","parent_name":"Optional"},"Extensions/Optional.html#/equals(rhs:)":{"name":"equals(rhs:)","parent_name":"Optional"},"Extensions/Optional.html":{"name":"Optional"},"Extensions/String.html":{"name":"String"},"Extensions/NSString.html":{"name":"NSString"},"Extensions/NSNumber.html":{"name":"NSNumber"},"Extensions/Int.html":{"name":"Int"},"Extensions/UInt.html":{"name":"UInt"},"Extensions/Double.html":{"name":"Double"},"Extensions/Float.html":{"name":"Float"},"Extensions/Bool.html":{"name":"Bool"},"Extensions/Date.html":{"name":"Date"},"Extensions/URL.html":{"name":"URL"},"Extensions/NSNull.html":{"name":"NSNull"},"Extensions/Array.html":{"name":"Array"},"Extensions/NSArray.html":{"name":"NSArray"},"Extensions/Dictionary.html":{"name":"Dictionary"},"Classes/People.html#/ignoreTime":{"name":"ignoreTime","abstract":"controls the $ignore_time property in any subsequent MixpanelPeople operation.","parent_name":"People"},"Classes/People.html#/set(properties:)":{"name":"set(properties:)","abstract":"
Set properties on the current user in Mixpanel People.
","parent_name":"People"},"Classes/People.html#/set(property:to:)":{"name":"set(property:to:)","abstract":"Convenience method for setting a single property in Mixpanel People.
","parent_name":"People"},"Classes/People.html#/setOnce(properties:)":{"name":"setOnce(properties:)","abstract":"Set properties on the current user in Mixpanel People, but doesn’t overwrite if","parent_name":"People"},"Classes/People.html#/unset(properties:)":{"name":"unset(properties:)","abstract":"
Remove a list of properties and their values from the current user’s profile","parent_name":"People"},"Classes/People.html#/increment(properties:)":{"name":"increment(properties:)","abstract":"
Increment the given numeric properties by the given values.
","parent_name":"People"},"Classes/People.html#/increment(property:by:)":{"name":"increment(property:by:)","abstract":"Convenience method for incrementing a single numeric property by the specified","parent_name":"People"},"Classes/People.html#/append(properties:)":{"name":"append(properties:)","abstract":"
Append values to list properties.
","parent_name":"People"},"Classes/People.html#/remove(properties:)":{"name":"remove(properties:)","abstract":"Removes list properties.
","parent_name":"People"},"Classes/People.html#/union(properties:)":{"name":"union(properties:)","abstract":"Union list properties.
","parent_name":"People"},"Classes/People.html#/trackCharge(amount:properties:)":{"name":"trackCharge(amount:properties:)","abstract":"Track money spent by the current user for revenue analytics and associate","parent_name":"People"},"Classes/People.html#/clearCharges()":{"name":"clearCharges()","abstract":"
Delete current user’s revenue history.
","parent_name":"People"},"Classes/People.html#/deleteUser()":{"name":"deleteUser()","abstract":"Delete current user’s record from Mixpanel People.
","parent_name":"People"},"Classes/MixpanelInstance.html#/apiToken":{"name":"apiToken","abstract":"apiToken string that identifies the project to track data to
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/delegate":{"name":"delegate","abstract":"The a MixpanelDelegate object that gives control over Mixpanel network activity.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/distinctId":{"name":"distinctId","abstract":"distinctId string that uniquely identifies the current user.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/anonymousId":{"name":"anonymousId","abstract":"anonymousId string that uniquely identifies the device.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/userId":{"name":"userId","abstract":"userId string that identify is called with.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/hadPersistedDistinctId":{"name":"hadPersistedDistinctId","abstract":"hadPersistedDistinctId is a boolean value which specifies that the stored distinct_id","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/alias":{"name":"alias","abstract":"
alias string that uniquely identifies the current user.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/people":{"name":"people","abstract":"Accessor to the Mixpanel People API object.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/showNetworkActivityIndicator":{"name":"showNetworkActivityIndicator","abstract":"Controls whether to show spinning network activity indicator when flushing","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/trackAutomaticEventsEnabled":{"name":"trackAutomaticEventsEnabled","abstract":"
This allows enabling or disabling collecting common mobile events,
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/flushInterval":{"name":"flushInterval","abstract":"Flush timer’s interval.","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/flushOnBackground":{"name":"flushOnBackground","abstract":"
Control whether the library should flush data to Mixpanel when the app","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/useIPAddressForGeoLocation":{"name":"useIPAddressForGeoLocation","abstract":"
Controls whether to automatically send the client IP Address as part of","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/serverURL":{"name":"serverURL","abstract":"
The base URL used for Mixpanel API requests.","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/debugDescription":{"name":"debugDescription","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/loggingEnabled":{"name":"loggingEnabled","abstract":"
This allows enabling or disabling of all Mixpanel logs at run time.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/name":{"name":"name","abstract":"A unique identifier for this MixpanelInstance
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/minimumSessionDuration":{"name":"minimumSessionDuration","abstract":"The minimum session duration (ms) that is tracked in automatic events.","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/maximumSessionDuration":{"name":"maximumSessionDuration","abstract":"
The maximum session duration (ms) that is tracked in automatic events.","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/identify(distinctId:usePeople:completion:)":{"name":"identify(distinctId:usePeople:completion:)","abstract":"
Sets the distinct ID of the current user.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/createAlias(_:distinctId:usePeople:andIdentify:completion:)":{"name":"createAlias(_:distinctId:usePeople:andIdentify:completion:)","abstract":"The alias method creates an alias which Mixpanel will use to remap one id to another.","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/reset(completion:)":{"name":"reset(completion:)","abstract":"
Clears all stored properties including the distinct Id.","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/archive()":{"name":"archive()","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/flush(performFullFlush:completion:)":{"name":"flush(performFullFlush:completion:)","abstract":"
Uploads queued data to the Mixpanel server.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/track(event:properties:)":{"name":"track(event:properties:)","abstract":"Tracks an event with properties.","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/trackWithGroups(event:properties:groups:)":{"name":"trackWithGroups(event:properties:groups:)","abstract":"
Tracks an event with properties and to specific groups.","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/getGroup(groupKey:groupID:)":{"name":"getGroup(groupKey:groupID:)","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/time(event:)":{"name":"time(event:)","abstract":"
Starts a timer that will be stopped and added as a property when a","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/eventElapsedTime(event:)":{"name":"eventElapsedTime(event:)","abstract":"
Retrieves the time elapsed for the named event since time(event:) was called.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/clearTimedEvents()":{"name":"clearTimedEvents()","abstract":"Clears all current event timers.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/clearTimedEvent(event:)":{"name":"clearTimedEvent(event:)","abstract":"Clears the event timer for the named event.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/currentSuperProperties()":{"name":"currentSuperProperties()","abstract":"Returns the currently set super properties.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/clearSuperProperties()":{"name":"clearSuperProperties()","abstract":"Clears all currently set super properties.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/registerSuperProperties(_:)":{"name":"registerSuperProperties(_:)","abstract":"Registers super properties, overwriting ones that have already been set.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/registerSuperPropertiesOnce(_:defaultValue:)":{"name":"registerSuperPropertiesOnce(_:defaultValue:)","abstract":"Registers super properties without overwriting ones that have already been set,","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/unregisterSuperProperty(_:)":{"name":"unregisterSuperProperty(_:)","abstract":"
Removes a previously registered super property.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/setGroup(groupKey:groupID:)":{"name":"setGroup(groupKey:groupID:)","abstract":"Convenience method to set a single group the user belongs to.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/setGroup(groupKey:groupIDs:)":{"name":"setGroup(groupKey:groupIDs:)","abstract":"Set the groups this user belongs to.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/addGroup(groupKey:groupID:)":{"name":"addGroup(groupKey:groupID:)","abstract":"Add a group to this user’s membership for a particular group key
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/removeGroup(groupKey:groupID:)":{"name":"removeGroup(groupKey:groupID:)","abstract":"Remove a group from this user’s membership for a particular group key
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/optOutTracking()":{"name":"optOutTracking()","abstract":"Opt out tracking.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/optInTracking(distinctId:properties:)":{"name":"optInTracking(distinctId:properties:)","abstract":"Opt in tracking.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/hasOptedOutTracking()":{"name":"hasOptedOutTracking()","abstract":"Returns if the current user has opted out tracking.
","parent_name":"MixpanelInstance"},"Classes/Mixpanel.html#/initialize(token:trackAutomaticEvents:flushInterval:instanceName:optOutTrackingByDefault:useUniqueDistinctId:superProperties:serverURL:)":{"name":"initialize(token:trackAutomaticEvents:flushInterval:instanceName:optOutTrackingByDefault:useUniqueDistinctId:superProperties:serverURL:)","abstract":"Initializes an instance of the API with the given project token.
","parent_name":"Mixpanel"},"Classes/Mixpanel.html#/initialize(token:flushInterval:instanceName:optOutTrackingByDefault:useUniqueDistinctId:superProperties:serverURL:)":{"name":"initialize(token:flushInterval:instanceName:optOutTrackingByDefault:useUniqueDistinctId:superProperties:serverURL:)","abstract":"Initializes an instance of the API with the given project token (MAC OS ONLY).
","parent_name":"Mixpanel"},"Classes/Mixpanel.html#/getInstance(name:)":{"name":"getInstance(name:)","abstract":"Gets the mixpanel instance with the given name
","parent_name":"Mixpanel"},"Classes/Mixpanel.html#/mainInstance()":{"name":"mainInstance()","abstract":"Returns the main instance that was initialized.
","parent_name":"Mixpanel"},"Classes/Mixpanel.html#/setMainInstance(name:)":{"name":"setMainInstance(name:)","abstract":"Sets the main instance based on the instance name
","parent_name":"Mixpanel"},"Classes/Mixpanel.html#/removeInstance(name:)":{"name":"removeInstance(name:)","abstract":"Removes an unneeded Mixpanel instance based on its name
","parent_name":"Mixpanel"},"Classes/Group.html#/set(properties:)":{"name":"set(properties:)","abstract":"Sets properties on this group.
","parent_name":"Group"},"Classes/Group.html#/set(property:to:)":{"name":"set(property:to:)","abstract":"Convenience method for setting a single property in Mixpanel Groups.
","parent_name":"Group"},"Classes/Group.html#/setOnce(properties:)":{"name":"setOnce(properties:)","abstract":"Sets properties on the current Mixpanel Group, but doesn’t overwrite if","parent_name":"Group"},"Classes/Group.html#/unset(property:)":{"name":"unset(property:)","abstract":"
Remove a property and its value from a group’s profile in Mixpanel Groups.
","parent_name":"Group"},"Classes/Group.html#/remove(key:value:)":{"name":"remove(key:value:)","abstract":"Removes list properties.
","parent_name":"Group"},"Classes/Group.html#/union(key:values:)":{"name":"union(key:values:)","abstract":"Union list properties.
","parent_name":"Group"},"Classes/Group.html#/deleteGroup()":{"name":"deleteGroup()","abstract":"Delete group’s record from Mixpanel Groups.
","parent_name":"Group"},"Classes/Group.html":{"name":"Group","abstract":"Access to the Mixpanel Groups API, available through the getGroup function from"},"Classes/Mixpanel.html":{"name":"Mixpanel","abstract":"
The primary class for integrating Mixpanel with your app.
"},"Classes/MixpanelInstance.html":{"name":"MixpanelInstance","abstract":"The class that represents the Mixpanel Instance
"},"Classes/People.html":{"name":"People","abstract":"Access to the Mixpanel People API, available as an accessible variable from"},"Classes.html":{"name":"Classes","abstract":"
The following classes are available globally.
"},"Extensions.html":{"name":"Extensions","abstract":"The following extensions are available globally.
"},"Protocols.html":{"name":"Protocols","abstract":"The following protocols are available globally.
"},"Typealiases.html":{"name":"Type Aliases","abstract":"The following type aliases are available globally.
"}} \ No newline at end of file diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/docSet.dsidx b/docs/docsets/Mixpanel.docset/Contents/Resources/docSet.dsidx index 391f9a6e..8fd6afc0 100644 Binary files a/docs/docsets/Mixpanel.docset/Contents/Resources/docSet.dsidx and b/docs/docsets/Mixpanel.docset/Contents/Resources/docSet.dsidx differ diff --git a/docs/docsets/Mixpanel.tgz b/docs/docsets/Mixpanel.tgz index 02fafc67..9a940021 100644 Binary files a/docs/docsets/Mixpanel.tgz and b/docs/docsets/Mixpanel.tgz differ diff --git a/docs/index.html b/docs/index.html index 2167b58c..d45f986a 100644 --- a/docs/index.html +++ b/docs/index.html @@ -16,7 +16,7 @@Mixpanel 4.1.2 Docs (83% documented)
+Mixpanel 4.1.3 Docs (0% documented)
Why aren’t my events showing up?
-To preserve battery life and customer bandwidth, the Mixpanel library doesn’t send the events you record immediately. Instead, it sends batches to the Mixpanel servers every 60 seconds while your application is running, as well as when the application transitions to the background. You can call flush() manually if you want to force a flush at a particular moment.
+First, make sure your test device has internet access. To preserve battery life and customer bandwidth, the Mixpanel library doesn’t send the events you record immediately. Instead, it sends batches to the Mixpanel servers every 60 seconds while your application is running, as well as when the application transitions to the background. You can call flush() manually if you want to force a flush at a particular moment.
Mixpanel.mainInstance().flush()
@@ -288,7 +288,7 @@ Undocumented
"},"Protocols/MixpanelType.html#/s:8Mixpanel0A4TypeP013isValidNestedB8AndValueSbyF":{"name":"isValidNestedTypeAndValue()","abstract":"Checks if this object has nested object types that Mixpanel supports.
","parent_name":"MixpanelType"},"Protocols/MixpanelType.html#/s:8Mixpanel0A4TypeP6equals3rhsSbAaB_p_tF":{"name":"equals(rhs:)","abstract":"Undocumented
","parent_name":"MixpanelType"},"Protocols/MixpanelDelegate.html#/s:8Mixpanel0A8DelegateP17mixpanelWillFlushySbAA0A8InstanceCF":{"name":"mixpanelWillFlush(_:)","abstract":"Asks the delegate if data should be uploaded to the server.
","parent_name":"MixpanelDelegate"},"Protocols/MixpanelDelegate.html":{"name":"MixpanelDelegate","abstract":"Delegate protocol for controlling the Mixpanel API’s network behavior.
"},"Protocols/MixpanelType.html":{"name":"MixpanelType","abstract":"Property keys must be String objects and the supported value types need to conform to MixpanelType."},"Extensions/Dictionary.html#/s:SD8MixpanelE25isValidNestedTypeAndValueSbyF":{"name":"isValidNestedTypeAndValue()","abstract":"
Checks if this object has nested object types that Mixpanel supports.
","parent_name":"Dictionary"},"Extensions/Dictionary.html#/s:SD8MixpanelE6equals3rhsSbAA0A4Type_p_tF":{"name":"equals(rhs:)","abstract":"Undocumented
","parent_name":"Dictionary"},"Extensions/NSArray.html#/s:So7NSArrayC8MixpanelE25isValidNestedTypeAndValueSbyF":{"name":"isValidNestedTypeAndValue()","abstract":"Checks if this object has nested object types that Mixpanel supports.
","parent_name":"NSArray"},"Extensions/NSArray.html#/s:So7NSArrayC8MixpanelE6equals3rhsSbAC0B4Type_p_tF":{"name":"equals(rhs:)","abstract":"Undocumented
","parent_name":"NSArray"},"Extensions/Array.html#/s:Sa8MixpanelE25isValidNestedTypeAndValueSbyF":{"name":"isValidNestedTypeAndValue()","abstract":"Checks if this object has nested object types that Mixpanel supports.
","parent_name":"Array"},"Extensions/Array.html#/s:Sa8MixpanelE6equals3rhsSbAA0A4Type_p_tF":{"name":"equals(rhs:)","abstract":"Undocumented
","parent_name":"Array"},"Extensions/NSNull.html#/s:So6NSNullC8MixpanelE25isValidNestedTypeAndValueSbyF":{"name":"isValidNestedTypeAndValue()","abstract":"Checks if this object has nested object types that Mixpanel supports.","parent_name":"NSNull"},"Extensions/NSNull.html#/s:So6NSNullC8MixpanelE6equals3rhsSbAC0B4Type_p_tF":{"name":"equals(rhs:)","abstract":"
Undocumented
","parent_name":"NSNull"},"Extensions/URL.html#/s:10Foundation3URLV8MixpanelE25isValidNestedTypeAndValueSbyF":{"name":"isValidNestedTypeAndValue()","abstract":"Checks if this object has nested object types that Mixpanel supports.","parent_name":"URL"},"Extensions/URL.html#/s:10Foundation3URLV8MixpanelE6equals3rhsSbAD0C4Type_p_tF":{"name":"equals(rhs:)","abstract":"
Undocumented
","parent_name":"URL"},"Extensions/Date.html#/s:10Foundation4DateV8MixpanelE25isValidNestedTypeAndValueSbyF":{"name":"isValidNestedTypeAndValue()","abstract":"Checks if this object has nested object types that Mixpanel supports.","parent_name":"Date"},"Extensions/Date.html#/s:10Foundation4DateV8MixpanelE6equals3rhsSbAD0C4Type_p_tF":{"name":"equals(rhs:)","abstract":"
Undocumented
","parent_name":"Date"},"Extensions/Bool.html#/s:Sb8MixpanelE25isValidNestedTypeAndValueSbyF":{"name":"isValidNestedTypeAndValue()","abstract":"Checks if this object has nested object types that Mixpanel supports.","parent_name":"Bool"},"Extensions/Bool.html#/s:Sb8MixpanelE6equals3rhsSbAA0A4Type_p_tF":{"name":"equals(rhs:)","abstract":"
Undocumented
","parent_name":"Bool"},"Extensions/Float.html#/s:Sf8MixpanelE25isValidNestedTypeAndValueSbyF":{"name":"isValidNestedTypeAndValue()","abstract":"Checks if this object has nested object types that Mixpanel supports.","parent_name":"Float"},"Extensions/Float.html#/s:Sf8MixpanelE6equals3rhsSbAA0A4Type_p_tF":{"name":"equals(rhs:)","abstract":"
Undocumented
","parent_name":"Float"},"Extensions/Double.html#/s:Sd8MixpanelE25isValidNestedTypeAndValueSbyF":{"name":"isValidNestedTypeAndValue()","abstract":"Checks if this object has nested object types that Mixpanel supports.","parent_name":"Double"},"Extensions/Double.html#/s:Sd8MixpanelE6equals3rhsSbAA0A4Type_p_tF":{"name":"equals(rhs:)","abstract":"
Undocumented
","parent_name":"Double"},"Extensions/UInt.html#/s:Su8MixpanelE25isValidNestedTypeAndValueSbyF":{"name":"isValidNestedTypeAndValue()","abstract":"Checks if this object has nested object types that Mixpanel supports.","parent_name":"UInt"},"Extensions/UInt.html#/s:Su8MixpanelE6equals3rhsSbAA0A4Type_p_tF":{"name":"equals(rhs:)","abstract":"
Undocumented
","parent_name":"UInt"},"Extensions/Int.html#/s:Si8MixpanelE25isValidNestedTypeAndValueSbyF":{"name":"isValidNestedTypeAndValue()","abstract":"Checks if this object has nested object types that Mixpanel supports.","parent_name":"Int"},"Extensions/Int.html#/s:Si8MixpanelE6equals3rhsSbAA0A4Type_p_tF":{"name":"equals(rhs:)","abstract":"
Undocumented
","parent_name":"Int"},"Extensions/NSNumber.html#/s:So8NSNumberC8MixpanelE25isValidNestedTypeAndValueSbyF":{"name":"isValidNestedTypeAndValue()","abstract":"Checks if this object has nested object types that Mixpanel supports.","parent_name":"NSNumber"},"Extensions/NSNumber.html#/s:So8NSNumberC8MixpanelE6equals3rhsSbAC0B4Type_p_tF":{"name":"equals(rhs:)","abstract":"
Undocumented
","parent_name":"NSNumber"},"Extensions/NSString.html#/s:So8NSStringC8MixpanelE25isValidNestedTypeAndValueSbyF":{"name":"isValidNestedTypeAndValue()","abstract":"Checks if this object has nested object types that Mixpanel supports.","parent_name":"NSString"},"Extensions/NSString.html#/s:So8NSStringC8MixpanelE6equals3rhsSbAC0B4Type_p_tF":{"name":"equals(rhs:)","abstract":"
Undocumented
","parent_name":"NSString"},"Extensions/String.html#/s:SS8MixpanelE25isValidNestedTypeAndValueSbyF":{"name":"isValidNestedTypeAndValue()","abstract":"Checks if this object has nested object types that Mixpanel supports.","parent_name":"String"},"Extensions/String.html#/s:SS8MixpanelE6equals3rhsSbAA0A4Type_p_tF":{"name":"equals(rhs:)","abstract":"
Undocumented
","parent_name":"String"},"Extensions/Optional.html#/s:Sq8MixpanelE25isValidNestedTypeAndValueSbyF":{"name":"isValidNestedTypeAndValue()","abstract":"Checks if this object has nested object types that Mixpanel supports.
","parent_name":"Optional"},"Extensions/Optional.html#/s:Sq8MixpanelE6equals3rhsSbAA0A4Type_p_tF":{"name":"equals(rhs:)","abstract":"Undocumented
","parent_name":"Optional"},"Extensions/Optional.html":{"name":"Optional"},"Extensions/String.html":{"name":"String"},"Extensions/NSString.html":{"name":"NSString"},"Extensions/NSNumber.html":{"name":"NSNumber"},"Extensions/Int.html":{"name":"Int"},"Extensions/UInt.html":{"name":"UInt"},"Extensions/Double.html":{"name":"Double"},"Extensions/Float.html":{"name":"Float"},"Extensions/Bool.html":{"name":"Bool"},"Extensions/Date.html":{"name":"Date"},"Extensions/URL.html":{"name":"URL"},"Extensions/NSNull.html":{"name":"NSNull"},"Extensions/Array.html":{"name":"Array"},"Extensions/NSArray.html":{"name":"NSArray"},"Extensions/Dictionary.html":{"name":"Dictionary"},"Classes/People.html#/s:8Mixpanel6PeopleC10ignoreTimeSbvp":{"name":"ignoreTime","abstract":"controls the $ignore_time property in any subsequent MixpanelPeople operation.","parent_name":"People"},"Classes/People.html#/s:8Mixpanel6PeopleC3set10propertiesySDySSAA0A4Type_pG_tF":{"name":"set(properties:)","abstract":"
Set properties on the current user in Mixpanel People.
","parent_name":"People"},"Classes/People.html#/s:8Mixpanel6PeopleC3set8property2toySS_AA0A4Type_ptF":{"name":"set(property:to:)","abstract":"Convenience method for setting a single property in Mixpanel People.
","parent_name":"People"},"Classes/People.html#/s:8Mixpanel6PeopleC7setOnce10propertiesySDySSAA0A4Type_pG_tF":{"name":"setOnce(properties:)","abstract":"Set properties on the current user in Mixpanel People, but doesn’t overwrite if","parent_name":"People"},"Classes/People.html#/s:8Mixpanel6PeopleC5unset10propertiesySaySSG_tF":{"name":"unset(properties:)","abstract":"
Remove a list of properties and their values from the current user’s profile","parent_name":"People"},"Classes/People.html#/s:8Mixpanel6PeopleC9increment10propertiesySDySSAA0A4Type_pG_tF":{"name":"increment(properties:)","abstract":"
Increment the given numeric properties by the given values.
","parent_name":"People"},"Classes/People.html#/s:8Mixpanel6PeopleC9increment8property2byySS_SdtF":{"name":"increment(property:by:)","abstract":"Convenience method for incrementing a single numeric property by the specified","parent_name":"People"},"Classes/People.html#/s:8Mixpanel6PeopleC6append10propertiesySDySSAA0A4Type_pG_tF":{"name":"append(properties:)","abstract":"
Append values to list properties.
","parent_name":"People"},"Classes/People.html#/s:8Mixpanel6PeopleC6remove10propertiesySDySSAA0A4Type_pG_tF":{"name":"remove(properties:)","abstract":"Removes list properties.
","parent_name":"People"},"Classes/People.html#/s:8Mixpanel6PeopleC5union10propertiesySDySSAA0A4Type_pG_tF":{"name":"union(properties:)","abstract":"Union list properties.
","parent_name":"People"},"Classes/People.html#/s:8Mixpanel6PeopleC11trackCharge6amount10propertiesySd_SDySSAA0A4Type_pGSgtF":{"name":"trackCharge(amount:properties:)","abstract":"Track money spent by the current user for revenue analytics and associate","parent_name":"People"},"Classes/People.html#/s:8Mixpanel6PeopleC12clearChargesyyF":{"name":"clearCharges()","abstract":"
Delete current user’s revenue history.
","parent_name":"People"},"Classes/People.html#/s:8Mixpanel6PeopleC10deleteUseryyF":{"name":"deleteUser()","abstract":"Delete current user’s record from Mixpanel People.
","parent_name":"People"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC8apiTokenSSvp":{"name":"apiToken","abstract":"apiToken string that identifies the project to track data to
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC8delegateAA0A8Delegate_pSgvp":{"name":"delegate","abstract":"The a MixpanelDelegate object that gives control over Mixpanel network activity.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC10distinctIdSSvp":{"name":"distinctId","abstract":"distinctId string that uniquely identifies the current user.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC11anonymousIdSSSgvp":{"name":"anonymousId","abstract":"anonymousId string that uniquely identifies the device.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC6userIdSSSgvp":{"name":"userId","abstract":"userId string that identify is called with.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC22hadPersistedDistinctIdSbSgvp":{"name":"hadPersistedDistinctId","abstract":"hadPersistedDistinctId is a boolean value which specifies that the stored distinct_id","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC5aliasSSSgvp":{"name":"alias","abstract":"
alias string that uniquely identifies the current user.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC6peopleAA6PeopleCSgvp":{"name":"people","abstract":"Accessor to the Mixpanel People API object.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC28showNetworkActivityIndicatorSbvp":{"name":"showNetworkActivityIndicator","abstract":"Controls whether to show spinning network activity indicator when flushing","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC27trackAutomaticEventsEnabledSbvp":{"name":"trackAutomaticEventsEnabled","abstract":"
This allows enabling or disabling collecting common mobile events,
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC13flushIntervalSdvp":{"name":"flushInterval","abstract":"Flush timer’s interval.","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC17flushOnBackgroundSbvp":{"name":"flushOnBackground","abstract":"
Control whether the library should flush data to Mixpanel when the app","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC26useIPAddressForGeoLocationSbvp":{"name":"useIPAddressForGeoLocation","abstract":"
Controls whether to automatically send the client IP Address as part of","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC9serverURLSSvp":{"name":"serverURL","abstract":"
The base URL used for Mixpanel API requests.","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:s28CustomDebugStringConvertibleP16debugDescriptionSSvp":{"name":"debugDescription","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC14loggingEnabledSbvp":{"name":"loggingEnabled","abstract":"
This allows enabling or disabling of all Mixpanel logs at run time.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC4nameSSvp":{"name":"name","abstract":"A unique identifier for this MixpanelInstance
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC22minimumSessionDurations6UInt64Vvp":{"name":"minimumSessionDuration","abstract":"Undocumented
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC22maximumSessionDurations6UInt64Vvp":{"name":"maximumSessionDuration","abstract":"The maximum session duration (ms) that is tracked in automatic events.","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC8identify10distinctId9usePeople10completionySS_SbyycSgtF":{"name":"identify(distinctId:usePeople:completion:)","abstract":"
Sets the distinct ID of the current user.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC11createAlias_10distinctId9usePeople11andIdentify10completionySS_SSS2byycSgtF":{"name":"createAlias(_:distinctId:usePeople:andIdentify:completion:)","abstract":"The alias method creates an alias which Mixpanel will use to remap one id to another.","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC5reset10completionyyycSg_tF":{"name":"reset(completion:)","abstract":"
Clears all stored properties including the distinct Id.","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC7archiveyyF":{"name":"archive()","abstract":"
Undocumented
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC5flush16performFullFlush10completionySb_yycSgtF":{"name":"flush(performFullFlush:completion:)","abstract":"Uploads queued data to the Mixpanel server.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC5track5event10propertiesySSSg_SDySSAA0A4Type_pGSgtF":{"name":"track(event:properties:)","abstract":"Tracks an event with properties.","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC15trackWithGroups5event10properties6groupsySSSg_SDySSAA0A4Type_pGSgAKtF":{"name":"trackWithGroups(event:properties:groups:)","abstract":"
Tracks an event with properties and to specific groups.","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC8getGroup8groupKey0E2IDAA0D0CSS_AA0A4Type_ptF":{"name":"getGroup(groupKey:groupID:)","abstract":"
Undocumented
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC4time5eventySS_tF":{"name":"time(event:)","abstract":"Starts a timer that will be stopped and added as a property when a","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC16eventElapsedTime0C0SdSS_tF":{"name":"eventElapsedTime(event:)","abstract":"
Retrieves the time elapsed for the named event since time(event:) was called.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC16clearTimedEventsyyF":{"name":"clearTimedEvents()","abstract":"Clears all current event timers.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC15clearTimedEvent5eventySS_tF":{"name":"clearTimedEvent(event:)","abstract":"Clears the event timer for the named event.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC22currentSuperPropertiesSDySSypGyF":{"name":"currentSuperProperties()","abstract":"Returns the currently set super properties.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC20clearSuperPropertiesyyF":{"name":"clearSuperProperties()","abstract":"Clears all currently set super properties.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC23registerSuperPropertiesyySDySSAA0A4Type_pGF":{"name":"registerSuperProperties(_:)","abstract":"Registers super properties, overwriting ones that have already been set.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC27registerSuperPropertiesOnce_12defaultValueySDySSAA0A4Type_pG_AaF_pSgtF":{"name":"registerSuperPropertiesOnce(_:defaultValue:)","abstract":"Registers super properties without overwriting ones that have already been set,","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC23unregisterSuperPropertyyySSF":{"name":"unregisterSuperProperty(_:)","abstract":"
Removes a previously registered super property.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC8setGroup8groupKey0E2IDySS_AA0A4Type_ptF":{"name":"setGroup(groupKey:groupID:)","abstract":"Convenience method to set a single group the user belongs to.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC8setGroup8groupKey0E3IDsySS_SayAA0A4Type_pGtF":{"name":"setGroup(groupKey:groupIDs:)","abstract":"Set the groups this user belongs to.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC8addGroup8groupKey0E2IDySS_AA0A4Type_ptF":{"name":"addGroup(groupKey:groupID:)","abstract":"Add a group to this user’s membership for a particular group key
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC11removeGroup8groupKey0E2IDySS_AA0A4Type_ptF":{"name":"removeGroup(groupKey:groupID:)","abstract":"Remove a group from this user’s membership for a particular group key
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC14optOutTrackingyyF":{"name":"optOutTracking()","abstract":"Opt out tracking.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC13optInTracking10distinctId10propertiesySSSg_SDySSAA0A4Type_pGSgtF":{"name":"optInTracking(distinctId:properties:)","abstract":"Opt in tracking.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC19hasOptedOutTrackingSbyF":{"name":"hasOptedOutTracking()","abstract":"Returns if the current user has opted out tracking.
","parent_name":"MixpanelInstance"},"Classes/Mixpanel.html#/s:8MixpanelAAC10initialize5token20trackAutomaticEvents13flushInterval12instanceName23optOutTrackingByDefault19useUniqueDistinctId15superProperties9serverURLAA0A8InstanceCSS_SbSdSSSgS2bSDySSAA0A4Type_pGSgANtFZ":{"name":"initialize(token:trackAutomaticEvents:flushInterval:instanceName:optOutTrackingByDefault:useUniqueDistinctId:superProperties:serverURL:)","abstract":"Initializes an instance of the API with the given project token.
","parent_name":"Mixpanel"},"Classes/Mixpanel.html#/initialize(token:flushInterval:instanceName:optOutTrackingByDefault:useUniqueDistinctId:superProperties:serverURL:)":{"name":"initialize(token:flushInterval:instanceName:optOutTrackingByDefault:useUniqueDistinctId:superProperties:serverURL:)","abstract":"Initializes an instance of the API with the given project token (MAC OS ONLY).
","parent_name":"Mixpanel"},"Classes/Mixpanel.html#/s:8MixpanelAAC11getInstance4nameAA0aC0CSgSS_tFZ":{"name":"getInstance(name:)","abstract":"Gets the mixpanel instance with the given name
","parent_name":"Mixpanel"},"Classes/Mixpanel.html#/s:8MixpanelAAC12mainInstanceAA0aC0CyFZ":{"name":"mainInstance()","abstract":"Returns the main instance that was initialized.
","parent_name":"Mixpanel"},"Classes/Mixpanel.html#/s:8MixpanelAAC15setMainInstance4nameySS_tFZ":{"name":"setMainInstance(name:)","abstract":"Sets the main instance based on the instance name
","parent_name":"Mixpanel"},"Classes/Mixpanel.html#/s:8MixpanelAAC14removeInstance4nameySS_tFZ":{"name":"removeInstance(name:)","abstract":"Removes an unneeded Mixpanel instance based on its name
","parent_name":"Mixpanel"},"Classes/Group.html#/s:8Mixpanel5GroupC3set10propertiesySDySSAA0A4Type_pG_tF":{"name":"set(properties:)","abstract":"Sets properties on this group.
","parent_name":"Group"},"Classes/Group.html#/s:8Mixpanel5GroupC3set8property2toySS_AA0A4Type_ptF":{"name":"set(property:to:)","abstract":"Convenience method for setting a single property in Mixpanel Groups.
","parent_name":"Group"},"Classes/Group.html#/s:8Mixpanel5GroupC7setOnce10propertiesySDySSAA0A4Type_pG_tF":{"name":"setOnce(properties:)","abstract":"Sets properties on the current Mixpanel Group, but doesn’t overwrite if","parent_name":"Group"},"Classes/Group.html#/s:8Mixpanel5GroupC5unset8propertyySS_tF":{"name":"unset(property:)","abstract":"
Remove a property and its value from a group’s profile in Mixpanel Groups.
","parent_name":"Group"},"Classes/Group.html#/s:8Mixpanel5GroupC6remove3key5valueySS_AA0A4Type_ptF":{"name":"remove(key:value:)","abstract":"Removes list properties.
","parent_name":"Group"},"Classes/Group.html#/s:8Mixpanel5GroupC5union3key6valuesySS_SayAA0A4Type_pGtF":{"name":"union(key:values:)","abstract":"Union list properties.
","parent_name":"Group"},"Classes/Group.html#/s:8Mixpanel5GroupC06deleteB0yyF":{"name":"deleteGroup()","abstract":"Delete group’s record from Mixpanel Groups.
","parent_name":"Group"},"Classes/Group.html":{"name":"Group","abstract":"Access to the Mixpanel Groups API, available through the getGroup function from"},"Classes/Mixpanel.html":{"name":"Mixpanel","abstract":"
The primary class for integrating Mixpanel with your app.
"},"Classes/MixpanelInstance.html":{"name":"MixpanelInstance","abstract":"The class that represents the Mixpanel Instance
"},"Classes/People.html":{"name":"People","abstract":"Access to the Mixpanel People API, available as an accessible variable from"},"Classes.html":{"name":"Classes","abstract":"
The following classes are available globally.
"},"Extensions.html":{"name":"Extensions","abstract":"The following extensions are available globally.
"},"Protocols.html":{"name":"Protocols","abstract":"The following protocols are available globally.
"},"Typealiases.html":{"name":"Type Aliases","abstract":"The following type aliases are available globally.
"}} \ No newline at end of file +{"Typealiases.html#/Properties":{"name":"Properties"},"Protocols/MixpanelType.html#/isValidNestedTypeAndValue()":{"name":"isValidNestedTypeAndValue()","abstract":"Checks if this object has nested object types that Mixpanel supports.
","parent_name":"MixpanelType"},"Protocols/MixpanelType.html#/equals(rhs:)":{"name":"equals(rhs:)","parent_name":"MixpanelType"},"Protocols/MixpanelDelegate.html#/mixpanelWillFlush(_:)":{"name":"mixpanelWillFlush(_:)","abstract":"Asks the delegate if data should be uploaded to the server.
","parent_name":"MixpanelDelegate"},"Protocols/MixpanelDelegate.html":{"name":"MixpanelDelegate","abstract":"Delegate protocol for controlling the Mixpanel API’s network behavior.
"},"Protocols/MixpanelType.html":{"name":"MixpanelType","abstract":"Property keys must be String objects and the supported value types need to conform to MixpanelType."},"Extensions/Dictionary.html#/isValidNestedTypeAndValue()":{"name":"isValidNestedTypeAndValue()","abstract":"
Checks if this object has nested object types that Mixpanel supports.
","parent_name":"Dictionary"},"Extensions/Dictionary.html#/equals(rhs:)":{"name":"equals(rhs:)","parent_name":"Dictionary"},"Extensions/NSArray.html#/isValidNestedTypeAndValue()":{"name":"isValidNestedTypeAndValue()","abstract":"Checks if this object has nested object types that Mixpanel supports.
","parent_name":"NSArray"},"Extensions/NSArray.html#/equals(rhs:)":{"name":"equals(rhs:)","parent_name":"NSArray"},"Extensions/Array.html#/isValidNestedTypeAndValue()":{"name":"isValidNestedTypeAndValue()","abstract":"Checks if this object has nested object types that Mixpanel supports.
","parent_name":"Array"},"Extensions/Array.html#/equals(rhs:)":{"name":"equals(rhs:)","parent_name":"Array"},"Extensions/NSNull.html#/isValidNestedTypeAndValue()":{"name":"isValidNestedTypeAndValue()","abstract":"Checks if this object has nested object types that Mixpanel supports.","parent_name":"NSNull"},"Extensions/NSNull.html#/equals(rhs:)":{"name":"equals(rhs:)","parent_name":"NSNull"},"Extensions/URL.html#/isValidNestedTypeAndValue()":{"name":"isValidNestedTypeAndValue()","abstract":"
Checks if this object has nested object types that Mixpanel supports.","parent_name":"URL"},"Extensions/URL.html#/equals(rhs:)":{"name":"equals(rhs:)","parent_name":"URL"},"Extensions/Date.html#/isValidNestedTypeAndValue()":{"name":"isValidNestedTypeAndValue()","abstract":"
Checks if this object has nested object types that Mixpanel supports.","parent_name":"Date"},"Extensions/Date.html#/equals(rhs:)":{"name":"equals(rhs:)","parent_name":"Date"},"Extensions/Bool.html#/isValidNestedTypeAndValue()":{"name":"isValidNestedTypeAndValue()","abstract":"
Checks if this object has nested object types that Mixpanel supports.","parent_name":"Bool"},"Extensions/Bool.html#/equals(rhs:)":{"name":"equals(rhs:)","parent_name":"Bool"},"Extensions/Float.html#/isValidNestedTypeAndValue()":{"name":"isValidNestedTypeAndValue()","abstract":"
Checks if this object has nested object types that Mixpanel supports.","parent_name":"Float"},"Extensions/Float.html#/equals(rhs:)":{"name":"equals(rhs:)","parent_name":"Float"},"Extensions/Double.html#/isValidNestedTypeAndValue()":{"name":"isValidNestedTypeAndValue()","abstract":"
Checks if this object has nested object types that Mixpanel supports.","parent_name":"Double"},"Extensions/Double.html#/equals(rhs:)":{"name":"equals(rhs:)","parent_name":"Double"},"Extensions/UInt.html#/isValidNestedTypeAndValue()":{"name":"isValidNestedTypeAndValue()","abstract":"
Checks if this object has nested object types that Mixpanel supports.","parent_name":"UInt"},"Extensions/UInt.html#/equals(rhs:)":{"name":"equals(rhs:)","parent_name":"UInt"},"Extensions/Int.html#/isValidNestedTypeAndValue()":{"name":"isValidNestedTypeAndValue()","abstract":"
Checks if this object has nested object types that Mixpanel supports.","parent_name":"Int"},"Extensions/Int.html#/equals(rhs:)":{"name":"equals(rhs:)","parent_name":"Int"},"Extensions/NSNumber.html#/isValidNestedTypeAndValue()":{"name":"isValidNestedTypeAndValue()","abstract":"
Checks if this object has nested object types that Mixpanel supports.","parent_name":"NSNumber"},"Extensions/NSNumber.html#/equals(rhs:)":{"name":"equals(rhs:)","parent_name":"NSNumber"},"Extensions/NSString.html#/isValidNestedTypeAndValue()":{"name":"isValidNestedTypeAndValue()","abstract":"
Checks if this object has nested object types that Mixpanel supports.","parent_name":"NSString"},"Extensions/NSString.html#/equals(rhs:)":{"name":"equals(rhs:)","parent_name":"NSString"},"Extensions/String.html#/isValidNestedTypeAndValue()":{"name":"isValidNestedTypeAndValue()","abstract":"
Checks if this object has nested object types that Mixpanel supports.","parent_name":"String"},"Extensions/String.html#/equals(rhs:)":{"name":"equals(rhs:)","parent_name":"String"},"Extensions/Optional.html#/isValidNestedTypeAndValue()":{"name":"isValidNestedTypeAndValue()","abstract":"
Checks if this object has nested object types that Mixpanel supports.
","parent_name":"Optional"},"Extensions/Optional.html#/equals(rhs:)":{"name":"equals(rhs:)","parent_name":"Optional"},"Extensions/Optional.html":{"name":"Optional"},"Extensions/String.html":{"name":"String"},"Extensions/NSString.html":{"name":"NSString"},"Extensions/NSNumber.html":{"name":"NSNumber"},"Extensions/Int.html":{"name":"Int"},"Extensions/UInt.html":{"name":"UInt"},"Extensions/Double.html":{"name":"Double"},"Extensions/Float.html":{"name":"Float"},"Extensions/Bool.html":{"name":"Bool"},"Extensions/Date.html":{"name":"Date"},"Extensions/URL.html":{"name":"URL"},"Extensions/NSNull.html":{"name":"NSNull"},"Extensions/Array.html":{"name":"Array"},"Extensions/NSArray.html":{"name":"NSArray"},"Extensions/Dictionary.html":{"name":"Dictionary"},"Classes/People.html#/ignoreTime":{"name":"ignoreTime","abstract":"controls the $ignore_time property in any subsequent MixpanelPeople operation.","parent_name":"People"},"Classes/People.html#/set(properties:)":{"name":"set(properties:)","abstract":"
Set properties on the current user in Mixpanel People.
","parent_name":"People"},"Classes/People.html#/set(property:to:)":{"name":"set(property:to:)","abstract":"Convenience method for setting a single property in Mixpanel People.
","parent_name":"People"},"Classes/People.html#/setOnce(properties:)":{"name":"setOnce(properties:)","abstract":"Set properties on the current user in Mixpanel People, but doesn’t overwrite if","parent_name":"People"},"Classes/People.html#/unset(properties:)":{"name":"unset(properties:)","abstract":"
Remove a list of properties and their values from the current user’s profile","parent_name":"People"},"Classes/People.html#/increment(properties:)":{"name":"increment(properties:)","abstract":"
Increment the given numeric properties by the given values.
","parent_name":"People"},"Classes/People.html#/increment(property:by:)":{"name":"increment(property:by:)","abstract":"Convenience method for incrementing a single numeric property by the specified","parent_name":"People"},"Classes/People.html#/append(properties:)":{"name":"append(properties:)","abstract":"
Append values to list properties.
","parent_name":"People"},"Classes/People.html#/remove(properties:)":{"name":"remove(properties:)","abstract":"Removes list properties.
","parent_name":"People"},"Classes/People.html#/union(properties:)":{"name":"union(properties:)","abstract":"Union list properties.
","parent_name":"People"},"Classes/People.html#/trackCharge(amount:properties:)":{"name":"trackCharge(amount:properties:)","abstract":"Track money spent by the current user for revenue analytics and associate","parent_name":"People"},"Classes/People.html#/clearCharges()":{"name":"clearCharges()","abstract":"
Delete current user’s revenue history.
","parent_name":"People"},"Classes/People.html#/deleteUser()":{"name":"deleteUser()","abstract":"Delete current user’s record from Mixpanel People.
","parent_name":"People"},"Classes/MixpanelInstance.html#/apiToken":{"name":"apiToken","abstract":"apiToken string that identifies the project to track data to
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/delegate":{"name":"delegate","abstract":"The a MixpanelDelegate object that gives control over Mixpanel network activity.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/distinctId":{"name":"distinctId","abstract":"distinctId string that uniquely identifies the current user.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/anonymousId":{"name":"anonymousId","abstract":"anonymousId string that uniquely identifies the device.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/userId":{"name":"userId","abstract":"userId string that identify is called with.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/hadPersistedDistinctId":{"name":"hadPersistedDistinctId","abstract":"hadPersistedDistinctId is a boolean value which specifies that the stored distinct_id","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/alias":{"name":"alias","abstract":"
alias string that uniquely identifies the current user.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/people":{"name":"people","abstract":"Accessor to the Mixpanel People API object.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/showNetworkActivityIndicator":{"name":"showNetworkActivityIndicator","abstract":"Controls whether to show spinning network activity indicator when flushing","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/trackAutomaticEventsEnabled":{"name":"trackAutomaticEventsEnabled","abstract":"
This allows enabling or disabling collecting common mobile events,
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/flushInterval":{"name":"flushInterval","abstract":"Flush timer’s interval.","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/flushOnBackground":{"name":"flushOnBackground","abstract":"
Control whether the library should flush data to Mixpanel when the app","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/useIPAddressForGeoLocation":{"name":"useIPAddressForGeoLocation","abstract":"
Controls whether to automatically send the client IP Address as part of","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/serverURL":{"name":"serverURL","abstract":"
The base URL used for Mixpanel API requests.","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/debugDescription":{"name":"debugDescription","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/loggingEnabled":{"name":"loggingEnabled","abstract":"
This allows enabling or disabling of all Mixpanel logs at run time.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/name":{"name":"name","abstract":"A unique identifier for this MixpanelInstance
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/minimumSessionDuration":{"name":"minimumSessionDuration","abstract":"The minimum session duration (ms) that is tracked in automatic events.","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/maximumSessionDuration":{"name":"maximumSessionDuration","abstract":"
The maximum session duration (ms) that is tracked in automatic events.","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/identify(distinctId:usePeople:completion:)":{"name":"identify(distinctId:usePeople:completion:)","abstract":"
Sets the distinct ID of the current user.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/createAlias(_:distinctId:usePeople:andIdentify:completion:)":{"name":"createAlias(_:distinctId:usePeople:andIdentify:completion:)","abstract":"The alias method creates an alias which Mixpanel will use to remap one id to another.","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/reset(completion:)":{"name":"reset(completion:)","abstract":"
Clears all stored properties including the distinct Id.","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/archive()":{"name":"archive()","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/flush(performFullFlush:completion:)":{"name":"flush(performFullFlush:completion:)","abstract":"
Uploads queued data to the Mixpanel server.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/track(event:properties:)":{"name":"track(event:properties:)","abstract":"Tracks an event with properties.","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/trackWithGroups(event:properties:groups:)":{"name":"trackWithGroups(event:properties:groups:)","abstract":"
Tracks an event with properties and to specific groups.","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/getGroup(groupKey:groupID:)":{"name":"getGroup(groupKey:groupID:)","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/time(event:)":{"name":"time(event:)","abstract":"
Starts a timer that will be stopped and added as a property when a","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/eventElapsedTime(event:)":{"name":"eventElapsedTime(event:)","abstract":"
Retrieves the time elapsed for the named event since time(event:) was called.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/clearTimedEvents()":{"name":"clearTimedEvents()","abstract":"Clears all current event timers.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/clearTimedEvent(event:)":{"name":"clearTimedEvent(event:)","abstract":"Clears the event timer for the named event.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/currentSuperProperties()":{"name":"currentSuperProperties()","abstract":"Returns the currently set super properties.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/clearSuperProperties()":{"name":"clearSuperProperties()","abstract":"Clears all currently set super properties.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/registerSuperProperties(_:)":{"name":"registerSuperProperties(_:)","abstract":"Registers super properties, overwriting ones that have already been set.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/registerSuperPropertiesOnce(_:defaultValue:)":{"name":"registerSuperPropertiesOnce(_:defaultValue:)","abstract":"Registers super properties without overwriting ones that have already been set,","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/unregisterSuperProperty(_:)":{"name":"unregisterSuperProperty(_:)","abstract":"
Removes a previously registered super property.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/setGroup(groupKey:groupID:)":{"name":"setGroup(groupKey:groupID:)","abstract":"Convenience method to set a single group the user belongs to.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/setGroup(groupKey:groupIDs:)":{"name":"setGroup(groupKey:groupIDs:)","abstract":"Set the groups this user belongs to.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/addGroup(groupKey:groupID:)":{"name":"addGroup(groupKey:groupID:)","abstract":"Add a group to this user’s membership for a particular group key
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/removeGroup(groupKey:groupID:)":{"name":"removeGroup(groupKey:groupID:)","abstract":"Remove a group from this user’s membership for a particular group key
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/optOutTracking()":{"name":"optOutTracking()","abstract":"Opt out tracking.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/optInTracking(distinctId:properties:)":{"name":"optInTracking(distinctId:properties:)","abstract":"Opt in tracking.
","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/hasOptedOutTracking()":{"name":"hasOptedOutTracking()","abstract":"Returns if the current user has opted out tracking.
","parent_name":"MixpanelInstance"},"Classes/Mixpanel.html#/initialize(token:trackAutomaticEvents:flushInterval:instanceName:optOutTrackingByDefault:useUniqueDistinctId:superProperties:serverURL:)":{"name":"initialize(token:trackAutomaticEvents:flushInterval:instanceName:optOutTrackingByDefault:useUniqueDistinctId:superProperties:serverURL:)","abstract":"Initializes an instance of the API with the given project token.
","parent_name":"Mixpanel"},"Classes/Mixpanel.html#/initialize(token:flushInterval:instanceName:optOutTrackingByDefault:useUniqueDistinctId:superProperties:serverURL:)":{"name":"initialize(token:flushInterval:instanceName:optOutTrackingByDefault:useUniqueDistinctId:superProperties:serverURL:)","abstract":"Initializes an instance of the API with the given project token (MAC OS ONLY).
","parent_name":"Mixpanel"},"Classes/Mixpanel.html#/getInstance(name:)":{"name":"getInstance(name:)","abstract":"Gets the mixpanel instance with the given name
","parent_name":"Mixpanel"},"Classes/Mixpanel.html#/mainInstance()":{"name":"mainInstance()","abstract":"Returns the main instance that was initialized.
","parent_name":"Mixpanel"},"Classes/Mixpanel.html#/setMainInstance(name:)":{"name":"setMainInstance(name:)","abstract":"Sets the main instance based on the instance name
","parent_name":"Mixpanel"},"Classes/Mixpanel.html#/removeInstance(name:)":{"name":"removeInstance(name:)","abstract":"Removes an unneeded Mixpanel instance based on its name
","parent_name":"Mixpanel"},"Classes/Group.html#/set(properties:)":{"name":"set(properties:)","abstract":"Sets properties on this group.
","parent_name":"Group"},"Classes/Group.html#/set(property:to:)":{"name":"set(property:to:)","abstract":"Convenience method for setting a single property in Mixpanel Groups.
","parent_name":"Group"},"Classes/Group.html#/setOnce(properties:)":{"name":"setOnce(properties:)","abstract":"Sets properties on the current Mixpanel Group, but doesn’t overwrite if","parent_name":"Group"},"Classes/Group.html#/unset(property:)":{"name":"unset(property:)","abstract":"
Remove a property and its value from a group’s profile in Mixpanel Groups.
","parent_name":"Group"},"Classes/Group.html#/remove(key:value:)":{"name":"remove(key:value:)","abstract":"Removes list properties.
","parent_name":"Group"},"Classes/Group.html#/union(key:values:)":{"name":"union(key:values:)","abstract":"Union list properties.
","parent_name":"Group"},"Classes/Group.html#/deleteGroup()":{"name":"deleteGroup()","abstract":"Delete group’s record from Mixpanel Groups.
","parent_name":"Group"},"Classes/Group.html":{"name":"Group","abstract":"Access to the Mixpanel Groups API, available through the getGroup function from"},"Classes/Mixpanel.html":{"name":"Mixpanel","abstract":"
The primary class for integrating Mixpanel with your app.
"},"Classes/MixpanelInstance.html":{"name":"MixpanelInstance","abstract":"The class that represents the Mixpanel Instance
"},"Classes/People.html":{"name":"People","abstract":"Access to the Mixpanel People API, available as an accessible variable from"},"Classes.html":{"name":"Classes","abstract":"
The following classes are available globally.
"},"Extensions.html":{"name":"Extensions","abstract":"The following extensions are available globally.
"},"Protocols.html":{"name":"Protocols","abstract":"The following protocols are available globally.
"},"Typealiases.html":{"name":"Type Aliases","abstract":"The following type aliases are available globally.
"}} \ No newline at end of file diff --git a/docs/undocumented.json b/docs/undocumented.json index 79ef330c..f6c7d87e 100644 --- a/docs/undocumented.json +++ b/docs/undocumented.json @@ -1,145 +1,6 @@ { "warnings": [ - { - "file": "/Users/jaredmcfarland/Developer/mixpanel-swift/Sources/MixpanelInstance.swift", - "line": 38, - "symbol": "Properties", - "symbol_kind": "source.lang.swift.decl.typealias", - "warning": "undocumented" - }, - { - "file": "/Users/jaredmcfarland/Developer/mixpanel-swift/Sources/MixpanelInstance.swift", - "line": 175, - "symbol": "MixpanelInstance.minimumSessionDuration", - "symbol_kind": "source.lang.swift.decl.var.instance", - "warning": "undocumented" - }, - { - "file": "/Users/jaredmcfarland/Developer/mixpanel-swift/Sources/MixpanelInstance.swift", - "line": 830, - "symbol": "MixpanelInstance.archive()", - "symbol_kind": "source.lang.swift.decl.function.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/jaredmcfarland/Developer/mixpanel-swift/Sources/MixpanelInstance.swift", - "line": 1082, - "symbol": "MixpanelInstance.getGroup(groupKey:groupID:)", - "symbol_kind": "source.lang.swift.decl.function.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/jaredmcfarland/Developer/mixpanel-swift/Sources/MixpanelType.swift", - "line": 20, - "symbol": "MixpanelType.equals(rhs:)", - "symbol_kind": "source.lang.swift.decl.function.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/jaredmcfarland/Developer/mixpanel-swift/Sources/MixpanelType.swift", - "line": 38, - "symbol": "Optional.equals(rhs:)", - "symbol_kind": "source.lang.swift.decl.function.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/jaredmcfarland/Developer/mixpanel-swift/Sources/MixpanelType.swift", - "line": 72, - "symbol": "String.equals(rhs:)", - "symbol_kind": "source.lang.swift.decl.function.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/jaredmcfarland/Developer/mixpanel-swift/Sources/MixpanelType.swift", - "line": 87, - "symbol": "NSString.equals(rhs:)", - "symbol_kind": "source.lang.swift.decl.function.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/jaredmcfarland/Developer/mixpanel-swift/Sources/MixpanelType.swift", - "line": 104, - "symbol": "NSNumber.equals(rhs:)", - "symbol_kind": "source.lang.swift.decl.function.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/jaredmcfarland/Developer/mixpanel-swift/Sources/MixpanelType.swift", - "line": 119, - "symbol": "Int.equals(rhs:)", - "symbol_kind": "source.lang.swift.decl.function.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/jaredmcfarland/Developer/mixpanel-swift/Sources/MixpanelType.swift", - "line": 134, - "symbol": "UInt.equals(rhs:)", - "symbol_kind": "source.lang.swift.decl.function.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/jaredmcfarland/Developer/mixpanel-swift/Sources/MixpanelType.swift", - "line": 150, - "symbol": "Double.equals(rhs:)", - "symbol_kind": "source.lang.swift.decl.function.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/jaredmcfarland/Developer/mixpanel-swift/Sources/MixpanelType.swift", - "line": 166, - "symbol": "Float.equals(rhs:)", - "symbol_kind": "source.lang.swift.decl.function.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/jaredmcfarland/Developer/mixpanel-swift/Sources/MixpanelType.swift", - "line": 180, - "symbol": "Bool.equals(rhs:)", - "symbol_kind": "source.lang.swift.decl.function.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/jaredmcfarland/Developer/mixpanel-swift/Sources/MixpanelType.swift", - "line": 195, - "symbol": "Date.equals(rhs:)", - "symbol_kind": "source.lang.swift.decl.function.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/jaredmcfarland/Developer/mixpanel-swift/Sources/MixpanelType.swift", - "line": 210, - "symbol": "URL.equals(rhs:)", - "symbol_kind": "source.lang.swift.decl.function.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/jaredmcfarland/Developer/mixpanel-swift/Sources/MixpanelType.swift", - "line": 225, - "symbol": "NSNull.equals(rhs:)", - "symbol_kind": "source.lang.swift.decl.function.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/jaredmcfarland/Developer/mixpanel-swift/Sources/MixpanelType.swift", - "line": 246, - "symbol": "Array.equals(rhs:)", - "symbol_kind": "source.lang.swift.decl.function.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/jaredmcfarland/Developer/mixpanel-swift/Sources/MixpanelType.swift", - "line": 283, - "symbol": "NSArray.equals(rhs:)", - "symbol_kind": "source.lang.swift.decl.function.method.instance", - "warning": "undocumented" - }, - { - "file": "/Users/jaredmcfarland/Developer/mixpanel-swift/Sources/MixpanelType.swift", - "line": 320, - "symbol": "Dictionary.equals(rhs:)", - "symbol_kind": "source.lang.swift.decl.function.method.instance", - "warning": "undocumented" - } + ], - "source_directory": "/Users/jaredmcfarland/Developer/mixpanel-swift" + "source_directory": "/Users/zihejia/Documents/Projects/Develop/mixpanel-swift" } \ No newline at end of file