mParticle.Identity Class
Invoke these methods on the mParticle.Identity object. Example: mParticle.Identity.getCurrentUser().
Item Index
Methods
aliasUsers
-
aliasRequest -
[callback]
Initiate an alias request to the mParticle server
Parameters:
-
aliasRequestObjectobject representing an AliasRequest
-
[callback]Function optionalA callback function that is called when the aliasUsers request completes
getCurrentUser
()
Object
Returns a user object with methods to interact with the current user
Returns:
the current user object
getUser
-
mpid
Returns a the user object associated with the mpid parameter or 'null' if no such user exists
Parameters:
-
mpidStringof the desired user
Returns:
the user for mpid
getUsers
()
Array
Returns all users, including the current user and all previous users that are stored on the device.
Returns:
array of users
identify
-
identityApiData -
[callback]
Initiate a logout request to the mParticle server
Parameters:
-
identityApiDataObjectThe identityApiData object as indicated here
-
[callback]Function optionalA callback function that is called when the identify request completes
login
-
identityApiData -
[callback]
Initiate a login request to the mParticle server
Parameters:
-
identityApiDataObjectThe identityApiData object as indicated here
-
[callback]Function optionalA callback function that is called when the login request completes
logout
-
identityApiData -
[callback]
Initiate a logout request to the mParticle server
Parameters:
-
identityApiDataObjectThe identityApiData object as indicated here
-
[callback]Function optionalA callback function that is called when the logout request completes
modify
-
identityApiData -
[callback]
Initiate a modify request to the mParticle server
Parameters:
-
identityApiDataObjectThe identityApiData object as indicated here
-
[callback]Function optionalA callback function that is called when the modify request completes