2016-07-27 21:07:01 +00:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< title > Mixpanel Reference< / title >
< link rel = "stylesheet" type = "text/css" href = "css/jazzy.css" / >
< link rel = "stylesheet" type = "text/css" href = "css/highlight.css" / >
< meta charset = 'utf-8' >
< script src = "js/jquery.min.js" defer > < / script >
< script src = "js/jazzy.js" defer > < / script >
< / head >
< body >
< a title = "Mixpanel Reference" > < / a >
< header >
< div class = "content-wrapper" >
2017-03-02 22:56:48 +00:00
< p > < a href = "index.html" > Mixpanel Docs< / a > (100% documented)< / p >
2016-07-27 21:07:01 +00:00
< p class = "header-right" > < a href = "https://github.com/mixpanel/mixpanel-swift" > < img src = "img/gh.png" / > View on GitHub< / a > < / p >
< / div >
< / header >
< div class = "content-wrapper" >
< p id = "breadcrumbs" >
< a href = "index.html" > Mixpanel Reference< / a >
< img id = "carat" src = "img/carat.png" / >
Mixpanel Reference
< / p >
< / div >
< div class = "content-wrapper" >
< nav class = "sidebar" >
< ul class = "nav-groups" >
< li class = "nav-group-name" >
< a href = "Classes.html" > Classes< / a >
< ul class = "nav-group-tasks" >
< li class = "nav-group-task" >
< a href = "Classes/Mixpanel.html" > Mixpanel< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Classes/MixpanelInstance.html" > MixpanelInstance< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Classes/People.html" > People< / a >
< / li >
2016-11-22 21:57:06 +00:00
< li class = "nav-group-task" >
< a href = "Classes.html#/s:C8Mixpanel10TweakStore" > TweakStore< / a >
< / li >
2016-07-27 21:07:01 +00:00
< / ul >
< / li >
2016-10-25 22:17:44 +00:00
< li class = "nav-group-name" >
< a href = "Enums.html" > Enums< / a >
< ul class = "nav-group-tasks" >
< li class = "nav-group-task" >
< a href = "Enums/TweakViewDataType.html" > TweakViewDataType< / a >
< / li >
< / ul >
< / li >
2016-09-26 20:34:10 +00:00
< li class = "nav-group-name" >
< a href = "Extensions.html" > Extensions< / a >
< ul class = "nav-group-tasks" >
< li class = "nav-group-task" >
< a href = "Extensions/Array.html" > Array< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Extensions/Bool.html" > Bool< / a >
< / li >
2016-10-25 22:17:44 +00:00
< li class = "nav-group-task" >
< a href = "Extensions/CGFloat.html" > CGFloat< / a >
< / li >
2016-09-26 20:34:10 +00:00
< li class = "nav-group-task" >
< a href = "Extensions/Date.html" > Date< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Extensions/Dictionary.html" > Dictionary< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Extensions/Double.html" > Double< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Extensions/Float.html" > Float< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Extensions/Int.html" > Int< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Extensions/NSNull.html" > NSNull< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Extensions/String.html" > String< / a >
< / li >
2016-10-25 22:17:44 +00:00
< li class = "nav-group-task" >
< a href = "Extensions/UIColor.html" > UIColor< / a >
< / li >
2016-09-26 20:34:10 +00:00
< li class = "nav-group-task" >
< a href = "Extensions/UInt.html" > UInt< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Extensions/URL.html" > URL< / a >
< / li >
< / ul >
< / li >
2016-10-25 22:17:44 +00:00
< li class = "nav-group-name" >
< a href = "Functions.html" > Functions< / a >
< ul class = "nav-group-tasks" >
< li class = "nav-group-task" >
< a href = "Functions.html#/s:F8Mixpaneloi2eeFTVS_8AnyTweakS0__Sb" > ==(_:_:)< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Functions/==(_:_:).html" > ==(_:_:)< / a >
< / li >
< / ul >
< / li >
2017-03-02 22:56:48 +00:00
< li class = "nav-group-name" >
< a href = "Instance Methods.html" > Instance Methods< / a >
< ul class = "nav-group-tasks" >
< li class = "nav-group-task" >
< a href = "Instance Methods.html#/s:FC8Mixpanel16MixpanelInstance7archiveFT_T_" > archive()< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Instance Methods.html#/s:FC8Mixpanel16MixpanelInstance20clearSuperPropertiesFT_T_" > clearSuperProperties()< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Instance Methods.html#/s:FC8Mixpanel16MixpanelInstance16clearTimedEventsFT_T_" > clearTimedEvents()< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Instance Methods.html#/s:FC8Mixpanel16MixpanelInstance11createAliasFTSS10distinctIdSS_T_" > createAlias(_:distinctId:)< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Instance Methods.html#/s:FC8Mixpanel16MixpanelInstance22currentSuperPropertiesFT_GVs10DictionarySSP__" > currentSuperProperties()< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Instance Methods.html#/s:FC8Mixpanel16MixpanelInstance24fetchNotificationPayloadFT10completionFGSqGVs10DictionarySSPs9AnyObject___T__T_" > fetchNotificationPayload(completion:)< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Instance Methods.html#/s:FC8Mixpanel16MixpanelInstance5flushFT10completionGSqFT_T___T_" > flush(completion:)< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Instance Methods.html#/s:FC8Mixpanel16MixpanelInstance8identifyFT10distinctIdSS_T_" > identify(distinctId:)< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Instance Methods.html#/s:FC8Mixpanel16MixpanelInstance15joinExperimentsFT8callbackGSqFT_T___T_" > joinExperiments(callback:)< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Instance Methods.html#/s:FC8Mixpanel16MixpanelInstance23registerSuperPropertiesFGVs10DictionarySSPS_12MixpanelType__T_" > registerSuperProperties(_:)< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Instance Methods.html#/s:FC8Mixpanel16MixpanelInstance27registerSuperPropertiesOnceFTGVs10DictionarySSPS_12MixpanelType__12defaultValueGSqPS2____T_" > registerSuperPropertiesOnce(_:defaultValue:)< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Instance Methods.html#/s:FC8Mixpanel16MixpanelInstance5resetFT_T_" > reset()< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Instance Methods.html#/s:FC8Mixpanel16MixpanelInstance16showNotificationFT_T_" > showNotification()< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Instance Methods.html#/s:FC8Mixpanel16MixpanelInstance16showNotificationFT2IDSi_T_" > showNotification(ID:)< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Instance Methods.html#/s:FC8Mixpanel16MixpanelInstance16showNotificationFT4typeSS_T_" > showNotification(type:)< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Instance Methods.html#/s:FC8Mixpanel16MixpanelInstance4timeFT5eventSS_T_" > time(event:)< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Instance Methods.html#/s:FC8Mixpanel16MixpanelInstance5trackFT5eventGSqSS_10propertiesGSqGVs10DictionarySSPS_12MixpanelType____T_" > track(event:properties:)< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Instance Methods.html#/s:FC8Mixpanel16MixpanelInstance21trackPushNotificationFTGVs10DictionaryVs11AnyHashableP__5eventSS_T_" > trackPushNotification(_:event:)< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Instance Methods.html#/s:FC8Mixpanel16MixpanelInstance23unregisterSuperPropertyFSST_" > unregisterSuperProperty(_:)< / a >
< / li >
< / ul >
< / li >
2016-07-27 21:07:01 +00:00
< li class = "nav-group-name" >
< a href = "Protocols.html" > Protocols< / a >
< ul class = "nav-group-tasks" >
< li class = "nav-group-task" >
< a href = "Protocols/MixpanelDelegate.html" > MixpanelDelegate< / a >
< / li >
2016-09-26 20:34:10 +00:00
< li class = "nav-group-task" >
< a href = "Protocols/MixpanelType.html" > MixpanelType< / a >
< / li >
2016-10-25 22:17:44 +00:00
< li class = "nav-group-task" >
< a href = "Protocols/TweakClusterType.html" > TweakClusterType< / a >
< / li >
2016-11-22 21:57:06 +00:00
< li class = "nav-group-task" >
< a href = "Protocols/TweakLibraryType.html" > TweakLibraryType< / a >
< / li >
2016-10-25 22:17:44 +00:00
< li class = "nav-group-task" >
< a href = "Protocols/TweakableType.html" > TweakableType< / a >
< / li >
< / ul >
< / li >
< li class = "nav-group-name" >
< a href = "Structs.html" > Structs< / a >
< ul class = "nav-group-tasks" >
< li class = "nav-group-task" >
< a href = "Structs/AnyTweak.html" > AnyTweak< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Structs/MixpanelTweaks.html" > MixpanelTweaks< / a >
< / li >
< li class = "nav-group-task" >
< a href = "Structs/Tweak.html" > Tweak< / a >
< / li >
2016-07-27 21:07:01 +00:00
< / ul >
< / li >
< / ul >
< / nav >
< article class = "main-content" >
< section >
< section class = "section" >
< p align = "center" >
< img src = "https://github.com/mixpanel/mixpanel-swift/blob/assets/mixpanelswift.png?raw=true" alt = "Mixpanel Swift Library" height = "200" / >
< / p >
< p > < a href = "https://travis-ci.org/mixpanel/mixpanel-swift" > < img src = "https://travis-ci.org/mixpanel/mixpanel-swift.svg" alt = "Build Status" > < / a >
2016-10-25 22:17:44 +00:00
< a href = "http://isitmaintained.com/project/mixpanel/mixpanel-swift" title = "Average time to resolve an issue" > < img src = "http://isitmaintained.com/badge/resolution/mixpanel/mixpanel-swift.svg" alt = "Average time to resolve an issue" > < / a >
< a href = "http://isitmaintained.com/project/mixpanel/mixpanel-swift" title = "Percentage of issues still open" > < img src = "http://isitmaintained.com/badge/open/mixpanel/mixpanel-swift.svg" alt = "Percentage of issues still open" > < / a >
< a href = "https://mixpanel.com" > < img src = "http://img.shields.io/cocoapods/v/Mixpanel-swift.svg" alt = "CocoaPods Compatible" > < / a >
< a href = "https://github.com/Carthage/Carthage" > < img src = "https://img.shields.io/badge/Carthage-compatible-4BC51D.svg" alt = "Carthage compatible" > < / a >
< a href = "https://mixpanel.com" > < img src = "http://img.shields.io/cocoapods/l/Mixpanel-swift.svg" alt = "Apache License" > < / a > < / p >
2016-07-27 21:07:01 +00:00
< a href = '#introduction' class = 'anchor' aria-hidden = true > < span class = "header-anchor" > < / span > < / a > < h1 id = 'introduction' > Introduction< / h1 >
< p > Welcome to the official Mixpanel Swift Library< / p >
< p > The Mixpanel Swift library for iOS is an open source project, and we’ d love to see your contributions!
We’ d also love for you to come and work with us! Check out < strong > < a href = "http://boards.greenhouse.io/mixpanel/jobs/25226#.U_4JXEhORKU" > Jobs< / a > < / strong > for details.< / p >
2016-10-25 22:17:44 +00:00
< p > If you are using Objective-C, we recommend using our < strong > < a href = "https://github.com/mixpanel/mixpanel-iphone" > Objective-C Library< / a > < / strong > .< / p >
2016-07-27 21:07:01 +00:00
< a href = '#current-supported-features' class = 'anchor' aria-hidden = true > < span class = "header-anchor" > < / span > < / a > < h2 id = 'current-supported-features' > Current supported features< / h2 >
2016-10-25 22:17:44 +00:00
< p > < strong > Our master branch and our 2.x releases are now in Swift 3. If you wish to use our Swift 2.3 implementation, please point to our v1.0.1 release.< / strong > < / p >
< table > < thead >
< tr >
< th > Feature< / th >
< th > Swift 3< / th >
< th > < a href = "https://github.com/mixpanel/mixpanel-swift/tree/swift2.3" > Swift 2.3< / a > < / th >
< / tr >
< / thead > < tbody >
< tr >
< td > Tracking API< / td >
< td > ✔< / td >
< td > ✔< / td >
< / tr >
< tr >
< td > People API< / td >
< td > ✔< / td >
< td > ✔< / td >
< / tr >
< tr >
< td > < a href = "https://mixpanel.github.io/mixpanel-swift" > Documentation< / a > < / td >
< td > ✔< / td >
< td > ✔< / td >
< / tr >
< tr >
< td > tvOS Support< / td >
< td > ✔< / td >
< td > < / td >
< / tr >
< tr >
< td > In-app Notifications< / td >
< td > ✔< / td >
< td > < / td >
< / tr >
< tr >
< td > Codeless Tracking< / td >
< td > ✔< / td >
< td > < / td >
< / tr >
2016-11-22 21:57:06 +00:00
< tr >
< td > A/B Testing< / td >
< td > ✔< / td >
< td > < / td >
< / tr >
2016-10-25 22:17:44 +00:00
< / tbody > < / table >
2016-07-27 21:07:01 +00:00
< a href = '#installation' class = 'anchor' aria-hidden = true > < span class = "header-anchor" > < / span > < / a > < h1 id = 'installation' > Installation< / h1 >
< a href = '#cocoapods' class = 'anchor' aria-hidden = true > < span class = "header-anchor" > < / span > < / a > < h2 id = 'cocoapods' > CocoaPods< / h2 >
2017-03-02 22:56:48 +00:00
< p > < strong > Our current release only supports CocoaPods version 1.1.0+< / strong > < / p >
2016-11-22 21:57:06 +00:00
2016-07-27 21:07:01 +00:00
< p > Mixpanel supports < code > CocoaPods< / code > for easy installation.
To Install, see our < strong > < a href = "https://mixpanel.com/help/reference/swift" > swift integration guide »< / a > < / strong > < / p >
< p > < code > pod ' Mixpanel-swift' < / code > < / p >
< a href = '#carthage' class = 'anchor' aria-hidden = true > < span class = "header-anchor" > < / span > < / a > < h2 id = 'carthage' > Carthage< / h2 >
< p > Mixpanel also supports < code > Carthage< / code > to package your dependencies as a framework. Include the following dependency in your Cartfile:< / p >
< p > < code > github " mixpanel/mixpanel-swift" < / code > < / p >
< p > Check out the < strong > < a href = "https://github.com/Carthage/Carthage#if-youre-building-for-ios-tvos-or-watchos" > Carthage docs »< / a > < / strong > for more info. < / p >
< a href = '#manual-installation' class = 'anchor' aria-hidden = true > < span class = "header-anchor" > < / span > < / a > < h2 id = 'manual-installation' > Manual Installation< / h2 >
< p > To help users stay up to date with the latests version of our Swift SDK, we always recommend integrating our SDK via CocoaPods, which simplifies version updates and dependency management. However, there are cases where users can’ t use CocoaPods. Not to worry, just follow these manual installation steps and you’ ll be all set.< / p >
< a href = '#step-1-add-as-a-submodule' class = 'anchor' aria-hidden = true > < span class = "header-anchor" > < / span > < / a > < h3 id = 'step-1-add-as-a-submodule' > Step 1: Add as a Submodule< / h3 >
< p > Add Mixpanel as a submodule to your local git repo like so:< / p >
< pre class = "highlight plaintext" > < code > git submodule add git@github.com:mixpanel/mixpanel-swift.git
< / code > < / pre >
< p > Now the Mixpanel project and its files should be in your project folder! < / p >
< a href = '#step-2-drag-mixpanel-to-your-project' class = 'anchor' aria-hidden = true > < span class = "header-anchor" > < / span > < / a > < h3 id = 'step-2-drag-mixpanel-to-your-project' > Step 2: Drag Mixpanel to your project< / h3 >
< p > Drag the Mixpanel.xcodeproj inside your sample project under the main sample project file:< / p >
< p > < img src = "http://images.mxpnl.com/docs/2016-07-19%2023:34:02.724663-Screen%20Shot%202016-07-19%20at%204.33.34%20PM.png" alt = "alt text" > < / p >
< a href = '#step-3-embed-the-framework' class = 'anchor' aria-hidden = true > < span class = "header-anchor" > < / span > < / a > < h3 id = 'step-3-embed-the-framework' > Step 3: Embed the framework< / h3 >
< p > Select your app .xcodeproj file. Under < q > General< / q > , add the Mixpanel framework as an embedded binary:< / p >
< p > < img src = "http://images.mxpnl.com/docs/2016-07-19%2023:31:29.237158-add_framework.png" alt = "alt text" > < / p >
< a href = '#step-4-integrate' class = 'anchor' aria-hidden = true > < span class = "header-anchor" > < / span > < / a > < h3 id = 'step-4-integrate' > Step 4: Integrate!< / h3 >
< p > Import Mixpanel into AppDelegate.swift, and initialize Mixpanel within < code > application:didFinishLaunchingWithOptions:< / code >
< img src = "http://images.mxpnl.com/docs/2016-07-19%2023:27:03.724972-Screen%20Shot%202016-07-18%20at%207.16.51%20PM.png" alt = "alt text" > < / p >
< pre class = "highlight plaintext" > < code > func application(_ application: UIApplication,
didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool {
Mixpanel.initialize(token: "MIXPANEL_TOKEN")
}
< / code > < / pre >
< a href = '#initializing-and-usage' class = 'anchor' aria-hidden = true > < span class = "header-anchor" > < / span > < / a > < h1 id = 'initializing-and-usage' > Initializing and Usage< / h1 >
< p > By calling:
< code >
let mixpanel = Mixpanel.initialize(token: " MIXPANEL_TOKEN" )
< / code > < / p >
< p > You initialize your mixpanel instance with the token provided to you on mixpanel.com.
To interact with the instance and start tracking, you can either use the mixpanel instance given when initializing:
< code >
mixpanel.track(event: " Tracked Event!" )
< / code >
or you can directly fetch the instance and use it from the Mixpanel object:
< code >
Mixpanel.mainInstance().track(event: " Tracked Event!" )
< / code > < / p >
< a href = '#start-tracking' class = 'anchor' aria-hidden = true > < span class = "header-anchor" > < / span > < / a > < h2 id = 'start-tracking' > Start tracking< / h2 >
< p > You’ re done! You’ ve successfully integrated the Mixpanel Swift SDK into your app. To stay up to speed on important SDK releases and updates, star or watch our repository on < a href = "https://github.com/mixpanel/mixpanel-swift" > Github< / a > .< / p >
< p > Have any questions? Reach out to < a href = "mailto:support@mixpanel.com" > support@mixpanel.com< / a > to speak to someone smart, quickly.< / p >
< / section >
< / section >
< section id = "footer" >
2017-03-02 22:56:48 +00:00
< p > © 2017 < a class = "link" href = "http://mixpanel.com" target = "_blank" rel = "external" > Mixpanel< / a > . All rights reserved. (Last updated: 2017-03-02)< / p >
< p > Generated by < a class = "link" href = "https://github.com/realm/jazzy" target = "_blank" rel = "external" > jazzy ♪♫ v0.7.4< / a > , a < a class = "link" href = "http://realm.io" target = "_blank" rel = "external" > Realm< / a > project.< / p >
2016-07-27 21:07:01 +00:00
< / section >
< / article >
< / div >
< / body >
< / div >
< / html >
