cordova-mixpanel-plugin: A JavaScript repository from nakulgulati

Cordova Plugin that wraps Mixpanel sdk for android and ios

NOTICE !!

3.0.0 is brand new and introduces some changes in requirements which might lead to some bugs.

I've only tested that basic functionality works.
if you have probs please open an issue and use the latest stable version 2.3.5.

Install

for cordova version > 5.x.x:
  cordova plugin add cordova-plugin-mixpanel

older versions:
  cordova plugin add https://github.com/samzilverberg/cordova-mixpanel-plugin.git

Usage

window.mixpanel:

alias(aliasId, originalId, onSuccess, onFail)
- also available as createAlias
distinctId(function onSuccess(distinctId), onFail)
flush(onSuccess, onFail)
identify(distinctId, onSuccess, onFail)
init(token, onSuccess, onFail)
registerSuperProperties(superProperties, onSuccess, onFail)
reset(onSuccess, onFail)
timeEvent(eventName, onSuccess, onFail)
track(eventName, eventProperties, onSuccess, onFail)

window.mixpanel.people:

increment(peopleProperties, onSuccess, onFail)

setPushId(pushId, onSuccess, onFail)

More info about push notifications at:
- android
- ios
Usage example using the PhoneGap Push Plugin:

  var push = PushNotification.init({
      'android': {'senderID': '<GCM Sender ID>'},
      'ios': {'alert': 'true', 'badge': 'true', 'sound': 'true'}
  });
  push.on('registration', function(data) {
    mixpanel.people.setPushId(data.registrationId, function onSuccess(){}, function onFail(){});
  });

set(peopleProperties, onSuccess, onFail)
setOnce(peopleProperties, onSuccess, onFail)
trackCharge(amount, chargeProperties, onSuccess, onFail)
unset(propertiesArray, onSuccess, onFail)
deleteUser(onSuccess, onFail)

TODOs

make sure ios/android use same error messages
refactor ios code
- try to remove code duplication of checking that mixpanel was init

Contributing and Testing

contributions of all sorts to the source code are more than welcome. any contribution will be noted in the changeslog (for FAME! :-D ).

Please try to test your contributions using your cordova project or a dummy test project. You may use mine which i've published to NPM: https://www.npmjs.com/package/cordova-mixpanel-plugin-testapp

Troubleshooting

IOS

installation of plugin fails with `Error: CocoaPods was not found. ...`

the plugin uses cocoapods to install the mixpanel iphone sdk.
you will also need cordova-cli >= 6.4.0 and cordova-ios >= 4.3.0.
you can install it via brew: brew install cocoapods
after first install you should: pod setup

hey i installed the plugin and now build fails, why?

open your xcode proj, goto build phases -> link binary with libraries:

drag all files under folder 'frameworks' (on the left) to here
add the following if missing:
- libicucore
- cfnetwork

my build still fails, got a compile error at UIImage+MPAverageColor.m

if your got this error: "variable-sized object may not be initialized" from char colorIndices[kNumberOfHexColors] = {0};.
this is caused by compiler using a wrong C dialect (C99 for example).
to fix:

open your project in xcode
goto build settings tab
scroll down to "apple llvm 8.0 - language"
set "C language dialect" to be default

i get error 'Mixpanel' plugin not found, check config.xml

appears to be some problem of the xcode proj settings.
only working solution i found so far is to

cordova platform remove ios
cordova platform add ios
cordova build ios

and setting up the build phase correctly again, as described in last question.

hey i'm on iOS>9 and nothing is happening, why?

google for NSAppTransportSecurity.
since iOS9 they are more strict about what your app is allowed to connect to.
you will have to manually add some entries to your app plist file to allow network connectivity to mixpanel server.

Android

my build fails, wat? why?

mixpanel lib depends on google play services 3.1 or higher.
you can install this through the android sdk under extras category.
FYI this plugin registers a dependency on ANY version of play services so it doesnt conflict with other plugins in any way.

Keywords

mixpanel, plugin cordova, phonegap, ionic, android, ios

nakulgulati/cordova-mixpanel-plugin