Package 

Class Config

  • 
public final class Config

    Class to build a configuration for Batch SDK

    • Constructor Summary

      Constructors 
      Constructor Description
      Config(String apikey)

    • Method Summary

      Modifier and Type Method Description
      Config setLoggerDelegate(LoggerDelegate delegate) Set if Batch should send its logs to an object of yours (default = null)Be careful with your implementation: setting this can impact stability and performanceYou should only use it if you know what you are doing.
      Config setLoggerLevel(LoggerLevel level) Set the log level Batch should use
      Config setCanUseAndroidID(boolean canUse) Method kept for compatibility: Batch will not use the Android ID in any situation
      Config setCanUseAdvertisingID(boolean canUse) Set if Batch can use AvertisingId (default = true)Setting this to false have a negative impact on offer delivery and restoreYou should only use it if you know what you are doing.
      Config setCanUseAdvancedDeviceInformation(boolean canUse) Set if Batch can use advanced device identifiers (default = true)Advanced device identifiers include information about the device itself, but nothing thatdirectly identify the user, such as but not limited to:- Device model- Device brand- Carrier nameSetting this to false have a negative impact on core Batch featuresYou should only use it if you know what you are doing.
      Config setCanUseInstanceID(boolean canUse) Set if Batch can use the Google Play Services Instance ID api (default = true)Setting this to false will make Batch fallback on the classic (and deprecated) GCM API.
      Config setShouldAutomaticallyRegisterPush(boolean shouldAutomaticallyRegisterPush) Set if Batch should automatically register for pushes using FCM or GCM.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • Config

        Config(String apikey)

    • Method Detail

      • setLoggerDelegate

         Config setLoggerDelegate(LoggerDelegate delegate)

        Set if Batch should send its logs to an object of yours (default = null)Be careful with your implementation: setting this can impact stability and performanceYou should only use it if you know what you are doing.

        Parameters:
        delegate - An object implementing LoggerDelegate

      • setCanUseAdvertisingID

         Config setCanUseAdvertisingID(boolean canUse)

        Set if Batch can use AvertisingId (default = true)Setting this to false have a negative impact on offer delivery and restoreYou should only use it if you know what you are doing.

        Parameters:
        canUse - can Batch use AdvertisingID

      • setCanUseAdvancedDeviceInformation

         Config setCanUseAdvancedDeviceInformation(boolean canUse)

        Set if Batch can use advanced device identifiers (default = true)Advanced device identifiers include information about the device itself, but nothing thatdirectly identify the user, such as but not limited to:- Device model- Device brand- Carrier nameSetting this to false have a negative impact on core Batch featuresYou should only use it if you know what you are doing.

        Note: Disabling this does not automatically disable Android ID/Advertising ID collection, use theappropriate methods to control these.

        Parameters:
        canUse - Can Batch use advanced device information?

      • setCanUseInstanceID

        @Deprecated() Config setCanUseInstanceID(boolean canUse)

        Set if Batch can use the Google Play Services Instance ID api (default = true)Setting this to false will make Batch fallback on the classic (and deprecated) GCM API.You should only use it if you know what you are doing.

        Parameters:
        canUse - can Batch use the Instance ID

      • setShouldAutomaticallyRegisterPush

        @Deprecated() Config setShouldAutomaticallyRegisterPush(boolean shouldAutomaticallyRegisterPush)

        Set if Batch should automatically register for pushes using FCM or GCM.Note: This doesn't do anything anymore

        Parameters:
        shouldAutomaticallyRegisterPush - Doesn't do anything