2019-12-19 02:23:17 +00:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< title > Group 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/Group" class = "dashAnchor" > < / a >
< a title = "Group Class Reference" > < / a >
< header >
< div class = "content-wrapper" >
2024-04-08 21:53:49 +00:00
< p > < a href = "../index.html" > Mixpanel 4.2.5 Docs< / a > (80% documented)< / p >
2022-04-11 20:48:27 +00:00
< p class = "header-right" > < a href = "https://github.com/mixpanel/mixpanel-swift" > < img src = "../img/gh.png" alt = "GitHub" / > View on GitHub< / a > < / p >
< div class = "header-right" >
2021-04-01 20:59:45 +00:00
< form role = "search" action = "../search.json" >
< input type = "text" placeholder = "Search documentation" data-typeahead >
< / form >
2022-04-11 20:48:27 +00:00
< / div >
2019-12-19 02:23:17 +00:00
< / div >
< / header >
< div class = "content-wrapper" >
< p id = "breadcrumbs" >
< a href = "../index.html" > Mixpanel Reference< / a >
2022-04-11 20:48:27 +00:00
< img id = "carat" src = "../img/carat.png" alt = "" / >
2019-12-19 02:23:17 +00:00
Group 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 >
2024-04-08 21:53:49 +00:00
< li class = "nav-group-task" >
< a href = "../Protocols/MixpanelProxyServerDelegate.html" > MixpanelProxyServerDelegate< / a >
< / li >
2019-12-19 02:23:17 +00:00
< li class = "nav-group-task" >
< a href = "../Protocols/MixpanelType.html" > MixpanelType< / a >
< / li >
< / ul >
< / li >
2024-04-08 21:53:49 +00:00
< li class = "nav-group-name" >
< a href = "../Structs.html" > Structures< / a >
< ul class = "nav-group-tasks" >
< li class = "nav-group-task" >
< a href = "../Structs/ProxyServerConfig.html" > ProxyServerConfig< / a >
< / li >
< li class = "nav-group-task" >
< a href = "../Structs/ServerProxyResource.html" > ServerProxyResource< / a >
< / li >
< / ul >
< / li >
2019-12-19 02:23:17 +00:00
< li class = "nav-group-name" >
< a href = "../Typealiases.html" > Type Aliases< / a >
< ul class = "nav-group-tasks" >
< li class = "nav-group-task" >
2024-03-14 23:32:29 +00:00
< a href = "../Typealiases.html#/s:8Mixpanel10Propertiesa" > Properties< / a >
2019-12-19 02:23:17 +00:00
< / li >
< / ul >
< / li >
< / ul >
< / nav >
< article class = "main-content" >
< section >
< section class = "section" >
< h1 > Group< / h1 >
2024-03-14 23:32:29 +00:00
< div class = "declaration" >
< div class = "language" >
< pre class = "highlight swift" > < code > < span class = "kd" > open< / span > < span class = "kd" > class< / span > < span class = "kt" > Group< / span > < / code > < / pre >
< / div >
< / div >
2019-12-19 02:23:17 +00:00
< p > Access to the Mixpanel Groups API, available through the getGroup function from
the main Mixpanel instance.< / p >
< / section >
< section class = "section task-group-section" >
< div class = "task-group" >
< div class = "task-name-container" >
< a name = "/Group" > < / a >
< a name = "//apple_ref/swift/Section/Group" class = "dashAnchor" > < / a >
< div class = "section-name-container" >
< a class = "section-name-link" href = "#/Group" > < / a >
2022-04-11 20:48:27 +00:00
< h3 class = "section-name" > < span > Group< / span >
2019-12-19 02:23:17 +00:00
< / h3 >
< / div >
< / div >
< ul >
< li class = "item" >
< div >
< code >
2024-03-14 23:32:29 +00:00
< a name = "/s:8Mixpanel5GroupC3set10propertiesySDySSAA0A4Type_pG_tF" > < / a >
2019-12-19 02:23:17 +00:00
< a name = "//apple_ref/swift/Method/set(properties:)" class = "dashAnchor" > < / a >
2024-03-14 23:32:29 +00:00
< a class = "token" href = "#/s:8Mixpanel5GroupC3set10propertiesySDySSAA0A4Type_pG_tF" > set(properties:< 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 properties on this group.< / p >
< p > 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.
If the existing group record on the server already has a value for a given property, the old
value is overwritten. Other existing properties will not be affected.< / p >
< / div >
2024-03-14 23:32:29 +00:00
< 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" > func< / span > < span class = "nf" > set< / span > < span class = "p" > (< / span > < span class = "nv" > properties< / span > < span class = "p" > :< / span > < span class = "kt" > < a href = "../Typealiases.html#/s:8Mixpanel10Propertiesa" > Properties< / a > < / span > < span class = "p" > )< / span > < / code > < / pre >
< / div >
< / div >
< div >
< h4 > Parameters< / h4 >
< table class = "graybox" >
< tbody >
< tr >
< td >
< code >
< em > properties< / em >
< / code >
< / td >
< td >
< div >
< p > properties dictionary< / p >
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
2019-12-19 02:23:17 +00:00
< / section >
< / div >
< / li >
< li class = "item" >
< div >
< code >
2024-03-14 23:32:29 +00:00
< a name = "/s:8Mixpanel5GroupC3set8property2toySS_AA0A4Type_ptF" > < / a >
2019-12-19 02:23:17 +00:00
< a name = "//apple_ref/swift/Method/set(property:to:)" class = "dashAnchor" > < / a >
2024-03-14 23:32:29 +00:00
< a class = "token" href = "#/s:8Mixpanel5GroupC3set8property2toySS_AA0A4Type_ptF" > set(property:< wbr > to:< 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 > Convenience method for setting a single property in Mixpanel Groups.< / p >
< p > 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.< / p >
< / div >
2024-03-14 23:32:29 +00:00
< 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" > func< / span > < span class = "nf" > set< / span > < span class = "p" > (< / span > < span class = "nv" > property< / span > < span class = "p" > :< / span > < span class = "kt" > String< / span > < span class = "p" > ,< / span > < span class = "nv" > to< / span > < span class = "p" > :< / span > < span class = "kt" > < a href = "../Protocols/MixpanelType.html" > MixpanelType< / a > < / span > < span class = "p" > )< / span > < / code > < / pre >
< / div >
< / div >
< div >
< h4 > Parameters< / h4 >
< table class = "graybox" >
< tbody >
< tr >
< td >
< code >
< em > property< / em >
< / code >
< / td >
< td >
< div >
< p > property name< / p >
< / div >
< / td >
< / tr >
< tr >
< td >
< code >
< em > to< / em >
< / code >
< / td >
< td >
< div >
< p > property value< / p >
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
2019-12-19 02:23:17 +00:00
< / section >
< / div >
< / li >
< li class = "item" >
< div >
< code >
2024-03-14 23:32:29 +00:00
< a name = "/s:8Mixpanel5GroupC7setOnce10propertiesySDySSAA0A4Type_pG_tF" > < / a >
2019-12-19 02:23:17 +00:00
< a name = "//apple_ref/swift/Method/setOnce(properties:)" class = "dashAnchor" > < / a >
2024-03-14 23:32:29 +00:00
< a class = "token" href = "#/s:8Mixpanel5GroupC7setOnce10propertiesySDySSAA0A4Type_pG_tF" > setOnce(properties:< 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 properties on the current Mixpanel Group, but doesn’ t overwrite if
there is an existing value.< / p >
< p > This method is identical to < code > set:< / code > except it will only set
properties that are not already set. It is particularly useful for collecting
data about dates representing the first time something happened.< / p >
< / div >
2024-03-14 23:32:29 +00:00
< 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" > func< / span > < span class = "nf" > setOnce< / span > < span class = "p" > (< / span > < span class = "nv" > properties< / span > < span class = "p" > :< / span > < span class = "kt" > < a href = "../Typealiases.html#/s:8Mixpanel10Propertiesa" > Properties< / a > < / span > < span class = "p" > )< / span > < / code > < / pre >
< / div >
< / div >
< div >
< h4 > Parameters< / h4 >
< table class = "graybox" >
< tbody >
< tr >
< td >
< code >
< em > properties< / em >
< / code >
< / td >
< td >
< div >
< p > properties dictionary< / p >
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
2019-12-19 02:23:17 +00:00
< / section >
< / div >
< / li >
< li class = "item" >
< div >
< code >
2024-03-14 23:32:29 +00:00
< a name = "/s:8Mixpanel5GroupC5unset8propertyySS_tF" > < / a >
2019-12-19 02:23:17 +00:00
< a name = "//apple_ref/swift/Method/unset(property:)" class = "dashAnchor" > < / a >
2024-03-14 23:32:29 +00:00
< a class = "token" href = "#/s:8Mixpanel5GroupC5unset8propertyySS_tF" > unset(property:< 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 > Remove a property and its value from a group’ s profile in Mixpanel Groups.< / p >
< p > For properties that don’ t exist there will be no effect.< / p >
< / div >
2024-03-14 23:32:29 +00:00
< 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" > func< / span > < span class = "nf" > unset< / span > < span class = "p" > (< / span > < span class = "nv" > property< / 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 > property< / em >
< / code >
< / td >
< td >
< div >
< p > name of the property to unset< / p >
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
2019-12-19 02:23:17 +00:00
< / section >
< / div >
< / li >
< li class = "item" >
< div >
< code >
2024-03-14 23:32:29 +00:00
< a name = "/s:8Mixpanel5GroupC6remove3key5valueySS_AA0A4Type_ptF" > < / a >
2019-12-19 02:23:17 +00:00
< a name = "//apple_ref/swift/Method/remove(key:value:)" class = "dashAnchor" > < / a >
2024-03-14 23:32:29 +00:00
< a class = "token" href = "#/s:8Mixpanel5GroupC6remove3key5valueySS_AA0A4Type_ptF" > remove(key:< wbr > value:< 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 list properties.< / p >
< p > 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.< / p >
< / div >
2024-03-14 23:32:29 +00:00
< 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" > func< / span > < span class = "nf" > remove< / span > < span class = "p" > (< / span > < span class = "nv" > key< / span > < span class = "p" > :< / span > < span class = "kt" > String< / span > < span class = "p" > ,< / span > < span class = "nv" > value< / span > < span class = "p" > :< / span > < span class = "kt" > < a href = "../Protocols/MixpanelType.html" > MixpanelType< / a > < / span > < span class = "p" > )< / span > < / code > < / pre >
< / div >
< / div >
< div >
< h4 > Parameters< / h4 >
< table class = "graybox" >
< tbody >
< tr >
< td >
< code >
< em > properties< / em >
< / code >
< / td >
< td >
< div >
< p > mapping of list property names to values to remove< / p >
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
2019-12-19 02:23:17 +00:00
< / section >
< / div >
< / li >
< li class = "item" >
< div >
< code >
2024-03-14 23:32:29 +00:00
< a name = "/s:8Mixpanel5GroupC5union3key6valuesySS_SayAA0A4Type_pGtF" > < / a >
2019-12-19 02:23:17 +00:00
< a name = "//apple_ref/swift/Method/union(key:values:)" class = "dashAnchor" > < / a >
2024-03-14 23:32:29 +00:00
< a class = "token" href = "#/s:8Mixpanel5GroupC5union3key6valuesySS_SayAA0A4Type_pGtF" > union(key:< wbr > values:< 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 > Union list properties.< / p >
< p > Property values must be array objects.< / p >
< / div >
2024-03-14 23:32:29 +00:00
< 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" > func< / span > < span class = "nf" > union< / span > < span class = "p" > (< / span > < span class = "nv" > key< / span > < span class = "p" > :< / span > < span class = "kt" > String< / span > < span class = "p" > ,< / span > < span class = "nv" > values< / span > < span class = "p" > :< / span > < span class = "p" > [< / span > < span class = "kt" > < a href = "../Protocols/MixpanelType.html" > MixpanelType< / a > < / span > < span class = "p" > ])< / span > < / code > < / pre >
< / div >
< / div >
< div >
< h4 > Parameters< / h4 >
< table class = "graybox" >
< tbody >
< tr >
< td >
< code >
< em > properties< / em >
< / code >
< / td >
< td >
< div >
< p > mapping of list property names to lists to union< / p >
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
2019-12-19 02:23:17 +00:00
< / section >
< / div >
< / li >
< li class = "item" >
< div >
< code >
2024-03-14 23:32:29 +00:00
< a name = "/s:8Mixpanel5GroupC06deleteB0yyF" > < / a >
2019-12-19 02:23:17 +00:00
< a name = "//apple_ref/swift/Method/deleteGroup()" class = "dashAnchor" > < / a >
2024-03-14 23:32:29 +00:00
< a class = "token" href = "#/s:8Mixpanel5GroupC06deleteB0yyF" > deleteGroup()< / 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 > Delete group’ s record from Mixpanel Groups.< / p >
< / div >
2024-03-14 23:32:29 +00:00
< 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" > func< / span > < span class = "nf" > deleteGroup< / span > < span class = "p" > ()< / span > < / code > < / pre >
< / div >
< / div >
2019-12-19 02:23:17 +00:00
< / section >
< / div >
< / li >
< / ul >
< / div >
< / section >
< / section >
< section id = "footer" >
2024-04-08 21:53:49 +00:00
< p > © 2024 < a class = "link" href = "http://mixpanel.com" target = "_blank" rel = "external noopener" > Mixpanel< / a > . All rights reserved. (Last updated: 2024-04-08)< / p >
2022-04-11 20:48:27 +00:00
< 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 >
2019-12-19 02:23:17 +00:00
< / section >
< / article >
< / div >
< / body >
< / html >
