1717 < a title ="Mixpanel Class Reference "> </ a >
1818 < header >
1919 < div class ="content-wrapper ">
20- < p > < a href ="../index.html "> Mixpanel 4.3.1 Docs</ a > (81 % documented)</ p >
20+ < p > < a href ="../index.html "> Mixpanel 4.4.0 Docs</ a > (77 % documented)</ p >
2121 < p class ="header-right "> < a href ="https://github.com/mixpanel/mixpanel-swift "> < img src ="../img/gh.png " alt ="GitHub "/> View on GitHub</ a > </ p >
2222 < div class ="header-right ">
2323 < form role ="search " action ="../search.json ">
5959 < li class ="nav-group-name ">
6060 < a href ="../Enums.html "> Enumerations</ a >
6161 < ul class ="nav-group-tasks ">
62+ < li class ="nav-group-task ">
63+ < a href ="../Enums/GzipError.html "> GzipError</ a >
64+ </ li >
6265 < li class ="nav-group-task ">
6366 < a href ="../Enums/MixpanelLogLevel.html "> MixpanelLogLevel</ a >
6467 </ li >
7376 < li class ="nav-group-task ">
7477 < a href ="../Extensions/Bool.html "> Bool</ a >
7578 </ li >
79+ < li class ="nav-group-task ">
80+ < a href ="../Extensions/Data.html "> Data</ a >
81+ </ li >
7682 < li class ="nav-group-task ">
7783 < a href ="../Extensions/Date.html "> Date</ a >
7884 </ li >
@@ -175,9 +181,9 @@ <h1>Mixpanel</h1>
175181 < li class ="item ">
176182 < div >
177183 < code >
178- < a name ="/s:8MixpanelAAC10initialize5token20trackAutomaticEvents13flushInterval12instanceName23optOutTrackingByDefault19useUniqueDistinctId15superProperties9serverURLAA0A8InstanceCSS_SbSdSSSgS2bSDySSAA0A4Type_pGSgANtFZ "> </ a >
179- < a name ="//apple_ref/swift/Method/initialize(token:trackAutomaticEvents:flushInterval:instanceName:optOutTrackingByDefault:useUniqueDistinctId:superProperties:serverURL:) " class ="dashAnchor "> </ a >
180- < a class ="token " href ="#/s:8MixpanelAAC10initialize5token20trackAutomaticEvents13flushInterval12instanceName23optOutTrackingByDefault19useUniqueDistinctId15superProperties9serverURLAA0A8InstanceCSS_SbSdSSSgS2bSDySSAA0A4Type_pGSgANtFZ "> initialize(token:< wbr > trackAutomaticEvents:< wbr > flushInterval:< wbr > instanceName:< wbr > optOutTrackingByDefault:< wbr > useUniqueDistinctId:< wbr > superProperties:< wbr > serverURL:< wbr > )</ a >
184+ < a name ="/s:8MixpanelAAC10initialize5token20trackAutomaticEvents13flushInterval12instanceName23optOutTrackingByDefault19useUniqueDistinctId15superProperties9serverURL0P15GzipCompressionAA0A8InstanceCSS_SbSdSSSgS2bSDySSAA0A4Type_pGSgAOSbtFZ "> </ a >
185+ < a name ="//apple_ref/swift/Method/initialize(token:trackAutomaticEvents:flushInterval:instanceName:optOutTrackingByDefault:useUniqueDistinctId:superProperties:serverURL:useGzipCompression: ) " class ="dashAnchor "> </ a >
186+ < a class ="token " href ="#/s:8MixpanelAAC10initialize5token20trackAutomaticEvents13flushInterval12instanceName23optOutTrackingByDefault19useUniqueDistinctId15superProperties9serverURL0P15GzipCompressionAA0A8InstanceCSS_SbSdSSSgS2bSDySSAA0A4Type_pGSgAOSbtFZ "> initialize(token:< wbr > trackAutomaticEvents:< wbr > flushInterval:< wbr > instanceName:< wbr > optOutTrackingByDefault:< wbr > useUniqueDistinctId:< wbr > superProperties:< wbr > serverURL: < wbr > useGzipCompression :< wbr > )</ a >
181187 </ code >
182188 </ div >
183189 < div class ="height-container ">
@@ -210,7 +216,8 @@ <h4>Declaration</h4>
210216 < 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 >
211217 < 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 >
212218 < 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 >
213- < span class ="nv "> serverURL</ 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 > < span class ="o "> -></ span > < span class ="kt "> < a href ="../Classes/MixpanelInstance.html "> MixpanelInstance</ a > </ span > </ code > </ pre >
219+ < span class ="nv "> serverURL</ 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 >
220+ < span class ="nv "> useGzipCompression</ 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 ="o "> -></ span > < span class ="kt "> < a href ="../Classes/MixpanelInstance.html "> MixpanelInstance</ a > </ span > </ code > </ pre >
214221
215222 </ div >
216223 </ div >
@@ -315,6 +322,18 @@ <h4>Parameters</h4>
315322 </ div >
316323 </ td >
317324 </ tr >
325+ < tr >
326+ < td >
327+ < code >
328+ < em > useGzipCompression</ em >
329+ </ code >
330+ </ td >
331+ < td >
332+ < div >
333+ < p > Optional. Whether to use gzip compression for network requests.</ p >
334+ </ div >
335+ </ td >
336+ </ tr >
318337 </ tbody >
319338 </ table >
320339 </ div >
@@ -329,9 +348,9 @@ <h4>Return Value</h4>
329348 < li class ="item ">
330349 < div >
331350 < code >
332- < a name ="/s:8MixpanelAAC10initialize5token20trackAutomaticEvents13flushInterval12instanceName23optOutTrackingByDefault19useUniqueDistinctId15superProperties17proxyServerConfigAA0A8InstanceCSS_SbSdSSSgS2bSDySSAA0A4Type_pGSgAA05ProxywX0VtFZ "> </ a >
333- < a name ="//apple_ref/swift/Method/initialize(token:trackAutomaticEvents:flushInterval:instanceName:optOutTrackingByDefault:useUniqueDistinctId:superProperties:proxyServerConfig:) " class ="dashAnchor "> </ a >
334- < a class ="token " href ="#/s:8MixpanelAAC10initialize5token20trackAutomaticEvents13flushInterval12instanceName23optOutTrackingByDefault19useUniqueDistinctId15superProperties17proxyServerConfigAA0A8InstanceCSS_SbSdSSSgS2bSDySSAA0A4Type_pGSgAA05ProxywX0VtFZ "> initialize(token:< wbr > trackAutomaticEvents:< wbr > flushInterval:< wbr > instanceName:< wbr > optOutTrackingByDefault:< wbr > useUniqueDistinctId:< wbr > superProperties:< wbr > proxyServerConfig:< wbr > )</ a >
351+ < a name ="/s:8MixpanelAAC10initialize5token20trackAutomaticEvents13flushInterval12instanceName23optOutTrackingByDefault19useUniqueDistinctId15superProperties17proxyServerConfig0P15GzipCompressionAA0A8InstanceCSS_SbSdSSSgS2bSDySSAA0A4Type_pGSgAA05ProxywX0VSbtFZ "> </ a >
352+ < a name ="//apple_ref/swift/Method/initialize(token:trackAutomaticEvents:flushInterval:instanceName:optOutTrackingByDefault:useUniqueDistinctId:superProperties:proxyServerConfig:useGzipCompression: ) " class ="dashAnchor "> </ a >
353+ < a class ="token " href ="#/s:8MixpanelAAC10initialize5token20trackAutomaticEvents13flushInterval12instanceName23optOutTrackingByDefault19useUniqueDistinctId15superProperties17proxyServerConfig0P15GzipCompressionAA0A8InstanceCSS_SbSdSSSgS2bSDySSAA0A4Type_pGSgAA05ProxywX0VSbtFZ "> initialize(token:< wbr > trackAutomaticEvents:< wbr > flushInterval:< wbr > instanceName:< wbr > optOutTrackingByDefault:< wbr > useUniqueDistinctId:< wbr > superProperties:< wbr > proxyServerConfig: < wbr > useGzipCompression :< wbr > )</ a >
335354 </ code >
336355 </ div >
337356 < div class ="height-container ">
@@ -364,7 +383,8 @@ <h4>Declaration</h4>
364383 < 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 >
365384 < 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 >
366385 < 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 >
367- < span class ="nv "> proxyServerConfig</ span > < span class ="p "> :</ span > < span class ="kt "> < a href ="../Structs/ProxyServerConfig.html "> ProxyServerConfig</ a > </ span > < span class ="p "> )</ span > < span class ="o "> -></ span > < span class ="kt "> < a href ="../Classes/MixpanelInstance.html "> MixpanelInstance</ a > </ span > </ code > </ pre >
386+ < span class ="nv "> proxyServerConfig</ span > < span class ="p "> :</ span > < span class ="kt "> < a href ="../Structs/ProxyServerConfig.html "> ProxyServerConfig</ a > </ span > < span class ="p "> ,</ span >
387+ < span class ="nv "> useGzipCompression</ 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 ="o "> -></ span > < span class ="kt "> < a href ="../Classes/MixpanelInstance.html "> MixpanelInstance</ a > </ span > </ code > </ pre >
368388
369389 </ div >
370390 </ div >
@@ -469,6 +489,18 @@ <h4>Parameters</h4>
469489 </ div >
470490 </ td >
471491 </ tr >
492+ < tr >
493+ < td >
494+ < code >
495+ < em > useGzipCompression</ em >
496+ </ code >
497+ </ td >
498+ < td >
499+ < div >
500+ < p > Optional. Whether to use gzip compression for network requests.</ p >
501+ </ div >
502+ </ td >
503+ </ tr >
472504 </ tbody >
473505 </ table >
474506 </ div >
@@ -484,8 +516,8 @@ <h4>Return Value</h4>
484516 < div >
485517 < code >
486518 < a name ="/ "> </ a >
487- < a name ="//apple_ref/swift/Method/initialize(token:flushInterval:instanceName:optOutTrackingByDefault:useUniqueDistinctId:superProperties:serverURL:) " class ="dashAnchor "> </ a >
488- < a class ="token " href ="#/ "> initialize(token:< wbr > flushInterval:< wbr > instanceName:< wbr > optOutTrackingByDefault:< wbr > useUniqueDistinctId:< wbr > superProperties:< wbr > serverURL:< wbr > )</ a >
519+ < a name ="//apple_ref/swift/Method/initialize(token:flushInterval:instanceName:optOutTrackingByDefault:useUniqueDistinctId:superProperties:serverURL:useGzipCompression: ) " class ="dashAnchor "> </ a >
520+ < a class ="token " href ="#/ "> initialize(token:< wbr > flushInterval:< wbr > instanceName:< wbr > optOutTrackingByDefault:< wbr > useUniqueDistinctId:< wbr > superProperties:< wbr > serverURL:< wbr > useGzipCompression: < wbr > )</ a >
489521 </ code >
490522 </ div >
491523 < div class ="height-container ">
@@ -513,8 +545,8 @@ <h4>Return Value</h4>
513545 < div >
514546 < code >
515547 < a name ="/ "> </ a >
516- < a name ="//apple_ref/swift/Method/initialize(token:flushInterval:instanceName:optOutTrackingByDefault:useUniqueDistinctId:superProperties:proxyServerConfig:) " class ="dashAnchor "> </ a >
517- < a class ="token " href ="#/ "> initialize(token:< wbr > flushInterval:< wbr > instanceName:< wbr > optOutTrackingByDefault:< wbr > useUniqueDistinctId:< wbr > superProperties:< wbr > proxyServerConfig:< wbr > )</ a >
548+ < a name ="//apple_ref/swift/Method/initialize(token:flushInterval:instanceName:optOutTrackingByDefault:useUniqueDistinctId:superProperties:proxyServerConfig:useGzipCompression: ) " class ="dashAnchor "> </ a >
549+ < a class ="token " href ="#/ "> initialize(token:< wbr > flushInterval:< wbr > instanceName:< wbr > optOutTrackingByDefault:< wbr > useUniqueDistinctId:< wbr > superProperties:< wbr > proxyServerConfig:< wbr > useGzipCompression: < wbr > )</ a >
518550 </ code >
519551 </ div >
520552 < div class ="height-container ">
@@ -621,6 +653,37 @@ <h4>Return Value</h4>
621653 </ section >
622654 </ div >
623655 </ li >
656+ < li class ="item ">
657+ < div >
658+ < code >
659+ < a name ="/s:8MixpanelAAC16safeMainInstanceAA0aD0CSgyFZ "> </ a >
660+ < a name ="//apple_ref/swift/Method/safeMainInstance() " class ="dashAnchor "> </ a >
661+ < a class ="token " href ="#/s:8MixpanelAAC16safeMainInstanceAA0aD0CSgyFZ "> safeMainInstance()</ a >
662+ </ code >
663+ </ div >
664+ < div class ="height-container ">
665+ < div class ="pointer-container "> </ div >
666+ < section class ="section ">
667+ < div class ="pointer "> </ div >
668+ < div class ="abstract ">
669+ < p > Returns the main Mixpanel instance if it has been initialized.</ p >
670+
671+ </ div >
672+ < div class ="declaration ">
673+ < h4 > Declaration</ h4 >
674+ < div class ="language ">
675+ < p class ="aside-title "> Swift</ p >
676+ < pre class ="highlight swift "> < code > < span class ="kd "> public</ span > < span class ="kd "> class</ span > < span class ="kd "> func</ span > < span class ="nf "> safeMainInstance</ 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 >
677+
678+ </ div >
679+ </ div >
680+ < div >
681+ < h4 > Return Value</ h4 >
682+ < p > An optional MixpanelInstance, or nil if not yet initialized.</ p >
683+ </ div >
684+ </ section >
685+ </ div >
686+ </ li >
624687 < li class ="item ">
625688 < div >
626689 < code >
@@ -718,7 +781,7 @@ <h4>Parameters</h4>
718781 </ section >
719782 </ section >
720783 < section id ="footer ">
721- < p > © 2025 < a class ="link " href ="http://mixpanel.com " target ="_blank " rel ="external noopener "> Mixpanel</ a > . All rights reserved. (Last updated: 2025-02-10 )</ p >
784+ < p > © 2025 < a class ="link " href ="http://mixpanel.com " target ="_blank " rel ="external noopener "> Mixpanel</ a > . All rights reserved. (Last updated: 2025-03-31 )</ p >
722785 < p > Generated by < a class ="link " href ="https://github.com/realm/jazzy " target ="_blank " rel ="external noopener "> jazzy ♪♫ v0.14.2</ a > , a < a class ="link " href ="https://realm.io " target ="_blank " rel ="external noopener "> Realm</ a > project.</ p >
723786 </ section >
724787 </ article >
0 commit comments