From b5f242788d3c3fdffe22ae613d171121d71740a3 Mon Sep 17 00:00:00 2001 From: Yarden Eitan Date: Mon, 22 May 2017 13:17:54 -0700 Subject: [PATCH] bump to 2.1.6 and updated docs --- Mixpanel-swift-appex.podspec | 2 +- Mixpanel-swift.podspec | 2 +- Mixpanel/Info.plist | 2 +- docs/Classes.html | 68 +- docs/Classes/Mixpanel.html | 80 +- docs/Classes/MixpanelInstance.html | 1150 +++++++++++++++- docs/Classes/People.html | 88 +- docs/Enums.html | 75 +- docs/Enums/TweakViewDataType.html | 106 +- docs/Extensions.html | 112 +- docs/Extensions/Array.html | 66 +- docs/Extensions/Bool.html | 66 +- docs/Extensions/CGFloat.html | 66 +- docs/Extensions/Date.html | 66 +- docs/Extensions/Dictionary.html | 68 +- docs/Extensions/Double.html | 66 +- docs/Extensions/Float.html | 66 +- docs/Extensions/Int.html | 66 +- docs/Extensions/NSNull.html | 66 +- docs/Extensions/String.html | 66 +- docs/Extensions/UIColor.html | 111 +- docs/Extensions/UInt.html | 66 +- docs/Extensions/URL.html | 66 +- docs/Functions.html | 72 +- docs/Functions/==(_:_:).html | 66 +- docs/Instance Methods.html | 1169 ----------------- docs/Protocols.html | 66 +- docs/Protocols/MixpanelDelegate.html | 68 +- docs/Protocols/MixpanelType.html | 66 +- docs/Protocols/TweakClusterType.html | 66 +- docs/Protocols/TweakLibraryType.html | 69 +- docs/Protocols/TweakableType.html | 66 +- docs/Structs.html | 66 +- docs/Structs/AnyTweak.html | 69 +- docs/Structs/MixpanelTweaks.html | 67 +- docs/Structs/Tweak.html | 80 +- docs/css/jazzy.css | 5 + .../Contents/Resources/Documents/Classes.html | 68 +- .../Resources/Documents/Classes/Mixpanel.html | 80 +- .../Documents/Classes/MixpanelInstance.html | 1150 +++++++++++++++- .../Resources/Documents/Classes/People.html | 88 +- .../Contents/Resources/Documents/Enums.html | 75 +- .../Documents/Enums/TweakViewDataType.html | 106 +- .../Resources/Documents/Extensions.html | 112 +- .../Resources/Documents/Extensions/Array.html | 66 +- .../Resources/Documents/Extensions/Bool.html | 66 +- .../Documents/Extensions/CGFloat.html | 66 +- .../Resources/Documents/Extensions/Date.html | 66 +- .../Documents/Extensions/Dictionary.html | 68 +- .../Documents/Extensions/Double.html | 66 +- .../Resources/Documents/Extensions/Float.html | 66 +- .../Resources/Documents/Extensions/Int.html | 66 +- .../Documents/Extensions/NSNull.html | 66 +- .../Documents/Extensions/String.html | 66 +- .../Documents/Extensions/UIColor.html | 111 +- .../Resources/Documents/Extensions/UInt.html | 66 +- .../Resources/Documents/Extensions/URL.html | 66 +- .../Resources/Documents/Functions.html | 72 +- .../Documents/Functions/==(_:_:).html | 66 +- .../Resources/Documents/Instance Methods.html | 1169 ----------------- .../Resources/Documents/Protocols.html | 66 +- .../Documents/Protocols/MixpanelDelegate.html | 68 +- .../Documents/Protocols/MixpanelType.html | 66 +- .../Documents/Protocols/TweakClusterType.html | 66 +- .../Documents/Protocols/TweakLibraryType.html | 69 +- .../Documents/Protocols/TweakableType.html | 66 +- .../Contents/Resources/Documents/Structs.html | 66 +- .../Resources/Documents/Structs/AnyTweak.html | 69 +- .../Documents/Structs/MixpanelTweaks.html | 67 +- .../Resources/Documents/Structs/Tweak.html | 80 +- .../Resources/Documents/css/jazzy.css | 5 + .../Contents/Resources/Documents/index.html | 225 ++-- .../Contents/Resources/Documents/search.json | 2 +- .../Contents/Resources/docSet.dsidx | Bin 45056 -> 45056 bytes docs/docsets/Mixpanel.tgz | Bin 84624 -> 80190 bytes docs/index.html | 225 ++-- docs/search.json | 2 +- .../Documents => }/undocumented.json | 0 generate_docs.sh | 5 +- 79 files changed, 2570 insertions(+), 7053 deletions(-) delete mode 100644 docs/Instance Methods.html delete mode 100644 docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Instance Methods.html rename docs/{docsets/Mixpanel.docset/Contents/Resources/Documents => }/undocumented.json (100%) diff --git a/Mixpanel-swift-appex.podspec b/Mixpanel-swift-appex.podspec index 89cd84892..460fc0bd3 100644 --- a/Mixpanel-swift-appex.podspec +++ b/Mixpanel-swift-appex.podspec @@ -1,6 +1,6 @@ Pod::Spec.new do |s| s.name = 'Mixpanel-swift-appex' - s.version = '2.1.5' + s.version = '2.1.6' s.module_name = 'MixpanelAppex' s.license = 'Apache License, Version 2.0' s.summary = 'Mixpanel tracking library for iOS (Swift) App Extensions' diff --git a/Mixpanel-swift.podspec b/Mixpanel-swift.podspec index 72dc7d398..e11b1b4f7 100644 --- a/Mixpanel-swift.podspec +++ b/Mixpanel-swift.podspec @@ -1,7 +1,7 @@ Pod::Spec.new do |s| s.name = 'Mixpanel-swift' - s.version = '2.1.5' + s.version = '2.1.6' s.module_name = 'Mixpanel' s.license = 'Apache License, Version 2.0' s.summary = 'Mixpanel tracking library for iOS (Swift)' diff --git a/Mixpanel/Info.plist b/Mixpanel/Info.plist index 5a46b9187..612e5de31 100644 --- a/Mixpanel/Info.plist +++ b/Mixpanel/Info.plist @@ -15,7 +15,7 @@ CFBundlePackageType FMWK CFBundleShortVersionString - 2.1.5 + 2.1.6 CFBundleSignature ???? CFBundleVersion diff --git a/docs/Classes.html b/docs/Classes.html index ffc964012..be6ae3a2f 100644 --- a/docs/Classes.html +++ b/docs/Classes.html @@ -107,68 +107,6 @@ -
  • - Instance Methods - -
  • Protocols
    • -
  • - Instance Methods - -
  • Protocols
    • -
  • - Instance Methods - -
  • Protocols + +
    +
    + + + +

    Identity

    +     +
    +
      +
    • +
      + + + + identify(distinctId:) + +
      +
      +
      +
      +
      +
      +

      Sets the distinct ID of the current user.

      + +

      Mixpanel uses the IFV String (UIDevice.current().identifierForVendor) +as the default distinct ID. This ID will identify a user across all apps by the same +vendor, but cannot be used to link the same user across apps from different +vendors. If we are unable to get the IFV, we will fall back to generating a +random persistent UUID

      + +

      For tracking events, you do not need to call identify: if you +want to use the default. However, +Mixpanel People always requires an explicit call to identify:. +If calls are made to +set:, increment or other People +methods prior to calling identify:, then they are queued up and +flushed once identify: is called.

      + +

      If you’d like to use the default distinct ID for Mixpanel People as well +(recommended), call identify: using the current distinct ID: +mixpanelInstance.identify(mixpanelInstance.distinctId).

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      open func identify(distinctId: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + distinctId + + +
      +

      string that uniquely identifies the current user

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Creates a distinctId alias from alias to the current id.

      + +

      This method is used to map an identifier called an alias to the existing Mixpanel +distinct id. This causes all events and people requests sent with the alias to be +mapped back to the original distinct id. The recommended usage pattern is to call +both createAlias: and identify: when the user signs up, and only identify: (with +their new user ID) when they log in. This will keep your signup funnels working +correctly.

      + +

      This makes the current id and ‘Alias’ interchangeable distinct ids. +Mixpanel. +mixpanelInstance.createAlias(Alias, mixpanelInstance.distinctId)

      +
      +

      Precondition

      +

      You must call identify if you haven’t already +(e.g. when your app launches)

      + +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      open func createAlias(_ alias: String, distinctId: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + alias + + +
      +

      the new distinct id that should represent the original

      +
      +
      + + distinctId + + +
      +

      the old distinct id that alias will be mapped to

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + reset() + +
      +
      +
      +
      +
      +
      +

      Clears all stored properties including the distinct Id. +Useful if your app’s user logs out.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      open func reset()
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + + +

    Persistence

    +     +
    +
      +
    • +
      + + + + archive() + +
      +
      +
      +
      +
      +
      +

      Writes current project info including the distinct Id, super properties, +and pending event and People record queues to disk.

      + +

      This state will be recovered when the app is launched again if the Mixpanel +library is initialized with the same project token. +The library listens for app state changes and handles +persisting data as needed.

      +
      +

      Important

      + You do not need to call this method.** + +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      open func archive()
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + archive() + +
      +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      open class MixpanelInstance: CustomDebugStringConvertible, FlushDelegate, AEDelegate
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + + +

    Flush

    +     +
    +
      +
    • +
      + + + + flush(completion:) + +
      +
      +
      +
      +
      +
      +

      Uploads queued data to the Mixpanel server.

      + +

      By default, queued data is flushed to the Mixpanel servers every minute (the +default for flushInterval), and on background (since +flushOnBackground is on by default). You only need to call this +method manually if you want to force a flush at a particular moment.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      open func flush(completion: (() -> Void)? = nil)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + completion + + +
      +

      an optional completion handler for when the flush has completed.

      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + + +

    Track

    +     +
    +
      +
    • + +
      +
      +
      +
      +
      +

      Tracks an event with properties. +Properties are optional and can be added only if needed.

      + +

      Properties will allow you to segment your events in your Mixpanel reports. +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 event is being timed, the timer will stop and be added as a property.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      open func track(event: String?, properties: Properties? = nil)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + event + + +
      +

      event name

      +
      +
      + + properties + + +
      +

      properties dictionary

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Track a push notification using its payload sent from Mixpanel.

      + +

      To simplify user interaction tracking, Mixpanel +automatically sends IDs for the relevant notification of each push. +This method parses the standard payload and queues a track call using this information.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      open func trackPushNotification(_ userInfo: [AnyHashable: Any],
+                                      event: String = "$campaign_received")
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + userInfo + + +
      +

      remote notification payload dictionary

      +
      +
      + + event + + +
      +

      optional, and usually shouldn’t be used, +unless the results is needed to be tracked elsewhere.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + time(event:) + +
      +
      +
      +
      +
      +
      +

      Starts a timer that will be stopped and added as a property when a +corresponding event is tracked.

      + +

      This method is intended to be used in advance of events that have +a duration. For example, if a developer were to track an Image Upload event +she might want to also know how long the upload took. Calling this method +before the upload code would implicitly cause the track +call to record its duration.

      +
      +

      Precondition

      +

      // begin timing the image upload: +mixpanelInstance.time(event:Image Upload) +// upload the image: +self.uploadImageWithSuccessHandler() { _ in +// track the event +mixpanelInstance.track(Image Upload) +}

      + +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      open func time(event: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + event + + +
      +

      the event name to be timed

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + clearTimedEvents() + +
      +
      +
      +
      +
      +
      +

      Clears all current event timers.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      open func clearTimedEvents()
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Returns the currently set super properties.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      open func currentSuperProperties() -> [String: Any]
      + +
      +
      +
      +

      Return Value

      +

      the current super properties

      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Clears all currently set super properties.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      open func clearSuperProperties()
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Registers super properties, overwriting ones that have already been set.

      + +

      Super properties, once registered, are automatically sent as properties for +all event tracking calls. They save you having to maintain and add a common +set of properties to your events. +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.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      open func registerSuperProperties(_ properties: Properties)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + properties + + +
      +

      properties dictionary

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Registers super properties without overwriting ones that have already been set, +unless the existing value is equal to defaultValue. defaultValue is optional.

      + +

      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.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      open func registerSuperPropertiesOnce(_ properties: Properties,
+                                            defaultValue: MixpanelType? = nil)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + properties + + +
      +

      properties dictionary

      +
      +
      + + defaultValue + + +
      +

      Optional. overwrite existing properties that have this value

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Removes a previously registered super property.

      + +

      As an alternative to clearing all properties, unregistering specific super +properties prevents them from being recorded on future events. This operation +does not affect the value of other super properties. Any property name that is +not registered is ignored. +Note that after removing a super property, events will show the attribute as +having the value undefined in Mixpanel until a new value is +registered.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      open func unregisterSuperProperty(_ propertyName: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + propertyName + + +
      +

      array of property name strings to remove

      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + + +

    A/B Testing

    +     +
    +
      +
    • + +
      +
      +
      +
      +
      +

      Join any experiments (A/B tests) that are available for the current user.

      + +

      Mixpanel will check for A/B tests automatically when your app enters +the foreground. Call this method if you would like to to check for, +and join, any experiments are newly available for the current user.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      open func joinExperiments(callback: (() -> Void)? = nil)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + callback + + +
      +

      Optional callback for after the experiments have been loaded and applied

      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + + +

    In App Notifications

    +     +
    +
      +
    • +
      + + + + showNotification() + +
      +
      +
      +
      +
      +
      +

      Shows a notification if one is available.

      +
      +

      Note

      + You do not need to call this method on the main thread. + +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      open func showNotification()
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Shows a notification with the given type if one is available.

      +
      +

      Note

      + You do not need to call this method on the main thread. + +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      open func showNotification(type: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + type + + +
      +

      The type of notification to show, either mini or takeover

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + showNotification(ID:) + +
      +
      +
      +
      +
      +
      +

      Shows a notification with the given ID

      +
      +

      Note

      + You do not need to call this method on the main thread. + +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      open func showNotification(ID: Int)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + ID + + +
      +

      The notification ID you want to present

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Returns the payload of a notification if available

      +
      +

      Note

      + You do not need to call this method on the main thread. + +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      open func fetchNotificationPayload(completion: @escaping ([String: AnyObject]?) -> Void)
      + +
      +
      +
      +
      +
    diff --git a/docs/Classes/People.html b/docs/Classes/People.html index 5b4af4faf..00b5dec5f 100644 --- a/docs/Classes/People.html +++ b/docs/Classes/People.html @@ -108,68 +108,6 @@
    • -
  • - Instance Methods - -
  • Protocols
    • -
  • - Instance Methods - -
  • Protocols
    • -
  • - Instance Methods - -
  • Protocols -
    -
      -
    • -
      - - - - uiColor - -
      -
      -
      -
      -
      -
      -

      TweakableType supports the uiColor type

      - -
      -
      -

      Declaration

      -
      -

      Swift

      - 
      case uiColor
      - -
      -
      -
      -
      -
      • -
    -
    diff --git a/docs/Extensions.html b/docs/Extensions.html index de1c38aba..59b7b4ca3 100644 --- a/docs/Extensions.html +++ b/docs/Extensions.html @@ -107,68 +107,6 @@
    • -
  • - Instance Methods - -
  • Protocols +
    + +
    diff --git a/docs/Extensions/Array.html b/docs/Extensions/Array.html index dc7e55d91..fca594073 100644 --- a/docs/Extensions/Array.html +++ b/docs/Extensions/Array.html @@ -108,68 +108,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -253,8 +191,8 @@

      Declaration

      diff --git a/docs/Extensions/Bool.html b/docs/Extensions/Bool.html index 3c622a331..1bf58c4e5 100644 --- a/docs/Extensions/Bool.html +++ b/docs/Extensions/Bool.html @@ -108,68 +108,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -285,8 +223,8 @@

      Declaration

      diff --git a/docs/Extensions/CGFloat.html b/docs/Extensions/CGFloat.html index f9e54943a..4792e92af 100644 --- a/docs/Extensions/CGFloat.html +++ b/docs/Extensions/CGFloat.html @@ -108,68 +108,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -248,8 +186,8 @@

      Declaration

      diff --git a/docs/Extensions/Date.html b/docs/Extensions/Date.html index 71fe19df2..51662a226 100644 --- a/docs/Extensions/Date.html +++ b/docs/Extensions/Date.html @@ -108,68 +108,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -254,8 +192,8 @@

      Declaration

      diff --git a/docs/Extensions/Dictionary.html b/docs/Extensions/Dictionary.html index 1e03623c2..7bb222b61 100644 --- a/docs/Extensions/Dictionary.html +++ b/docs/Extensions/Dictionary.html @@ -108,68 +108,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -212,7 +150,7 @@

      Dictionary

      - 
      struct Dictionary<Key : Hashable, Value> : Collection, ExpressibleByDictionaryLiteral
      + 
      struct Dictionary<Key, Value> : Collection, ExpressibleByDictionaryLiteral where Key : Hashable
      @@ -253,8 +191,8 @@

      Declaration

      diff --git a/docs/Extensions/Double.html b/docs/Extensions/Double.html index 0cb7c878b..0c31d3c5c 100644 --- a/docs/Extensions/Double.html +++ b/docs/Extensions/Double.html @@ -108,68 +108,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -285,8 +223,8 @@

      Declaration

      diff --git a/docs/Extensions/Float.html b/docs/Extensions/Float.html index ac55002ac..ec172929c 100644 --- a/docs/Extensions/Float.html +++ b/docs/Extensions/Float.html @@ -108,68 +108,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -254,8 +192,8 @@

      Declaration

      diff --git a/docs/Extensions/Int.html b/docs/Extensions/Int.html index 8c582ef2b..6f2464baf 100644 --- a/docs/Extensions/Int.html +++ b/docs/Extensions/Int.html @@ -108,68 +108,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -285,8 +223,8 @@

      Declaration

      diff --git a/docs/Extensions/NSNull.html b/docs/Extensions/NSNull.html index 8f8e9a29a..972d44160 100644 --- a/docs/Extensions/NSNull.html +++ b/docs/Extensions/NSNull.html @@ -108,68 +108,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -249,8 +187,8 @@

      Declaration

      diff --git a/docs/Extensions/String.html b/docs/Extensions/String.html index be23f23c4..c46bde467 100644 --- a/docs/Extensions/String.html +++ b/docs/Extensions/String.html @@ -108,68 +108,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -285,8 +223,8 @@

      Declaration

      diff --git a/docs/Extensions/UIColor.html b/docs/Extensions/UIColor.html index 76fd6fbfa..14f4a6dc0 100644 --- a/docs/Extensions/UIColor.html +++ b/docs/Extensions/UIColor.html @@ -108,68 +108,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -219,40 +157,9 @@

      UIColor

    • - - - tweakViewDataType - -
      -
      -
      -
      -
      -
      -

      TweakableType supports the uiColor type

      - -
      -
      -

      Declaration

      -
      -

      Swift

      - 
      public static var tweakViewDataType: TweakViewDataType
      - -
      -
      -
      -
      -
      • -
    - -
    -
      -
    • -
      - - - - init(hex4:) + + + init(MPHex:)
      @@ -261,15 +168,14 @@

      Declaration

      The shorthand four-digit hexadecimal representation of color with alpha.

      - -

      RGBA defines to the color #AARRGGBB.

      +

      RGBA defines to the color #AARRGGBB.

      Declaration

      Swift

      - 
      public convenience init(hex4: UInt)
      + 
      public convenience init(MPHex: UInt)
      @@ -280,13 +186,12 @@

      Parameters

      - hex4 + MPHex

      hexadecimal value.

      -
      @@ -301,8 +206,8 @@

      Parameters

      diff --git a/docs/Extensions/UInt.html b/docs/Extensions/UInt.html index ed6d3e947..70b66af62 100644 --- a/docs/Extensions/UInt.html +++ b/docs/Extensions/UInt.html @@ -108,68 +108,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -254,8 +192,8 @@

      Declaration

      diff --git a/docs/Extensions/URL.html b/docs/Extensions/URL.html index c3769a100..cb6a840f4 100644 --- a/docs/Extensions/URL.html +++ b/docs/Extensions/URL.html @@ -108,68 +108,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -254,8 +192,8 @@

      Declaration

      diff --git a/docs/Functions.html b/docs/Functions.html index f58b45cca..4ce95a589 100644 --- a/docs/Functions.html +++ b/docs/Functions.html @@ -107,68 +107,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -253,7 +191,6 @@

      Parameters

      the left hand side tweak to compare

      -
      @@ -266,7 +203,6 @@

      Parameters

      the right hand side tweak to compare

      -
      @@ -276,7 +212,6 @@

      Parameters

      Return Value

      a boolean telling if both tweaks are equal

      -
      @@ -322,7 +257,6 @@

      Parameters

      the left hand side tweak to compare

      -
      @@ -335,7 +269,6 @@

      Parameters

      the right hand side tweak to compare

      -
      @@ -345,7 +278,6 @@

      Parameters

      Return Value

      a boolean telling if both tweaks are equal

      -
      @@ -355,8 +287,8 @@

      Return Value

      diff --git a/docs/Functions/==(_:_:).html b/docs/Functions/==(_:_:).html index cfb89bfb3..13215091e 100644 --- a/docs/Functions/==(_:_:).html +++ b/docs/Functions/==(_:_:).html @@ -108,68 +108,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -254,8 +192,8 @@

      Declaration

      diff --git a/docs/Instance Methods.html b/docs/Instance Methods.html deleted file mode 100644 index 810a49822..000000000 --- a/docs/Instance Methods.html +++ /dev/null @@ -1,1169 +0,0 @@ - - - - Instance Methods Reference - - - - - - - - - -
      -
      -

      Mixpanel Docs (100% documented)

      -

      View on GitHub

      -
      -
      -
      - -
      -
      - -
      -
      -
      -

      Instance Methods

      -

      The following instance methods are available globally.

      - -
      -
      -
      -
        -
      • -
        - - - - showNotification() - -
        -
        -
        -
        -
        -
        -

        Shows a notification if one is available.

        - -
        -

        Note

        - You do not need to call this method on the main thread. - -
        - -
        -
        -

        Declaration

        -
        -

        Swift

        - 
        open func showNotification()
        - -
        -
        -
        -
        -
        • -
      • -
        - - - - identify(distinctId:) - -
        -
        -
        -
        -
        -
        -

        Sets the distinct ID of the current user.

        - -

        Mixpanel uses the IFV String (UIDevice.current().identifierForVendor) -as the default distinct ID. This ID will identify a user across all apps by the same -vendor, but cannot be used to link the same user across apps from different -vendors. If we are unable to get the IFV, we will fall back to generating a -random persistent UUID

        - -

        For tracking events, you do not need to call identify: if you -want to use the default. However, -Mixpanel People always requires an explicit call to identify:. -If calls are made to -set:, increment or other People -methods prior to calling identify:, then they are queued up and -flushed once identify: is called.

        - -

        If you’d like to use the default distinct ID for Mixpanel People as well -(recommended), call identify: using the current distinct ID: -mixpanelInstance.identify(mixpanelInstance.distinctId).

        - -
        -
        -

        Declaration

        -
        -

        Swift

        - 
        open func identify(distinctId: String)
        - -
        -
        -
        -

        Parameters

        - - - - - - - -
        - - distinctId - - -
        -

        string that uniquely identifies the current user

        - -
        -
        -
        -
        -
        -
        • -
      • - -
        -
        -
        -
        -
        -

        Creates a distinctId alias from alias to the current id.

        - -

        This method is used to map an identifier called an alias to the existing Mixpanel -distinct id. This causes all events and people requests sent with the alias to be -mapped back to the original distinct id. The recommended usage pattern is to call -both createAlias: and identify: when the user signs up, and only identify: (with -their new user ID) when they log in. This will keep your signup funnels working -correctly.

        - -

        This makes the current id and ‘Alias’ interchangeable distinct ids. -Mixpanel. -mixpanelInstance.createAlias(Alias, mixpanelInstance.distinctId)

        - -
        -

        Precondition

        -

        You must call identify if you haven’t already -(e.g. when your app launches)

        - -
        - -
        -
        -

        Declaration

        -
        -

        Swift

        - 
        open func createAlias(_ alias: String, distinctId: String)
        - -
        -
        -
        -

        Parameters

        - - - - - - - - - - - -
        - - alias - - -
        -

        the new distinct id that should represent the original

        - -
        -
        - - distinctId - - -
        -

        the old distinct id that alias will be mapped to

        - -
        -
        -
        -
        -
        -
        • -
      • -
        - - - - showNotification(ID:) - -
        -
        -
        -
        -
        -
        -

        Shows a notification with the given ID

        - -
        -

        Note

        - You do not need to call this method on the main thread. - -
        - -
        -
        -

        Declaration

        -
        -

        Swift

        - 
        open func showNotification(ID: Int)
        - -
        -
        -
        -

        Parameters

        - - - - - - - -
        - - ID - - -
        -

        The notification ID you want to present

        - -
        -
        -
        -
        -
        -
        • -
      • -
        - - - - archive() - -
        -
        -
        -
        -
        -
        -

        Writes current project info including the distinct Id, super properties, -and pending event and People record queues to disk.

        - -

        This state will be recovered when the app is launched again if the Mixpanel -library is initialized with the same project token. -The library listens for app state changes and handles -persisting data as needed.

        - -
        -

        Important

        - You do not need to call this method.** - -
        - -
        -
        -

        Declaration

        -
        -

        Swift

        - 
        open func archive()
        - -
        -
        -
        -
        -
        • -
      • -
        - - - - time(event:) - -
        -
        -
        -
        -
        -
        -

        Starts a timer that will be stopped and added as a property when a -corresponding event is tracked.

        - -

        This method is intended to be used in advance of events that have -a duration. For example, if a developer were to track an Image Upload event -she might want to also know how long the upload took. Calling this method -before the upload code would implicitly cause the track -call to record its duration.

        - -
        -

        Precondition

        -

        // begin timing the image upload: -mixpanelInstance.time(event:Image Upload) -// upload the image: -self.uploadImageWithSuccessHandler() { _ in -// track the event -mixpanelInstance.track(Image Upload) -}

        - -
        - -
        -
        -

        Declaration

        -
        -

        Swift

        - 
        open func time(event: String)
        - -
        -
        -
        -

        Parameters

        - - - - - - - -
        - - event - - -
        -

        the event name to be timed

        - -
        -
        -
        -
        -
        -
        • -
      • -
        - - - - reset() - -
        -
        -
        -
        -
        -
        -

        Clears all stored properties including the distinct Id. -Useful if your app’s user logs out.

        - -
        -
        -

        Declaration

        -
        -

        Swift

        - 
        open func reset()
        - -
        -
        -
        -
        -
        • -
      • -
        - - - - flush(completion:) - -
        -
        -
        -
        -
        -
        -

        Uploads queued data to the Mixpanel server.

        - -

        By default, queued data is flushed to the Mixpanel servers every minute (the -default for flushInterval), and on background (since -flushOnBackground is on by default). You only need to call this -method manually if you want to force a flush at a particular moment.

        - -
        -
        -

        Declaration

        -
        -

        Swift

        - 
        open func flush(completion: (() -> Void)? = nil)
        - -
        -
        -
        -

        Parameters

        - - - - - - - -
        - - completion - - -
        -

        an optional completion handler for when the flush has completed.

        - -
        -
        -
        -
        -
        -
        • -
      • - -
        -
        -
        -
        -
        -

        Returns the payload of a notification if available

        - -
        -

        Note

        - You do not need to call this method on the main thread. - -
        - -
        -
        -

        Declaration

        -
        -

        Swift

        - 
        open func fetchNotificationPayload(completion: @escaping ([String: AnyObject]?) -> Void)
        - -
        -
        -
        -
        -
        • -
      • - -
        -
        -
        -
        -
        -

        Removes a previously registered super property.

        - -

        As an alternative to clearing all properties, unregistering specific super -properties prevents them from being recorded on future events. This operation -does not affect the value of other super properties. Any property name that is -not registered is ignored. -Note that after removing a super property, events will show the attribute as -having the value undefined in Mixpanel until a new value is -registered.

        - -
        -
        -

        Declaration

        -
        -

        Swift

        - 
        open func unregisterSuperProperty(_ propertyName: String)
        - -
        -
        -
        -

        Parameters

        - - - - - - - -
        - - propertyName - - -
        -

        array of property name strings to remove

        - -
        -
        -
        -
        -
        -
        • -
      • - -
        -
        -
        -
        -
        -

        Shows a notification with the given type if one is available.

        - -
        -

        Note

        - You do not need to call this method on the main thread. - -
        - -
        -
        -

        Declaration

        -
        -

        Swift

        - 
        open func showNotification(type: String)
        - -
        -
        -
        -

        Parameters

        - - - - - - - -
        - - type - - -
        -

        The type of notification to show, either “mini” or “takeover”

        - -
        -
        -
        -
        -
        -
        • -
      • - -
        -
        -
        -
        -
        -

        Returns the currently set super properties.

        - -
        -
        -

        Declaration

        -
        -

        Swift

        - 
        open func currentSuperProperties() -> [String: Any]
        - -
        -
        -
        -

        Return Value

        -

        the current super properties

        - -
        -
        -
        -
        • -
      • - -
        -
        -
        -
        -
        -

        Registers super properties without overwriting ones that have already been set, -unless the existing value is equal to defaultValue. defaultValue is optional.

        - -

        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.

        - -
        -
        -

        Declaration

        -
        -

        Swift

        - 
        open func registerSuperPropertiesOnce(_ properties: Properties,
        - -
        -
        -
        -

        Parameters

        - - - - - - - - - - - -
        - - properties - - -
        -

        properties dictionary

        - -
        -
        - - defaultValue - - -
        -

        Optional. overwrite existing properties that have this value

        - -
        -
        -
        -
        -
        -
        • -
      • - -
        -
        -
        -
        -
        -

        Join any experiments (A/B tests) that are available for the current user.

        - -

        Mixpanel will check for A/B tests automatically when your app enters -the foreground. Call this method if you would like to to check for, -and join, any experiments are newly available for the current user.

        - -
        -
        -

        Declaration

        -
        -

        Swift

        - 
        open func joinExperiments(callback: (() -> Void)? = nil)
        - -
        -
        -
        -

        Parameters

        - - - - - - - -
        - - callback - - -
        -

        Optional callback for after the experiments have been loaded and applied

        - -
        -
        -
        -
        -
        -
        • -
      • - -
        -
        -
        -
        -
        -

        Clears all currently set super properties.

        - -
        -
        -

        Declaration

        -
        -

        Swift

        - 
        open func clearSuperProperties()
        - -
        -
        -
        -
        -
        • -
      • - -
        -
        -
        -
        -
        -

        Registers super properties, overwriting ones that have already been set.

        - -

        Super properties, once registered, are automatically sent as properties for -all event tracking calls. They save you having to maintain and add a common -set of properties to your events. -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.

        - -
        -
        -

        Declaration

        -
        -

        Swift

        - 
        open func registerSuperProperties(_ properties: Properties)
        - -
        -
        -
        -

        Parameters

        - - - - - - - -
        - - properties - - -
        -

        properties dictionary

        - -
        -
        -
        -
        -
        -
        • -
      • -
        - - - - clearTimedEvents() - -
        -
        -
        -
        -
        -
        -

        Clears all current event timers.

        - -
        -
        -

        Declaration

        -
        -

        Swift

        - 
        open func clearTimedEvents()
        - -
        -
        -
        -
        -
        • -
      • - -
        -
        -
        -
        -
        -

        Track a push notification using its payload sent from Mixpanel.

        - -

        To simplify user interaction tracking, Mixpanel -automatically sends IDs for the relevant notification of each push. -This method parses the standard payload and queues a track call using this information.

        - -
        -
        -

        Declaration

        -
        -

        Swift

        - 
        open func trackPushNotification(_ userInfo: [AnyHashable: Any],
        - -
        -
        -
        -

        Parameters

        - - - - - - - - - - - -
        - - userInfo - - -
        -

        remote notification payload dictionary

        - -
        -
        - - event - - -
        -

        optional, and usually shouldn’t be used, unless the results is needed to be tracked elsewhere.

        - -
        -
        -
        -
        -
        -
        • -
      • - -
        -
        -
        -
        -
        -

        Tracks an event with properties. -Properties are optional and can be added only if needed.

        - -

        Properties will allow you to segment your events in your Mixpanel reports. -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 event is being timed, the timer will stop and be added as a property.

        - -
        -
        -

        Declaration

        -
        -

        Swift

        - 
        open func track(event: String?, properties: Properties? = nil)
        - -
        -
        -
        -

        Parameters

        - - - - - - - - - - - -
        - - event - - -
        -

        event name

        - -
        -
        - - properties - - -
        -

        properties dictionary

        - -
        -
        -
        -
        -
        -
        • -
      -
      -
      -
      - -
      -
      - - - diff --git a/docs/Protocols.html b/docs/Protocols.html index da2359786..831bfdb3d 100644 --- a/docs/Protocols.html +++ b/docs/Protocols.html @@ -107,68 +107,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -379,8 +317,8 @@

      Declaration

      diff --git a/docs/Protocols/MixpanelDelegate.html b/docs/Protocols/MixpanelDelegate.html index 728cf0440..731c052f8 100644 --- a/docs/Protocols/MixpanelDelegate.html +++ b/docs/Protocols/MixpanelDelegate.html @@ -108,68 +108,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -259,7 +197,6 @@

      Parameters

      The mixpanel instance

      -
      @@ -269,7 +206,6 @@

      Parameters

      Return Value

      return true to upload now or false to defer until later

      -
      @@ -279,8 +215,8 @@

      Return Value

      diff --git a/docs/Protocols/MixpanelType.html b/docs/Protocols/MixpanelType.html index 5e13af5f9..d8685324a 100644 --- a/docs/Protocols/MixpanelType.html +++ b/docs/Protocols/MixpanelType.html @@ -108,68 +108,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -255,8 +193,8 @@

      Declaration

      diff --git a/docs/Protocols/TweakClusterType.html b/docs/Protocols/TweakClusterType.html index 71334e655..54beaebf1 100644 --- a/docs/Protocols/TweakClusterType.html +++ b/docs/Protocols/TweakClusterType.html @@ -108,68 +108,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -256,8 +194,8 @@

      Declaration

      diff --git a/docs/Protocols/TweakLibraryType.html b/docs/Protocols/TweakLibraryType.html index 56f90abec..9de5139bf 100644 --- a/docs/Protocols/TweakLibraryType.html +++ b/docs/Protocols/TweakLibraryType.html @@ -108,68 +108,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -293,7 +231,6 @@

      Parameters

      the tweak to assign

      -
      @@ -343,7 +280,6 @@

      Parameters

      the tweak to bind

      -
      @@ -356,7 +292,6 @@

      Parameters

      the binding to issue for the tweak

      -
      @@ -371,8 +306,8 @@

      Parameters

      diff --git a/docs/Protocols/TweakableType.html b/docs/Protocols/TweakableType.html index 0a4cd6637..d5c485c0b 100644 --- a/docs/Protocols/TweakableType.html +++ b/docs/Protocols/TweakableType.html @@ -108,68 +108,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -254,8 +192,8 @@

      Declaration

      diff --git a/docs/Structs.html b/docs/Structs.html index 22b77dcc9..248d2a41a 100644 --- a/docs/Structs.html +++ b/docs/Structs.html @@ -107,68 +107,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -314,8 +252,8 @@

      Declaration

      diff --git a/docs/Structs/AnyTweak.html b/docs/Structs/AnyTweak.html index 7b97c4ac0..e9b0e555a 100644 --- a/docs/Structs/AnyTweak.html +++ b/docs/Structs/AnyTweak.html @@ -108,68 +108,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -235,8 +173,7 @@

      AnyTweak

      -

      When combined with AnyTweak, this provides our type-erasure around Tweak

      - +

      Declaration

      @@ -285,8 +222,8 @@

      Declaration

      diff --git a/docs/Structs/MixpanelTweaks.html b/docs/Structs/MixpanelTweaks.html index a06ec14bd..66c4984fa 100644 --- a/docs/Structs/MixpanelTweaks.html +++ b/docs/Structs/MixpanelTweaks.html @@ -108,68 +108,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -286,7 +224,6 @@

      Parameters

      the tweaks to set

      -
      @@ -301,8 +238,8 @@

      Parameters

      diff --git a/docs/Structs/Tweak.html b/docs/Structs/Tweak.html index 262f20e96..611651ba2 100644 --- a/docs/Structs/Tweak.html +++ b/docs/Structs/Tweak.html @@ -108,68 +108,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -261,7 +199,6 @@

      Parameters

      name of the tweak

      -
      @@ -274,7 +211,6 @@

      Parameters

      the default value set for the tweak

      -
      @@ -287,7 +223,6 @@

      Parameters

      the collection name of the tweak (do not set, optional)

      -
      @@ -300,7 +235,6 @@

      Parameters

      the group name of the tweak (do not set, optional)

      -
      @@ -358,7 +292,6 @@

      Parameters

      name of the tweak

      -
      @@ -371,7 +304,6 @@

      Parameters

      the default value set for the tweak

      -
      @@ -384,7 +316,6 @@

      Parameters

      minimum value to allow for the tweak

      -
      @@ -397,7 +328,6 @@

      Parameters

      maximum value to allow for the tweak

      -
      @@ -410,7 +340,6 @@

      Parameters

      step size for the tweak (do not set, optional)

      -
      @@ -423,7 +352,6 @@

      Parameters

      the collection name of the tweak (do not set, optional)

      -
      @@ -436,7 +364,6 @@

      Parameters

      the group name of the tweak (do not set, optional)

      -
      @@ -494,8 +421,7 @@

      Declaration

      -

      Extend Tweak to support easy initialization of a TweakStore

      - +

      Declaration

      @@ -513,8 +439,8 @@

      Declaration

      diff --git a/docs/css/jazzy.css b/docs/css/jazzy.css index d6d65b7f0..d62828260 100644 --- a/docs/css/jazzy.css +++ b/docs/css/jazzy.css @@ -164,6 +164,11 @@ header { padding-top: 10px; } .main-content section .task-group-section .task-group:first-of-type .section-name { padding-top: 15px; } + .main-content section .heading:before { + content: ""; + display: block; + padding-top: 70px; + margin: -70px 0 0; } .section { padding: 0 25px; } diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Classes.html b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Classes.html index ffc964012..be6ae3a2f 100644 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Classes.html +++ b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Classes.html @@ -107,68 +107,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -236,7 +174,7 @@

      Classes

      Declaration

      Swift

      - 
      open class MixpanelInstance: CustomDebugStringConvertible, FlushDelegate
      + 
      open class MixpanelInstance: CustomDebugStringConvertible, FlushDelegate, AEDelegate
      @@ -344,8 +282,8 @@

      Declaration

      diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Classes/Mixpanel.html b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Classes/Mixpanel.html index 69b0173cc..116a22ce2 100644 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Classes/Mixpanel.html +++ b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Classes/Mixpanel.html @@ -108,68 +108,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -240,7 +178,6 @@

      Mixpanel

      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.

      -

      Important

      If you have more than one Mixpanel instance, it is beneficial to initialize @@ -273,7 +210,6 @@

      Parameters

      your project token

      -
      @@ -286,7 +222,6 @@

      Parameters

      Optional. App delegate launchOptions

      -
      @@ -299,7 +234,6 @@

      Parameters

      Optional. Interval to run background flushing

      -
      @@ -312,7 +246,6 @@

      Parameters

      Optional. The name you want to call this instance

      -
      @@ -321,8 +254,8 @@

      Parameters

      Return Value

      -

      returns a mixpanel instance if needed to keep throughout the project. You can always get the instance by calling getInstance(name)

      - +

      returns a mixpanel instance if needed to keep throughout the project. +You can always get the instance by calling getInstance(name)

      @@ -391,7 +324,6 @@

      Parameters

      the instance name

      -
      @@ -401,7 +333,6 @@

      Parameters

      Return Value

      returns the mixpanel instance

      -
      @@ -435,7 +366,6 @@

      Declaration

      Return Value

      returns the main Mixpanel instance

      -
      @@ -477,7 +407,6 @@

      Parameters

      the instance name

      -
      @@ -524,7 +453,6 @@

      Parameters

      the instance name

      -
      @@ -539,8 +467,8 @@

      Parameters

      diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Classes/MixpanelInstance.html b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Classes/MixpanelInstance.html index 0fc6cadba..bb7354afb 100644 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Classes/MixpanelInstance.html +++ b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Classes/MixpanelInstance.html @@ -108,68 +108,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -212,7 +150,7 @@

      MixpanelInstance

      - 
      open class MixpanelInstance: CustomDebugStringConvertible, FlushDelegate
      + 
      open class MixpanelInstance: CustomDebugStringConvertible, FlushDelegate, AEDelegate
      @@ -485,10 +423,7 @@

      Declaration

      -

      The base URL used for Mixpanel API requests. -Useful if you need to proxy Mixpanel requests. Defaults to -https://api.mixpanel.com.

      - +

      Declaration

      @@ -514,9 +449,13 @@

      Declaration

      -

      This allows enabling or disabling of all Mixpanel logs at run time. -- Note: All logging is disabled by default. Usually, this is only required - if you are running in to issues with the SDK and you need support.

      +

      This allows enabling or disabling of all Mixpanel logs at run time.

      +
      +

      Note

      + All logging is disabled by default. Usually, this is only required + if you are running in to issues with the SDK and you need support. + +
      @@ -702,13 +641,1080 @@

      Declaration

      +
    • + +
      +
      +
      +
      +
      +

      The minimum session duration (ms) that is tracked in automatic events. +The default value is 10000 (10 seconds).

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      open var minimumSessionDuration: UInt64
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      The maximum session duration (ms) that is tracked in automatic events. +The default value is UINT64_MAX (no maximum session duration).

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      open var maximumSessionDuration: UInt64
      + +
      +
      +
      +
      +
      • +
    + +
    +
    + + + +

    Identity

    +     +
    +
      +
    • +
      + + + + identify(distinctId:) + +
      +
      +
      +
      +
      +
      +

      Sets the distinct ID of the current user.

      + +

      Mixpanel uses the IFV String (UIDevice.current().identifierForVendor) +as the default distinct ID. This ID will identify a user across all apps by the same +vendor, but cannot be used to link the same user across apps from different +vendors. If we are unable to get the IFV, we will fall back to generating a +random persistent UUID

      + +

      For tracking events, you do not need to call identify: if you +want to use the default. However, +Mixpanel People always requires an explicit call to identify:. +If calls are made to +set:, increment or other People +methods prior to calling identify:, then they are queued up and +flushed once identify: is called.

      + +

      If you’d like to use the default distinct ID for Mixpanel People as well +(recommended), call identify: using the current distinct ID: +mixpanelInstance.identify(mixpanelInstance.distinctId).

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      open func identify(distinctId: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + distinctId + + +
      +

      string that uniquely identifies the current user

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Creates a distinctId alias from alias to the current id.

      + +

      This method is used to map an identifier called an alias to the existing Mixpanel +distinct id. This causes all events and people requests sent with the alias to be +mapped back to the original distinct id. The recommended usage pattern is to call +both createAlias: and identify: when the user signs up, and only identify: (with +their new user ID) when they log in. This will keep your signup funnels working +correctly.

      + +

      This makes the current id and ‘Alias’ interchangeable distinct ids. +Mixpanel. +mixpanelInstance.createAlias(Alias, mixpanelInstance.distinctId)

      +
      +

      Precondition

      +

      You must call identify if you haven’t already +(e.g. when your app launches)

      + +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      open func createAlias(_ alias: String, distinctId: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + alias + + +
      +

      the new distinct id that should represent the original

      +
      +
      + + distinctId + + +
      +

      the old distinct id that alias will be mapped to

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + reset() + +
      +
      +
      +
      +
      +
      +

      Clears all stored properties including the distinct Id. +Useful if your app’s user logs out.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      open func reset()
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + + +

    Persistence

    +     +
    +
      +
    • +
      + + + + archive() + +
      +
      +
      +
      +
      +
      +

      Writes current project info including the distinct Id, super properties, +and pending event and People record queues to disk.

      + +

      This state will be recovered when the app is launched again if the Mixpanel +library is initialized with the same project token. +The library listens for app state changes and handles +persisting data as needed.

      +
      +

      Important

      + You do not need to call this method.** + +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      open func archive()
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + archive() + +
      +
      +
      +
      +
      +
      +

      Undocumented

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      open class MixpanelInstance: CustomDebugStringConvertible, FlushDelegate, AEDelegate
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + + +

    Flush

    +     +
    +
      +
    • +
      + + + + flush(completion:) + +
      +
      +
      +
      +
      +
      +

      Uploads queued data to the Mixpanel server.

      + +

      By default, queued data is flushed to the Mixpanel servers every minute (the +default for flushInterval), and on background (since +flushOnBackground is on by default). You only need to call this +method manually if you want to force a flush at a particular moment.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      open func flush(completion: (() -> Void)? = nil)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + completion + + +
      +

      an optional completion handler for when the flush has completed.

      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + + +

    Track

    +     +
    +
      +
    • + +
      +
      +
      +
      +
      +

      Tracks an event with properties. +Properties are optional and can be added only if needed.

      + +

      Properties will allow you to segment your events in your Mixpanel reports. +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 event is being timed, the timer will stop and be added as a property.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      open func track(event: String?, properties: Properties? = nil)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + event + + +
      +

      event name

      +
      +
      + + properties + + +
      +

      properties dictionary

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Track a push notification using its payload sent from Mixpanel.

      + +

      To simplify user interaction tracking, Mixpanel +automatically sends IDs for the relevant notification of each push. +This method parses the standard payload and queues a track call using this information.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      open func trackPushNotification(_ userInfo: [AnyHashable: Any],
+                                      event: String = "$campaign_received")
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + userInfo + + +
      +

      remote notification payload dictionary

      +
      +
      + + event + + +
      +

      optional, and usually shouldn’t be used, +unless the results is needed to be tracked elsewhere.

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + time(event:) + +
      +
      +
      +
      +
      +
      +

      Starts a timer that will be stopped and added as a property when a +corresponding event is tracked.

      + +

      This method is intended to be used in advance of events that have +a duration. For example, if a developer were to track an Image Upload event +she might want to also know how long the upload took. Calling this method +before the upload code would implicitly cause the track +call to record its duration.

      +
      +

      Precondition

      +

      // begin timing the image upload: +mixpanelInstance.time(event:Image Upload) +// upload the image: +self.uploadImageWithSuccessHandler() { _ in +// track the event +mixpanelInstance.track(Image Upload) +}

      + +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      open func time(event: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + event + + +
      +

      the event name to be timed

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + clearTimedEvents() + +
      +
      +
      +
      +
      +
      +

      Clears all current event timers.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      open func clearTimedEvents()
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Returns the currently set super properties.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      open func currentSuperProperties() -> [String: Any]
      + +
      +
      +
      +

      Return Value

      +

      the current super properties

      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Clears all currently set super properties.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      open func clearSuperProperties()
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Registers super properties, overwriting ones that have already been set.

      + +

      Super properties, once registered, are automatically sent as properties for +all event tracking calls. They save you having to maintain and add a common +set of properties to your events. +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.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      open func registerSuperProperties(_ properties: Properties)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + properties + + +
      +

      properties dictionary

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Registers super properties without overwriting ones that have already been set, +unless the existing value is equal to defaultValue. defaultValue is optional.

      + +

      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.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      open func registerSuperPropertiesOnce(_ properties: Properties,
+                                            defaultValue: MixpanelType? = nil)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + properties + + +
      +

      properties dictionary

      +
      +
      + + defaultValue + + +
      +

      Optional. overwrite existing properties that have this value

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Removes a previously registered super property.

      + +

      As an alternative to clearing all properties, unregistering specific super +properties prevents them from being recorded on future events. This operation +does not affect the value of other super properties. Any property name that is +not registered is ignored. +Note that after removing a super property, events will show the attribute as +having the value undefined in Mixpanel until a new value is +registered.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      open func unregisterSuperProperty(_ propertyName: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + propertyName + + +
      +

      array of property name strings to remove

      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + + +

    A/B Testing

    +     +
    +
      +
    • + +
      +
      +
      +
      +
      +

      Join any experiments (A/B tests) that are available for the current user.

      + +

      Mixpanel will check for A/B tests automatically when your app enters +the foreground. Call this method if you would like to to check for, +and join, any experiments are newly available for the current user.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      open func joinExperiments(callback: (() -> Void)? = nil)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + callback + + +
      +

      Optional callback for after the experiments have been loaded and applied

      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + + +

    In App Notifications

    +     +
    +
      +
    • +
      + + + + showNotification() + +
      +
      +
      +
      +
      +
      +

      Shows a notification if one is available.

      +
      +

      Note

      + You do not need to call this method on the main thread. + +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      open func showNotification()
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Shows a notification with the given type if one is available.

      +
      +

      Note

      + You do not need to call this method on the main thread. + +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      open func showNotification(type: String)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + type + + +
      +

      The type of notification to show, either mini or takeover

      +
      +
      +
      +
      +
      +
      • +
    • +
      + + + + showNotification(ID:) + +
      +
      +
      +
      +
      +
      +

      Shows a notification with the given ID

      +
      +

      Note

      + You do not need to call this method on the main thread. + +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      open func showNotification(ID: Int)
      + +
      +
      +
      +

      Parameters

      + + + + + + + +
      + + ID + + +
      +

      The notification ID you want to present

      +
      +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Returns the payload of a notification if available

      +
      +

      Note

      + You do not need to call this method on the main thread. + +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      open func fetchNotificationPayload(completion: @escaping ([String: AnyObject]?) -> Void)
      + +
      +
      +
      +
      +
    diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Classes/People.html b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Classes/People.html index 5b4af4faf..00b5dec5f 100644 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Classes/People.html +++ b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Classes/People.html @@ -108,68 +108,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -307,8 +245,8 @@

      Parameters

      -

      device token as returned from application:didRegisterForRemoteNotificationsWithDeviceToken:

      - +

      device token as returned from +application:didRegisterForRemoteNotificationsWithDeviceToken:

      @@ -357,8 +295,8 @@

      Parameters

      -

      device token as returned from application:didRegisterForRemoteNotificationsWithDeviceToken:

      - +

      device token as returned from +application:didRegisterForRemoteNotificationsWithDeviceToken:

      @@ -390,7 +328,6 @@

      Parameters

      including the special properties: $token and $distinct_id. If the existing user record on the server already has a value for a given property, the old value is overwritten. Other existing properties will not be affected.

      -

      Precondition

      You must identify for the set information to be linked to that user

      @@ -419,7 +356,6 @@

      Parameters

      properties dictionary

      -
      @@ -469,7 +405,6 @@

      Parameters

      property name

      -
      @@ -482,7 +417,6 @@

      Parameters

      property value

      -
      @@ -535,7 +469,6 @@

      Parameters

      properties dictionary

      -
      @@ -586,7 +519,6 @@

      Parameters

      properties array

      -
      @@ -637,7 +569,6 @@

      Parameters

      properties array

      -
      @@ -685,7 +616,6 @@

      Parameters

      property name

      -
      @@ -698,7 +628,6 @@

      Parameters

      amount to increment by

      -
      @@ -748,7 +677,6 @@

      Parameters

      mapping of list property names to values to append

      -
      @@ -798,7 +726,6 @@

      Parameters

      mapping of list property names to values to remove

      -
      @@ -847,7 +774,6 @@

      Parameters

      mapping of list property names to lists to union

      -
      @@ -899,7 +825,6 @@

      Parameters

      amount of revenue received

      -
      @@ -912,7 +837,6 @@

      Parameters

      Optional. properties dictionary

      -
      @@ -981,8 +905,8 @@

      Declaration

      diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Enums.html b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Enums.html index 993ee403f..b7c99c809 100644 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Enums.html +++ b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Enums.html @@ -107,68 +107,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -229,9 +167,12 @@

      Enums

      The data types that are currently supported for SwiftTweaks. -While Tweak is generic, we have to build UI for editing each kind of -- hence the need for a protocol to restrict what can be tweaked. -Of course, we can add new TweakViewDataTypes over time, too!

      +While Tweak is generic, we have to build UI for editing each kind of

      + +
        +
      • hence the need for a protocol to restrict what can be tweaked. +Of course, we can add new TweakViewDataTypes over time, too!
        • +
      See more
      @@ -251,8 +192,8 @@

      Declaration

      diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Enums/TweakViewDataType.html b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Enums/TweakViewDataType.html index 33992d2a6..5b768592d 100644 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Enums/TweakViewDataType.html +++ b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Enums/TweakViewDataType.html @@ -108,68 +108,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -217,9 +155,12 @@

      TweakViewDataType

      The data types that are currently supported for SwiftTweaks. -While Tweak is generic, we have to build UI for editing each kind of -- hence the need for a protocol to restrict what can be tweaked. -Of course, we can add new TweakViewDataTypes over time, too!

      +While Tweak is generic, we have to build UI for editing each kind of

      + +
        +
      • hence the need for a protocol to restrict what can be tweaked. +Of course, we can add new TweakViewDataTypes over time, too!
        • +
      @@ -347,37 +288,6 @@

      Declaration

    -
    -
      -
    • -
      - - - - uiColor - -
      -
      -
      -
      -
      -
      -

      TweakableType supports the uiColor type

      - -
      -
      -

      Declaration

      -
      -

      Swift

      - 
      case uiColor
      - -
      -
      -
      -
      -
      • -
    -
    diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions.html b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions.html index de1c38aba..59b7b4ca3 100644 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions.html +++ b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions.html @@ -107,68 +107,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -323,26 +261,6 @@

      Declaration

      -
    • -
      - - - - UIColor - -
      -
      -
      -
      -
      -
      -

      Undocumented

      - - See more -
      -
      -
      -
    • @@ -549,7 +467,7 @@

      Declaration

      Declaration

      Swift

      - 
      struct Dictionary<Key : Hashable, Value> : Collection, ExpressibleByDictionaryLiteral
      + 
      struct Dictionary<Key, Value> : Collection, ExpressibleByDictionaryLiteral where Key : Hashable
      @@ -558,11 +476,35 @@

      Declaration

    +
    + +
    diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/Array.html b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/Array.html index dc7e55d91..fca594073 100644 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/Array.html +++ b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/Array.html @@ -108,68 +108,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -253,8 +191,8 @@

      Declaration

      diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/Bool.html b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/Bool.html index 3c622a331..1bf58c4e5 100644 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/Bool.html +++ b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/Bool.html @@ -108,68 +108,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -285,8 +223,8 @@

      Declaration

      diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/CGFloat.html b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/CGFloat.html index f9e54943a..4792e92af 100644 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/CGFloat.html +++ b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/CGFloat.html @@ -108,68 +108,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -248,8 +186,8 @@

      Declaration

      diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/Date.html b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/Date.html index 71fe19df2..51662a226 100644 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/Date.html +++ b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/Date.html @@ -108,68 +108,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -254,8 +192,8 @@

      Declaration

      diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/Dictionary.html b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/Dictionary.html index 1e03623c2..7bb222b61 100644 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/Dictionary.html +++ b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/Dictionary.html @@ -108,68 +108,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -212,7 +150,7 @@

      Dictionary

      - 
      struct Dictionary<Key : Hashable, Value> : Collection, ExpressibleByDictionaryLiteral
      + 
      struct Dictionary<Key, Value> : Collection, ExpressibleByDictionaryLiteral where Key : Hashable
      @@ -253,8 +191,8 @@

      Declaration

      diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/Double.html b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/Double.html index 0cb7c878b..0c31d3c5c 100644 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/Double.html +++ b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/Double.html @@ -108,68 +108,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -285,8 +223,8 @@

      Declaration

      diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/Float.html b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/Float.html index ac55002ac..ec172929c 100644 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/Float.html +++ b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/Float.html @@ -108,68 +108,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -254,8 +192,8 @@

      Declaration

      diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/Int.html b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/Int.html index 8c582ef2b..6f2464baf 100644 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/Int.html +++ b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/Int.html @@ -108,68 +108,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -285,8 +223,8 @@

      Declaration

      diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/NSNull.html b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/NSNull.html index 8f8e9a29a..972d44160 100644 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/NSNull.html +++ b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/NSNull.html @@ -108,68 +108,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -249,8 +187,8 @@

      Declaration

      diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/String.html b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/String.html index be23f23c4..c46bde467 100644 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/String.html +++ b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/String.html @@ -108,68 +108,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -285,8 +223,8 @@

      Declaration

      diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/UIColor.html b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/UIColor.html index 76fd6fbfa..14f4a6dc0 100644 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/UIColor.html +++ b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/UIColor.html @@ -108,68 +108,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -219,40 +157,9 @@

      UIColor

    • - - - tweakViewDataType - -
      -
      -
      -
      -
      -
      -

      TweakableType supports the uiColor type

      - -
      -
      -

      Declaration

      -
      -

      Swift

      - 
      public static var tweakViewDataType: TweakViewDataType
      - -
      -
      -
      -
      -
      • -
    - -
    -
      -
    • -
      - - - - init(hex4:) + + + init(MPHex:)
      @@ -261,15 +168,14 @@

      Declaration

      The shorthand four-digit hexadecimal representation of color with alpha.

      - -

      RGBA defines to the color #AARRGGBB.

      +

      RGBA defines to the color #AARRGGBB.

      Declaration

      Swift

      - 
      public convenience init(hex4: UInt)
      + 
      public convenience init(MPHex: UInt)
      @@ -280,13 +186,12 @@

      Parameters

      - hex4 + MPHex

      hexadecimal value.

      -
      @@ -301,8 +206,8 @@

      Parameters

      diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/UInt.html b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/UInt.html index ed6d3e947..70b66af62 100644 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/UInt.html +++ b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/UInt.html @@ -108,68 +108,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -254,8 +192,8 @@

      Declaration

      diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/URL.html b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/URL.html index c3769a100..cb6a840f4 100644 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/URL.html +++ b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/URL.html @@ -108,68 +108,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -254,8 +192,8 @@

      Declaration

      diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Functions.html b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Functions.html index f58b45cca..4ce95a589 100644 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Functions.html +++ b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Functions.html @@ -107,68 +107,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -253,7 +191,6 @@

      Parameters

      the left hand side tweak to compare

      -
      @@ -266,7 +203,6 @@

      Parameters

      the right hand side tweak to compare

      -
      @@ -276,7 +212,6 @@

      Parameters

      Return Value

      a boolean telling if both tweaks are equal

      -
      @@ -322,7 +257,6 @@

      Parameters

      the left hand side tweak to compare

      -
      @@ -335,7 +269,6 @@

      Parameters

      the right hand side tweak to compare

      -
      @@ -345,7 +278,6 @@

      Parameters

      Return Value

      a boolean telling if both tweaks are equal

      -
      @@ -355,8 +287,8 @@

      Return Value

      diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Functions/==(_:_:).html b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Functions/==(_:_:).html index cfb89bfb3..13215091e 100644 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Functions/==(_:_:).html +++ b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Functions/==(_:_:).html @@ -108,68 +108,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -254,8 +192,8 @@

      Declaration

      diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Instance Methods.html b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Instance Methods.html deleted file mode 100644 index 810a49822..000000000 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Instance Methods.html +++ /dev/null @@ -1,1169 +0,0 @@ - - - - Instance Methods Reference - - - - - - - - - -
      -
      -

      Mixpanel Docs (100% documented)

      -

      View on GitHub

      -
      -
      -
      - -
      -
      - -
      -
      -
      -

      Instance Methods

      -

      The following instance methods are available globally.

      - -
      -
      -
      -
        -
      • -
        - - - - showNotification() - -
        -
        -
        -
        -
        -
        -

        Shows a notification if one is available.

        - -
        -

        Note

        - You do not need to call this method on the main thread. - -
        - -
        -
        -

        Declaration

        -
        -

        Swift

        - 
        open func showNotification()
        - -
        -
        -
        -
        -
        • -
      • -
        - - - - identify(distinctId:) - -
        -
        -
        -
        -
        -
        -

        Sets the distinct ID of the current user.

        - -

        Mixpanel uses the IFV String (UIDevice.current().identifierForVendor) -as the default distinct ID. This ID will identify a user across all apps by the same -vendor, but cannot be used to link the same user across apps from different -vendors. If we are unable to get the IFV, we will fall back to generating a -random persistent UUID

        - -

        For tracking events, you do not need to call identify: if you -want to use the default. However, -Mixpanel People always requires an explicit call to identify:. -If calls are made to -set:, increment or other People -methods prior to calling identify:, then they are queued up and -flushed once identify: is called.

        - -

        If you’d like to use the default distinct ID for Mixpanel People as well -(recommended), call identify: using the current distinct ID: -mixpanelInstance.identify(mixpanelInstance.distinctId).

        - -
        -
        -

        Declaration

        -
        -

        Swift

        - 
        open func identify(distinctId: String)
        - -
        -
        -
        -

        Parameters

        - - - - - - - -
        - - distinctId - - -
        -

        string that uniquely identifies the current user

        - -
        -
        -
        -
        -
        -
        • -
      • - -
        -
        -
        -
        -
        -

        Creates a distinctId alias from alias to the current id.

        - -

        This method is used to map an identifier called an alias to the existing Mixpanel -distinct id. This causes all events and people requests sent with the alias to be -mapped back to the original distinct id. The recommended usage pattern is to call -both createAlias: and identify: when the user signs up, and only identify: (with -their new user ID) when they log in. This will keep your signup funnels working -correctly.

        - -

        This makes the current id and ‘Alias’ interchangeable distinct ids. -Mixpanel. -mixpanelInstance.createAlias(Alias, mixpanelInstance.distinctId)

        - -
        -

        Precondition

        -

        You must call identify if you haven’t already -(e.g. when your app launches)

        - -
        - -
        -
        -

        Declaration

        -
        -

        Swift

        - 
        open func createAlias(_ alias: String, distinctId: String)
        - -
        -
        -
        -

        Parameters

        - - - - - - - - - - - -
        - - alias - - -
        -

        the new distinct id that should represent the original

        - -
        -
        - - distinctId - - -
        -

        the old distinct id that alias will be mapped to

        - -
        -
        -
        -
        -
        -
        • -
      • -
        - - - - showNotification(ID:) - -
        -
        -
        -
        -
        -
        -

        Shows a notification with the given ID

        - -
        -

        Note

        - You do not need to call this method on the main thread. - -
        - -
        -
        -

        Declaration

        -
        -

        Swift

        - 
        open func showNotification(ID: Int)
        - -
        -
        -
        -

        Parameters

        - - - - - - - -
        - - ID - - -
        -

        The notification ID you want to present

        - -
        -
        -
        -
        -
        -
        • -
      • -
        - - - - archive() - -
        -
        -
        -
        -
        -
        -

        Writes current project info including the distinct Id, super properties, -and pending event and People record queues to disk.

        - -

        This state will be recovered when the app is launched again if the Mixpanel -library is initialized with the same project token. -The library listens for app state changes and handles -persisting data as needed.

        - -
        -

        Important

        - You do not need to call this method.** - -
        - -
        -
        -

        Declaration

        -
        -

        Swift

        - 
        open func archive()
        - -
        -
        -
        -
        -
        • -
      • -
        - - - - time(event:) - -
        -
        -
        -
        -
        -
        -

        Starts a timer that will be stopped and added as a property when a -corresponding event is tracked.

        - -

        This method is intended to be used in advance of events that have -a duration. For example, if a developer were to track an Image Upload event -she might want to also know how long the upload took. Calling this method -before the upload code would implicitly cause the track -call to record its duration.

        - -
        -

        Precondition

        -

        // begin timing the image upload: -mixpanelInstance.time(event:Image Upload) -// upload the image: -self.uploadImageWithSuccessHandler() { _ in -// track the event -mixpanelInstance.track(Image Upload) -}

        - -
        - -
        -
        -

        Declaration

        -
        -

        Swift

        - 
        open func time(event: String)
        - -
        -
        -
        -

        Parameters

        - - - - - - - -
        - - event - - -
        -

        the event name to be timed

        - -
        -
        -
        -
        -
        -
        • -
      • -
        - - - - reset() - -
        -
        -
        -
        -
        -
        -

        Clears all stored properties including the distinct Id. -Useful if your app’s user logs out.

        - -
        -
        -

        Declaration

        -
        -

        Swift

        - 
        open func reset()
        - -
        -
        -
        -
        -
        • -
      • -
        - - - - flush(completion:) - -
        -
        -
        -
        -
        -
        -

        Uploads queued data to the Mixpanel server.

        - -

        By default, queued data is flushed to the Mixpanel servers every minute (the -default for flushInterval), and on background (since -flushOnBackground is on by default). You only need to call this -method manually if you want to force a flush at a particular moment.

        - -
        -
        -

        Declaration

        -
        -

        Swift

        - 
        open func flush(completion: (() -> Void)? = nil)
        - -
        -
        -
        -

        Parameters

        - - - - - - - -
        - - completion - - -
        -

        an optional completion handler for when the flush has completed.

        - -
        -
        -
        -
        -
        -
        • -
      • - -
        -
        -
        -
        -
        -

        Returns the payload of a notification if available

        - -
        -

        Note

        - You do not need to call this method on the main thread. - -
        - -
        -
        -

        Declaration

        -
        -

        Swift

        - 
        open func fetchNotificationPayload(completion: @escaping ([String: AnyObject]?) -> Void)
        - -
        -
        -
        -
        -
        • -
      • - -
        -
        -
        -
        -
        -

        Removes a previously registered super property.

        - -

        As an alternative to clearing all properties, unregistering specific super -properties prevents them from being recorded on future events. This operation -does not affect the value of other super properties. Any property name that is -not registered is ignored. -Note that after removing a super property, events will show the attribute as -having the value undefined in Mixpanel until a new value is -registered.

        - -
        -
        -

        Declaration

        -
        -

        Swift

        - 
        open func unregisterSuperProperty(_ propertyName: String)
        - -
        -
        -
        -

        Parameters

        - - - - - - - -
        - - propertyName - - -
        -

        array of property name strings to remove

        - -
        -
        -
        -
        -
        -
        • -
      • - -
        -
        -
        -
        -
        -

        Shows a notification with the given type if one is available.

        - -
        -

        Note

        - You do not need to call this method on the main thread. - -
        - -
        -
        -

        Declaration

        -
        -

        Swift

        - 
        open func showNotification(type: String)
        - -
        -
        -
        -

        Parameters

        - - - - - - - -
        - - type - - -
        -

        The type of notification to show, either “mini” or “takeover”

        - -
        -
        -
        -
        -
        -
        • -
      • - -
        -
        -
        -
        -
        -

        Returns the currently set super properties.

        - -
        -
        -

        Declaration

        -
        -

        Swift

        - 
        open func currentSuperProperties() -> [String: Any]
        - -
        -
        -
        -

        Return Value

        -

        the current super properties

        - -
        -
        -
        -
        • -
      • - -
        -
        -
        -
        -
        -

        Registers super properties without overwriting ones that have already been set, -unless the existing value is equal to defaultValue. defaultValue is optional.

        - -

        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.

        - -
        -
        -

        Declaration

        -
        -

        Swift

        - 
        open func registerSuperPropertiesOnce(_ properties: Properties,
        - -
        -
        -
        -

        Parameters

        - - - - - - - - - - - -
        - - properties - - -
        -

        properties dictionary

        - -
        -
        - - defaultValue - - -
        -

        Optional. overwrite existing properties that have this value

        - -
        -
        -
        -
        -
        -
        • -
      • - -
        -
        -
        -
        -
        -

        Join any experiments (A/B tests) that are available for the current user.

        - -

        Mixpanel will check for A/B tests automatically when your app enters -the foreground. Call this method if you would like to to check for, -and join, any experiments are newly available for the current user.

        - -
        -
        -

        Declaration

        -
        -

        Swift

        - 
        open func joinExperiments(callback: (() -> Void)? = nil)
        - -
        -
        -
        -

        Parameters

        - - - - - - - -
        - - callback - - -
        -

        Optional callback for after the experiments have been loaded and applied

        - -
        -
        -
        -
        -
        -
        • -
      • - -
        -
        -
        -
        -
        -

        Clears all currently set super properties.

        - -
        -
        -

        Declaration

        -
        -

        Swift

        - 
        open func clearSuperProperties()
        - -
        -
        -
        -
        -
        • -
      • - -
        -
        -
        -
        -
        -

        Registers super properties, overwriting ones that have already been set.

        - -

        Super properties, once registered, are automatically sent as properties for -all event tracking calls. They save you having to maintain and add a common -set of properties to your events. -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.

        - -
        -
        -

        Declaration

        -
        -

        Swift

        - 
        open func registerSuperProperties(_ properties: Properties)
        - -
        -
        -
        -

        Parameters

        - - - - - - - -
        - - properties - - -
        -

        properties dictionary

        - -
        -
        -
        -
        -
        -
        • -
      • -
        - - - - clearTimedEvents() - -
        -
        -
        -
        -
        -
        -

        Clears all current event timers.

        - -
        -
        -

        Declaration

        -
        -

        Swift

        - 
        open func clearTimedEvents()
        - -
        -
        -
        -
        -
        • -
      • - -
        -
        -
        -
        -
        -

        Track a push notification using its payload sent from Mixpanel.

        - -

        To simplify user interaction tracking, Mixpanel -automatically sends IDs for the relevant notification of each push. -This method parses the standard payload and queues a track call using this information.

        - -
        -
        -

        Declaration

        -
        -

        Swift

        - 
        open func trackPushNotification(_ userInfo: [AnyHashable: Any],
        - -
        -
        -
        -

        Parameters

        - - - - - - - - - - - -
        - - userInfo - - -
        -

        remote notification payload dictionary

        - -
        -
        - - event - - -
        -

        optional, and usually shouldn’t be used, unless the results is needed to be tracked elsewhere.

        - -
        -
        -
        -
        -
        -
        • -
      • - -
        -
        -
        -
        -
        -

        Tracks an event with properties. -Properties are optional and can be added only if needed.

        - -

        Properties will allow you to segment your events in your Mixpanel reports. -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 event is being timed, the timer will stop and be added as a property.

        - -
        -
        -

        Declaration

        -
        -

        Swift

        - 
        open func track(event: String?, properties: Properties? = nil)
        - -
        -
        -
        -

        Parameters

        - - - - - - - - - - - -
        - - event - - -
        -

        event name

        - -
        -
        - - properties - - -
        -

        properties dictionary

        - -
        -
        -
        -
        -
        -
        • -
      -
      -
      -
      - -
      -
      - - - diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Protocols.html b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Protocols.html index da2359786..831bfdb3d 100644 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Protocols.html +++ b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Protocols.html @@ -107,68 +107,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -379,8 +317,8 @@

      Declaration

      diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Protocols/MixpanelDelegate.html b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Protocols/MixpanelDelegate.html index 728cf0440..731c052f8 100644 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Protocols/MixpanelDelegate.html +++ b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Protocols/MixpanelDelegate.html @@ -108,68 +108,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -259,7 +197,6 @@

      Parameters

      The mixpanel instance

      -
      @@ -269,7 +206,6 @@

      Parameters

      Return Value

      return true to upload now or false to defer until later

      -
      @@ -279,8 +215,8 @@

      Return Value

      diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Protocols/MixpanelType.html b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Protocols/MixpanelType.html index 5e13af5f9..d8685324a 100644 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Protocols/MixpanelType.html +++ b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Protocols/MixpanelType.html @@ -108,68 +108,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -255,8 +193,8 @@

      Declaration

      diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Protocols/TweakClusterType.html b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Protocols/TweakClusterType.html index 71334e655..54beaebf1 100644 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Protocols/TweakClusterType.html +++ b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Protocols/TweakClusterType.html @@ -108,68 +108,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -256,8 +194,8 @@

      Declaration

      diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Protocols/TweakLibraryType.html b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Protocols/TweakLibraryType.html index 56f90abec..9de5139bf 100644 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Protocols/TweakLibraryType.html +++ b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Protocols/TweakLibraryType.html @@ -108,68 +108,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -293,7 +231,6 @@

      Parameters

      the tweak to assign

      -
      @@ -343,7 +280,6 @@

      Parameters

      the tweak to bind

      -
      @@ -356,7 +292,6 @@

      Parameters

      the binding to issue for the tweak

      -
      @@ -371,8 +306,8 @@

      Parameters

      diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Protocols/TweakableType.html b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Protocols/TweakableType.html index 0a4cd6637..d5c485c0b 100644 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Protocols/TweakableType.html +++ b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Protocols/TweakableType.html @@ -108,68 +108,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -254,8 +192,8 @@

      Declaration

      diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Structs.html b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Structs.html index 22b77dcc9..248d2a41a 100644 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Structs.html +++ b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Structs.html @@ -107,68 +107,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -314,8 +252,8 @@

      Declaration

      diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Structs/AnyTweak.html b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Structs/AnyTweak.html index 7b97c4ac0..e9b0e555a 100644 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Structs/AnyTweak.html +++ b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Structs/AnyTweak.html @@ -108,68 +108,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -235,8 +173,7 @@

      AnyTweak

      -

      When combined with AnyTweak, this provides our type-erasure around Tweak

      - +

      Declaration

      @@ -285,8 +222,8 @@

      Declaration

      diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Structs/MixpanelTweaks.html b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Structs/MixpanelTweaks.html index a06ec14bd..66c4984fa 100644 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Structs/MixpanelTweaks.html +++ b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Structs/MixpanelTweaks.html @@ -108,68 +108,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -286,7 +224,6 @@

      Parameters

      the tweaks to set

      -
      @@ -301,8 +238,8 @@

      Parameters

      diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Structs/Tweak.html b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Structs/Tweak.html index 262f20e96..611651ba2 100644 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Structs/Tweak.html +++ b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Structs/Tweak.html @@ -108,68 +108,6 @@
    • -
  • - Instance Methods - -
  • Protocols
      @@ -261,7 +199,6 @@

      Parameters

      name of the tweak

      -
      @@ -274,7 +211,6 @@

      Parameters

      the default value set for the tweak

      -
      @@ -287,7 +223,6 @@

      Parameters

      the collection name of the tweak (do not set, optional)

      -
      @@ -300,7 +235,6 @@

      Parameters

      the group name of the tweak (do not set, optional)

      -
      @@ -358,7 +292,6 @@

      Parameters

      name of the tweak

      -
      @@ -371,7 +304,6 @@

      Parameters

      the default value set for the tweak

      -
      @@ -384,7 +316,6 @@

      Parameters

      minimum value to allow for the tweak

      -
      @@ -397,7 +328,6 @@

      Parameters

      maximum value to allow for the tweak

      -
      @@ -410,7 +340,6 @@

      Parameters

      step size for the tweak (do not set, optional)

      -
      @@ -423,7 +352,6 @@

      Parameters

      the collection name of the tweak (do not set, optional)

      -
      @@ -436,7 +364,6 @@

      Parameters

      the group name of the tweak (do not set, optional)

      -
      @@ -494,8 +421,7 @@

      Declaration

      -

      Extend Tweak to support easy initialization of a TweakStore

      - +

      Declaration

      @@ -513,8 +439,8 @@

      Declaration

      diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/css/jazzy.css b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/css/jazzy.css index d6d65b7f0..d62828260 100644 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/css/jazzy.css +++ b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/css/jazzy.css @@ -164,6 +164,11 @@ header { padding-top: 10px; } .main-content section .task-group-section .task-group:first-of-type .section-name { padding-top: 15px; } + .main-content section .heading:before { + content: ""; + display: block; + padding-top: 70px; + margin: -70px 0 0; } .section { padding: 0 25px; } diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/index.html b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/index.html index d282b1db1..b31c80789 100644 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/index.html +++ b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/index.html @@ -107,68 +107,6 @@
    • -
  • - Instance Methods - -
  • Protocols
    • -
  • - Instance Methods - -
  • Protocols
      @@ -219,123 +157,126 @@ CocoaPods Compatible Carthage compatible Apache License

      -

      Introduction

      +

      Table of Contents

      + + + + + + + +

      +

      Introduction

      Welcome to the official Mixpanel Swift Library

      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 Jobs for details.

      +We’d also love for you to come and work with us! Check out Jobs for details.

      If you are using Objective-C, we recommend using our Objective-C Library.

      -

      Current supported features

      - -

      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.

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      FeatureSwift 3Swift 2.3
      Tracking API✔✔
      People API✔✔
      Documentation✔✔
      tvOS Support✔
      In-app Notifications✔
      Codeless Tracking✔
      A/B Testing✔
      -

      Installation

      -

      CocoaPods

      + +

      +

      Current supported features

      + +

      Our master branch and our releases are in Swift 3. If you wish to use our Swift 2.3 implementation, please point to our v1.0.1 release.

      + +

      Our Swift library fully supports all of the Mixpanel features, and has full parity with the Objective-C Library.

      + +

      +

      Installation

      + +

      +

      CocoaPods

      Our current release only supports CocoaPods version 1.1.0+

      Mixpanel supports CocoaPods for easy installation. To Install, see our swift integration guide »

      +

      For iOS, tvOS, and macOS integrations:

      +

      pod 'Mixpanel-swift'

      -

      Carthage

      + +

      For App Extension integrations (you may need both the above and this):

      + +

      pod 'Mixpanel-swift-appex'

      + +

      +

      Carthage

      Mixpanel also supports Carthage to package your dependencies as a framework. Include the following dependency in your Cartfile:

      github "mixpanel/mixpanel-swift"

      Check out the Carthage docs » for more info.

      -

      Manual Installation

      + +

      +

      Manual Installation

      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.

      -

      Step 1: Add as a Submodule

      +

      Step 1: Add as a Submodule

      Add Mixpanel as a submodule to your local git repo like so:

      git submodule add git@github.com:mixpanel/mixpanel-swift.git

      Now the Mixpanel project and its files should be in your project folder!

      -

      Step 2: Drag Mixpanel to your project

      +

      Step 2: Drag Mixpanel to your project

      Drag the Mixpanel.xcodeproj inside your sample project under the main sample project file:

      alt text

      -

      Step 3: Embed the framework

      +

      Step 3: Embed the framework

      Select your app .xcodeproj file. Under General, add the Mixpanel framework as an embedded binary:

      alt text

      -

      Step 4: Integrate!

      + +

      +

      Initializing and Usage

      + +

      +

      Integrate

      Import Mixpanel into AppDelegate.swift, and initialize Mixpanel within application:didFinishLaunchingWithOptions: alt text

      -
      func application(_ application: UIApplication,
-                 didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool {
-    Mixpanel.initialize(token: "MIXPANEL_TOKEN")
-}
+
      func application(_ application: UIApplication,
+                 didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool {
+    Mixpanel.initialize(token: "MIXPANEL_TOKEN")
+}
+
      
+
+
      You initialize your Mixpanel instance with the token provided to you on mixpanel.com.
      
+
+
      
+
      Start tracking
      
+
+
      To interact with the instance and start tracking, you can either use the mixpanel instance given when initializing:
      
+
      mixpanel.track(event: "Tracked Event!")
+
      
+
+
      or you can directly fetch the instance and use it from the Mixpanel object:
      
+
      Mixpanel.mainInstance().track(event: "Tracked Event!")
 
      
-
      Initializing and Usage
      
-
-
      By calling:
-
-let mixpanel = Mixpanel.initialize(token: "MIXPANEL_TOKEN")
-
      
-
-
      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:
-
-mixpanel.track(event: "Tracked Event!")
-
-or you can directly fetch the instance and use it from the Mixpanel object:
-
-Mixpanel.mainInstance().track(event: "Tracked Event!")
-
      
-
      Start tracking
      
 
 
      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 Github.
      
 
@@ -344,8 +285,8 @@
           
         
         
       
     
diff --git a/docs/search.json b/docs/search.json
index 26439587c..83d855139 100644
--- a/docs/search.json
+++ b/docs/search.json
@@ -1 +1 @@
-{"Structs/AnyTweak.html#/s:vPs8Hashable9hashValueSi":{"name":"hashValue","abstract":"
      When combined with AnyTweak, this provides our type-erasure around Tweak
      ","parent_name":"AnyTweak"},"Structs/AnyTweak.html#/s:vV8Mixpanel8AnyTweak12tweakClusterGSaS0__":{"name":"tweakCluster","abstract":"
      Allows easy tweak initialization by clustering tweaks together for A/B Testing
      ","parent_name":"AnyTweak"},"Structs/Tweak.html#/s:FV8Mixpanel5TweakcFT9tweakNameSS12defaultValuexSSSS_GS0_x_":{"name":"init(tweakName:defaultValue:_:_:)","abstract":"
      Initializer for a Tweak for A/B Testing
      ","parent_name":"Tweak"},"Structs/Tweak.html#/s:Fe8MixpanelRxS_13TweakableTypexs12SignedNumberrVS_5TweakcFT9tweakNameSS12defaultValuex3minGSqx_3maxGSqx_8stepSizeGSqx_SSSS_GS2_x_":{"name":"init(tweakName:defaultValue:min:max:stepSize:_:_:)","abstract":"
      Creates a Tweak where T: SignedNumberType","parent_name":"Tweak"},"Structs/Tweak.html#/s:vV8Mixpanel5Tweak9hashValueSi":{"name":"hashValue","abstract":"
      Hashing for a Tweak for A/B Testing in order for it to be stored.
      ","parent_name":"Tweak"},"Structs/Tweak.html#/s:vP8Mixpanel16TweakClusterType12tweakClusterGSaVS_8AnyTweak_":{"name":"tweakCluster","abstract":"
      Extend Tweak to support easy initialization of a TweakStore
      ","parent_name":"Tweak"},"Structs/MixpanelTweaks.html#/s:ZvV8Mixpanel14MixpanelTweaks12defaultStoreCS_10TweakStore":{"name":"defaultStore","abstract":"
      The default store that holds the Tweaks
      ","parent_name":"MixpanelTweaks"},"Structs/MixpanelTweaks.html#/s:ZFV8Mixpanel14MixpanelTweaks9setTweaksFT6tweaksGSaPS_16TweakClusterType___T_":{"name":"setTweaks(tweaks:)","abstract":"
      setTweaks needs to be called to add the defined Tweaks into the environment.
      ","parent_name":"MixpanelTweaks"},"Structs/MixpanelTweaks.html":{"name":"MixpanelTweaks","abstract":"
      The MixpanelTweaks struct that needs to be extended to define new Tweaks for A/B testing
      "},"Structs/Tweak.html":{"name":"Tweak","abstract":"
      Tweaks let you adjust things on the fly."},"Structs/AnyTweak.html":{"name":"AnyTweak","abstract":"
      A type-erasure around Tweak for A/B Testing.
      "},"Protocols/TweakLibraryType.html#/s:ZvP8Mixpanel16TweakLibraryType12defaultStoreCS_10TweakStore":{"name":"defaultStore","abstract":"
      the default tweak store
      ","parent_name":"TweakLibraryType"},"Protocols/TweakLibraryType.html#/s:ZFE8MixpanelPS_16TweakLibraryType6assignuRd__S_13TweakableTyperFGVS_5Tweakqd___qd__":{"name":"assign(_:)","abstract":"
      Returns the current value for a tweak from the TweakLibrary’s default store.
      ","parent_name":"TweakLibraryType"},"Protocols/TweakLibraryType.html#/s:ZFE8MixpanelPS_16TweakLibraryType4binduRd__S_13TweakableTyperFTGVS_5Tweakqd___7bindingFqd__T__T_":{"name":"bind(_:binding:)","abstract":"
      Immediately binds the currentValue of a given tweak, and then continues to update whenever the tweak changes.
      ","parent_name":"TweakLibraryType"},"Protocols/MixpanelType.html#/s:FP8Mixpanel12MixpanelType17isValidNestedTypeFT_Sb":{"name":"isValidNestedType()","abstract":"
      Checks if this object has nested object types that Mixpanel supports.
      ","parent_name":"MixpanelType"},"Protocols/TweakableType.html#/s:ZvP8Mixpanel13TweakableType17tweakViewDataTypeOS_17TweakViewDataType":{"name":"tweakViewDataType","abstract":"
      The data type of the TweakableType
      ","parent_name":"TweakableType"},"Protocols/TweakClusterType.html#/s:vP8Mixpanel16TweakClusterType12tweakClusterGSaVS_8AnyTweak_":{"name":"tweakCluster","abstract":"
      The tweak cluster to allow easy initialization of Tweaks
      ","parent_name":"TweakClusterType"},"Protocols/MixpanelDelegate.html#/s:FP8Mixpanel16MixpanelDelegate17mixpanelWillFlushFCS_16MixpanelInstanceSb":{"name":"mixpanelWillFlush(_:)","abstract":"
      Asks the delegate if data should be uploaded to the server.
      ","parent_name":"MixpanelDelegate"},"Protocols/MixpanelDelegate.html":{"name":"MixpanelDelegate","abstract":"
      Delegate protocol for controlling the Mixpanel API’s network behavior.
      "},"Protocols/TweakClusterType.html":{"name":"TweakClusterType","abstract":"
      This protocol allows for easy initialization of TweakStore."},"Protocols/TweakableType.html":{"name":"TweakableType","abstract":"
      To add a new  to our Tweak, make T conform to this protocol.
      "},"Protocols/MixpanelType.html":{"name":"MixpanelType","abstract":"
      Property keys must be String objects and the supported value types need to conform to MixpanelType."},"Protocols/TweakLibraryType.html":{"name":"TweakLibraryType","abstract":"
      Create a public struct in your application that conforms to this protocol to declare your own tweaks!
      "},"Instance Methods.html#/s:FC8Mixpanel16MixpanelInstance16showNotificationFT_T_":{"name":"showNotification()","abstract":"
      Shows a notification if one is available.
      "},"Instance Methods.html#/s:FC8Mixpanel16MixpanelInstance8identifyFT10distinctIdSS_T_":{"name":"identify(distinctId:)","abstract":"
      Sets the distinct ID of the current user.
      "},"Instance Methods.html#/s:FC8Mixpanel16MixpanelInstance11createAliasFTSS10distinctIdSS_T_":{"name":"createAlias(_:distinctId:)","abstract":"
      Creates a distinctId alias from alias to the current id.
      "},"Instance Methods.html#/s:FC8Mixpanel16MixpanelInstance16showNotificationFT2IDSi_T_":{"name":"showNotification(ID:)","abstract":"
      Shows a notification with the given ID
      "},"Instance Methods.html#/s:FC8Mixpanel16MixpanelInstance7archiveFT_T_":{"name":"archive()","abstract":"
      Writes current project info including the distinct Id, super properties,"},"Instance Methods.html#/s:FC8Mixpanel16MixpanelInstance4timeFT5eventSS_T_":{"name":"time(event:)","abstract":"
      Starts a timer that will be stopped and added as a property when a"},"Instance Methods.html#/s:FC8Mixpanel16MixpanelInstance5resetFT_T_":{"name":"reset()","abstract":"
      Clears all stored properties including the distinct Id."},"Instance Methods.html#/s:FC8Mixpanel16MixpanelInstance5flushFT10completionGSqFT_T___T_":{"name":"flush(completion:)","abstract":"
      Uploads queued data to the Mixpanel server.
      "},"Instance Methods.html#/s:FC8Mixpanel16MixpanelInstance24fetchNotificationPayloadFT10completionFGSqGVs10DictionarySSPs9AnyObject___T__T_":{"name":"fetchNotificationPayload(completion:)","abstract":"
      Returns the payload of a notification if available
      "},"Instance Methods.html#/s:FC8Mixpanel16MixpanelInstance23unregisterSuperPropertyFSST_":{"name":"unregisterSuperProperty(_:)","abstract":"
      Removes a previously registered super property.
      "},"Instance Methods.html#/s:FC8Mixpanel16MixpanelInstance16showNotificationFT4typeSS_T_":{"name":"showNotification(type:)","abstract":"
      Shows a notification with the given type if one is available.
      "},"Instance Methods.html#/s:FC8Mixpanel16MixpanelInstance22currentSuperPropertiesFT_GVs10DictionarySSP__":{"name":"currentSuperProperties()","abstract":"
      Returns the currently set super properties.
      "},"Instance Methods.html#/s:FC8Mixpanel16MixpanelInstance27registerSuperPropertiesOnceFTGVs10DictionarySSPS_12MixpanelType__12defaultValueGSqPS2____T_":{"name":"registerSuperPropertiesOnce(_:defaultValue:)","abstract":"
      Registers super properties without overwriting ones that have already been set,"},"Instance Methods.html#/s:FC8Mixpanel16MixpanelInstance15joinExperimentsFT8callbackGSqFT_T___T_":{"name":"joinExperiments(callback:)","abstract":"
      Join any experiments (A/B tests) that are available for the current user.
      "},"Instance Methods.html#/s:FC8Mixpanel16MixpanelInstance20clearSuperPropertiesFT_T_":{"name":"clearSuperProperties()","abstract":"
      Clears all currently set super properties.
      "},"Instance Methods.html#/s:FC8Mixpanel16MixpanelInstance23registerSuperPropertiesFGVs10DictionarySSPS_12MixpanelType__T_":{"name":"registerSuperProperties(_:)","abstract":"
      Registers super properties, overwriting ones that have already been set.
      "},"Instance Methods.html#/s:FC8Mixpanel16MixpanelInstance16clearTimedEventsFT_T_":{"name":"clearTimedEvents()","abstract":"
      Clears all current event timers.
      "},"Instance Methods.html#/s:FC8Mixpanel16MixpanelInstance21trackPushNotificationFTGVs10DictionaryVs11AnyHashableP__5eventSS_T_":{"name":"trackPushNotification(_:event:)","abstract":"
      Track a push notification using its payload sent from Mixpanel.
      "},"Instance Methods.html#/s:FC8Mixpanel16MixpanelInstance5trackFT5eventGSqSS_10propertiesGSqGVs10DictionarySSPS_12MixpanelType____T_":{"name":"track(event:properties:)","abstract":"
      Tracks an event with properties."},"Functions/==(_:_:).html#/s:tF8Mixpaneloi2eeuRxS_13TweakableTyperFTGVS_5Tweakx_GS1_x__SbL_1TMx":{"name":"T","abstract":"Undocumented","parent_name":"==(_:_:)"},"Functions/==(_:_:).html":{"name":"==(_:_:)","abstract":"
      Comparator between two tweaks for A/B Testing.
      "},"Functions.html#/s:F8Mixpaneloi2eeFTVS_8AnyTweakS0__Sb":{"name":"==(_:_:)","abstract":"
      Comparator between two tweaks for A/B Testing.
      "},"Extensions/Dictionary.html#/s:FE8MixpanelVs10Dictionary17isValidNestedTypeFT_Sb":{"name":"isValidNestedType()","abstract":"
      Checks if this object has nested object types that Mixpanel supports.
      ","parent_name":"Dictionary"},"Extensions/Array.html#/s:FE8MixpanelSa17isValidNestedTypeFT_Sb":{"name":"isValidNestedType()","abstract":"
      Checks if this object has nested object types that Mixpanel supports.
      ","parent_name":"Array"},"Extensions/NSNull.html#/s:FE8MixpanelCSo6NSNull17isValidNestedTypeFT_Sb":{"name":"isValidNestedType()","abstract":"
      Checks if this object has nested object types that Mixpanel supports.","parent_name":"NSNull"},"Extensions/URL.html#/s:FE8MixpanelV10Foundation3URL17isValidNestedTypeFT_Sb":{"name":"isValidNestedType()","abstract":"
      Checks if this object has nested object types that Mixpanel supports.","parent_name":"URL"},"Extensions/Date.html#/s:FE8MixpanelV10Foundation4Date17isValidNestedTypeFT_Sb":{"name":"isValidNestedType()","abstract":"
      Checks if this object has nested object types that Mixpanel supports.","parent_name":"Date"},"Extensions/Float.html#/s:FE8MixpanelSf17isValidNestedTypeFT_Sb":{"name":"isValidNestedType()","abstract":"
      Checks if this object has nested object types that Mixpanel supports.","parent_name":"Float"},"Extensions/UInt.html#/s:FE8MixpanelSu17isValidNestedTypeFT_Sb":{"name":"isValidNestedType()","abstract":"
      Checks if this object has nested object types that Mixpanel supports.","parent_name":"UInt"},"Extensions/String.html#/s:ZvE8MixpanelSS17tweakViewDataTypeOS_17TweakViewDataType":{"name":"tweakViewDataType","abstract":"
      TweakableType supports the string type
      ","parent_name":"String"},"Extensions/String.html#/s:FE8MixpanelSS17isValidNestedTypeFT_Sb":{"name":"isValidNestedType()","abstract":"
      Checks if this object has nested object types that Mixpanel supports.","parent_name":"String"},"Extensions/UIColor.html#/s:ZvE8MixpanelCSo7UIColor17tweakViewDataTypeOS_17TweakViewDataType":{"name":"tweakViewDataType","abstract":"
      TweakableType supports the uiColor type
      ","parent_name":"UIColor"},"Extensions/UIColor.html#/s:FE8MixpanelCSo7UIColorcFT4hex4Su_S0_":{"name":"init(hex4:)","abstract":"
      The shorthand four-digit hexadecimal representation of color with alpha.
      ","parent_name":"UIColor"},"Extensions/Double.html#/s:ZvE8MixpanelSd17tweakViewDataTypeOS_17TweakViewDataType":{"name":"tweakViewDataType","abstract":"
      TweakableType supports the double type
      ","parent_name":"Double"},"Extensions/Double.html#/s:FE8MixpanelSd17isValidNestedTypeFT_Sb":{"name":"isValidNestedType()","abstract":"
      Checks if this object has nested object types that Mixpanel supports.","parent_name":"Double"},"Extensions/CGFloat.html#/s:ZvE8MixpanelV12CoreGraphics7CGFloat17tweakViewDataTypeOS_17TweakViewDataType":{"name":"tweakViewDataType","abstract":"
      TweakableType supports the cgFloat type
      ","parent_name":"CGFloat"},"Extensions/Int.html#/s:ZvE8MixpanelSi17tweakViewDataTypeOS_17TweakViewDataType":{"name":"tweakViewDataType","abstract":"
      TweakableType supports the integer type
      ","parent_name":"Int"},"Extensions/Int.html#/s:FE8MixpanelSi17isValidNestedTypeFT_Sb":{"name":"isValidNestedType()","abstract":"
      Checks if this object has nested object types that Mixpanel supports.","parent_name":"Int"},"Extensions/Bool.html#/s:ZvE8MixpanelSb17tweakViewDataTypeOS_17TweakViewDataType":{"name":"tweakViewDataType","abstract":"
      TweakableType supports the boolean type
      ","parent_name":"Bool"},"Extensions/Bool.html#/s:FE8MixpanelSb17isValidNestedTypeFT_Sb":{"name":"isValidNestedType()","abstract":"
      Checks if this object has nested object types that Mixpanel supports.","parent_name":"Bool"},"Extensions/Bool.html":{"name":"Bool"},"Extensions/Int.html":{"name":"Int"},"Extensions/CGFloat.html":{"name":"CGFloat","abstract":"Undocumented"},"Extensions/Double.html":{"name":"Double"},"Extensions/UIColor.html":{"name":"UIColor","abstract":"Undocumented"},"Extensions/String.html":{"name":"String"},"Extensions/UInt.html":{"name":"UInt"},"Extensions/Float.html":{"name":"Float"},"Extensions/Date.html":{"name":"Date"},"Extensions/URL.html":{"name":"URL"},"Extensions/NSNull.html":{"name":"NSNull","abstract":"Undocumented"},"Extensions/Array.html":{"name":"Array"},"Extensions/Dictionary.html":{"name":"Dictionary"},"Enums/TweakViewDataType.html#/s:FO8Mixpanel17TweakViewDataType7booleanFMS0_S0_":{"name":"boolean","abstract":"
      TweakableType supports the boolean type
      ","parent_name":"TweakViewDataType"},"Enums/TweakViewDataType.html#/s:FO8Mixpanel17TweakViewDataType7integerFMS0_S0_":{"name":"integer","abstract":"
      TweakableType supports the integer type
      ","parent_name":"TweakViewDataType"},"Enums/TweakViewDataType.html#/s:FO8Mixpanel17TweakViewDataType7cgFloatFMS0_S0_":{"name":"cgFloat","abstract":"
      TweakableType supports the cgFloat type
      ","parent_name":"TweakViewDataType"},"Enums/TweakViewDataType.html#/s:FO8Mixpanel17TweakViewDataType6doubleFMS0_S0_":{"name":"double","abstract":"
      TweakableType supports the double type
      ","parent_name":"TweakViewDataType"},"Enums/TweakViewDataType.html#/s:FO8Mixpanel17TweakViewDataType7uiColorFMS0_S0_":{"name":"uiColor","abstract":"
      TweakableType supports the uiColor type
      ","parent_name":"TweakViewDataType"},"Enums/TweakViewDataType.html#/s:FO8Mixpanel17TweakViewDataType6stringFMS0_S0_":{"name":"string","abstract":"
      TweakableType supports the string type
      ","parent_name":"TweakViewDataType"},"Enums/TweakViewDataType.html":{"name":"TweakViewDataType","abstract":"
      The data types that are currently supported for SwiftTweaks."},"Classes/Mixpanel.html#/s:ZFC8Mixpanel8Mixpanel10initializeFT5tokenSS13launchOptionsGSqGVs10DictionaryVSC29UIApplicationLaunchOptionsKeyP___13flushIntervalSd12instanceNameSS_CS_16MixpanelInstance":{"name":"initialize(token:launchOptions:flushInterval:instanceName:)","abstract":"
      Initializes an instance of the API with the given project token.
      ","parent_name":"Mixpanel"},"Classes/Mixpanel.html#/initialize(token:flushInterval:instanceName:)":{"name":"initialize(token:flushInterval:instanceName:)","abstract":"Undocumented","parent_name":"Mixpanel"},"Classes/Mixpanel.html#/s:ZFC8Mixpanel8Mixpanel11getInstanceFT4nameSS_GSqCS_16MixpanelInstance_":{"name":"getInstance(name:)","abstract":"
      Gets the mixpanel instance with the given name
      ","parent_name":"Mixpanel"},"Classes/Mixpanel.html#/s:ZFC8Mixpanel8Mixpanel12mainInstanceFT_CS_16MixpanelInstance":{"name":"mainInstance()","abstract":"
      Returns the main instance that was initialized.
      ","parent_name":"Mixpanel"},"Classes/Mixpanel.html#/s:ZFC8Mixpanel8Mixpanel15setMainInstanceFT4nameSS_T_":{"name":"setMainInstance(name:)","abstract":"
      Sets the main instance based on the instance name
      ","parent_name":"Mixpanel"},"Classes/Mixpanel.html#/s:ZFC8Mixpanel8Mixpanel14removeInstanceFT4nameSS_T_":{"name":"removeInstance(name:)","abstract":"
      Removes an unneeded Mixpanel instance based on its name
      ","parent_name":"Mixpanel"},"Classes/People.html#/s:vC8Mixpanel6People10ignoreTimeSb":{"name":"ignoreTime","abstract":"
      controls the $ignore_time property in any subsequent MixpanelPeople operation.","parent_name":"People"},"Classes/People.html#/s:FC8Mixpanel6People18addPushDeviceTokenFV10Foundation4DataT_":{"name":"addPushDeviceToken(_:)","abstract":"
      Register the given device to receive push notifications.
      ","parent_name":"People"},"Classes/People.html#/s:FC8Mixpanel6People21removePushDeviceTokenFV10Foundation4DataT_":{"name":"removePushDeviceToken(_:)","abstract":"
      Unregister a specific device token from the ability to receive push notifications.
      ","parent_name":"People"},"Classes/People.html#/s:FC8Mixpanel6People3setFT10propertiesGVs10DictionarySSPS_12MixpanelType___T_":{"name":"set(properties:)","abstract":"
      Set properties on the current user in Mixpanel People.
      ","parent_name":"People"},"Classes/People.html#/s:FC8Mixpanel6People3setFT8propertySS2toPS_12MixpanelType__T_":{"name":"set(property:to:)","abstract":"
      Convenience method for setting a single property in Mixpanel People.
      ","parent_name":"People"},"Classes/People.html#/s:FC8Mixpanel6People7setOnceFT10propertiesGVs10DictionarySSPS_12MixpanelType___T_":{"name":"setOnce(properties:)","abstract":"
      Set properties on the current user in Mixpanel People, but doesn’t overwrite if","parent_name":"People"},"Classes/People.html#/s:FC8Mixpanel6People5unsetFT10propertiesGSaSS__T_":{"name":"unset(properties:)","abstract":"
      Remove a list of properties and their values from the current user’s profile","parent_name":"People"},"Classes/People.html#/s:FC8Mixpanel6People9incrementFT10propertiesGVs10DictionarySSPS_12MixpanelType___T_":{"name":"increment(properties:)","abstract":"
      Increment the given numeric properties by the given values.
      ","parent_name":"People"},"Classes/People.html#/s:FC8Mixpanel6People9incrementFT8propertySS2bySd_T_":{"name":"increment(property:by:)","abstract":"
      Convenience method for incrementing a single numeric property by the specified","parent_name":"People"},"Classes/People.html#/s:FC8Mixpanel6People6appendFT10propertiesGVs10DictionarySSPS_12MixpanelType___T_":{"name":"append(properties:)","abstract":"
      Append values to list properties.
      ","parent_name":"People"},"Classes/People.html#/s:FC8Mixpanel6People6removeFT10propertiesGVs10DictionarySSPS_12MixpanelType___T_":{"name":"remove(properties:)","abstract":"
      Removes list properties.
      ","parent_name":"People"},"Classes/People.html#/s:FC8Mixpanel6People5unionFT10propertiesGVs10DictionarySSPS_12MixpanelType___T_":{"name":"union(properties:)","abstract":"
      Union list properties.
      ","parent_name":"People"},"Classes/People.html#/s:FC8Mixpanel6People11trackChargeFT6amountSd10propertiesGSqGVs10DictionarySSPS_12MixpanelType____T_":{"name":"trackCharge(amount:properties:)","abstract":"
      Track money spent by the current user for revenue analytics and associate","parent_name":"People"},"Classes/People.html#/s:FC8Mixpanel6People12clearChargesFT_T_":{"name":"clearCharges()","abstract":"
      Delete current user’s revenue history.
      ","parent_name":"People"},"Classes/People.html#/s:FC8Mixpanel6People10deleteUserFT_T_":{"name":"deleteUser()","abstract":"
      Delete current user’s record from Mixpanel People.
      ","parent_name":"People"},"Classes/MixpanelInstance.html#/s:vC8Mixpanel16MixpanelInstance8delegateGSqPS_16MixpanelDelegate__":{"name":"delegate","abstract":"
      The a MixpanelDelegate object that gives control over Mixpanel network activity.
      ","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:vC8Mixpanel16MixpanelInstance10distinctIdSS":{"name":"distinctId","abstract":"
      distinctId string that uniquely identifies the current user.
      ","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:vC8Mixpanel16MixpanelInstance5aliasGSqSS_":{"name":"alias","abstract":"
      alias string that uniquely identifies the current user.
      ","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:vC8Mixpanel16MixpanelInstance6peopleGSQCS_6People_":{"name":"people","abstract":"
      Accessor to the Mixpanel People API object.
      ","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:vC8Mixpanel16MixpanelInstance28showNetworkActivityIndicatorSb":{"name":"showNetworkActivityIndicator","abstract":"
      Controls whether to show spinning network activity indicator when flushing","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:vC8Mixpanel16MixpanelInstance13flushIntervalSd":{"name":"flushInterval","abstract":"
      Flush timer’s interval.","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:vC8Mixpanel16MixpanelInstance17flushOnBackgroundSb":{"name":"flushOnBackground","abstract":"
      Control whether the library should flush data to Mixpanel when the app","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:vC8Mixpanel16MixpanelInstance26useIPAddressForGeoLocationSb":{"name":"useIPAddressForGeoLocation","abstract":"
      Controls whether to automatically send the client IP Address as part of","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:vC8Mixpanel16MixpanelInstance9serverURLSS":{"name":"serverURL","abstract":"
      The base URL used for Mixpanel API requests.","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:vPs28CustomDebugStringConvertible16debugDescriptionSS":{"name":"debugDescription","abstract":"
      The base URL used for Mixpanel API requests.","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:vC8Mixpanel16MixpanelInstance14loggingEnabledSb":{"name":"loggingEnabled","abstract":"
      This allows enabling or disabling of all Mixpanel logs at run time.","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:vC8Mixpanel16MixpanelInstance4nameSS":{"name":"name","abstract":"
      A unique identifier for this MixpanelInstance
      ","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:vC8Mixpanel16MixpanelInstance29enableVisualEditorForCodelessSb":{"name":"enableVisualEditorForCodeless","abstract":"
      Controls whether to enable the visual editor for codeless on mixpanel.com","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:vC8Mixpanel16MixpanelInstance24checkForVariantsOnActiveSb":{"name":"checkForVariantsOnActive","abstract":"
      Controls whether to automatically check for A/B test variants for the","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:vC8Mixpanel16MixpanelInstance28checkForNotificationOnActiveSb":{"name":"checkForNotificationOnActive","abstract":"
      Controls whether to automatically check for notifications for the","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:vC8Mixpanel16MixpanelInstance24showNotificationOnActiveSb":{"name":"showNotificationOnActive","abstract":"
      Controls whether to automatically check for and show in-app notifications","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:vC8Mixpanel16MixpanelInstance32miniNotificationPresentationTimeSd":{"name":"miniNotificationPresentationTime","abstract":"
      Determines the time, in seconds, that a mini notification will remain on","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html":{"name":"MixpanelInstance","abstract":"
      The class that represents the Mixpanel Instance
      "},"Classes/People.html":{"name":"People","abstract":"
      Access to the Mixpanel People API, available as an accessible variable from"},"Classes.html#/s:C8Mixpanel10TweakStore":{"name":"TweakStore","abstract":"
      Looks up the persisted state for tweaks.
      "},"Classes/Mixpanel.html":{"name":"Mixpanel","abstract":"
      The primary class for integrating Mixpanel with your app.
      "},"Classes.html":{"name":"Classes","abstract":"The following classes are available globally."},"Enums.html":{"name":"Enums","abstract":"The following enums are available globally."},"Extensions.html":{"name":"Extensions","abstract":"The following extensions are available globally."},"Functions.html":{"name":"Functions","abstract":"The following functions are available globally."},"Instance Methods.html":{"name":"Instance Methods","abstract":"The following instance methods are available globally."},"Protocols.html":{"name":"Protocols","abstract":"The following protocols are available globally."},"Structs.html":{"name":"Structs","abstract":"The following structs are available globally."}}
\ No newline at end of file
+{"Structs/AnyTweak.html#/s:vPs8Hashable9hashValueSi":{"name":"hashValue","parent_name":"AnyTweak"},"Structs/AnyTweak.html#/s:vV8Mixpanel8AnyTweak12tweakClusterGSaS0__":{"name":"tweakCluster","abstract":"
      Allows easy tweak initialization by clustering tweaks together for A/B Testing
      ","parent_name":"AnyTweak"},"Structs/Tweak.html#/s:FV8Mixpanel5TweakcFT9tweakNameSS12defaultValuexSSSS_GS0_x_":{"name":"init(tweakName:defaultValue:_:_:)","abstract":"
      Initializer for a Tweak for A/B Testing
      ","parent_name":"Tweak"},"Structs/Tweak.html#/s:Fe8MixpanelRxS_13TweakableTypexs12SignedNumberrVS_5TweakcFT9tweakNameSS12defaultValuex3minGSqx_3maxGSqx_8stepSizeGSqx_SSSS_GS2_x_":{"name":"init(tweakName:defaultValue:min:max:stepSize:_:_:)","abstract":"
      Creates a Tweak where T: SignedNumberType","parent_name":"Tweak"},"Structs/Tweak.html#/s:vV8Mixpanel5Tweak9hashValueSi":{"name":"hashValue","abstract":"
      Hashing for a Tweak for A/B Testing in order for it to be stored.
      ","parent_name":"Tweak"},"Structs/Tweak.html#/s:vP8Mixpanel16TweakClusterType12tweakClusterGSaVS_8AnyTweak_":{"name":"tweakCluster","parent_name":"Tweak"},"Structs/MixpanelTweaks.html#/s:ZvV8Mixpanel14MixpanelTweaks12defaultStoreCS_10TweakStore":{"name":"defaultStore","abstract":"
      The default store that holds the Tweaks
      ","parent_name":"MixpanelTweaks"},"Structs/MixpanelTweaks.html#/s:ZFV8Mixpanel14MixpanelTweaks9setTweaksFT6tweaksGSaPS_16TweakClusterType___T_":{"name":"setTweaks(tweaks:)","abstract":"
      setTweaks needs to be called to add the defined Tweaks into the environment.
      ","parent_name":"MixpanelTweaks"},"Structs/MixpanelTweaks.html":{"name":"MixpanelTweaks","abstract":"
      The MixpanelTweaks struct that needs to be extended to define new Tweaks for A/B testing
      "},"Structs/Tweak.html":{"name":"Tweak","abstract":"
      Tweaks let you adjust things on the fly."},"Structs/AnyTweak.html":{"name":"AnyTweak","abstract":"
      A type-erasure around Tweak for A/B Testing.
      "},"Protocols/TweakLibraryType.html#/s:ZvP8Mixpanel16TweakLibraryType12defaultStoreCS_10TweakStore":{"name":"defaultStore","abstract":"
      the default tweak store
      ","parent_name":"TweakLibraryType"},"Protocols/TweakLibraryType.html#/s:ZFE8MixpanelPS_16TweakLibraryType6assignuRd__S_13TweakableTyperFGVS_5Tweakqd___qd__":{"name":"assign(_:)","abstract":"
      Returns the current value for a tweak from the TweakLibrary’s default store.
      ","parent_name":"TweakLibraryType"},"Protocols/TweakLibraryType.html#/s:ZFE8MixpanelPS_16TweakLibraryType4binduRd__S_13TweakableTyperFTGVS_5Tweakqd___7bindingFqd__T__T_":{"name":"bind(_:binding:)","abstract":"
      Immediately binds the currentValue of a given tweak, and then continues to update whenever the tweak changes.
      ","parent_name":"TweakLibraryType"},"Protocols/MixpanelType.html#/s:FP8Mixpanel12MixpanelType17isValidNestedTypeFT_Sb":{"name":"isValidNestedType()","abstract":"
      Checks if this object has nested object types that Mixpanel supports.
      ","parent_name":"MixpanelType"},"Protocols/TweakableType.html#/s:ZvP8Mixpanel13TweakableType17tweakViewDataTypeOS_17TweakViewDataType":{"name":"tweakViewDataType","abstract":"
      The data type of the TweakableType
      ","parent_name":"TweakableType"},"Protocols/TweakClusterType.html#/s:vP8Mixpanel16TweakClusterType12tweakClusterGSaVS_8AnyTweak_":{"name":"tweakCluster","abstract":"
      The tweak cluster to allow easy initialization of Tweaks
      ","parent_name":"TweakClusterType"},"Protocols/MixpanelDelegate.html#/s:FP8Mixpanel16MixpanelDelegate17mixpanelWillFlushFCS_16MixpanelInstanceSb":{"name":"mixpanelWillFlush(_:)","abstract":"
      Asks the delegate if data should be uploaded to the server.
      ","parent_name":"MixpanelDelegate"},"Protocols/MixpanelDelegate.html":{"name":"MixpanelDelegate","abstract":"
      Delegate protocol for controlling the Mixpanel API’s network behavior.
      "},"Protocols/TweakClusterType.html":{"name":"TweakClusterType","abstract":"
      This protocol allows for easy initialization of TweakStore."},"Protocols/TweakableType.html":{"name":"TweakableType","abstract":"
      To add a new  to our Tweak, make T conform to this protocol.
      "},"Protocols/MixpanelType.html":{"name":"MixpanelType","abstract":"
      Property keys must be String objects and the supported value types need to conform to MixpanelType."},"Protocols/TweakLibraryType.html":{"name":"TweakLibraryType","abstract":"
      Create a public struct in your application that conforms to this protocol to declare your own tweaks!
      "},"Functions/==(_:_:).html#/s:tF8Mixpaneloi2eeuRxS_13TweakableTyperFTGVS_5Tweakx_GS1_x__SbL_1TMx":{"name":"T","abstract":"
      Undocumented
      ","parent_name":"==(_:_:)"},"Functions/==(_:_:).html":{"name":"==(_:_:)","abstract":"
      Comparator between two tweaks for A/B Testing.
      "},"Functions.html#/s:F8Mixpaneloi2eeFTVS_8AnyTweakS0__Sb":{"name":"==(_:_:)","abstract":"
      Comparator between two tweaks for A/B Testing.
      "},"Extensions/UIColor.html#/s:FE8MixpanelCSo7UIColorcFT5MPHexSu_S0_":{"name":"init(MPHex:)","abstract":"
      The shorthand four-digit hexadecimal representation of color with alpha.
      ","parent_name":"UIColor"},"Extensions/Dictionary.html#/s:FE8MixpanelVs10Dictionary17isValidNestedTypeFT_Sb":{"name":"isValidNestedType()","abstract":"
      Checks if this object has nested object types that Mixpanel supports.
      ","parent_name":"Dictionary"},"Extensions/Array.html#/s:FE8MixpanelSa17isValidNestedTypeFT_Sb":{"name":"isValidNestedType()","abstract":"
      Checks if this object has nested object types that Mixpanel supports.
      ","parent_name":"Array"},"Extensions/NSNull.html#/s:FE8MixpanelCSo6NSNull17isValidNestedTypeFT_Sb":{"name":"isValidNestedType()","abstract":"
      Checks if this object has nested object types that Mixpanel supports.","parent_name":"NSNull"},"Extensions/URL.html#/s:FE8MixpanelV10Foundation3URL17isValidNestedTypeFT_Sb":{"name":"isValidNestedType()","abstract":"
      Checks if this object has nested object types that Mixpanel supports.","parent_name":"URL"},"Extensions/Date.html#/s:FE8MixpanelV10Foundation4Date17isValidNestedTypeFT_Sb":{"name":"isValidNestedType()","abstract":"
      Checks if this object has nested object types that Mixpanel supports.","parent_name":"Date"},"Extensions/Float.html#/s:FE8MixpanelSf17isValidNestedTypeFT_Sb":{"name":"isValidNestedType()","abstract":"
      Checks if this object has nested object types that Mixpanel supports.","parent_name":"Float"},"Extensions/UInt.html#/s:FE8MixpanelSu17isValidNestedTypeFT_Sb":{"name":"isValidNestedType()","abstract":"
      Checks if this object has nested object types that Mixpanel supports.","parent_name":"UInt"},"Extensions/String.html#/s:ZvE8MixpanelSS17tweakViewDataTypeOS_17TweakViewDataType":{"name":"tweakViewDataType","abstract":"
      TweakableType supports the string type
      ","parent_name":"String"},"Extensions/String.html#/s:FE8MixpanelSS17isValidNestedTypeFT_Sb":{"name":"isValidNestedType()","abstract":"
      Checks if this object has nested object types that Mixpanel supports.","parent_name":"String"},"Extensions/Double.html#/s:ZvE8MixpanelSd17tweakViewDataTypeOS_17TweakViewDataType":{"name":"tweakViewDataType","abstract":"
      TweakableType supports the double type
      ","parent_name":"Double"},"Extensions/Double.html#/s:FE8MixpanelSd17isValidNestedTypeFT_Sb":{"name":"isValidNestedType()","abstract":"
      Checks if this object has nested object types that Mixpanel supports.","parent_name":"Double"},"Extensions/CGFloat.html#/s:ZvE8MixpanelV12CoreGraphics7CGFloat17tweakViewDataTypeOS_17TweakViewDataType":{"name":"tweakViewDataType","abstract":"
      TweakableType supports the cgFloat type
      ","parent_name":"CGFloat"},"Extensions/Int.html#/s:ZvE8MixpanelSi17tweakViewDataTypeOS_17TweakViewDataType":{"name":"tweakViewDataType","abstract":"
      TweakableType supports the integer type
      ","parent_name":"Int"},"Extensions/Int.html#/s:FE8MixpanelSi17isValidNestedTypeFT_Sb":{"name":"isValidNestedType()","abstract":"
      Checks if this object has nested object types that Mixpanel supports.","parent_name":"Int"},"Extensions/Bool.html#/s:ZvE8MixpanelSb17tweakViewDataTypeOS_17TweakViewDataType":{"name":"tweakViewDataType","abstract":"
      TweakableType supports the boolean type
      ","parent_name":"Bool"},"Extensions/Bool.html#/s:FE8MixpanelSb17isValidNestedTypeFT_Sb":{"name":"isValidNestedType()","abstract":"
      Checks if this object has nested object types that Mixpanel supports.","parent_name":"Bool"},"Extensions/Bool.html":{"name":"Bool"},"Extensions/Int.html":{"name":"Int"},"Extensions/CGFloat.html":{"name":"CGFloat","abstract":"
      Undocumented
      "},"Extensions/Double.html":{"name":"Double"},"Extensions/String.html":{"name":"String"},"Extensions/UInt.html":{"name":"UInt"},"Extensions/Float.html":{"name":"Float"},"Extensions/Date.html":{"name":"Date"},"Extensions/URL.html":{"name":"URL"},"Extensions/NSNull.html":{"name":"NSNull","abstract":"
      Undocumented
      "},"Extensions/Array.html":{"name":"Array"},"Extensions/Dictionary.html":{"name":"Dictionary"},"Extensions/UIColor.html":{"name":"UIColor","abstract":"
      Undocumented
      "},"Enums/TweakViewDataType.html#/s:FO8Mixpanel17TweakViewDataType7booleanFMS0_S0_":{"name":"boolean","abstract":"
      TweakableType supports the boolean type
      ","parent_name":"TweakViewDataType"},"Enums/TweakViewDataType.html#/s:FO8Mixpanel17TweakViewDataType7integerFMS0_S0_":{"name":"integer","abstract":"
      TweakableType supports the integer type
      ","parent_name":"TweakViewDataType"},"Enums/TweakViewDataType.html#/s:FO8Mixpanel17TweakViewDataType7cgFloatFMS0_S0_":{"name":"cgFloat","abstract":"
      TweakableType supports the cgFloat type
      ","parent_name":"TweakViewDataType"},"Enums/TweakViewDataType.html#/s:FO8Mixpanel17TweakViewDataType6doubleFMS0_S0_":{"name":"double","abstract":"
      TweakableType supports the double type
      ","parent_name":"TweakViewDataType"},"Enums/TweakViewDataType.html#/s:FO8Mixpanel17TweakViewDataType6stringFMS0_S0_":{"name":"string","abstract":"
      TweakableType supports the string type
      ","parent_name":"TweakViewDataType"},"Enums/TweakViewDataType.html":{"name":"TweakViewDataType","abstract":"
      The data types that are currently supported for SwiftTweaks."},"Classes/Mixpanel.html#/s:ZFC8Mixpanel8Mixpanel10initializeFT5tokenSS13launchOptionsGSqGVs10DictionaryVSC29UIApplicationLaunchOptionsKeyP___13flushIntervalSd12instanceNameSS_CS_16MixpanelInstance":{"name":"initialize(token:launchOptions:flushInterval:instanceName:)","abstract":"
      Initializes an instance of the API with the given project token.
      ","parent_name":"Mixpanel"},"Classes/Mixpanel.html#/initialize(token:flushInterval:instanceName:)":{"name":"initialize(token:flushInterval:instanceName:)","abstract":"
      Undocumented
      ","parent_name":"Mixpanel"},"Classes/Mixpanel.html#/s:ZFC8Mixpanel8Mixpanel11getInstanceFT4nameSS_GSqCS_16MixpanelInstance_":{"name":"getInstance(name:)","abstract":"
      Gets the mixpanel instance with the given name
      ","parent_name":"Mixpanel"},"Classes/Mixpanel.html#/s:ZFC8Mixpanel8Mixpanel12mainInstanceFT_CS_16MixpanelInstance":{"name":"mainInstance()","abstract":"
      Returns the main instance that was initialized.
      ","parent_name":"Mixpanel"},"Classes/Mixpanel.html#/s:ZFC8Mixpanel8Mixpanel15setMainInstanceFT4nameSS_T_":{"name":"setMainInstance(name:)","abstract":"
      Sets the main instance based on the instance name
      ","parent_name":"Mixpanel"},"Classes/Mixpanel.html#/s:ZFC8Mixpanel8Mixpanel14removeInstanceFT4nameSS_T_":{"name":"removeInstance(name:)","abstract":"
      Removes an unneeded Mixpanel instance based on its name
      ","parent_name":"Mixpanel"},"Classes/People.html#/s:vC8Mixpanel6People10ignoreTimeSb":{"name":"ignoreTime","abstract":"
      controls the $ignore_time property in any subsequent MixpanelPeople operation.","parent_name":"People"},"Classes/People.html#/s:FC8Mixpanel6People18addPushDeviceTokenFV10Foundation4DataT_":{"name":"addPushDeviceToken(_:)","abstract":"
      Register the given device to receive push notifications.
      ","parent_name":"People"},"Classes/People.html#/s:FC8Mixpanel6People21removePushDeviceTokenFV10Foundation4DataT_":{"name":"removePushDeviceToken(_:)","abstract":"
      Unregister a specific device token from the ability to receive push notifications.
      ","parent_name":"People"},"Classes/People.html#/s:FC8Mixpanel6People3setFT10propertiesGVs10DictionarySSPS_12MixpanelType___T_":{"name":"set(properties:)","abstract":"
      Set properties on the current user in Mixpanel People.
      ","parent_name":"People"},"Classes/People.html#/s:FC8Mixpanel6People3setFT8propertySS2toPS_12MixpanelType__T_":{"name":"set(property:to:)","abstract":"
      Convenience method for setting a single property in Mixpanel People.
      ","parent_name":"People"},"Classes/People.html#/s:FC8Mixpanel6People7setOnceFT10propertiesGVs10DictionarySSPS_12MixpanelType___T_":{"name":"setOnce(properties:)","abstract":"
      Set properties on the current user in Mixpanel People, but doesn’t overwrite if","parent_name":"People"},"Classes/People.html#/s:FC8Mixpanel6People5unsetFT10propertiesGSaSS__T_":{"name":"unset(properties:)","abstract":"
      Remove a list of properties and their values from the current user’s profile","parent_name":"People"},"Classes/People.html#/s:FC8Mixpanel6People9incrementFT10propertiesGVs10DictionarySSPS_12MixpanelType___T_":{"name":"increment(properties:)","abstract":"
      Increment the given numeric properties by the given values.
      ","parent_name":"People"},"Classes/People.html#/s:FC8Mixpanel6People9incrementFT8propertySS2bySd_T_":{"name":"increment(property:by:)","abstract":"
      Convenience method for incrementing a single numeric property by the specified","parent_name":"People"},"Classes/People.html#/s:FC8Mixpanel6People6appendFT10propertiesGVs10DictionarySSPS_12MixpanelType___T_":{"name":"append(properties:)","abstract":"
      Append values to list properties.
      ","parent_name":"People"},"Classes/People.html#/s:FC8Mixpanel6People6removeFT10propertiesGVs10DictionarySSPS_12MixpanelType___T_":{"name":"remove(properties:)","abstract":"
      Removes list properties.
      ","parent_name":"People"},"Classes/People.html#/s:FC8Mixpanel6People5unionFT10propertiesGVs10DictionarySSPS_12MixpanelType___T_":{"name":"union(properties:)","abstract":"
      Union list properties.
      ","parent_name":"People"},"Classes/People.html#/s:FC8Mixpanel6People11trackChargeFT6amountSd10propertiesGSqGVs10DictionarySSPS_12MixpanelType____T_":{"name":"trackCharge(amount:properties:)","abstract":"
      Track money spent by the current user for revenue analytics and associate","parent_name":"People"},"Classes/People.html#/s:FC8Mixpanel6People12clearChargesFT_T_":{"name":"clearCharges()","abstract":"
      Delete current user’s revenue history.
      ","parent_name":"People"},"Classes/People.html#/s:FC8Mixpanel6People10deleteUserFT_T_":{"name":"deleteUser()","abstract":"
      Delete current user’s record from Mixpanel People.
      ","parent_name":"People"},"Classes/MixpanelInstance.html#/s:vC8Mixpanel16MixpanelInstance8delegateGSqPS_16MixpanelDelegate__":{"name":"delegate","abstract":"
      The a MixpanelDelegate object that gives control over Mixpanel network activity.
      ","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:vC8Mixpanel16MixpanelInstance10distinctIdSS":{"name":"distinctId","abstract":"
      distinctId string that uniquely identifies the current user.
      ","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:vC8Mixpanel16MixpanelInstance5aliasGSqSS_":{"name":"alias","abstract":"
      alias string that uniquely identifies the current user.
      ","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:vC8Mixpanel16MixpanelInstance6peopleGSQCS_6People_":{"name":"people","abstract":"
      Accessor to the Mixpanel People API object.
      ","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:vC8Mixpanel16MixpanelInstance28showNetworkActivityIndicatorSb":{"name":"showNetworkActivityIndicator","abstract":"
      Controls whether to show spinning network activity indicator when flushing","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:vC8Mixpanel16MixpanelInstance13flushIntervalSd":{"name":"flushInterval","abstract":"
      Flush timer’s interval.","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:vC8Mixpanel16MixpanelInstance17flushOnBackgroundSb":{"name":"flushOnBackground","abstract":"
      Control whether the library should flush data to Mixpanel when the app","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:vC8Mixpanel16MixpanelInstance26useIPAddressForGeoLocationSb":{"name":"useIPAddressForGeoLocation","abstract":"
      Controls whether to automatically send the client IP Address as part of","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:vC8Mixpanel16MixpanelInstance9serverURLSS":{"name":"serverURL","abstract":"
      The base URL used for Mixpanel API requests.","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:vPs28CustomDebugStringConvertible16debugDescriptionSS":{"name":"debugDescription","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:vC8Mixpanel16MixpanelInstance14loggingEnabledSb":{"name":"loggingEnabled","abstract":"
      This allows enabling or disabling of all Mixpanel logs at run time.
      ","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:vC8Mixpanel16MixpanelInstance4nameSS":{"name":"name","abstract":"
      A unique identifier for this MixpanelInstance
      ","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:vC8Mixpanel16MixpanelInstance29enableVisualEditorForCodelessSb":{"name":"enableVisualEditorForCodeless","abstract":"
      Controls whether to enable the visual editor for codeless on mixpanel.com","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:vC8Mixpanel16MixpanelInstance24checkForVariantsOnActiveSb":{"name":"checkForVariantsOnActive","abstract":"
      Controls whether to automatically check for A/B test variants for the","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:vC8Mixpanel16MixpanelInstance28checkForNotificationOnActiveSb":{"name":"checkForNotificationOnActive","abstract":"
      Controls whether to automatically check for notifications for the","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:vC8Mixpanel16MixpanelInstance24showNotificationOnActiveSb":{"name":"showNotificationOnActive","abstract":"
      Controls whether to automatically check for and show in-app notifications","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:vC8Mixpanel16MixpanelInstance32miniNotificationPresentationTimeSd":{"name":"miniNotificationPresentationTime","abstract":"
      Determines the time, in seconds, that a mini notification will remain on","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:vC8Mixpanel16MixpanelInstance22minimumSessionDurationVs6UInt64":{"name":"minimumSessionDuration","abstract":"
      The minimum session duration (ms) that is tracked in automatic events.","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:vC8Mixpanel16MixpanelInstance22maximumSessionDurationVs6UInt64":{"name":"maximumSessionDuration","abstract":"
      The maximum session duration (ms) that is tracked in automatic events.","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:FC8Mixpanel16MixpanelInstance8identifyFT10distinctIdSS_T_":{"name":"identify(distinctId:)","abstract":"
      Sets the distinct ID of the current user.
      ","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:FC8Mixpanel16MixpanelInstance11createAliasFTSS10distinctIdSS_T_":{"name":"createAlias(_:distinctId:)","abstract":"
      Creates a distinctId alias from alias to the current id.
      ","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:FC8Mixpanel16MixpanelInstance5resetFT_T_":{"name":"reset()","abstract":"
      Clears all stored properties including the distinct Id.","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:FC8Mixpanel16MixpanelInstance7archiveFT_T_":{"name":"archive()","abstract":"
      Writes current project info including the distinct Id, super properties,","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/archive()":{"name":"archive()","abstract":"
      Undocumented
      ","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:FC8Mixpanel16MixpanelInstance5flushFT10completionGSqFT_T___T_":{"name":"flush(completion:)","abstract":"
      Uploads queued data to the Mixpanel server.
      ","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:FC8Mixpanel16MixpanelInstance5trackFT5eventGSqSS_10propertiesGSqGVs10DictionarySSPS_12MixpanelType____T_":{"name":"track(event:properties:)","abstract":"
      Tracks an event with properties.","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:FC8Mixpanel16MixpanelInstance21trackPushNotificationFTGVs10DictionaryVs11AnyHashableP__5eventSS_T_":{"name":"trackPushNotification(_:event:)","abstract":"
      Track a push notification using its payload sent from Mixpanel.
      ","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:FC8Mixpanel16MixpanelInstance4timeFT5eventSS_T_":{"name":"time(event:)","abstract":"
      Starts a timer that will be stopped and added as a property when a","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:FC8Mixpanel16MixpanelInstance16clearTimedEventsFT_T_":{"name":"clearTimedEvents()","abstract":"
      Clears all current event timers.
      ","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:FC8Mixpanel16MixpanelInstance22currentSuperPropertiesFT_GVs10DictionarySSP__":{"name":"currentSuperProperties()","abstract":"
      Returns the currently set super properties.
      ","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:FC8Mixpanel16MixpanelInstance20clearSuperPropertiesFT_T_":{"name":"clearSuperProperties()","abstract":"
      Clears all currently set super properties.
      ","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:FC8Mixpanel16MixpanelInstance23registerSuperPropertiesFGVs10DictionarySSPS_12MixpanelType__T_":{"name":"registerSuperProperties(_:)","abstract":"
      Registers super properties, overwriting ones that have already been set.
      ","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:FC8Mixpanel16MixpanelInstance27registerSuperPropertiesOnceFTGVs10DictionarySSPS_12MixpanelType__12defaultValueGSqPS2____T_":{"name":"registerSuperPropertiesOnce(_:defaultValue:)","abstract":"
      Registers super properties without overwriting ones that have already been set,","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:FC8Mixpanel16MixpanelInstance23unregisterSuperPropertyFSST_":{"name":"unregisterSuperProperty(_:)","abstract":"
      Removes a previously registered super property.
      ","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:FC8Mixpanel16MixpanelInstance15joinExperimentsFT8callbackGSqFT_T___T_":{"name":"joinExperiments(callback:)","abstract":"
      Join any experiments (A/B tests) that are available for the current user.
      ","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:FC8Mixpanel16MixpanelInstance16showNotificationFT_T_":{"name":"showNotification()","abstract":"
      Shows a notification if one is available.
      ","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:FC8Mixpanel16MixpanelInstance16showNotificationFT4typeSS_T_":{"name":"showNotification(type:)","abstract":"
      Shows a notification with the given type if one is available.
      ","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:FC8Mixpanel16MixpanelInstance16showNotificationFT2IDSi_T_":{"name":"showNotification(ID:)","abstract":"
      Shows a notification with the given ID
      ","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html#/s:FC8Mixpanel16MixpanelInstance24fetchNotificationPayloadFT10completionFGSqGVs10DictionarySSPs9AnyObject___T__T_":{"name":"fetchNotificationPayload(completion:)","abstract":"
      Returns the payload of a notification if available
      ","parent_name":"MixpanelInstance"},"Classes/MixpanelInstance.html":{"name":"MixpanelInstance","abstract":"
      The class that represents the Mixpanel Instance
      "},"Classes/People.html":{"name":"People","abstract":"
      Access to the Mixpanel People API, available as an accessible variable from"},"Classes.html#/s:C8Mixpanel10TweakStore":{"name":"TweakStore","abstract":"
      Looks up the persisted state for tweaks.
      "},"Classes/Mixpanel.html":{"name":"Mixpanel","abstract":"
      The primary class for integrating Mixpanel with your app.
      "},"Classes.html":{"name":"Classes","abstract":"
      The following classes are available globally.
      "},"Enums.html":{"name":"Enums","abstract":"
      The following enums are available globally.
      "},"Extensions.html":{"name":"Extensions","abstract":"
      The following extensions are available globally.
      "},"Functions.html":{"name":"Functions","abstract":"
      The following functions are available globally.
      "},"Protocols.html":{"name":"Protocols","abstract":"
      The following protocols are available globally.
      "},"Structs.html":{"name":"Structs","abstract":"
      The following structs are available globally.
      "}}
\ No newline at end of file
diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/undocumented.json b/docs/undocumented.json
similarity index 100%
rename from docs/docsets/Mixpanel.docset/Contents/Resources/Documents/undocumented.json
rename to docs/undocumented.json
diff --git a/generate_docs.sh b/generate_docs.sh
index c258168be..559445170 100755
--- a/generate_docs.sh
+++ b/generate_docs.sh
@@ -3,6 +3,7 @@ jazzy \
 -a Mixpanel \
 -u http://mixpanel.com \
 --github_url https://github.com/mixpanel/mixpanel-swift \
---module-version 2.1.4 \
+--module-version 2.1.6 \
 --framework-root . \
---module Mixpanel
+--module Mixpanel \
+--no-download-badge