API Docs for: 2.18.0
Show:

mParticle.Identity Class

Defined in: src/identity.js:228

Invoke these methods on the mParticle.Identity object. Example: mParticle.Identity.getCurrentUser().

Methods

aliasUsers

(
  • aliasRequest
  • [callback]
)

Defined in src/identity.js:622

Initiate an alias request to the mParticle server

Parameters:

  • aliasRequest Object

    object representing an AliasRequest

  • [callback] Function optional

    A callback function that is called when the aliasUsers request completes

getCurrentUser

() Object

Defined in src/identity.js:547

Returns a user object with methods to interact with the current user

Returns:

Object:

the current user object

getUser

(
  • mpid
)
Object

Defined in src/identity.js:572

Returns a the user object associated with the mpid parameter or 'null' if no such user exists

Parameters:

  • mpid String

    of the desired user

Returns:

Object:

the user for mpid

getUsers

() Array

Defined in src/identity.js:595

Returns all users, including the current user and all previous users that are stored on the device.

Returns:

Array:

array of users

identify

(
  • identityApiData
  • [callback]
)

Defined in src/identity.js:235

Initiate a logout request to the mParticle server

Parameters:

  • identityApiData Object

    The identityApiData object as indicated here

  • [callback] Function optional

    A callback function that is called when the identify request completes

login

(
  • identityApiData
  • [callback]
)

Defined in src/identity.js:397

Initiate a login request to the mParticle server

Parameters:

  • identityApiData Object

    The identityApiData object as indicated here

  • [callback] Function optional

    A callback function that is called when the login request completes

logout

(
  • identityApiData
  • [callback]
)

Defined in src/identity.js:308

Initiate a logout request to the mParticle server

Parameters:

  • identityApiData Object

    The identityApiData object as indicated here

  • [callback] Function optional

    A callback function that is called when the logout request completes

modify

(
  • identityApiData
  • [callback]
)

Defined in src/identity.js:470

Initiate a modify request to the mParticle server

Parameters:

  • identityApiData Object

    The identityApiData object as indicated here

  • [callback] Function optional

    A callback function that is called when the modify request completes