MixpanelInstance

open class MixpanelInstance: CustomDebugStringConvertible, FlushDelegate

The class that represents the Mixpanel Instance

  • The a MixpanelDelegate object that gives control over Mixpanel network activity.

    Declaration

    Swift

    open var delegate: MixpanelDelegate?

  • distinctId string that uniquely identifies the current user.

    Declaration

    Swift

    open var distinctId = ""

  • alias string that uniquely identifies the current user.

    Declaration

    Swift

    open var alias: String? = nil

  • Accessor to the Mixpanel People API object.

    Declaration

    Swift

    open var people: People!

  • Controls whether to show spinning network activity indicator when flushing data to the Mixpanel servers. Defaults to true.

    Declaration

    Swift

    open var showNetworkActivityIndicator = true

  • Flush timer’s interval. Setting a flush interval of 0 will turn off the flush timer.

    Declaration

    Swift

    open var flushInterval: Double

  • Control whether the library should flush data to Mixpanel when the app enters the background. Defaults to true.

    Declaration

    Swift

    open var flushOnBackground: Bool

  • Controls whether to automatically send the client IP Address as part of event tracking. With an IP address, the Mixpanel Dashboard will show you the users’ city. Defaults to true.

    Declaration

    Swift

    open var useIPAddressForGeoLocation: Bool

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

    Declaration

    Swift

    open var serverURL = BasePath.DefaultMixpanelAPI

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

    Declaration

    Swift

    open var debugDescription: String

  • 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.

    Declaration

    Swift

    open var loggingEnabled: Bool = false

  • A unique identifier for this MixpanelInstance

    Declaration

    Swift

    open let name: String

  • 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

  • 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

  • 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

  • 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

  • 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