All Implemented Interfaces:


public final class AATKitConfiguration
extends AATKitAbstractConfiguration

Used to set up AATKit.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public enum`	`AATKitConfiguration.Platform`
`public interface`	`AATKitConfiguration.ReportsDelegate`	Notifies about placement reporting being sent.

Field Summary

Fields
Modifier and Type	Field	Description
`private final String`	`initialRules`
`private Boolean`	`isShouldCacheRules`
`private Boolean`	`isShouldSkipRules`
`private Boolean`	`isShouldReportUsingAlternativeBundleId`
`private AATKit.Delegate`	`delegate`
`private Boolean`	`isUseDebugShake`
`private Boolean`	`useAutomaticPPID`
`private AATKitConfiguration.Platform`	`platform`
`private AATKitConfiguration.ReportsDelegate`	`reportsDelegate`
`private AATKitAdNetworkOptions`	`adNetworkOptions`
`private final Application`	`application`
`private Boolean`	`isConsentRequired`
`private Consent`	`consent`
`private Boolean`	`isUseGeoLocation`

Constructor Summary

Constructors
Constructor	Description
`AATKitConfiguration(Application application)`	Creates the default Configuration object to be used when initializing AATKit.

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`getInitialRules()`
`final Boolean`	`isShouldCacheRules()`	Allows the AATKit to preserve last downloaded ad rules when the application is closed.
`final Unit`	`setShouldCacheRules(Boolean isShouldCacheRules)`	Allows the AATKit to preserve last downloaded ad rules when the application is closed.
`final Boolean`	`isShouldSkipRules()`	Sets if networks without TCF2 consent should be skipped (only works if TCF2 compliant CMP is used).
`final Unit`	`setShouldSkipRules(@Deprecated(message = "TCF-based rule skipping feature is deprecated and will be removed in the future.") Boolean isShouldSkipRules)`	Sets if networks without TCF2 consent should be skipped (only works if TCF2 compliant CMP is used).
`final Boolean`	`isShouldReportUsingAlternativeBundleId()`	If used together with setAlternativeBundleId allows to set if the same fake bundle ID should be used in reporting.
`final Unit`	`setShouldReportUsingAlternativeBundleId(Boolean isShouldReportUsingAlternativeBundleId)`	If used together with setAlternativeBundleId allows to set if the same fake bundle ID should be used in reporting.
`final AATKit.Delegate`	`getDelegate()`	Sets the delegate notifying about AATKit events.
`final Unit`	`setDelegate(AATKit.Delegate delegate)`	Sets the delegate notifying about AATKit events.
`final Boolean`	`isUseDebugShake()`	Sets if the debug screen should be displayed after shaking the device.
`final Unit`	`setUseDebugShake(Boolean isUseDebugShake)`	Sets if the debug screen should be displayed after shaking the device.
`final Boolean`	`getUseAutomaticPPID()`	Sets if automatically generated userId should be used.
`final Unit`	`setUseAutomaticPPID(Boolean useAutomaticPPID)`	Sets if automatically generated userId should be used.
`final AATKitConfiguration.Platform`	`getPlatform()`	Sets the platform.
`final Unit`	`setPlatform(AATKitConfiguration.Platform platform)`	Sets the platform.
`final AATKitConfiguration.ReportsDelegate`	`getReportsDelegate()`	Sets the optional listener notifying about reporting.
`final Unit`	`setReportsDelegate(AATKitConfiguration.ReportsDelegate reportsDelegate)`	Sets the optional listener notifying about reporting.
`final AATKitAdNetworkOptions`	`getAdNetworkOptions()`	Object describing advanced ad-network specific configurations.
`final Unit`	`setAdNetworkOptions(AATKitAdNetworkOptions adNetworkOptions)`	Object describing advanced ad-network specific configurations.
`final Application`	`getApplication()`
`String`	`toString()`
`final Unit`	`setInitialRules(String initialRules)`	Allows setting of ad rules that will be used before real rules from the server are downloaded.
`final String`	`getAlternativeBundleId()`
`final Unit`	`setAlternativeBundleId(String alternativeBundleId)`	Sets the fake bundle ID for testing purposes.
`final Integer`	`getTestModeAccountId()`
`final Unit`	`setTestModeAccountId(Integer testModeAccountId)`	Enables AATKit test ads that should be for testing - only during development.

Methods inherited from class com.intentsoftware.addapptr.internal.AATKitAbstractConfiguration
getConsent, isConsentRequired, isUseGeoLocation, setConsent, setConsentRequired, setUseGeoLocation
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AATKitConfiguration
```
AATKitConfiguration(Application application)
```
    Creates the default Configuration object to be used when initializing AATKit.
    
    Parameters:
    
    application - Reference to Application.
- Method Detail
  - getInitialRules
```
 final String getInitialRules()
```
  - isShouldCacheRules
```
 final Boolean isShouldCacheRules()
```
    Allows the AATKit to preserve last downloaded ad rules when the application is closed. Such rules will be re-used next time the application is started, before new ones get downloaded. Enabled by default.
  - setShouldCacheRules
```
 final Unit setShouldCacheRules(Boolean isShouldCacheRules)
