MParticleOptions Class Reference

Inherits from NSObject
Declared in mParticle.h

Overview

Main configuration object for initial SDK setup.

+ optionsWithKey:secret:

Creates an options object with your specified App key and Secret.

+ (MParticleOptions *)optionsWithKey:(NSString *)apiKey secret:(NSString *)secret

Discussion

Creates an options object with your specified App key and Secret.

These values can be retrieved from your App’s dashboard within the mParticle platform.

Declared In

mParticle.h

  trackNotifications

Determines whether the mParticle Apple SDK will automatically track Remote and Local Notification events. Defaults to YES

@property (nonatomic, unsafe_unretained, readwrite) BOOL trackNotifications

Discussion

Determines whether the mParticle Apple SDK will automatically track Remote and Local Notification events. Defaults to YES

Declared In

mParticle.h

  uploadInterval

Upload interval.

@property (nonatomic, unsafe_unretained, readwrite) NSTimeInterval uploadInterval

Discussion

Upload interval.

Batches of data are sent periodically to the mParticle servers at the rate defined by this property. Batches are also uploaded when the application is sent to the background.

Declared In

mParticle.h

  sessionTimeout

Session timeout.

@property (nonatomic, unsafe_unretained, readwrite) NSTimeInterval sessionTimeout

Discussion

Session timeout.

Sets the user session timeout interval. A session is ended if the app goes into the background for longer than the session timeout interval or when more than 1000 events are logged.

Declared In

mParticle.h

  networkOptions

Allows you to override the default HTTPS hosts and certificates used by the SDK, if required.

@property (nonatomic, strong, readwrite) MPNetworkOptions *networkOptions

Discussion

Allows you to override the default HTTPS hosts and certificates used by the SDK, if required.

(Provided to accomodate certain advanced use cases. Most integrations of the SDK will not require modifying this property.)

Declared In

mParticle.h

  consentState

Consent state.

@property (nonatomic, strong, nullable) MPConsentState *consentState

Discussion

Consent state.

Allows you to record one or more consent purposes and whether or not the user agreed to each one.

Declared In

mParticle.h

  dataPlanId

Data Plan ID.

@property (nonatomic, strong, readwrite, nullable) NSString *dataPlanId

Discussion

Data Plan ID.

If set, this informs the SDK of which data plan each event is supposed to conform to.

Declared In

mParticle.h

  dataPlanVersion

Data Plan Version.

@property (nonatomic, strong, readwrite, nullable) NSNumber *dataPlanVersion

Discussion

Data Plan Version.

If set, this informs the SDK of which version of the data plan each event is supposed to conform to.

Declared In

mParticle.h

  dataPlanOptions

Data Plan Options.

@property (nonatomic, strong, readwrite, nullable) MPDataPlanOptions *dataPlanOptions

Discussion

Data Plan Options.

Settings for blocking data to kits

Declared In

mParticle.h

  onIdentifyComplete

Identify callback.

@property (nonatomic, copy) void ( ^ ) ( MPIdentityApiResult *_Nullable apiResult , NSError *_Nullable error ) onIdentifyComplete

Discussion

Identify callback.

This will be called when an identify request completes.

This applies to both the initial identify request triggered by the SDK and any identify requests you may send.

Declared In

mParticle.h

  onAttributionComplete

Attribution callback.

@property (nonatomic, copy) void ( ^ ) ( MPAttributionResult *_Nullable attributionResult , NSError *_Nullable error ) onAttributionComplete

Discussion

Attribution callback.

This will be called each time a kit returns attribution info.

Declared In

mParticle.h