com.mparticle.sdk.model.registration

Class Permissions

java.lang.Object

com.mparticle.sdk.model.registration.Permissions

public final class Permissions
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Permissions()

Method Summary

Modifier and Type	Method and Description
java.util.List<DeviceIdentityPermission>	getDeviceIdentities()
java.util.List<PartnerIdentityPermission>	getPartnerIdentities()
java.util.List<UserIdentityPermission>	getUserIdentities()
boolean	isAllowAccessDeviceApplicationStamp()
boolean	isAllowAccessHttpUserAgent() Setting this will allow a partner to receive the HTTP user agent as a part of a runtime environment.
boolean	isAllowAccessIpAddress()
boolean	isAllowAccessLocation()
boolean	isAllowAccessMpid() Setting for allowing for an MPID to be forwarded as a part of the user profile.
boolean	isAllowAudienceUserAttributeSharing()
boolean	isAllowConsentState()
boolean	isAllowDeviceInformation()
boolean	isAllowUserAttributes()
Permissions	setAllowAccessDeviceApplicationStamp(boolean allowAccessDeviceApplicationStamp) Request access to the "device application stamp" for this event data.
Permissions	setAllowAccessHttpUserAgent(boolean allowAccessHttpUserAgent) Setting this will allow a partner to receive the HTTP user agent as a part of a runtime environment.
Permissions	setAllowAccessIpAddress(boolean allowAccessIpAddress) Request access to the IP address that sent this event data.
Permissions	setAllowAccessLocation(boolean allowAccessLocation)
Permissions	setAllowAccessMpid(boolean allowAccessMpid) Setting this will allow a partner to get an MPID as a part of the user profile.
Permissions	setAllowAudienceUserAttributeSharing(boolean allowAudienceUserAttributeSharing) Setting this will allow a partner to receive audience user attribute updates.
Permissions	setAllowConsentState(boolean allowConsentState) Setting this will allow a partner to receive the consent state of the mParticle user profile to which this request pertains.
Permissions	setAllowDeviceInformation(boolean allowDeviceInformation) Request access to device information
Permissions	setAllowUserAttributes(boolean allowUserAttributes) Request access to user attributes Disabling this will also disable UserAttributeChange events
Permissions	setDeviceIdentities(java.util.List<DeviceIdentityPermission> deviceIdentities)
Permissions	setPartnerIdentities(java.util.List<PartnerIdentityPermission> partnerIdentities)
Permissions	setUserIdentities(java.util.List<UserIdentityPermission> userIdentities)

Methods inherited from class java.lang.Object

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

Constructor Detail

Permissions

public Permissions()

Method Detail

getPartnerIdentities

public java.util.List<PartnerIdentityPermission> getPartnerIdentities()

Returns:

requested partner identities

setPartnerIdentities

public Permissions setPartnerIdentities(java.util.List<PartnerIdentityPermission> partnerIdentities)

Parameters:

partnerIdentities - requested partner identities

Returns:

this

getDeviceIdentities

public java.util.List<DeviceIdentityPermission> getDeviceIdentities()

Returns:

requested device identities

setDeviceIdentities

public Permissions setDeviceIdentities(java.util.List<DeviceIdentityPermission> deviceIdentities)

Parameters:

deviceIdentities - requested device identities

Returns:

this

getUserIdentities

public java.util.List<UserIdentityPermission> getUserIdentities()

Returns:

requested user identities

setUserIdentities

public Permissions setUserIdentities(java.util.List<UserIdentityPermission> userIdentities)

Parameters:

userIdentities - requested user identities

Returns:

isAllowAccessLocation

public boolean isAllowAccessLocation()

Returns:

true if requesting access to GEO location

setAllowAccessLocation

public Permissions setAllowAccessLocation(boolean allowAccessLocation)

Parameters:

allowAccessLocation -

Returns:

true if requesting access to GEO location

isAllowAccessIpAddress

public boolean isAllowAccessIpAddress()

Returns:

true if requesting access to the client IP address

setAllowAccessIpAddress

public Permissions setAllowAccessIpAddress(boolean allowAccessIpAddress)

Request access to the IP address that sent this event data. Requests to the mParticle API may come from a browser, and iOS/tvOS/Android device, or a server when data originates from a server-to-server integration.

Parameters:

allowAccessIpAddress -

See Also:

RuntimeEnvironment.getClientIpAddress()

isAllowAccessDeviceApplicationStamp

public boolean isAllowAccessDeviceApplicationStamp()

setAllowAccessDeviceApplicationStamp

public Permissions setAllowAccessDeviceApplicationStamp(boolean allowAccessDeviceApplicationStamp)

Request access to the "device application stamp" for this event data. The "device application stamp" is a unique identifier for this particular app and device instance. It will stay persistent for a given device and application pair, as long as the app is installed and/or cookies have not been cleared.

Parameters:

allowAccessDeviceApplicationStamp -

See Also:

EventProcessingRequest.getDeviceApplicationStamp()

isAllowDeviceInformation

public boolean isAllowDeviceInformation()

setAllowDeviceInformation

public Permissions setAllowDeviceInformation(boolean allowDeviceInformation)

Request access to device information

Parameters:

allowDeviceInformation -

isAllowUserAttributes

public boolean isAllowUserAttributes()

setAllowUserAttributes

public Permissions setAllowUserAttributes(boolean allowUserAttributes)

Request access to user attributes Disabling this will also disable UserAttributeChange events

Parameters:

allowUserAttributes -

isAllowConsentState

public boolean isAllowConsentState()

setAllowConsentState

public Permissions setAllowConsentState(boolean allowConsentState)

Setting this will allow a partner to receive the consent state of the mParticle user profile to which this request pertains.

Parameters:

allowConsentState -

Returns:

isAllowAudienceUserAttributeSharing

public boolean isAllowAudienceUserAttributeSharing()

setAllowAudienceUserAttributeSharing

public Permissions setAllowAudienceUserAttributeSharing(boolean allowAudienceUserAttributeSharing)

Setting this will allow a partner to receive audience user attribute updates.

Parameters:

allowAudienceUserAttributeSharing -

Returns:

isAllowAccessMpid

public boolean isAllowAccessMpid()

Setting for allowing for an MPID to be forwarded as a part of the user profile.

Returns:

setAllowAccessMpid

public Permissions setAllowAccessMpid(boolean allowAccessMpid)

Setting this will allow a partner to get an MPID as a part of the user profile.

Parameters:

allowAccessMpid -

Returns:

isAllowAccessHttpUserAgent

public boolean isAllowAccessHttpUserAgent()

Setting this will allow a partner to receive the HTTP user agent as a part of a runtime environment.

Returns:

setAllowAccessHttpUserAgent

public Permissions setAllowAccessHttpUserAgent(boolean allowAccessHttpUserAgent)

Setting this will allow a partner to receive the HTTP user agent as a part of a runtime environment.

Parameters:

allowAccessHttpUserAgent -

Returns: