mparticle-integrations/mparticle-apple-integration-braze-12

This is the Braze integration for the mParticle Apple SDK, built against the Braze Swift SDK 12.x.

Installation

Swift Package Manager

Add the Braze kit package dependency in Xcode or in your Package.swift. Swift Package Manager resolves the mParticle SDK automatically as a transitive dependency, so you do not need a separate .package entry for mparticle-apple-sdk.

let mParticleVersion: Version = "9.0.0"

.package(
    url: "https://github.com/mparticle-integrations/mparticle-apple-integration-braze-12",
    .upToNextMajor(from: mParticleVersion)
),

Then add mParticle-Braze as a dependency of your target.

Note: Add the -ObjC flag to your target's Other Linker Flags build setting, per the Braze documentation.

CocoaPods

Add the kit dependency to your app's Podfile:

pod 'mParticle-Braze-12', '~> 9.0'

For iOS push-launch tracking, initialize Braze in application(_:didFinishLaunchingWithOptions:) before starting mParticle, then pass the instance to the kit:

import BrazeKit
import mParticle_Braze

let configuration = Braze.Configuration(
    apiKey: "[YOUR_BRAZE_API_KEY]",
    endpoint: "[YOUR_BRAZE_ENDPOINT]"
)
let braze = Braze(configuration: configuration)

MPKitBraze.setBrazeInstance(braze)
MPKitBraze.setShouldDisableNotificationHandling(true)
// Start mParticle after this.

Complete setup details (including required push delegate methods) are in the mParticle docs:

mParticle Braze iOS App Launch Tracking

Verifying the Integration

After installing, rebuild and launch your app. With the mParticle log level set to Debug or higher, you should see the following in your Xcode console:

Included kits: { Braze }

Platform Support

| Platform | Minimum Version | | -------- | --------------- | | iOS | 15.0 | | tvOS | 15.0 |

Documentation

Issues

Please report bugs and feature requests to the mparticle-apple-sdk repository. This mirror repository is not actively monitored for issues.

License

Apache License 2.0

Package Metadata

Repository: mparticle-integrations/mparticle-apple-integration-braze-12

Default branch: main

README: README.md