Package com.mparticle.identity

Class IdentityApiRequest

java.lang.Object

com.mparticle.identity.IdentityApiRequest

public final class IdentityApiRequest
extends java.lang.Object

Class that represents observed changes in user state, can be used as a parameter in an Identity Request. To instantiate an IdentityApiRequest, you must use a IdentityApiRequest.Builder which can be retrieved by calling withEmptyUser() or withUser(MParticleUser) if you would like to use a current user's Identities in the request.

See Also:

IdentityApi.login(IdentityApiRequest), IdentityApi.logout(IdentityApiRequest), IdentityApi.identify(IdentityApiRequest), IdentityApi.modify(IdentityApiRequest)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IdentityApiRequest.Builder	A class used for constructing IdentityApiRequest.

Method Summary

Modifier and Type	Method	Description
protected java.util.Map<java.lang.String,java.lang.String>	getOtherNewIdentities()
protected java.util.Map<java.lang.String,java.lang.String>	getOtherOldIdentities()
UserAliasHandler	getUserAliasHandler()
java.util.Map<MParticle.IdentityType,java.lang.String>	getUserIdentities()
static IdentityApiRequest.Builder	withEmptyUser()	Instantiate an IdentityApiRequest.Builder() with no existing state (no UserIdentities).
static IdentityApiRequest.Builder	withUser(MParticleUser currentUser)	instantiate an IdentityApiRequest.Builder() with an existing user's UserIdentities.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

withEmptyUser

@NonNull
public static IdentityApiRequest.Builder withEmptyUser()

Instantiate an IdentityApiRequest.Builder() with no existing state (no UserIdentities).

Returns:

an IdentityApiRequest.Builder

See Also:

IdentityApiRequest.Builder

withUser

@NonNull
public static IdentityApiRequest.Builder withUser(@Nullable
                                                  MParticleUser currentUser)

instantiate an IdentityApiRequest.Builder() with an existing user's UserIdentities.

Parameters:

currentUser - an MParticleUser

Returns:

an IdentityApiRequest.Builder

See Also:

IdentityApiRequest.Builder

getUserIdentities

@NonNull
public java.util.Map<MParticle.IdentityType,java.lang.String> getUserIdentities()

getOtherOldIdentities

@NonNull
protected java.util.Map<java.lang.String,java.lang.String> getOtherOldIdentities()

getOtherNewIdentities

@NonNull
protected java.util.Map<java.lang.String,java.lang.String> getOtherNewIdentities()

getUserAliasHandler

@Nullable
public UserAliasHandler getUserAliasHandler()