@houseninja/capacitor-mixpanel v2.1.1

Maintainers

Install

npm install @houseninja/capacitor-mixpanel

Add the following plugin configuration:

{
  ...
  "Mixpanel": {
    "token": "token-abcdefg1234",
    "trackAutomaticEvents": true, // optional, default: true
    "optOutTrackingByDefault": false, // optional, default: false
    "disableIosIpCollection": true, // optional, default: false
    "serverURL": "https://api-eu.mixpanel.com/", // optional, default: "https://api.mixpanel.com/"
  },
  ...
}

Sync capacitor configuration

npx cap sync

API

• initialize(...)
• distinctId()
• track(...)
• identify(...)
• alias(...)
• reset()
• clearSuperProperties()
• currentSuperProperties()
• registerSuperProperties(...)
• setProfile(...)
• setProfileUnion(...)
• deleteProfile()
• trackCharge(...)
• flush()
• optInTracking(...)
• optOutTracking()
• hasOptedOutTracking()
• Interfaces

initialize(...)

initialize(options: InitializeOptions) => Promise<void>

Initialize the plugin (web only)

distinctId()

distinctId() => Promise<{ value: string; }>

Returns the current distinct id of the user. This is either the id automatically generated by the library or the id that has been passed by a call to identify().

Returns: Promise<{ value: string; }>

track(...)

track(options: TrackOptions) => Promise<void>

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

identify(...)

identify(options: IdentifyOptions) => Promise<void>

Identify a user with a unique ID to track user activity across devices, tie a user to their events, and create a user profile. If you never call this method, unique visitors are tracked using a UUID generated the first time they visit the site.

alias(...)

alias(options: AliasOptions) => Promise<void>

The alias method creates an alias which Mixpanel will use to remap one id to another. Multiple aliases can point to the same identifier.

reset()

reset() => Promise<void>

Clears super properties and generates a new random distinct_id for this instance. Useful for clearing data when a user logs out.

clearSuperProperties()

clearSuperProperties() => Promise<void>

Clears all currently set super properties.

currentSuperProperties()

currentSuperProperties() => Promise<{ properties: any; }>

Returns the currently set super properties.

Returns: Promise<{ properties: any; }>

registerSuperProperties(...)

registerSuperProperties(options: SuperPropertyOptions) => Promise<void>

Register super properties that will be sent with every event.

setProfile(...)

setProfile(options: ProfileProperties) => Promise<void>

Set properties on the current user in Mixpanel People.

setProfileUnion(...)

setProfileUnion(options: ProfileProperties) => Promise<void>

Union list properties.

deleteProfile()

deleteProfile() => Promise<void>

Permanently deletes the current people analytics profile from Mixpanel (using the current distinctId).

trackCharge(...)

trackCharge(options: ChargeOptions) => Promise<void>

Track money spent by the current user for revenue analytics and associate properties with the charge. Properties is optional.

flush()

flush() => Promise<void>

Uploads queued data to the Mixpanel server. (only ios, android)

optInTracking(...)

optInTracking(options: OptInOptions) => Promise<void>

Opt in tracking.

Use this method to opt in an already opted out user from tracking. People updates and track calls will be sent to Mixpanel after using this method.

optOutTracking()

optOutTracking() => Promise<void>

Opt out tracking.

This method is used to opt out tracking. This causes all events and people request no longer to be sent back to the Mixpanel server.

hasOptedOutTracking()

hasOptedOutTracking() => Promise<{ value: boolean; }>

Returns the current opt-out status.

Returns: Promise<{ value: boolean; }>

Interfaces

InitializeOptions

TrackOptions

TrackProperties

IdentifyOptions

AliasOptions

SuperPropertyOptions

ProfileProperties

ChargeOptions

OptInOptions

Contributors

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!