2019-12-19 02:23:17 +00:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< title > Mixpanel Class 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 >
2021-04-01 20:59:45 +00:00
< script src = "../js/lunr.min.js" defer > < / script >
< script src = "../js/typeahead.jquery.js" defer > < / script >
< script src = "../js/jazzy.search.js" defer > < / script >
2019-12-19 02:23:17 +00:00
< / head >
< body >
< a name = "//apple_ref/swift/Class/Mixpanel" class = "dashAnchor" > < / a >
< a title = "Mixpanel Class Reference" > < / a >
< header >
< div class = "content-wrapper" >
2022-03-23 22:29:13 +00:00
< p > < a href = "../index.html" > Mixpanel 3.1.7 Docs< / a > (84% documented)< / p >
2019-12-19 02:23:17 +00:00
< p class = "header-right" > < a href = "https://github.com/mixpanel/mixpanel-swift" > < img src = "../img/gh.png" / > View on GitHub< / a > < / p >
2021-04-01 20:59:45 +00:00
< p class = "header-right" >
< form role = "search" action = "../search.json" >
< input type = "text" placeholder = "Search documentation" data-typeahead >
< / form >
< / p >
2019-12-19 02:23:17 +00:00
< / div >
< / header >
< div class = "content-wrapper" >
< p id = "breadcrumbs" >
< a href = "../index.html" > Mixpanel Reference< / a >
< img id = "carat" src = "../img/carat.png" / >
Mixpanel Class 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/Group.html" > Group< / a >
< / li >
< 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 >
< / ul >
< / li >
< 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 >
< 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 >
2021-04-01 20:59:45 +00:00
< li class = "nav-group-task" >
< a href = "../Extensions/NSArray.html" > NSArray< / a >
< / li >
2019-12-19 02:23:17 +00:00
< li class = "nav-group-task" >
< a href = "../Extensions/NSNull.html" > NSNull< / a >
< / li >
2020-05-07 20:52:30 +00:00
< li class = "nav-group-task" >
< a href = "../Extensions/NSNumber.html" > NSNumber< / a >
< / li >
2020-04-23 23:36:21 +00:00
< li class = "nav-group-task" >
2021-04-01 20:59:45 +00:00
< a href = "../Extensions/NSString.html" > NSString< / a >
2020-04-23 23:36:21 +00:00
< / li >
2021-06-07 18:22:15 +00:00
< li class = "nav-group-task" >
< a href = "../Extensions/Optional.html" > Optional< / a >
< / li >
2019-12-19 02:23:17 +00:00
< li class = "nav-group-task" >
< a href = "../Extensions/String.html" > String< / a >
< / li >
< 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 >
< 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 >
< li class = "nav-group-task" >
< a href = "../Protocols/MixpanelType.html" > MixpanelType< / a >
< / li >
< / ul >
< / li >
< li class = "nav-group-name" >
< a href = "../Typealiases.html" > Type Aliases< / a >
< ul class = "nav-group-tasks" >
< li class = "nav-group-task" >
< a href = "../Typealiases.html#/s:8Mixpanel10Propertiesa" > Properties< / a >
< / li >
< / ul >
< / li >
< / ul >
< / nav >
< article class = "main-content" >
< section >
< section class = "section" >
< h1 > Mixpanel< / h1 >
< div class = "declaration" >
< div class = "language" >
2021-04-01 20:59:45 +00:00
2019-12-19 02:23:17 +00:00
< pre class = "highlight swift" > < code > < span class = "kd" > open< / span > < span class = "kd" > class< / span > < span class = "kt" > Mixpanel< / span > < / code > < / pre >
< / div >
< / div >
< p > The primary class for integrating Mixpanel with your app.< / p >
< / section >
< section class = "section task-group-section" >
< div class = "task-group" >
< ul >
< li class = "item" >
< div >
< code >
2022-02-19 01:37:59 +00:00
< a name = "/s:8MixpanelAAC10initialize5token13flushInterval12instanceName23optOutTrackingByDefault20trackAutomaticEvents19useUniqueDistinctId15superPropertiesAA0A8InstanceCSS_SdSSSgS2bSgSbSDySSAA0A4Type_pGSgtFZ" > < / a >
2022-01-13 00:52:14 +00:00
< a name = "//apple_ref/swift/Method/initialize(token:flushInterval:instanceName:optOutTrackingByDefault:trackAutomaticEvents:useUniqueDistinctId:superProperties:)" class = "dashAnchor" > < / a >
2022-02-19 01:37:59 +00:00
< a class = "token" href = "#/s:8MixpanelAAC10initialize5token13flushInterval12instanceName23optOutTrackingByDefault20trackAutomaticEvents19useUniqueDistinctId15superPropertiesAA0A8InstanceCSS_SdSSSgS2bSgSbSDySSAA0A4Type_pGSgtFZ" > initialize(token:< wbr > flushInterval:< wbr > instanceName:< wbr > optOutTrackingByDefault:< wbr > trackAutomaticEvents:< wbr > useUniqueDistinctId:< wbr > superProperties:< wbr > )< / a >
2019-12-19 02:23:17 +00:00
< / code >
< / div >
< div class = "height-container" >
< div class = "pointer-container" > < / div >
< section class = "section" >
< div class = "pointer" > < / div >
< div class = "abstract" >
< p > Initializes an instance of the API with the given project token.< / p >
< p > Returns a new Mixpanel instance API object. This allows you to create more than one instance
of the API object, which is convenient if you’ d like to send data to more than
one Mixpanel project from a single app.< / p >
< div class = "aside aside-important" >
< p class = "aside-title" > Important< / p >
< p > If you have more than one Mixpanel instance, it is beneficial to initialize
the instances with an instanceName. Then they can be reached by calling getInstance with name.< / p >
< / div >
< / div >
< div class = "declaration" >
< h4 > Declaration< / h4 >
< div class = "language" >
< p class = "aside-title" > Swift< / p >
< pre class = "highlight swift" > < code > < span class = "kd" > @discardableResult< / span >
< span class = "kd" > open< / span > < span class = "kd" > class< / span > < span class = "kd" > func< / span > < span class = "nf" > initialize< / span > < span class = "p" > (< / span > < span class = "n" > token< / span > < span class = "nv" > apiToken< / span > < span class = "p" > :< / span > < span class = "kt" > String< / span > < span class = "p" > ,< / span >
< span class = "nv" > flushInterval< / span > < span class = "p" > :< / span > < span class = "kt" > Double< / span > < span class = "o" > =< / span > < span class = "mi" > 60< / span > < span class = "p" > ,< / span >
2022-02-19 01:37:59 +00:00
< span class = "nv" > instanceName< / span > < span class = "p" > :< / span > < span class = "kt" > String< / span > < span class = "p" > ?< / span > < span class = "o" > =< / span > < span class = "kc" > nil< / span > < span class = "p" > ,< / span >
2022-01-13 00:52:14 +00:00
< span class = "nv" > optOutTrackingByDefault< / span > < span class = "p" > :< / span > < span class = "kt" > Bool< / span > < span class = "o" > =< / span > < span class = "kc" > false< / span > < span class = "p" > ,< / span >
2022-02-03 19:31:22 +00:00
< span class = "nv" > trackAutomaticEvents< / span > < span class = "p" > :< / span > < span class = "kt" > Bool< / span > < span class = "p" > ?< / span > < span class = "o" > =< / span > < span class = "kc" > nil< / span > < span class = "p" > ,< / span >
2022-01-13 00:52:14 +00:00
< span class = "nv" > useUniqueDistinctId< / span > < span class = "p" > :< / span > < span class = "kt" > Bool< / span > < span class = "o" > =< / span > < span class = "kc" > false< / span > < span class = "p" > ,< / span >
< span class = "nv" > superProperties< / span > < span class = "p" > :< / span > < span class = "kt" > < a href = "../Typealiases.html#/s:8Mixpanel10Propertiesa" > Properties< / a > < / span > < span class = "p" > ?< / span > < span class = "o" > =< / span > < span class = "kc" > nil< / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "kt" > < a href = "../Classes/MixpanelInstance.html" > MixpanelInstance< / a > < / span > < / code > < / pre >
2019-12-19 02:23:17 +00:00
< / div >
< / div >
< div >
< h4 > Parameters< / h4 >
< table class = "graybox" >
< tbody >
< tr >
< td >
< code >
< em > token< / em >
< / code >
< / td >
< td >
< div >
< p > your project token< / p >
< / div >
< / td >
< / tr >
< tr >
< td >
< code >
< em > flushInterval< / em >
< / code >
< / td >
< td >
< div >
< p > Optional. Interval to run background flushing< / p >
< / div >
< / td >
< / tr >
< tr >
< td >
< code >
< em > instanceName< / em >
< / code >
< / td >
< td >
< div >
2022-02-19 01:37:59 +00:00
< p > Optional. The name you want to call this instance, must be unique 1:1 for each instance’ s project token. Defaults to project token.< / p >
2019-12-19 02:23:17 +00:00
< / div >
< / td >
< / tr >
< tr >
< td >
< code >
< em > optOutTrackingByDefault< / em >
< / code >
< / td >
< td >
< div >
< p > Optional. Whether or not to be opted out from tracking by default< / p >
< / div >
< / td >
< / tr >
2022-01-13 00:52:14 +00:00
< tr >
< td >
< code >
< em > trackAutomaticEvents< / em >
< / code >
< / td >
< td >
< div >
2022-02-03 19:31:22 +00:00
< p > Optional. Whether or not to collect common mobile events, it takes precedence over Autotrack settings from the Mixpanel server.< / p >
2022-01-13 00:52:14 +00:00
< / div >
< / td >
< / tr >
< tr >
< td >
< code >
2022-02-19 01:37:59 +00:00
< em > useUniqueDistinctId< / em >
2022-01-13 00:52:14 +00:00
< / code >
< / td >
< td >
< div >
2022-02-19 01:37:59 +00:00
< p > Optional. whether or not to use the unique device identifier as the distinct_id< / p >
2022-01-13 00:52:14 +00:00
< / div >
< / td >
< / tr >
< tr >
< td >
< code >
2022-02-19 01:37:59 +00:00
< em > superProperties< / em >
2022-01-13 00:52:14 +00:00
< / code >
< / td >
< td >
< div >
2022-02-19 01:37:59 +00:00
< p > Optional. Super properties dictionary to register during initialization< / p >
2022-01-13 00:52:14 +00:00
< / div >
< / td >
< / tr >
2019-12-19 02:23:17 +00:00
< / tbody >
< / table >
< / div >
< div >
< h4 > Return Value< / h4 >
< p > returns a mixpanel instance if needed to keep throughout the project.
You can always get the instance by calling getInstance(name)< / p >
< / div >
< / section >
< / div >
< / li >
< li class = "item" >
< div >
< code >
< a name = "/" > < / a >
2022-02-19 01:37:59 +00:00
< a name = "//apple_ref/swift/Method/initialize(token:flushInterval:instanceName:optOutTrackingByDefault:useUniqueDistinctId:superProperties:)" class = "dashAnchor" > < / a >
< a class = "token" href = "#/" > initialize(token:< wbr > flushInterval:< wbr > instanceName:< wbr > optOutTrackingByDefault:< wbr > useUniqueDistinctId:< wbr > superProperties:< wbr > )< / a >
2019-12-19 02:23:17 +00:00
< / code >
< / div >
< div class = "height-container" >
< div class = "pointer-container" > < / div >
< section class = "section" >
< div class = "pointer" > < / div >
< div class = "abstract" >
< p > Initializes an instance of the API with the given project token (MAC OS ONLY).< / p >
< p > Returns a new Mixpanel instance API object. This allows you to create more than one instance
of the API object, which is convenient if you’ d like to send data to more than
one Mixpanel project from a single app.< / p >
< div class = "aside aside-important" >
< p class = "aside-title" > Important< / p >
< p > If you have more than one Mixpanel instance, it is beneficial to initialize
the instances with an instanceName. Then they can be reached by calling getInstance with name.< / p >
< / div >
< / div >
< / section >
< / div >
< / li >
< li class = "item" >
< div >
< code >
< a name = "/s:8MixpanelAAC11getInstance4nameAA0aC0CSgSS_tFZ" > < / a >
< a name = "//apple_ref/swift/Method/getInstance(name:)" class = "dashAnchor" > < / a >
2021-04-01 20:59:45 +00:00
< a class = "token" href = "#/s:8MixpanelAAC11getInstance4nameAA0aC0CSgSS_tFZ" > getInstance(name:< wbr > )< / a >
2019-12-19 02:23:17 +00:00
< / code >
< / div >
< div class = "height-container" >
< div class = "pointer-container" > < / div >
< section class = "section" >
< div class = "pointer" > < / div >
< div class = "abstract" >
< p > Gets the mixpanel instance with the given name< / p >
< / div >
< div class = "declaration" >
< h4 > Declaration< / h4 >
< div class = "language" >
< p class = "aside-title" > Swift< / p >
< pre class = "highlight swift" > < code > < span class = "kd" > open< / span > < span class = "kd" > class< / span > < span class = "kd" > func< / span > < span class = "nf" > getInstance< / span > < span class = "p" > (< / span > < span class = "nv" > name< / span > < span class = "p" > :< / span > < span class = "kt" > String< / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "kt" > < a href = "../Classes/MixpanelInstance.html" > MixpanelInstance< / a > < / span > < span class = "p" > ?< / span > < / code > < / pre >
< / div >
< / div >
< div >
< h4 > Parameters< / h4 >
< table class = "graybox" >
< tbody >
< tr >
< td >
< code >
< em > name< / em >
< / code >
< / td >
< td >
< div >
< p > the instance name< / p >
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
< div >
< h4 > Return Value< / h4 >
< p > returns the mixpanel instance< / p >
< / div >
< / section >
< / div >
< / li >
< li class = "item" >
< div >
< code >
< a name = "/s:8MixpanelAAC12mainInstanceAA0aC0CyFZ" > < / a >
< a name = "//apple_ref/swift/Method/mainInstance()" class = "dashAnchor" > < / a >
< a class = "token" href = "#/s:8MixpanelAAC12mainInstanceAA0aC0CyFZ" > mainInstance()< / a >
< / code >
< / div >
< div class = "height-container" >
< div class = "pointer-container" > < / div >
< section class = "section" >
< div class = "pointer" > < / div >
< div class = "abstract" >
< p > Returns the main instance that was initialized.< / p >
< p > If not specified explicitly, the main instance is always the last instance added< / p >
< / div >
< div class = "declaration" >
< h4 > Declaration< / h4 >
< div class = "language" >
< p class = "aside-title" > Swift< / p >
< pre class = "highlight swift" > < code > < span class = "kd" > open< / span > < span class = "kd" > class< / span > < span class = "kd" > func< / span > < span class = "nf" > mainInstance< / span > < span class = "p" > ()< / span > < span class = "o" > -> < / span > < span class = "kt" > < a href = "../Classes/MixpanelInstance.html" > MixpanelInstance< / a > < / span > < / code > < / pre >
< / div >
< / div >
< div >
< h4 > Return Value< / h4 >
< p > returns the main Mixpanel instance< / p >
< / div >
< / section >
< / div >
< / li >
< li class = "item" >
< div >
< code >
< a name = "/s:8MixpanelAAC15setMainInstance4nameySS_tFZ" > < / a >
< a name = "//apple_ref/swift/Method/setMainInstance(name:)" class = "dashAnchor" > < / a >
2021-04-01 20:59:45 +00:00
< a class = "token" href = "#/s:8MixpanelAAC15setMainInstance4nameySS_tFZ" > setMainInstance(name:< wbr > )< / a >
2019-12-19 02:23:17 +00:00
< / code >
< / div >
< div class = "height-container" >
< div class = "pointer-container" > < / div >
< section class = "section" >
< div class = "pointer" > < / div >
< div class = "abstract" >
< p > Sets the main instance based on the instance name< / p >
< / div >
< div class = "declaration" >
< h4 > Declaration< / h4 >
< div class = "language" >
< p class = "aside-title" > Swift< / p >
< pre class = "highlight swift" > < code > < span class = "kd" > open< / span > < span class = "kd" > class< / span > < span class = "kd" > func< / span > < span class = "nf" > setMainInstance< / span > < span class = "p" > (< / span > < span class = "nv" > name< / span > < span class = "p" > :< / span > < span class = "kt" > String< / span > < span class = "p" > )< / span > < / code > < / pre >
< / div >
< / div >
< div >
< h4 > Parameters< / h4 >
< table class = "graybox" >
< tbody >
< tr >
< td >
< code >
< em > name< / em >
< / code >
< / td >
< td >
< div >
< p > the instance name< / p >
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
< / section >
< / div >
< / li >
< li class = "item" >
< div >
< code >
< a name = "/s:8MixpanelAAC14removeInstance4nameySS_tFZ" > < / a >
< a name = "//apple_ref/swift/Method/removeInstance(name:)" class = "dashAnchor" > < / a >
2021-04-01 20:59:45 +00:00
< a class = "token" href = "#/s:8MixpanelAAC14removeInstance4nameySS_tFZ" > removeInstance(name:< wbr > )< / a >
2019-12-19 02:23:17 +00:00
< / code >
< / div >
< div class = "height-container" >
< div class = "pointer-container" > < / div >
< section class = "section" >
< div class = "pointer" > < / div >
< div class = "abstract" >
< p > Removes an unneeded Mixpanel instance based on its name< / p >
< / div >
< div class = "declaration" >
< h4 > Declaration< / h4 >
< div class = "language" >
< p class = "aside-title" > Swift< / p >
< pre class = "highlight swift" > < code > < span class = "kd" > open< / span > < span class = "kd" > class< / span > < span class = "kd" > func< / span > < span class = "nf" > removeInstance< / span > < span class = "p" > (< / span > < span class = "nv" > name< / span > < span class = "p" > :< / span > < span class = "kt" > String< / span > < span class = "p" > )< / span > < / code > < / pre >
< / div >
< / div >
< div >
< h4 > Parameters< / h4 >
< table class = "graybox" >
< tbody >
< tr >
< td >
< code >
< em > name< / em >
< / code >
< / td >
< td >
< div >
< p > the instance name< / p >
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
< / section >
< / div >
< / li >
< / ul >
< / div >
< / section >
< / section >
< section id = "footer" >
2022-03-23 22:29:13 +00:00
< p > © 2022 < a class = "link" href = "http://mixpanel.com" target = "_blank" rel = "external" > Mixpanel< / a > . All rights reserved. (Last updated: 2022-03-23)< / p >
2022-03-09 01:14:32 +00:00
< p > Generated by < a class = "link" href = "https://github.com/realm/jazzy" target = "_blank" rel = "external" > jazzy ♪♫ v0.13.7< / a > , a < a class = "link" href = "https://realm.io" target = "_blank" rel = "external" > Realm< / a > project.< / p >
2019-12-19 02:23:17 +00:00
< / section >
< / article >
< / div >
< / body >
< / div >
< / html >
