API Docs for: 2.18.0
Show:

mParticle & mParticleInstance Class

Defined in: src/mp-instance.js:44

All of the following methods can be called on the primary mParticle class. In version 2.10.0, we introduced multiple instances. If you are using multiple instances (self hosted environments only), you should call these methods on each instance.

In current versions of mParticle, if your site has one instance, that instance name is 'default_instance'. Any methods called on mParticle on a site with one instance will be mapped to the default_instance.

This is for simplicity and backwards compatibility. For example, calling mParticle.logPageView() automatically maps to mParticle.getInstance('default_instance').logPageView().

If you have multiple instances, instances must first be initialized and then a method can be called on that instance. For example:

mParticle.init('apiKey', config, 'another_instance'); mParticle.getInstance('another_instance').logPageView();

Methods

endSession

()

Defined in src/mp-instance.js:330

Ends the current session

getAppName

() String

Defined in src/mp-instance.js:245

Gets the app name

Returns:

String:

App name

getAppVersion

() String

Defined in src/mp-instance.js:267

Gets the app version

Returns:

String:

App version

getEnvironment

() String

Defined in src/mp-instance.js:191

Returns the current mParticle environment setting

Returns:

String:

mParticle environment setting

getVersion

() String

Defined in src/mp-instance.js:201

Returns the mParticle SDK version number

Returns:

String:

mParticle SDK version number

isInitialized

() Boolean

Defined in src/mp-instance.js:236

Returns a boolean for whether or not the SDKhas been fully initialized

Returns:

Boolean:

a boolean for whether or not the SDK has been fully initialized

logError

(
  • error
  • [attrs]
)

Defined in src/mp-instance.js:432

Used to log custom errors

Parameters:

  • error String or Object

    The name of the error (string), or an object formed as follows {name: 'exampleName', message: 'exampleMessage', stack: 'exampleStack'}

  • [attrs] Object optional

    Custom attrs to be passed along with the error event; values must be string, number, or boolean

logEvent

(
  • eventName
  • [eventType] The eventType as seen [here]
  • [eventInfo]
  • [customFlags]
  • [eventOptions]
)

Defined in src/mp-instance.js:368

Logs an event to mParticle's servers

Parameters:

logForm

(
  • selector
  • [eventName]
  • [eventType] The eventType as seen [here]
  • [eventInfo]
)

Defined in src/mp-instance.js:494

Logs submit events

Parameters:

logPageView

(
  • eventName
  • [attrs]
  • [customFlags]
  • [eventOptions]
)

Defined in src/mp-instance.js:511

Logs a page view

Parameters:

  • eventName String

    The name of the event. Defaults to 'PageView'.

  • [attrs] Object optional

    Attributes for the event

  • [customFlags] Object optional

    Custom flags for the event

  • [eventOptions] Object optional

    For Event-level Configuration Options

ready

(
  • function
)

Defined in src/mp-instance.js:179

A callback method that is invoked after mParticle is initialized.

Parameters:

  • function Function

    A function to be called after mParticle is initialized

reset

()

Defined in src/mp-instance.js:141

Resets the SDK to an uninitialized state and removes cookies/localStorage. You MUST call mParticle.init(apiKey, window.mParticle.config) before any other mParticle methods or the SDK will not function as intended.

setAppName

(
  • name
)

Defined in src/mp-instance.js:253

Sets the app name

Parameters:

  • name String

    App Name

setAppVersion

(
  • version
)

Defined in src/mp-instance.js:209

Sets the app version

Parameters:

  • version String

    version number

setDeviceId

(
  • name
)

Defined in src/mp-instance.js:224

Sets the device id

Parameters:

  • name String

    device ID (UUIDv4-formatted string)

setLogLevel

(
  • logLevel
)

Defined in src/mp-instance.js:131

Resets the SDK to an uninitialized state and removes cookies/localStorage. You MUST call mParticle.init(apiKey, window.mParticle.config) before any other mParticle methods or the SDK will not function as intended.

Parameters:

  • logLevel String

    verbose, warning, or none. By default, warning is chosen.

setPosition

(
  • lattitude
  • longitude
)

Defined in src/mp-instance.js:298

Sets the position of the user

Parameters:

  • lattitude Number

    lattitude digit

  • longitude Number

    longitude digit

startNewSession

()

Defined in src/mp-instance.js:323

Starts a new session

startTrackingLocation

(
  • [callback]
)

Defined in src/mp-instance.js:283

Starts tracking the location of the user

Parameters:

  • [callback] Function optional

    A callback function that is called when the location is either allowed or rejected by the user. A position object of schema {coords: {latitude: number, longitude: number}} is passed to the callback

stopTrackingLocation

()

Defined in src/mp-instance.js:275

Stops tracking the location of the user

upload

()

Defined in src/mp-instance.js:566

Forces an upload of the batch