Package com.mparticle.sdk.model.registration

Class Permissions

java.lang.Object
com.mparticle.sdk.model.registration.Permissions
public final class Permissions extends Object

  • Constructor Details

    • Permissions

      public Permissions()

  • Method Details

    • getPartnerIdentities

      public List<PartnerIdentityPermission> getPartnerIdentities()
      Returns:
      requested partner identities

    • setPartnerIdentities

      public Permissions setPartnerIdentities(List<PartnerIdentityPermission> partnerIdentities)
      Parameters:
      partnerIdentities - requested partner identities
      Returns:
      this

    • getDeviceIdentities

      public List<DeviceIdentityPermission> getDeviceIdentities()
      Returns:
      requested device identities

    • setDeviceIdentities

      public Permissions setDeviceIdentities(List<DeviceIdentityPermission> deviceIdentities)
      Parameters:
      deviceIdentities - requested device identities
      Returns:
      this

    • getUserIdentities

      public List<UserIdentityPermission> getUserIdentities()
      Returns:
      requested user identities

    • setUserIdentities

      public Permissions setUserIdentities(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:

    • 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:

    • 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:

    • isAllowPlatformFields

      public boolean isAllowPlatformFields()
      Setting this will allow a partner to receive platform fields like account id and workspace name.
      Returns:
      allowPlatformFields

    • setAllowPlatformFields

      public Permissions setAllowPlatformFields(boolean allowPlatformFields)
      Setting this will allow a partner to receive platform fields like account id and workspace name.
      Parameters:
      allowPlatformFields - Allow platform fields boolean
      Returns:
      Permissions

    • isAllowEventlessBatches

      public boolean isAllowEventlessBatches()
      Setting this will allow a partner to receive batches that don't contain any events.
      Returns:
      allowEventlessBatches

    • setAllowEventlessBatches

      public Permissions setAllowEventlessBatches(boolean allowEventlessBatches)
      Setting this will allow a partner to receive batches that don't contain any events.
      Parameters:
      allowEventlessBatches - Allow eventless batches boolean
      Returns:
      Permissions

    • 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: