Swiftpack.co - Package - mixpanel/mixpanel-swift

Mixpanel Swift Library

Build Status Average time to resolve an issue Percentage of issues still open CocoaPods Compatible Carthage compatible Apache License Documentation

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.

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

Current supported features

Our master branch and our releases are now on Swift 5.

If you wish to use our Swift 4.2 implementation, please point to the v2.6.1 release. For Swift 4/4.1 implementation, please point to the v2.4.5 release. For Swift 3 implementation, please point to the v2.2.3 release. For Swift 2.3 implementation, please point to the 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.4.0+

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

For iOS, tvOS, macOS, and App Extension integrations:

pod 'Mixpanel-swift'

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

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

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

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

alt text

Step 3: Embed the framework

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

alt text

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")
}

You initialize your Mixpanel instance with the token provided to you on mixpanel.com.

Start tracking

After installing the library into your iOS app, Mixpanel will automatically collect common mobile events. You can enable/ disable automatic collection through your project settings.

To interact with the instance and track additional events, 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!")

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.

Have any questions? Reach out to support@mixpanel.com to speak to someone smart, quickly.

Github

link
Stars: 206
Help us keep the lights on

Dependencies

Used By

Total: 0

Releases

v2.6.2 - Apr 1, 2019

  • Xcode 10.2 and swift 5 support https://github.com/mixpanel/mixpanel-swift/pull/296

v2.6.1 - Mar 28, 2019

  • Include super properties during display trigger evaluation
  • Fix bug while comparing string types https://github.com/mixpanel/mixpanel-swift/pull/291

v2.6.0 - Mar 26, 2019

  • Add Apple watch support

  • Enable automatically track common mobile events($ae_session, $ae_updated, $ae_first_open) for Apple TV. to turn it off, please remove the TV_AUTO_EVENTS flag in Active Compilation Conditions in build settings. image More details about Default Mobile Events Collection: https://help.mixpanel.com/hc/en-us/articles/115004596186-Default-Mobile-Events-Collection

  • GDPR fix: Change the default behavior for setting optOutTrackingByDefault in the Mixpanel initialization method. We will not override opt out persistence with optOutTrackingByDefault the flag since opt-out default state is supposed to be used as an initial state while GDPR information is being collected https://github.com/mixpanel/mixpanel-swift/pull/290

v2.5.9 - Mar 22, 2019

New Features

  • Set, add, and remove groups the user belongs to.
  • Track events with specific groups
  • Support for group-level profiles—set, update, and remove properties on account/group objects in Mixpanel
  • Allow to remove All device push tokens, thanks @asiliuk for providing this PR https://github.com/mixpanel/mixpanel-swift/pull/288

Bug fix

  • Fix EXC_BAD_ACCESS crash in background thread and a complete audit for async dispatch, special thanks to @RamblinWreck77 for providing this PR https://github.com/mixpanel/mixpanel-swift/pull/285

v2.5.8 - Mar 15, 2019

  • Add the feature: Event triggered in-app notifications support

Currently users have no control over when an in-app notification shows up. With this release users can now control when an in-app gets displayed based on an event that they track within their app. This "trigger" event is defined during message creation at www.mixpanel.com.

You can additionally filter the event based on properties that are tracked along with the event for even finer controls. https://github.com/mixpanel/mixpanel-swift/pull/287