2016-10-25 22:17:44 +00:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< title > Tweak Struct 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 name = "//apple_ref/swift/Struct/Tweak" class = "dashAnchor" > < / a >
< a title = "Tweak Struct 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-10-25 22:17:44 +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" / >
Tweak Struct 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-10-25 22:17:44 +00:00
< / ul >
< / li >
< 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 >
< 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/CGFloat.html" > CGFloat< / 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 >
< 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 >
< li class = "nav-group-task" >
< a href = "../Extensions/UIColor.html" > UIColor< / 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 = "../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-10-25 22:17:44 +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 >
< li class = "nav-group-task" >
< a href = "../Protocols/MixpanelType.html" > MixpanelType< / a >
< / li >
< 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 >
< / ul >
< / li >
< / ul >
< / nav >
< article class = "main-content" >
< section >
< section class = "section" >
< h1 > Tweak< / h1 >
< div class = "declaration" >
< div class = "language" >
< pre class = "highlight" > < code > < span class = "kd" > public< / span > < span class = "kd" > struct< / span > < span class = "kt" > Tweak< / span > < span class = "o" > < < / span > < span class = "kt" > T< / span > < span class = "p" > :< / span > < span class = "kt" > < a href = "../Protocols/TweakableType.html" > TweakableType< / a > < / span > < span class = "o" > > < / span > < / code > < / pre >
< / div >
< / div >
< p > Tweaks let you adjust things on the fly.
Because each T needs a UI component, we have to restrict what T can be - hence T: TweakableType.
If T: SignedNumberType, you can declare a min / max for a Tweak.< / p >
< / section >
< section class = "section task-group-section" >
< div class = "task-group" >
< ul >
< li class = "item" >
< div >
< code >
< a name = "/s:FV8Mixpanel5TweakcFT9tweakNameSS12defaultValuexSSSS_GS0_x_" > < / a >
< a name = "//apple_ref/swift/Method/init(tweakName:defaultValue:_:_:)" class = "dashAnchor" > < / a >
< a class = "token" href = "#/s:FV8Mixpanel5TweakcFT9tweakNameSS12defaultValuexSSSS_GS0_x_" > init(tweakName:defaultValue:_:_:)< / a >
< / code >
< / div >
< div class = "height-container" >
< div class = "pointer-container" > < / div >
< section class = "section" >
< div class = "pointer" > < / div >
< div class = "abstract" >
< p > Initializer for a Tweak for A/B Testing< / p >
< / div >
< div class = "declaration" >
< h4 > Declaration< / h4 >
< div class = "language" >
< p class = "aside-title" > Swift< / p >
< pre class = "highlight" > < code > < span class = "kd" > public< / span > < span class = "nf" > init< / span > < span class = "p" > (< / span > < span class = "nv" > tweakName< / span > < span class = "p" > :< / span > < span class = "kt" > String< / span > < span class = "p" > ,< / span > < span class = "n" > defaultValue< / span > < span class = "p" > :< / span > < span class = "kt" > T< / span > < span class = "p" > ,< / span > < span class = "n" > _< / span > < span class = "nv" > collectionName< / span > < span class = "p" > :< / span > < span class = "kt" > String< / span > < span class = "o" > =< / span > < span class = "s" > "Mixpanel"< / span > < span class = "p" > ,< / span > < span class = "n" > _< / span > < span class = "nv" > groupName< / span > < span class = "p" > :< / span > < span class = "kt" > String< / span > < span class = "o" > =< / span > < span class = "s" > "Mixpanel"< / span > < span class = "p" > )< / span > < / code > < / pre >
< / div >
< / div >
< div >
< h4 > Parameters< / h4 >
< table class = "graybox" >
< tbody >
< tr >
< td >
< code >
< em > tweakName< / em >
< / code >
< / td >
< td >
< div >
< p > name of the tweak< / p >
< / div >
< / td >
< / tr >
< tr >
< td >
< code >
< em > defaultValue< / em >
< / code >
< / td >
< td >
< div >
< p > the default value set for the tweak< / p >
< / div >
< / td >
< / tr >
< tr >
< td >
< code >
< em > collectionName< / em >
< / code >
< / td >
< td >
< div >
< p > the collection name of the tweak (do not set, optional)< / p >
< / div >
< / td >
< / tr >
< tr >
< td >
< code >
< em > groupName< / em >
< / code >
< / td >
< td >
< div >
< p > the group name of the tweak (do not set, optional)< / p >
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
< / section >
< / div >
< / li >
< / ul >
< / div >
< div class = "task-group" >
< ul >
< li class = "item" >
< div >
< code >
< a name = "/s:Fe8MixpanelRxS_13TweakableTypexs12SignedNumberrVS_5TweakcFT9tweakNameSS12defaultValuex3minGSqx_3maxGSqx_8stepSizeGSqx_SSSS_GS2_x_" > < / a >
< a name = "//apple_ref/swift/Method/init(tweakName:defaultValue:min:max:stepSize:_:_:)" class = "dashAnchor" > < / a >
< a class = "token" href = "#/s:Fe8MixpanelRxS_13TweakableTypexs12SignedNumberrVS_5TweakcFT9tweakNameSS12defaultValuex3minGSqx_3maxGSqx_8stepSizeGSqx_SSSS_GS2_x_" > init(tweakName:defaultValue:min:max:stepSize:_:_:)< / a >
< / code >
< / div >
< div class = "height-container" >
< div class = "pointer-container" > < / div >
< section class = "section" >
< div class = "pointer" > < / div >
< div class = "abstract" >
< p > Creates a Tweak< T > where T: SignedNumberType
You can optionally provide a min / max / stepSize to restrict the bounds and behavior of a tweak.< / p >
< / div >
< div class = "declaration" >
< h4 > Declaration< / h4 >
< div class = "language" >
< p class = "aside-title" > Swift< / p >
< pre class = "highlight" > < code > < span class = "kd" > public< / span > < span class = "nf" > init< / span > < span class = "p" > (< / span > < span class = "nv" > tweakName< / span > < span class = "p" > :< / span > < span class = "kt" > String< / span > < span class = "p" > ,< / span >
< span class = "n" > defaultValue< / span > < span class = "p" > :< / span > < span class = "kt" > T< / span > < span class = "p" > ,< / span >
< span class = "n" > min< / span > < span class = "nv" > minimumValue< / span > < span class = "p" > :< / span > < span class = "kt" > T< / span > < span class = "p" > ?< / span > < span class = "o" > =< / span > < span class = "kc" > nil< / span > < span class = "p" > ,< / span >
< span class = "n" > max< / span > < span class = "nv" > maximumValue< / span > < span class = "p" > :< / span > < span class = "kt" > T< / span > < span class = "p" > ?< / span > < span class = "o" > =< / span > < span class = "kc" > nil< / span > < span class = "p" > ,< / span >
< span class = "nv" > stepSize< / span > < span class = "p" > :< / span > < span class = "kt" > T< / span > < span class = "p" > ?< / span > < span class = "o" > =< / span > < span class = "kc" > nil< / span > < span class = "p" > ,< / span >
< span class = "n" > _< / span > < span class = "nv" > collectionName< / span > < span class = "p" > :< / span > < span class = "kt" > String< / span > < span class = "o" > =< / span > < span class = "s" > "Mixpanel"< / span > < span class = "p" > ,< / span >
< span class = "n" > _< / span > < span class = "nv" > groupName< / span > < span class = "p" > :< / span > < span class = "kt" > String< / span > < span class = "o" > =< / span > < span class = "s" > "Mixpanel"< / span > < span class = "p" > )< / span > < / code > < / pre >
< / div >
< / div >
< div >
< h4 > Parameters< / h4 >
< table class = "graybox" >
< tbody >
< tr >
< td >
< code >
< em > tweakName< / em >
< / code >
< / td >
< td >
< div >
< p > name of the tweak< / p >
< / div >
< / td >
< / tr >
< tr >
< td >
< code >
< em > defaultValue< / em >
< / code >
< / td >
< td >
< div >
< p > the default value set for the tweak< / p >
< / div >
< / td >
< / tr >
< tr >
< td >
< code >
< em > minimumValue< / em >
< / code >
< / td >
< td >
< div >
< p > minimum value to allow for the tweak< / p >
< / div >
< / td >
< / tr >
< tr >
< td >
< code >
< em > maximumValue< / em >
< / code >
< / td >
< td >
< div >
< p > maximum value to allow for the tweak< / p >
< / div >
< / td >
< / tr >
< tr >
< td >
< code >
< em > stepSize< / em >
< / code >
< / td >
< td >
< div >
< p > step size for the tweak (do not set, optional)< / p >
< / div >
< / td >
< / tr >
< tr >
< td >
< code >
< em > collectionName< / em >
< / code >
< / td >
< td >
< div >
< p > the collection name of the tweak (do not set, optional)< / p >
< / div >
< / td >
< / tr >
< tr >
< td >
< code >
< em > groupName< / em >
< / code >
< / td >
< td >
< div >
< p > the group name of the tweak (do not set, optional)< / p >
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
< / section >
< / div >
< / li >
< / ul >
< / div >
< div class = "task-group" >
< ul >
< li class = "item" >
< div >
< code >
< a name = "/s:vV8Mixpanel5Tweak9hashValueSi" > < / a >
< a name = "//apple_ref/swift/Property/hashValue" class = "dashAnchor" > < / a >
< a class = "token" href = "#/s:vV8Mixpanel5Tweak9hashValueSi" > hashValue< / a >
< / code >
< / div >
< div class = "height-container" >
< div class = "pointer-container" > < / div >
< section class = "section" >
< div class = "pointer" > < / div >
< div class = "abstract" >
< p > Hashing for a Tweak for A/B Testing in order for it to be stored.< / p >
< / div >
< div class = "declaration" >
< h4 > Declaration< / h4 >
< div class = "language" >
< p class = "aside-title" > Swift< / p >
< pre class = "highlight" > < code > < span class = "kd" > public< / span > < span class = "k" > var< / span > < span class = "nv" > hashValue< / span > < span class = "p" > :< / span > < span class = "kt" > Int< / span > < / code > < / pre >
< / div >
< / div >
< / section >
< / div >
< / li >
< / ul >
< / div >
< div class = "task-group" >
< ul >
< li class = "item" >
< div >
< code >
< a name = "/s:vP8Mixpanel16TweakClusterType12tweakClusterGSaVS_8AnyTweak_" > < / a >
< a name = "//apple_ref/swift/Property/tweakCluster" class = "dashAnchor" > < / a >
< a class = "token" href = "#/s:vP8Mixpanel16TweakClusterType12tweakClusterGSaVS_8AnyTweak_" > tweakCluster< / a >
< / code >
< / div >
< div class = "height-container" >
< div class = "pointer-container" > < / div >
< section class = "section" >
< div class = "pointer" > < / div >
< div class = "abstract" >
< p > Extend Tweak to support easy initialization of a TweakStore< / p >
< / div >
< div class = "declaration" >
< h4 > Declaration< / h4 >
< div class = "language" >
< p class = "aside-title" > Swift< / p >
< pre class = "highlight" > < code > < span class = "kd" > public< / span > < span class = "k" > var< / span > < span class = "nv" > tweakCluster< / span > < span class = "p" > :< / span > < span class = "p" > [< / span > < span class = "kt" > < a href = "../Structs/AnyTweak.html" > AnyTweak< / a > < / span > < span class = "p" > ]< / span > < / code > < / pre >
< / div >
< / div >
< / section >
< / div >
< / li >
< / ul >
< / div >
< / 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-10-25 22:17:44 +00:00
< / section >
< / article >
< / div >
< / body >
< / div >
< / html >