```
    Allows the AATKit to preserve last downloaded ad rules when the application is closed. Such rules will be re-used next time the application is started, before new ones get downloaded. Enabled by default.
  - isShouldSkipRules
```
 final Boolean isShouldSkipRules()
```
    Sets if networks without TCF2 consent should be skipped (only works if TCF2 compliant CMP is used). False by default.
  - setShouldSkipRules
```
 final Unit setShouldSkipRules(@Deprecated(message = "TCF-based rule skipping feature is deprecated and will be removed in the future.") Boolean isShouldSkipRules)
```
    Sets if networks without TCF2 consent should be skipped (only works if TCF2 compliant CMP is used). False by default.
  - isShouldReportUsingAlternativeBundleId
```
 final Boolean isShouldReportUsingAlternativeBundleId()
```
    If used together with setAlternativeBundleId allows to set if the same fake bundle ID should be used in reporting. True by default. If set to false, real bundle ID will be used in reporting even if fake one is used for testing.
  - setShouldReportUsingAlternativeBundleId
```
 final Unit setShouldReportUsingAlternativeBundleId(Boolean isShouldReportUsingAlternativeBundleId)
```
    If used together with setAlternativeBundleId allows to set if the same fake bundle ID should be used in reporting. True by default. If set to false, real bundle ID will be used in reporting even if fake one is used for testing.
  - getDelegate
```
 final AATKit.Delegate getDelegate()
```
    Sets the delegate notifying about AATKit events.
  - setDelegate
```
 final Unit setDelegate(AATKit.Delegate delegate)
```
    Sets the delegate notifying about AATKit events.
  - isUseDebugShake
```
 final Boolean isUseDebugShake()
```
    Sets if the debug screen should be displayed after shaking the device. Enabled by default.
  - setUseDebugShake
```
 final Unit setUseDebugShake(Boolean isUseDebugShake)
```
    Sets if the debug screen should be displayed after shaking the device. Enabled by default.
  - getUseAutomaticPPID
```
 final Boolean getUseAutomaticPPID()
```
    Sets if automatically generated userId should be used. False by default.
  - setUseAutomaticPPID
```
 final Unit setUseAutomaticPPID(Boolean useAutomaticPPID)
```
    Sets if automatically generated userId should be used. False by default.
  - getPlatform
```
 final AATKitConfiguration.Platform getPlatform()
```
    Sets the platform. Android by default
  - setPlatform
```
 final Unit setPlatform(AATKitConfiguration.Platform platform)
```
    Sets the platform. Android by default
  - getReportsDelegate
```
 final AATKitConfiguration.ReportsDelegate getReportsDelegate()
```
    Sets the optional listener notifying about reporting.
  - setReportsDelegate
```
 final Unit setReportsDelegate(AATKitConfiguration.ReportsDelegate reportsDelegate)
```
    Sets the optional listener notifying about reporting.
  - getAdNetworkOptions
```
 final AATKitAdNetworkOptions getAdNetworkOptions()
```
    Object describing advanced ad-network specific configurations.
  - setAdNetworkOptions
```
 final Unit setAdNetworkOptions(AATKitAdNetworkOptions adNetworkOptions)
```
    Object describing advanced ad-network specific configurations.
  - getApplication
```
 final Application getApplication()
```
  - toString
```
 String toString()
```
  - setInitialRules
```
@Deprecated(message = "Initial rules feature is deprecated and will be removed in the future.") final Unit setInitialRules(String initialRules)
```
    Allows setting of ad rules that will be used before real rules from the server are downloaded.
    
    Parameters:
    
    initialRules - String containing the rules to be used.
  - getAlternativeBundleId
```
 final String getAlternativeBundleId()
```
  - setAlternativeBundleId
```
 final Unit setAlternativeBundleId(String alternativeBundleId)
```
    Sets the fake bundle ID for testing purposes. It should only be used during development. Cannot be used together with classic test mode (setTestModeAccountId).
    
    Parameters:
    
    alternativeBundleId - Bundle ID to be used during testing.
  - getTestModeAccountId
```
 final Integer getTestModeAccountId()
```
  - setTestModeAccountId
```
 final Unit setTestModeAccountId(Integer testModeAccountId)
```
    Enables AATKit test ads that should be for testing - only during development. Cannot be used with alternative bundle ID (setAlternativeBundleId).
    
    Parameters:
    
    testModeAccountId - Test application id obtained from addapptr.com account.

Class AATKitConfiguration

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class com.intentsoftware.addapptr.internal.AATKitAbstractConfiguration

Methods inherited from class java.lang.Object

Constructor Detail

AATKitConfiguration

Method Detail

getInitialRules

isShouldCacheRules

setShouldCacheRules

isShouldSkipRules

setShouldSkipRules

isShouldReportUsingAlternativeBundleId

setShouldReportUsingAlternativeBundleId

getDelegate

setDelegate

isUseDebugShake

setUseDebugShake

getUseAutomaticPPID

setUseAutomaticPPID

getPlatform

setPlatform

getReportsDelegate

setReportsDelegate

getAdNetworkOptions

setAdNetworkOptions

getApplication

toString

setInitialRules

getAlternativeBundleId

setAlternativeBundleId

getTestModeAccountId

setTestModeAccountId