diff --git a/docs/Classes.html b/docs/Classes.html index 4f6a0ac4..0cffbaae 100644 --- a/docs/Classes.html +++ b/docs/Classes.html @@ -17,7 +17,7 @@
-

Mixpanel 2.10.4 Docs (87% documented)

+

Mixpanel 3.0.0 Docs (84% documented)

View on GitHub

@@ -48,26 +48,9 @@ - - - - - - - @@ -115,9 +95,6 @@ - @@ -126,17 +103,6 @@ - -
-
  • -
    - - - - MixpanelNotificationServiceExtension - -
    -
    -
    -
    -
    -
    -

    Undocumented

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    -
    open class MixpanelNotificationServiceExtension : UNNotificationServiceExtension
    - -
    -
    -
    -
    -
  • @@ -333,67 +248,12 @@

    Declaration

  • -
  • -
    - - - - MixpanelPushNotifications - -
    -
    -
    -
    -
    -
    -

    Undocumented

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public class MixpanelPushNotifications
    - -
    -
    -
    -
    -
  • -
  • -
    - - - - TweakStore - -
    -
    -
    -
    -
    -
    -

    Looks up the persisted state for tweaks.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public final class TweakStore
    - -
    -
    -
    -
    -
  • diff --git a/docs/Classes/Group.html b/docs/Classes/Group.html index 8f8d610d..99d90513 100644 --- a/docs/Classes/Group.html +++ b/docs/Classes/Group.html @@ -17,7 +17,7 @@
    -

    Mixpanel 2.10.4 Docs (87% documented)

    +

    Mixpanel 3.0.0 Docs (84% documented)

    View on GitHub

    @@ -48,26 +48,9 @@

    - - - - - - - @@ -115,9 +95,6 @@ - @@ -126,17 +103,6 @@ - - - - @@ -115,9 +95,6 @@ - @@ -126,17 +103,6 @@ - -
  • @@ -230,10 +173,8 @@

    Declaration

    Swift

    @discardableResult
     open class func initialize(token apiToken: String,
    -                           launchOptions: [UIApplication.LaunchOptionsKey: Any]? = nil,
                                flushInterval: Double = 60,
                                instanceName: String = UUID().uuidString,
    -                           automaticPushTracking: Bool = true,
                                optOutTrackingByDefault: Bool = false) -> MixpanelInstance
    @@ -254,18 +195,6 @@

    Parameters

  • - - - - launchOptions - - - -
    -

    Optional. App delegate launchOptions

    -
    - - @@ -522,7 +451,7 @@

    Parameters

    diff --git a/docs/Classes/MixpanelInstance.html b/docs/Classes/MixpanelInstance.html index 49e7258f..dc26ac26 100644 --- a/docs/Classes/MixpanelInstance.html +++ b/docs/Classes/MixpanelInstance.html @@ -17,7 +17,7 @@
    -

    Mixpanel 2.10.4 Docs (87% documented)

    +

    Mixpanel 3.0.0 Docs (84% documented)

    View on GitHub

    @@ -48,26 +48,9 @@

    - - - - - - - @@ -115,9 +95,6 @@ - @@ -126,17 +103,6 @@ - -
    @@ -464,7 +407,7 @@

    Declaration

    Declaration

    Swift

    -
    open var trackAutomaticEventsEnabled: Bool?
    +
    open var trackAutomaticEventsEnabled: Bool? { get set }
    @@ -485,7 +428,8 @@

    Declaration

    Flush timer’s interval. -Setting a flush interval of 0 will turn off the flush timer and you need to call the flush() API manually to upload queued data to the Mixpanel server.

    +Setting a flush interval of 0 will turn off the flush timer and you need to call the flush() API manually +to upload queued data to the Mixpanel server.

    @@ -671,151 +615,6 @@

    Declaration

    -
  • - -
    -
    -
    -
    -
    -

    Controls whether to enable the visual editor for codeless on mixpanel.com -You will be unable to edit codeless events with this disabled, however previously -created codeless events will still be delivered.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    open var enableVisualEditorForCodeless: Bool { get set }
    - -
    -
    -
    -
    -
  • -
  • - -
    -
    -
    -
    -
    -

    Controls whether to automatically check for A/B test variants for the -currently identified user when the application becomes active. -Defaults to true.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    open var checkForVariantsOnActive: Bool { get set }
    - -
    -
    -
    -
    -
  • -
  • - -
    -
    -
    -
    -
    -

    Controls whether to automatically check for notifications for the -currently identified user when the application becomes active. -Defaults to true.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    open var checkForNotificationOnActive: Bool { get set }
    - -
    -
    -
    -
    -
  • -
  • - -
    -
    -
    -
    -
    -

    Controls whether to automatically check for and show in-app notifications -for the currently identified user when the application becomes active. -Defaults to true.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    open var showNotificationOnActive: Bool { get set }
    - -
    -
    -
    -
    -
  • -
  • - -
    -
    -
    -
    -
    -

    Determines the time, in seconds, that a mini notification will remain on -the screen before automatically hiding itself. -Defaults to 6 (seconds).

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    open var miniNotificationPresentationTime: Double { get set }
    - -
    -
    -
    -
    -
  • @@ -1139,18 +938,7 @@

    Persistence

    -

    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.** - -
    +

    Undocumented

    @@ -1164,36 +952,6 @@

    Declaration

  • -
  • -
    - - - - 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.** - -
    - -
    -
    -
    -
  • @@ -1756,7 +1514,7 @@

    Declaration

    Swift

    open func registerSuperPropertiesOnce(_ properties: Properties,
    -                                        defaultValue: MixpanelType? = nil)
    + defaultValue: MixpanelType? = nil)
    @@ -2163,7 +1921,8 @@

    Parameters

    -

    an optional properties dictionary that could be passed to add properties to the opt-in event that is sent to Mixpanel

    +

    an optional properties dictionary that could be passed to add properties to the opt-in event +that is sent to Mixpanel

    @@ -2206,252 +1965,10 @@

    Return Value

    -
    -
    - - -
    - -

    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/MixpanelNotificationServiceExtension.html b/docs/Classes/MixpanelNotificationServiceExtension.html deleted file mode 100644 index 962e6e41..00000000 --- a/docs/Classes/MixpanelNotificationServiceExtension.html +++ /dev/null @@ -1,267 +0,0 @@ - - - - MixpanelNotificationServiceExtension Class Reference - - - - - - - - - - - - - -
    -
    -

    Mixpanel 2.10.4 Docs (87% documented)

    -

    View on GitHub

    -

    - - - -

    -
    -
    -
    - -
    -
    - -
    -
    -
    -

    MixpanelNotificationServiceExtension

    -
    -
    - -
    open class MixpanelNotificationServiceExtension : UNNotificationServiceExtension
    - -
    -
    -

    Undocumented

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

      Undocumented

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      open override func didReceive(_ request: UNNotificationRequest, withContentHandler contentHandler: @escaping (UNNotificationContent) -> Void)
      - -
      -
      -
      -
      -
    • -
    • - -
      -
      -
      -
      -
      -

      Undocumented

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      open override func serviceExtensionTimeWillExpire()
      - -
      -
      -
      -
      -
    • -
    -
    -
    -
    - -
    -
    - - - diff --git a/docs/Classes/MixpanelPushNotifications.html b/docs/Classes/MixpanelPushNotifications.html deleted file mode 100644 index 2832414c..00000000 --- a/docs/Classes/MixpanelPushNotifications.html +++ /dev/null @@ -1,267 +0,0 @@ - - - - MixpanelPushNotifications Class Reference - - - - - - - - - - - - - -
    -
    -

    Mixpanel 2.10.4 Docs (87% documented)

    -

    View on GitHub

    -

    -

    - -
    -

    -
    -
    -
    - -
    -
    - -
    -
    -
    -

    MixpanelPushNotifications

    -
    -
    - -
    public class MixpanelPushNotifications
    - -
    -
    -

    Undocumented

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

      Undocumented

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public static func isMixpanelPushNotification(_ content: UNNotificationContent) -> Bool
      - -
      -
      -
      -
      -
    • -
    • - -
      -
      -
      -
      -
      -

      Undocumented

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public static func trackEvent(_ event: String, properties: Dictionary<String, MixpanelType>, request: UNNotificationRequest)
      - -
      -
      -
      -
      -
    • -
    -
    -
    -
    - -
    -
    - - - diff --git a/docs/Classes/People.html b/docs/Classes/People.html index 3f14a1cf..c8d75983 100644 --- a/docs/Classes/People.html +++ b/docs/Classes/People.html @@ -17,7 +17,7 @@
    -

    Mixpanel 2.10.4 Docs (87% documented)

    +

    Mixpanel 3.0.0 Docs (84% documented)

    View on GitHub

    @@ -48,26 +48,9 @@ - - - - - - - @@ -115,9 +95,6 @@ - @@ -126,17 +103,6 @@ - -
    - - - @@ -115,9 +95,6 @@ - @@ -126,17 +103,6 @@ - - - - -
    -
    - - -
    - -

    Types that conform to TweakableType

    -

    -
    -
    - - - - @@ -115,9 +95,6 @@ - @@ -126,17 +103,6 @@ - - - - @@ -115,9 +95,6 @@ - @@ -126,17 +103,6 @@ - -
    @@ -255,50 +197,10 @@

    Declaration

    -
    -
    - - -
    - -

    Types that conform to TweakableType

    -

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

      TweakableType supports the boolean type

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public static var tweakViewDataType: TweakViewDataType { get }
      - -
      -
      -
      -
      -
    • -
    -
    diff --git a/docs/Extensions/CGFloat.html b/docs/Extensions/CGFloat.html deleted file mode 100644 index c943cd2c..00000000 --- a/docs/Extensions/CGFloat.html +++ /dev/null @@ -1,239 +0,0 @@ - - - - CGFloat Extension Reference - - - - - - - - - - - - - -
    -
    -

    Mixpanel 2.10.4 Docs (87% documented)

    -

    View on GitHub

    -

    - - - -

    -
    -
    -
    - -
    -
    - -
    -
    -
    -

    CGFloat

    -
    -
    - -
    extension CGFloat: TweakableType
    - -
    -
    - -
    -
    -
    -
      -
    • -
      - - - - tweakViewDataType - -
      -
      -
      -
      -
      -
      -

      TweakableType supports the cgFloat type

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public static var tweakViewDataType: TweakViewDataType { get }
      - -
      -
      -
      -
      -
    • -
    -
    -
    -
    - -
    -
    - - - diff --git a/docs/Extensions/Date.html b/docs/Extensions/Date.html index fd0e2118..f37868c0 100644 --- a/docs/Extensions/Date.html +++ b/docs/Extensions/Date.html @@ -17,7 +17,7 @@
    -

    Mixpanel 2.10.4 Docs (87% documented)

    +

    Mixpanel 3.0.0 Docs (84% documented)

    View on GitHub

    @@ -48,26 +48,9 @@ - - - - - - - @@ -115,9 +95,6 @@ - @@ -126,17 +103,6 @@ - - - - @@ -115,9 +95,6 @@ - @@ -126,17 +103,6 @@ - - - - @@ -115,9 +95,6 @@ - @@ -126,17 +103,6 @@ - -
    @@ -255,50 +197,10 @@

    Declaration

    -
    -
    - - -
    - -

    Types that conform to TweakableType

    -

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

      TweakableType supports the double type

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public static var tweakViewDataType: TweakViewDataType { get }
      - -
      -
      -
      -
      -
    • -
    -
    diff --git a/docs/Extensions/Float.html b/docs/Extensions/Float.html index dfaa86e2..4aa3d564 100644 --- a/docs/Extensions/Float.html +++ b/docs/Extensions/Float.html @@ -17,7 +17,7 @@
    -

    Mixpanel 2.10.4 Docs (87% documented)

    +

    Mixpanel 3.0.0 Docs (84% documented)

    View on GitHub

    @@ -48,26 +48,9 @@

    - - - - - - - @@ -115,9 +95,6 @@ - @@ -126,17 +103,6 @@ - - - - @@ -115,9 +95,6 @@ - @@ -126,17 +103,6 @@ - -
    @@ -255,50 +197,10 @@

    Declaration

    -
    -
    - - -
    - -

    Types that conform to TweakableType

    -

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

      TweakableType supports the integer type

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public static var tweakViewDataType: TweakViewDataType { get }
      - -
      -
      -
      -
      -
    • -
    -
    diff --git a/docs/Extensions/NSArray.html b/docs/Extensions/NSArray.html index 52f9d48b..2c25a8e8 100644 --- a/docs/Extensions/NSArray.html +++ b/docs/Extensions/NSArray.html @@ -17,7 +17,7 @@
    -

    Mixpanel 2.10.4 Docs (87% documented)

    +

    Mixpanel 3.0.0 Docs (84% documented)

    View on GitHub

    @@ -48,26 +48,9 @@

    - - - - - - - @@ -115,9 +95,6 @@ - @@ -126,17 +103,6 @@ - - - - @@ -115,9 +95,6 @@ - @@ -126,17 +103,6 @@ - - - - @@ -115,9 +95,6 @@ - @@ -126,17 +103,6 @@ - - - - @@ -115,9 +95,6 @@ - @@ -126,17 +103,6 @@ - - - - @@ -115,9 +95,6 @@ - @@ -126,17 +103,6 @@ - - - - @@ -115,9 +95,6 @@ - @@ -126,17 +103,6 @@ - -
    @@ -255,50 +197,10 @@

    Declaration

    -
    -
    - - -
    - -

    Types that conform to TweakableType

    -

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

      TweakableType supports the string type

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public static var tweakViewDataType: TweakViewDataType { get }
      - -
      -
      -
      -
      -
    • -
    -
    diff --git a/docs/Extensions/UIColor.html b/docs/Extensions/UIColor.html deleted file mode 100644 index 1af52be9..00000000 --- a/docs/Extensions/UIColor.html +++ /dev/null @@ -1,259 +0,0 @@ - - - - UIColor Extension Reference - - - - - - - - - - - - - -
    -
    -

    Mixpanel 2.10.4 Docs (87% documented)

    -

    View on GitHub

    -

    - - - -

    -
    -
    -
    - -
    -
    - -
    -
    -
    -

    UIColor

    -
    -
    - -
    extension UIColor
    - -
    -
    - -
    -
    -
    -
      -
    • -
      - - - - init(MPHex:) - -
      -
      -
      -
      -
      -
      -

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

      -

      RGBA defines to the color #AARRGGBB.

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public convenience init(MPHex: UInt)
      - -
      -
      -
      -

      Parameters

      - - - - - - - -
      - - MPHex - - -
      -

      hexadecimal value.

      -
      -
      -
      -
      -
      -
    • -
    -
    -
    -
    - -
    -
    - - - diff --git a/docs/Extensions/UInt.html b/docs/Extensions/UInt.html index 83047faf..c11a53e8 100644 --- a/docs/Extensions/UInt.html +++ b/docs/Extensions/UInt.html @@ -17,7 +17,7 @@
    -

    Mixpanel 2.10.4 Docs (87% documented)

    +

    Mixpanel 3.0.0 Docs (84% documented)

    View on GitHub

    @@ -48,26 +48,9 @@ - - - - - - - @@ -115,9 +95,6 @@ - @@ -126,17 +103,6 @@ - - - - @@ -115,9 +95,6 @@ - @@ -126,17 +103,6 @@ - -
    - diff --git a/docs/Protocols.html b/docs/Protocols.html index db446e7f..cf3455ba 100644 --- a/docs/Protocols.html +++ b/docs/Protocols.html @@ -17,7 +17,7 @@
    -

    Mixpanel 2.10.4 Docs (87% documented)

    +

    Mixpanel 3.0.0 Docs (84% documented)

    View on GitHub

    @@ -48,26 +48,9 @@ - - - - - - - @@ -115,9 +95,6 @@ - @@ -126,17 +103,6 @@ - -
    @@ -249,98 +192,12 @@

    Declaration

    -
  • -
    - - - - TweakClusterType - -
    -
    -
    -
    -
    -
    -

    This protocol allows for easy initialization of TweakStore. -It allows you to combine one-off Tweak‘s with TweakGroupTemplates into a single array without hassle. -(For example, a single Tweak can conform by returning itself wrapped in an array!)

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public protocol TweakClusterType
    - -
    -
    -
    -
    -
  • -
  • -
    - - - - TweakLibraryType - -
    -
    -
    -
    -
    -
    -

    Create a public struct in your application that conforms to this protocol to declare your own tweaks!

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public protocol TweakLibraryType
    - -
    -
    -
    -
    -
  • -
  • -
    - - - - TweakableType - -
    -
    -
    -
    -
    -
    -

    To add a new to our Tweak, make T conform to this protocol.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public protocol TweakableType
    - -
    -
    -
    -
    -
  • diff --git a/docs/Protocols/MixpanelDelegate.html b/docs/Protocols/MixpanelDelegate.html index e44e233b..7e894f2e 100644 --- a/docs/Protocols/MixpanelDelegate.html +++ b/docs/Protocols/MixpanelDelegate.html @@ -17,7 +17,7 @@
    -

    Mixpanel 2.10.4 Docs (87% documented)

    +

    Mixpanel 3.0.0 Docs (84% documented)

    View on GitHub

    @@ -48,26 +48,9 @@

    - - - - - - - @@ -115,9 +95,6 @@ - @@ -126,17 +103,6 @@ - - - - @@ -115,9 +95,6 @@ - @@ -126,17 +103,6 @@ - -
    - diff --git a/docs/Protocols/TweakLibraryType.html b/docs/Protocols/TweakLibraryType.html deleted file mode 100644 index ad58a254..00000000 --- a/docs/Protocols/TweakLibraryType.html +++ /dev/null @@ -1,350 +0,0 @@ - - - - TweakLibraryType Protocol Reference - - - - - - - - - - - - - -
    -
    -

    Mixpanel 2.10.4 Docs (87% documented)

    -

    View on GitHub

    -

    -

    - -
    -

    -
    -
    -
    - -
    -
    - -
    -
    -
    -

    TweakLibraryType

    -
    -
    - -
    public protocol TweakLibraryType
    - -
    -
    -

    Create a public struct in your application that conforms to this protocol to declare your own tweaks!

    - -
    -
    -
    -
      -
    • -
      - - - - defaultStore - -
      -
      -
      -
      -
      -
      -

      the default tweak store

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      static var defaultStore: TweakStore { get }
      - -
      -
      -
      -
      -
    • -
    • -
      - - - - assign(_:) - - - Extension method - -
      -
      -
      -
      -
      -
      -

      Returns the current value for a tweak from the TweakLibrary’s default store.

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public static func assign<T>(_ tweak: Tweak<T>) -> T where T : TweakableType
      - -
      -
      -
      -

      Parameters

      - - - - - - - -
      - - tweak - - -
      -

      the tweak to assign

      -
      -
      -
      -
      -
      -
    • -
    • -
      - - - - bind(_:binding:) - - - Extension method - -
      -
      -
      -
      -
      -
      -

      Immediately binds the currentValue of a given tweak, and then continues to update whenever the tweak changes.

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public static func bind<T>(_ tweak: Tweak<T>, binding: @escaping (T) -> Void) where T : TweakableType
      - -
      -
      -
      -

      Parameters

      - - - - - - - - - - - -
      - - tweak - - -
      -

      the tweak to bind

      -
      -
      - - binding - - -
      -

      the binding to issue for the tweak

      -
      -
      -
      -
      -
      -
    • -
    -
    -
    -
    - -
    -
    - - - diff --git a/docs/Protocols/TweakableType.html b/docs/Protocols/TweakableType.html deleted file mode 100644 index c37e38e9..00000000 --- a/docs/Protocols/TweakableType.html +++ /dev/null @@ -1,240 +0,0 @@ - - - - TweakableType Protocol Reference - - - - - - - - - - - - - -
    -
    -

    Mixpanel 2.10.4 Docs (87% documented)

    -

    View on GitHub

    -

    -

    - -
    -

    -
    -
    -
    - -
    -
    - -
    -
    -
    -

    TweakableType

    -
    -
    - -
    public protocol TweakableType
    - -
    -
    -

    To add a new to our Tweak, make T conform to this protocol.

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

      The data type of the TweakableType

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      static var tweakViewDataType: TweakViewDataType { get }
      - -
      -
      -
      -
      -
    • -
    -
    -
    -
    - -
    -
    - - - diff --git a/docs/Structs.html b/docs/Structs.html deleted file mode 100644 index 5ba34ffa..00000000 --- a/docs/Structs.html +++ /dev/null @@ -1,296 +0,0 @@ - - - - Structures Reference - - - - - - - - - - - - - -
    -
    -

    Mixpanel 2.10.4 Docs (87% documented)

    -

    View on GitHub

    -

    -

    - -
    -

    -
    -
    -
    - -
    -
    - -
    -
    -
    -

    Structures

    -

    The following structures are available globally.

    - -
    -
    -
    -
      -
    • -
      - - - - AnyTweak - -
      -
      -
      -
      -
      -
      -

      A type-erasure around Tweak for A/B Testing.

      - - See more -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public struct AnyTweak : TweakType
      -
      extension AnyTweak: Hashable
      -
      extension AnyTweak: TweakClusterType
      - -
      -
      -
      -
      -
    • -
    • -
      - - - - Tweak - -
      -
      -
      -
      -
      -
      -

      Tweaks let you adjust things on the fly. -Because each T needs a UI component, we have to restrict what T can be - hence T: TweakableType. -If T: SignedNumberType, you can declare a min / max for a Tweak.

      - - See more -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public struct Tweak<T> where T : TweakableType
      -
      extension Tweak: Hashable
      -
      extension Tweak: TweakClusterType
      - -
      -
      -
      -
      -
    • -
    • -
      - - - - MixpanelTweaks - -
      -
      -
      -
      -
      -
      -

      The MixpanelTweaks struct that needs to be extended to define new Tweaks for A/B testing

      - - See more -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public struct MixpanelTweaks : TweakLibraryType
      - -
      -
      -
      -
      -
    • -
    -
    -
    -
    - -
    -
    - - - diff --git a/docs/Structs/AnyTweak.html b/docs/Structs/AnyTweak.html deleted file mode 100644 index f2a5f798..00000000 --- a/docs/Structs/AnyTweak.html +++ /dev/null @@ -1,268 +0,0 @@ - - - - AnyTweak Structure Reference - - - - - - - - - - - - - -
    -
    -

    Mixpanel 2.10.4 Docs (87% documented)

    -

    View on GitHub

    -

    -

    - -
    -

    -
    -
    -
    - -
    -
    - -
    -
    -
    -

    AnyTweak

    -
    -
    - -
    public struct AnyTweak : TweakType
    -
    extension AnyTweak: Hashable
    -
    extension AnyTweak: TweakClusterType
    - -
    -
    -

    A type-erasure around Tweak for A/B Testing.

    - -
    -
    -
    -
      -
    • -
      - - - - hash(into:) - -
      -
      -
      -
      -
      -
      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public func hash(into hasher: inout Hasher)
      - -
      -
      -
      -
      -
    • -
    • -
      - - - - tweakCluster - -
      -
      -
      -
      -
      -
      -

      Allows easy tweak initialization by clustering tweaks together for A/B Testing

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public var tweakCluster: [AnyTweak] { get }
      - -
      -
      -
      -
      -
    • -
    -
    -
    -
    - -
    -
    - - - diff --git a/docs/Structs/MixpanelTweaks.html b/docs/Structs/MixpanelTweaks.html deleted file mode 100644 index 4c340f42..00000000 --- a/docs/Structs/MixpanelTweaks.html +++ /dev/null @@ -1,286 +0,0 @@ - - - - MixpanelTweaks Structure Reference - - - - - - - - - - - - - -
    -
    -

    Mixpanel 2.10.4 Docs (87% documented)

    -

    View on GitHub

    -

    -

    - -
    -

    -
    -
    -
    - -
    -
    - -
    -
    -
    -

    MixpanelTweaks

    -
    -
    - -
    public struct MixpanelTweaks : TweakLibraryType
    - -
    -
    -

    The MixpanelTweaks struct that needs to be extended to define new Tweaks for A/B testing

    - -
    -
    -
    -
      -
    • -
      - - - - defaultStore - -
      -
      -
      -
      -
      -
      -

      The default store that holds the Tweaks

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public static var defaultStore: TweakStore
      - -
      -
      -
      -
      -
    • -
    • -
      - - - - setTweaks(tweaks:) - -
      -
      -
      -
      -
      -
      -

      setTweaks needs to be called to add the defined Tweaks into the environment.

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public static func setTweaks(tweaks: [TweakClusterType])
      - -
      -
      -
      -

      Parameters

      - - - - - - - -
      - - tweaks - - -
      -

      the tweaks to set

      -
      -
      -
      -
      -
      -
    • -
    -
    -
    -
    - -
    -
    - - - diff --git a/docs/Structs/Tweak.html b/docs/Structs/Tweak.html deleted file mode 100644 index eaf9cccd..00000000 --- a/docs/Structs/Tweak.html +++ /dev/null @@ -1,440 +0,0 @@ - - - - Tweak Structure Reference - - - - - - - - - - - - - -
    -
    -

    Mixpanel 2.10.4 Docs (87% documented)

    -

    View on GitHub

    -

    -

    - -
    -

    -
    -
    -
    - -
    -
    - -
    -
    -
    -

    Tweak

    -
    -
    - -
    public struct Tweak<T> where T : TweakableType
    -
    extension Tweak: Hashable
    -
    extension Tweak: TweakClusterType
    - -
    -
    -

    Tweaks let you adjust things on the fly. -Because each T needs a UI component, we have to restrict what T can be - hence T: TweakableType. -If T: SignedNumberType, you can declare a min / max for a Tweak.

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

      Initializer for a Tweak for A/B Testing

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public init(tweakName: String, defaultValue: T)
      - -
      -
      -
      -

      Parameters

      - - - - - - - - - - - -
      - - tweakName - - -
      -

      name of the tweak

      -
      -
      - - defaultValue - - -
      -

      the default value set for the tweak

      -
      -
      -
      -
      -
      -
    • -
    • -
      - - - - hash(into:) - -
      -
      -
      -
      -
      -
      -

      Hashing for a Tweak for A/B Testing in order for it to be stored.

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public func hash(into hasher: inout Hasher)
      - -
      -
      -
      -
      -
    • -
    • -
      - - - - tweakCluster - -
      -
      -
      -
      -
      -
      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public var tweakCluster: [AnyTweak] { get }
      - -
      -
      -
      -
      -
    • -
    -
    -
    -
    - - -
    - -

    Available where T: SignedNumeric & Comparable

    -

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

      Creates a Tweak where T: SignedNumberType -You can optionally provide a min / max / stepSize to restrict the bounds and behavior of a tweak.

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public init(tweakName: String,
      -            defaultValue: T,
      -            min minimumValue: T? = nil,
      -            max maximumValue: T? = nil,
      -            stepSize: T? = nil)
      - -
      -
      -
      -

      Parameters

      - - - - - - - - - - - - - - - - - - - - - - - -
      - - tweakName - - -
      -

      name of the tweak

      -
      -
      - - defaultValue - - -
      -

      the default value set for the tweak

      -
      -
      - - minimumValue - - -
      -

      minimum value to allow for the tweak

      -
      -
      - - maximumValue - - -
      -

      maximum value to allow for the tweak

      -
      -
      - - stepSize - - -
      -

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

      -
      -
      -
      -
      -
      -
    • -
    -
    -
    -
    - -
    -
    - - - diff --git a/docs/Typealiases.html b/docs/Typealiases.html index cf49d4ff..76556326 100644 --- a/docs/Typealiases.html +++ b/docs/Typealiases.html @@ -17,7 +17,7 @@
    -

    Mixpanel 2.10.4 Docs (87% documented)

    +

    Mixpanel 3.0.0 Docs (84% documented)

    View on GitHub

    @@ -48,26 +48,9 @@ - - - - - - - @@ -115,9 +95,6 @@ - @@ -126,17 +103,6 @@ - - - - @@ -115,9 +95,6 @@ - @@ -126,17 +103,6 @@ - -
    -
  • - -
    -
    -
    -
    -
    -

    Undocumented

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    -
    open class MixpanelNotificationServiceExtension : UNNotificationServiceExtension
    - -
    -
    -
    -
    -
  • @@ -333,67 +248,12 @@

    Declaration

  • -
  • - -
    -
    -
    -
    -
    -

    Undocumented

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public class MixpanelPushNotifications
    - -
    -
    -
    -
    -
  • -
  • -
    - - - - TweakStore - -
    -
    -
    -
    -
    -
    -

    Looks up the persisted state for tweaks.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public final class TweakStore
    - -
    -
    -
    -
    -
  • diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Classes/Group.html b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Classes/Group.html index 8f8d610d..99d90513 100644 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Classes/Group.html +++ b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Classes/Group.html @@ -17,7 +17,7 @@
    -

    Mixpanel 2.10.4 Docs (87% documented)

    +

    Mixpanel 3.0.0 Docs (84% documented)

    View on GitHub

    @@ -48,26 +48,9 @@

    - - - - - - - @@ -115,9 +95,6 @@ - @@ -126,17 +103,6 @@ - - - - @@ -115,9 +95,6 @@ - @@ -126,17 +103,6 @@ - -
  • @@ -230,10 +173,8 @@

    Declaration

    Swift

    @discardableResult
     open class func initialize(token apiToken: String,
    -                           launchOptions: [UIApplication.LaunchOptionsKey: Any]? = nil,
                                flushInterval: Double = 60,
                                instanceName: String = UUID().uuidString,
    -                           automaticPushTracking: Bool = true,
                                optOutTrackingByDefault: Bool = false) -> MixpanelInstance
    @@ -254,18 +195,6 @@

    Parameters

  • - - - - launchOptions - - - -
    -

    Optional. App delegate launchOptions

    -
    - - @@ -522,7 +451,7 @@

    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 49e7258f..dc26ac26 100644 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Classes/MixpanelInstance.html +++ b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Classes/MixpanelInstance.html @@ -17,7 +17,7 @@
    -

    Mixpanel 2.10.4 Docs (87% documented)

    +

    Mixpanel 3.0.0 Docs (84% documented)

    View on GitHub

    @@ -48,26 +48,9 @@

    - - - - - - - @@ -115,9 +95,6 @@ - @@ -126,17 +103,6 @@ - -
    @@ -464,7 +407,7 @@

    Declaration

    Declaration

    Swift

    -
    open var trackAutomaticEventsEnabled: Bool?
    +
    open var trackAutomaticEventsEnabled: Bool? { get set }
    @@ -485,7 +428,8 @@

    Declaration

    Flush timer’s interval. -Setting a flush interval of 0 will turn off the flush timer and you need to call the flush() API manually to upload queued data to the Mixpanel server.

    +Setting a flush interval of 0 will turn off the flush timer and you need to call the flush() API manually +to upload queued data to the Mixpanel server.

    @@ -671,151 +615,6 @@

    Declaration

    -
  • - -
    -
    -
    -
    -
    -

    Controls whether to enable the visual editor for codeless on mixpanel.com -You will be unable to edit codeless events with this disabled, however previously -created codeless events will still be delivered.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    open var enableVisualEditorForCodeless: Bool { get set }
    - -
    -
    -
    -
    -
  • -
  • - -
    -
    -
    -
    -
    -

    Controls whether to automatically check for A/B test variants for the -currently identified user when the application becomes active. -Defaults to true.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    open var checkForVariantsOnActive: Bool { get set }
    - -
    -
    -
    -
    -
  • -
  • - -
    -
    -
    -
    -
    -

    Controls whether to automatically check for notifications for the -currently identified user when the application becomes active. -Defaults to true.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    open var checkForNotificationOnActive: Bool { get set }
    - -
    -
    -
    -
    -
  • -
  • - -
    -
    -
    -
    -
    -

    Controls whether to automatically check for and show in-app notifications -for the currently identified user when the application becomes active. -Defaults to true.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    open var showNotificationOnActive: Bool { get set }
    - -
    -
    -
    -
    -
  • -
  • - -
    -
    -
    -
    -
    -

    Determines the time, in seconds, that a mini notification will remain on -the screen before automatically hiding itself. -Defaults to 6 (seconds).

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    open var miniNotificationPresentationTime: Double { get set }
    - -
    -
    -
    -
    -
  • @@ -1139,18 +938,7 @@

    Persistence

    -

    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.** - -
    +

    Undocumented

    @@ -1164,36 +952,6 @@

    Declaration

  • -
  • -
    - - - - 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.** - -
    - -
    -
    -
    -
  • @@ -1756,7 +1514,7 @@

    Declaration

    Swift

    open func registerSuperPropertiesOnce(_ properties: Properties,
    -                                        defaultValue: MixpanelType? = nil)
    + defaultValue: MixpanelType? = nil)
    @@ -2163,7 +1921,8 @@

    Parameters

    -

    an optional properties dictionary that could be passed to add properties to the opt-in event that is sent to Mixpanel

    +

    an optional properties dictionary that could be passed to add properties to the opt-in event +that is sent to Mixpanel

    @@ -2206,252 +1965,10 @@

    Return Value

    -
    -
    - - -
    - -

    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/MixpanelNotificationServiceExtension.html b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Classes/MixpanelNotificationServiceExtension.html deleted file mode 100644 index 962e6e41..00000000 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Classes/MixpanelNotificationServiceExtension.html +++ /dev/null @@ -1,267 +0,0 @@ - - - - MixpanelNotificationServiceExtension Class Reference - - - - - - - - - - - - - -
    -
    -

    Mixpanel 2.10.4 Docs (87% documented)

    -

    View on GitHub

    -

    - - - -

    -
    -
    -
    - -
    -
    - -
    -
    -
    -

    MixpanelNotificationServiceExtension

    -
    -
    - -
    open class MixpanelNotificationServiceExtension : UNNotificationServiceExtension
    - -
    -
    -

    Undocumented

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

      Undocumented

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      open override func didReceive(_ request: UNNotificationRequest, withContentHandler contentHandler: @escaping (UNNotificationContent) -> Void)
      - -
      -
      -
      -
      -
    • -
    • - -
      -
      -
      -
      -
      -

      Undocumented

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      open override func serviceExtensionTimeWillExpire()
      - -
      -
      -
      -
      -
    • -
    -
    -
    -
    - -
    -
    - - - diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Classes/MixpanelPushNotifications.html b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Classes/MixpanelPushNotifications.html deleted file mode 100644 index 2832414c..00000000 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Classes/MixpanelPushNotifications.html +++ /dev/null @@ -1,267 +0,0 @@ - - - - MixpanelPushNotifications Class Reference - - - - - - - - - - - - - -
    -
    -

    Mixpanel 2.10.4 Docs (87% documented)

    -

    View on GitHub

    -

    -

    - -
    -

    -
    -
    -
    - -
    -
    - -
    -
    -
    -

    MixpanelPushNotifications

    -
    -
    - -
    public class MixpanelPushNotifications
    - -
    -
    -

    Undocumented

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

      Undocumented

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public static func isMixpanelPushNotification(_ content: UNNotificationContent) -> Bool
      - -
      -
      -
      -
      -
    • -
    • - -
      -
      -
      -
      -
      -

      Undocumented

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public static func trackEvent(_ event: String, properties: Dictionary<String, MixpanelType>, request: UNNotificationRequest)
      - -
      -
      -
      -
      -
    • -
    -
    -
    -
    - -
    -
    - - - 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 3f14a1cf..c8d75983 100644 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Classes/People.html +++ b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Classes/People.html @@ -17,7 +17,7 @@
    -

    Mixpanel 2.10.4 Docs (87% documented)

    +

    Mixpanel 3.0.0 Docs (84% documented)

    View on GitHub

    @@ -48,26 +48,9 @@ - - - - - - - @@ -115,9 +95,6 @@ - @@ -126,17 +103,6 @@ - -
      -
    • - -
      -
      -
      -
      -
      -

      Register the given device to receive push notifications.

      - -

      This will associate the device token with the current user in Mixpanel People, -which will allow you to send push notifications to the user from the Mixpanel -People web interface. You should call this method with the Data -token passed to -application:didRegisterForRemoteNotificationsWithDeviceToken:.

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      open func addPushDeviceToken(_ deviceToken: Data)
      - -
      -
      -
      -

      Parameters

      - - - - - - - -
      - - deviceToken - - -
      -

      device token as returned from -application:didRegisterForRemoteNotificationsWithDeviceToken:

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

      Unregister the given device to receive push notifications.

      - -

      This will unset all of the push tokens saved to this people profile. This is useful -in conjunction with a call to reset, or when a user is logging out.

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      open func removeAllPushDeviceTokens()
      - -
      -
      -
      -
      -
    • -
    • - -
      -
      -
      -
      -
      -

      Unregister a specific device token from the ability to receive push notifications.

      - -

      This will remove the provided push token saved to this people profile. This is useful -in conjunction with a call to reset, or when a user is logging out.

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      open func removePushDeviceToken(_ deviceToken: Data)
      - -
      -
      -
      -

      Parameters

      - - - - - - - -
      - - deviceToken - - -
      -

      device token as returned from -application:didRegisterForRemoteNotificationsWithDeviceToken:

      -
      -
      -
      -
      -
      -
    • @@ -975,7 +785,7 @@

      Declaration

      diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Enums.html b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Enums.html deleted file mode 100644 index 7a28b59c..00000000 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Enums.html +++ /dev/null @@ -1,240 +0,0 @@ - - - - Enumerations Reference - - - - - - - - - - - - - -
      -
      -

      Mixpanel 2.10.4 Docs (87% documented)

      -

      View on GitHub

      -

      - - - -

      -
      -
      -
      - -
      -
      - -
      -
      -
      -

      Enumerations

      -

      The following enumerations are available globally.

      - -
      -
      -
      -
        -
      • -
        - - - - 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!
        • -
        - - See more -
        -
        -

        Declaration

        -
        -

        Swift

        -
        public enum TweakViewDataType
        - -
        -
        -
        -
        -
      • -
      -
      -
      -
      - -
      -
      - -
      - diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Enums/TweakViewDataType.html b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Enums/TweakViewDataType.html deleted file mode 100644 index 0f5bfbd9..00000000 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Enums/TweakViewDataType.html +++ /dev/null @@ -1,354 +0,0 @@ - - - - TweakViewDataType Enumeration Reference - - - - - - - - - - - - - -
      -
      -

      Mixpanel 2.10.4 Docs (87% documented)

      -

      View on GitHub

      -

      -

      - -
      -

      -
      -
      -
      - -
      -
      - -
      -
      -
      -

      TweakViewDataType

      -
      -
      - -
      public enum 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!
      • -
      - -
      -
      -
      -
        -
      • -
        - - - - boolean - -
        -
        -
        -
        -
        -
        -

        TweakableType supports the boolean type

        - -
        -
        -

        Declaration

        -
        -

        Swift

        -
        case boolean
        - -
        -
        -
        -
        -
      • -
      • -
        - - - - integer - -
        -
        -
        -
        -
        -
        -

        TweakableType supports the integer type

        - -
        -
        -

        Declaration

        -
        -

        Swift

        -
        case integer
        - -
        -
        -
        -
        -
      • -
      • -
        - - - - cgFloat - -
        -
        -
        -
        -
        -
        -

        TweakableType supports the cgFloat type

        - -
        -
        -

        Declaration

        -
        -

        Swift

        -
        case cgFloat
        - -
        -
        -
        -
        -
      • -
      • -
        - - - - double - -
        -
        -
        -
        -
        -
        -

        TweakableType supports the double type

        - -
        -
        -

        Declaration

        -
        -

        Swift

        -
        case double
        - -
        -
        -
        -
        -
      • -
      • -
        - - - - string - -
        -
        -
        -
        -
        -
        -

        TweakableType supports the string type

        - -
        -
        -

        Declaration

        -
        -

        Swift

        -
        case string
        - -
        -
        -
        -
        -
      • -
      -
      -
      -
      - -
      -
      - - - diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions.html b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions.html index 9c847e6c..6c574fec 100644 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions.html +++ b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions.html @@ -17,7 +17,7 @@
    - - - @@ -115,9 +95,6 @@ - @@ -126,17 +103,6 @@ - - - - -
    -
    - - -
    - -

    Types that conform to TweakableType

    -

    -
    -
    - - - - @@ -115,9 +95,6 @@ - @@ -126,17 +103,6 @@ - - - - @@ -115,9 +95,6 @@ - @@ -126,17 +103,6 @@ - -
    @@ -255,50 +197,10 @@

    Declaration

    -
    -
    - - -
    - -

    Types that conform to TweakableType

    -

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

      TweakableType supports the boolean type

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public static var tweakViewDataType: TweakViewDataType { get }
      - -
      -
      -
      -
      -
    • -
    -
    diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/CGFloat.html b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/CGFloat.html deleted file mode 100644 index c943cd2c..00000000 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/CGFloat.html +++ /dev/null @@ -1,239 +0,0 @@ - - - - CGFloat Extension Reference - - - - - - - - - - - - - -
    -
    -

    Mixpanel 2.10.4 Docs (87% documented)

    -

    View on GitHub

    -

    - - - -

    -
    -
    -
    - -
    -
    - -
    -
    -
    -

    CGFloat

    -
    -
    - -
    extension CGFloat: TweakableType
    - -
    -
    - -
    -
    -
    -
      -
    • -
      - - - - tweakViewDataType - -
      -
      -
      -
      -
      -
      -

      TweakableType supports the cgFloat type

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public static var tweakViewDataType: TweakViewDataType { get }
      - -
      -
      -
      -
      -
    • -
    -
    -
    -
    - -
    -
    - - - 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 fd0e2118..f37868c0 100644 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/Date.html +++ b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/Date.html @@ -17,7 +17,7 @@
    -

    Mixpanel 2.10.4 Docs (87% documented)

    +

    Mixpanel 3.0.0 Docs (84% documented)

    View on GitHub

    @@ -48,26 +48,9 @@ - - - - - - - @@ -115,9 +95,6 @@ - @@ -126,17 +103,6 @@ - - - - @@ -115,9 +95,6 @@ - @@ -126,17 +103,6 @@ - - - - @@ -115,9 +95,6 @@ - @@ -126,17 +103,6 @@ - -
    @@ -255,50 +197,10 @@

    Declaration

    -
    -
    - - -
    - -

    Types that conform to TweakableType

    -

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

      TweakableType supports the double type

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public static var tweakViewDataType: TweakViewDataType { get }
      - -
      -
      -
      -
      -
    • -
    -
    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 dfaa86e2..4aa3d564 100644 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/Float.html +++ b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/Float.html @@ -17,7 +17,7 @@
    -

    Mixpanel 2.10.4 Docs (87% documented)

    +

    Mixpanel 3.0.0 Docs (84% documented)

    View on GitHub

    @@ -48,26 +48,9 @@

    - - - - - - - @@ -115,9 +95,6 @@ - @@ -126,17 +103,6 @@ - - - - @@ -115,9 +95,6 @@ - @@ -126,17 +103,6 @@ - -
    @@ -255,50 +197,10 @@

    Declaration

    -
    -
    - - -
    - -

    Types that conform to TweakableType

    -

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

      TweakableType supports the integer type

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public static var tweakViewDataType: TweakViewDataType { get }
      - -
      -
      -
      -
      -
    • -
    -
    diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/NSArray.html b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/NSArray.html index 52f9d48b..2c25a8e8 100644 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/NSArray.html +++ b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/NSArray.html @@ -17,7 +17,7 @@
    -

    Mixpanel 2.10.4 Docs (87% documented)

    +

    Mixpanel 3.0.0 Docs (84% documented)

    View on GitHub

    @@ -48,26 +48,9 @@

    - - - - - - - @@ -115,9 +95,6 @@ - @@ -126,17 +103,6 @@ - - - - @@ -115,9 +95,6 @@ - @@ -126,17 +103,6 @@ - - - - @@ -115,9 +95,6 @@ - @@ -126,17 +103,6 @@ - - - - @@ -115,9 +95,6 @@ - @@ -126,17 +103,6 @@ - - - - @@ -115,9 +95,6 @@ - @@ -126,17 +103,6 @@ - - - - @@ -115,9 +95,6 @@ - @@ -126,17 +103,6 @@ - -
    @@ -255,50 +197,10 @@

    Declaration

    -
    -
    - - -
    - -

    Types that conform to TweakableType

    -

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

      TweakableType supports the string type

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public static var tweakViewDataType: TweakViewDataType { get }
      - -
      -
      -
      -
      -
    • -
    -
    diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/UIColor.html b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/UIColor.html deleted file mode 100644 index 1af52be9..00000000 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/UIColor.html +++ /dev/null @@ -1,259 +0,0 @@ - - - - UIColor Extension Reference - - - - - - - - - - - - - -
    -
    -

    Mixpanel 2.10.4 Docs (87% documented)

    -

    View on GitHub

    -

    - - - -

    -
    -
    -
    - -
    -
    - -
    -
    -
    -

    UIColor

    -
    -
    - -
    extension UIColor
    - -
    -
    - -
    -
    -
    -
      -
    • -
      - - - - init(MPHex:) - -
      -
      -
      -
      -
      -
      -

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

      -

      RGBA defines to the color #AARRGGBB.

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public convenience init(MPHex: UInt)
      - -
      -
      -
      -

      Parameters

      - - - - - - - -
      - - MPHex - - -
      -

      hexadecimal value.

      -
      -
      -
      -
      -
      -
    • -
    -
    -
    -
    - -
    -
    - - - 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 83047faf..c11a53e8 100644 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/UInt.html +++ b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Extensions/UInt.html @@ -17,7 +17,7 @@
    -

    Mixpanel 2.10.4 Docs (87% documented)

    +

    Mixpanel 3.0.0 Docs (84% documented)

    View on GitHub

    @@ -48,26 +48,9 @@ - - - - - - - @@ -115,9 +95,6 @@ - @@ -126,17 +103,6 @@ - - - - @@ -115,9 +95,6 @@ - @@ -126,17 +103,6 @@ - -
    - diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Protocols.html b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Protocols.html index db446e7f..cf3455ba 100644 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Protocols.html +++ b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Protocols.html @@ -17,7 +17,7 @@
    -

    Mixpanel 2.10.4 Docs (87% documented)

    +

    Mixpanel 3.0.0 Docs (84% documented)

    View on GitHub

    @@ -48,26 +48,9 @@ - - - - - - - @@ -115,9 +95,6 @@ - @@ -126,17 +103,6 @@ - -
    @@ -249,98 +192,12 @@

    Declaration

    -
  • -
    - - - - TweakClusterType - -
    -
    -
    -
    -
    -
    -

    This protocol allows for easy initialization of TweakStore. -It allows you to combine one-off Tweak‘s with TweakGroupTemplates into a single array without hassle. -(For example, a single Tweak can conform by returning itself wrapped in an array!)

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public protocol TweakClusterType
    - -
    -
    -
    -
    -
  • -
  • -
    - - - - TweakLibraryType - -
    -
    -
    -
    -
    -
    -

    Create a public struct in your application that conforms to this protocol to declare your own tweaks!

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public protocol TweakLibraryType
    - -
    -
    -
    -
    -
  • -
  • -
    - - - - TweakableType - -
    -
    -
    -
    -
    -
    -

    To add a new to our Tweak, make T conform to this protocol.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public protocol TweakableType
    - -
    -
    -
    -
    -
  • 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 e44e233b..7e894f2e 100644 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Protocols/MixpanelDelegate.html +++ b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Protocols/MixpanelDelegate.html @@ -17,7 +17,7 @@
    -

    Mixpanel 2.10.4 Docs (87% documented)

    +

    Mixpanel 3.0.0 Docs (84% documented)

    View on GitHub

    @@ -48,26 +48,9 @@

    - - - - - - - @@ -115,9 +95,6 @@ - @@ -126,17 +103,6 @@ - - - - @@ -115,9 +95,6 @@ - @@ -126,17 +103,6 @@ - -
    - diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Protocols/TweakLibraryType.html b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Protocols/TweakLibraryType.html deleted file mode 100644 index ad58a254..00000000 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Protocols/TweakLibraryType.html +++ /dev/null @@ -1,350 +0,0 @@ - - - - TweakLibraryType Protocol Reference - - - - - - - - - - - - - -
    -
    -

    Mixpanel 2.10.4 Docs (87% documented)

    -

    View on GitHub

    -

    -

    - -
    -

    -
    -
    -
    - -
    -
    - -
    -
    -
    -

    TweakLibraryType

    -
    -
    - -
    public protocol TweakLibraryType
    - -
    -
    -

    Create a public struct in your application that conforms to this protocol to declare your own tweaks!

    - -
    -
    -
    -
      -
    • -
      - - - - defaultStore - -
      -
      -
      -
      -
      -
      -

      the default tweak store

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      static var defaultStore: TweakStore { get }
      - -
      -
      -
      -
      -
    • -
    • -
      - - - - assign(_:) - - - Extension method - -
      -
      -
      -
      -
      -
      -

      Returns the current value for a tweak from the TweakLibrary’s default store.

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public static func assign<T>(_ tweak: Tweak<T>) -> T where T : TweakableType
      - -
      -
      -
      -

      Parameters

      - - - - - - - -
      - - tweak - - -
      -

      the tweak to assign

      -
      -
      -
      -
      -
      -
    • -
    • -
      - - - - bind(_:binding:) - - - Extension method - -
      -
      -
      -
      -
      -
      -

      Immediately binds the currentValue of a given tweak, and then continues to update whenever the tweak changes.

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public static func bind<T>(_ tweak: Tweak<T>, binding: @escaping (T) -> Void) where T : TweakableType
      - -
      -
      -
      -

      Parameters

      - - - - - - - - - - - -
      - - tweak - - -
      -

      the tweak to bind

      -
      -
      - - binding - - -
      -

      the binding to issue for the tweak

      -
      -
      -
      -
      -
      -
    • -
    -
    -
    -
    - -
    -
    - - - diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Protocols/TweakableType.html b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Protocols/TweakableType.html deleted file mode 100644 index c37e38e9..00000000 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Protocols/TweakableType.html +++ /dev/null @@ -1,240 +0,0 @@ - - - - TweakableType Protocol Reference - - - - - - - - - - - - - -
    -
    -

    Mixpanel 2.10.4 Docs (87% documented)

    -

    View on GitHub

    -

    -

    - -
    -

    -
    -
    -
    - -
    -
    - -
    -
    -
    -

    TweakableType

    -
    -
    - -
    public protocol TweakableType
    - -
    -
    -

    To add a new to our Tweak, make T conform to this protocol.

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

      The data type of the TweakableType

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      static var tweakViewDataType: TweakViewDataType { get }
      - -
      -
      -
      -
      -
    • -
    -
    -
    -
    - -
    -
    - - - diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Structs.html b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Structs.html deleted file mode 100644 index 5ba34ffa..00000000 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Structs.html +++ /dev/null @@ -1,296 +0,0 @@ - - - - Structures Reference - - - - - - - - - - - - - -
    -
    -

    Mixpanel 2.10.4 Docs (87% documented)

    -

    View on GitHub

    -

    -

    - -
    -

    -
    -
    -
    - -
    -
    - -
    -
    -
    -

    Structures

    -

    The following structures are available globally.

    - -
    -
    -
    -
      -
    • -
      - - - - AnyTweak - -
      -
      -
      -
      -
      -
      -

      A type-erasure around Tweak for A/B Testing.

      - - See more -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public struct AnyTweak : TweakType
      -
      extension AnyTweak: Hashable
      -
      extension AnyTweak: TweakClusterType
      - -
      -
      -
      -
      -
    • -
    • -
      - - - - Tweak - -
      -
      -
      -
      -
      -
      -

      Tweaks let you adjust things on the fly. -Because each T needs a UI component, we have to restrict what T can be - hence T: TweakableType. -If T: SignedNumberType, you can declare a min / max for a Tweak.

      - - See more -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public struct Tweak<T> where T : TweakableType
      -
      extension Tweak: Hashable
      -
      extension Tweak: TweakClusterType
      - -
      -
      -
      -
      -
    • -
    • -
      - - - - MixpanelTweaks - -
      -
      -
      -
      -
      -
      -

      The MixpanelTweaks struct that needs to be extended to define new Tweaks for A/B testing

      - - See more -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public struct MixpanelTweaks : TweakLibraryType
      - -
      -
      -
      -
      -
    • -
    -
    -
    -
    - -
    -
    - - - diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Structs/AnyTweak.html b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Structs/AnyTweak.html deleted file mode 100644 index f2a5f798..00000000 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Structs/AnyTweak.html +++ /dev/null @@ -1,268 +0,0 @@ - - - - AnyTweak Structure Reference - - - - - - - - - - - - - -
    -
    -

    Mixpanel 2.10.4 Docs (87% documented)

    -

    View on GitHub

    -

    -

    - -
    -

    -
    -
    -
    - -
    -
    - -
    -
    -
    -

    AnyTweak

    -
    -
    - -
    public struct AnyTweak : TweakType
    -
    extension AnyTweak: Hashable
    -
    extension AnyTweak: TweakClusterType
    - -
    -
    -

    A type-erasure around Tweak for A/B Testing.

    - -
    -
    -
    -
      -
    • -
      - - - - hash(into:) - -
      -
      -
      -
      -
      -
      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public func hash(into hasher: inout Hasher)
      - -
      -
      -
      -
      -
    • -
    • -
      - - - - tweakCluster - -
      -
      -
      -
      -
      -
      -

      Allows easy tweak initialization by clustering tweaks together for A/B Testing

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public var tweakCluster: [AnyTweak] { get }
      - -
      -
      -
      -
      -
    • -
    -
    -
    -
    - -
    -
    - - - diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Structs/MixpanelTweaks.html b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Structs/MixpanelTweaks.html deleted file mode 100644 index 4c340f42..00000000 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Structs/MixpanelTweaks.html +++ /dev/null @@ -1,286 +0,0 @@ - - - - MixpanelTweaks Structure Reference - - - - - - - - - - - - - -
    -
    -

    Mixpanel 2.10.4 Docs (87% documented)

    -

    View on GitHub

    -

    -

    - -
    -

    -
    -
    -
    - -
    -
    - -
    -
    -
    -

    MixpanelTweaks

    -
    -
    - -
    public struct MixpanelTweaks : TweakLibraryType
    - -
    -
    -

    The MixpanelTweaks struct that needs to be extended to define new Tweaks for A/B testing

    - -
    -
    -
    -
      -
    • -
      - - - - defaultStore - -
      -
      -
      -
      -
      -
      -

      The default store that holds the Tweaks

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public static var defaultStore: TweakStore
      - -
      -
      -
      -
      -
    • -
    • -
      - - - - setTweaks(tweaks:) - -
      -
      -
      -
      -
      -
      -

      setTweaks needs to be called to add the defined Tweaks into the environment.

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public static func setTweaks(tweaks: [TweakClusterType])
      - -
      -
      -
      -

      Parameters

      - - - - - - - -
      - - tweaks - - -
      -

      the tweaks to set

      -
      -
      -
      -
      -
      -
    • -
    -
    -
    -
    - -
    -
    - - - diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Structs/Tweak.html b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Structs/Tweak.html deleted file mode 100644 index eaf9cccd..00000000 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Structs/Tweak.html +++ /dev/null @@ -1,440 +0,0 @@ - - - - Tweak Structure Reference - - - - - - - - - - - - - -
    -
    -

    Mixpanel 2.10.4 Docs (87% documented)

    -

    View on GitHub

    -

    -

    - -
    -

    -
    -
    -
    - -
    -
    - -
    -
    -
    -

    Tweak

    -
    -
    - -
    public struct Tweak<T> where T : TweakableType
    -
    extension Tweak: Hashable
    -
    extension Tweak: TweakClusterType
    - -
    -
    -

    Tweaks let you adjust things on the fly. -Because each T needs a UI component, we have to restrict what T can be - hence T: TweakableType. -If T: SignedNumberType, you can declare a min / max for a Tweak.

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

      Initializer for a Tweak for A/B Testing

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public init(tweakName: String, defaultValue: T)
      - -
      -
      -
      -

      Parameters

      - - - - - - - - - - - -
      - - tweakName - - -
      -

      name of the tweak

      -
      -
      - - defaultValue - - -
      -

      the default value set for the tweak

      -
      -
      -
      -
      -
      -
    • -
    • -
      - - - - hash(into:) - -
      -
      -
      -
      -
      -
      -

      Hashing for a Tweak for A/B Testing in order for it to be stored.

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public func hash(into hasher: inout Hasher)
      - -
      -
      -
      -
      -
    • -
    • -
      - - - - tweakCluster - -
      -
      -
      -
      -
      -
      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public var tweakCluster: [AnyTweak] { get }
      - -
      -
      -
      -
      -
    • -
    -
    -
    -
    - - -
    - -

    Available where T: SignedNumeric & Comparable

    -

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

      Creates a Tweak where T: SignedNumberType -You can optionally provide a min / max / stepSize to restrict the bounds and behavior of a tweak.

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public init(tweakName: String,
      -            defaultValue: T,
      -            min minimumValue: T? = nil,
      -            max maximumValue: T? = nil,
      -            stepSize: T? = nil)
      - -
      -
      -
      -

      Parameters

      - - - - - - - - - - - - - - - - - - - - - - - -
      - - tweakName - - -
      -

      name of the tweak

      -
      -
      - - defaultValue - - -
      -

      the default value set for the tweak

      -
      -
      - - minimumValue - - -
      -

      minimum value to allow for the tweak

      -
      -
      - - maximumValue - - -
      -

      maximum value to allow for the tweak

      -
      -
      - - stepSize - - -
      -

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

      -
      -
      -
      -
      -
      -
    • -
    -
    -
    -
    - -
    -
    - - - diff --git a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Typealiases.html b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Typealiases.html index cf49d4ff..76556326 100644 --- a/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Typealiases.html +++ b/docs/docsets/Mixpanel.docset/Contents/Resources/Documents/Typealiases.html @@ -17,7 +17,7 @@
    -

    Mixpanel 2.10.4 Docs (87% documented)

    +

    Mixpanel 3.0.0 Docs (84% documented)

    View on GitHub

    @@ -48,26 +48,9 @@ - - - - - - - @@ -115,9 +95,6 @@ - @@ -126,17 +103,6 @@ - - - - @@ -114,9 +94,6 @@ - @@ -125,17 +102,6 @@ - - - - @@ -114,9 +94,6 @@ - @@ -125,17 +102,6 @@ - -