├── app ├── .gitignore ├── src │ └── main │ │ ├── res │ │ ├── drawable │ │ │ ├── droid.jpg │ │ │ ├── splash.xml │ │ │ └── ic_launcher_background.xml │ │ ├── mipmap-hdpi │ │ │ ├── ic_launcher.png │ │ │ └── ic_launcher_round.png │ │ ├── mipmap-mdpi │ │ │ ├── ic_launcher.png │ │ │ └── ic_launcher_round.png │ │ ├── mipmap-xhdpi │ │ │ ├── ic_launcher.png │ │ │ └── ic_launcher_round.png │ │ ├── mipmap-xxhdpi │ │ │ ├── ic_launcher.png │ │ │ └── ic_launcher_round.png │ │ ├── mipmap-xxxhdpi │ │ │ ├── ic_launcher.png │ │ │ └── ic_launcher_round.png │ │ ├── values │ │ │ ├── strings.xml │ │ │ ├── styles.xml │ │ │ └── colors.xml │ │ ├── mipmap-anydpi-v26 │ │ │ ├── ic_launcher.xml │ │ │ └── ic_launcher_round.xml │ │ ├── layout │ │ │ └── main.xml │ │ └── drawable-v24 │ │ │ └── ic_launcher_foreground.xml │ │ ├── java │ │ └── com │ │ │ └── lazygeniouz │ │ │ └── appopenads │ │ │ ├── activities │ │ │ ├── MainActivity.kt │ │ │ └── SplashActivity.kt │ │ │ ├── AppJv.java │ │ │ └── AppKt.kt │ │ └── AndroidManifest.xml ├── proguard-rules.pro └── build.gradle ├── settings.gradle ├── aoa_manager ├── .gitignore ├── src │ └── main │ │ ├── java │ │ └── com │ │ │ └── lazygeniouz │ │ │ └── aoa │ │ │ ├── idelay │ │ │ ├── DelayType.kt │ │ │ └── InitialDelay.kt │ │ │ ├── extensions │ │ │ └── Extensions.kt │ │ │ ├── listener │ │ │ └── AppOpenAdListener.kt │ │ │ ├── configs │ │ │ └── Configs.kt │ │ │ ├── base │ │ │ ├── BaseObserver.kt │ │ │ └── BaseAdManager.kt │ │ │ └── AppOpenAdManager.kt │ │ └── AndroidManifest.xml ├── proguard-rules.pro └── build.gradle ├── .idea ├── .gitignore ├── codeStyles │ ├── codeStyleConfig.xml │ └── Project.xml ├── compiler.xml ├── vcs.xml ├── dictionaries │ └── itznotabug.xml ├── misc.xml ├── gradle.xml └── jarRepositories.xml ├── .gitignore ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradle.properties ├── gradlew.bat ├── Readme.md ├── gradlew └── LICENSE /app/.gitignore: -------------------------------------------------------------------------------- 1 | /build -------------------------------------------------------------------------------- /settings.gradle: -------------------------------------------------------------------------------- 1 | include (':aoa_manager', ':app') -------------------------------------------------------------------------------- /aoa_manager/.gitignore: -------------------------------------------------------------------------------- 1 | /build 2 | /gradle.properties -------------------------------------------------------------------------------- /.idea/.gitignore: -------------------------------------------------------------------------------- 1 | # Default ignored files 2 | /shelf/ 3 | /workspace.xml 4 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.iml 2 | .gradle 3 | /local.properties 4 | .idea 5 | .DS_Store 6 | /build 7 | /captures 8 | .externalNativeBuild 9 | .cxx -------------------------------------------------------------------------------- /app/src/main/res/drawable/droid.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ItzNotABug/AppOpenAdManager/HEAD/app/src/main/res/drawable/droid.jpg -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ItzNotABug/AppOpenAdManager/HEAD/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /app/src/main/res/mipmap-hdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ItzNotABug/AppOpenAdManager/HEAD/app/src/main/res/mipmap-hdpi/ic_launcher.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-mdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ItzNotABug/AppOpenAdManager/HEAD/app/src/main/res/mipmap-mdpi/ic_launcher.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xhdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ItzNotABug/AppOpenAdManager/HEAD/app/src/main/res/mipmap-xhdpi/ic_launcher.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xxhdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ItzNotABug/AppOpenAdManager/HEAD/app/src/main/res/mipmap-xxhdpi/ic_launcher.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xxxhdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ItzNotABug/AppOpenAdManager/HEAD/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-hdpi/ic_launcher_round.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ItzNotABug/AppOpenAdManager/HEAD/app/src/main/res/mipmap-hdpi/ic_launcher_round.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-mdpi/ic_launcher_round.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ItzNotABug/AppOpenAdManager/HEAD/app/src/main/res/mipmap-mdpi/ic_launcher_round.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xhdpi/ic_launcher_round.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ItzNotABug/AppOpenAdManager/HEAD/app/src/main/res/mipmap-xhdpi/ic_launcher_round.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xxhdpi/ic_launcher_round.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ItzNotABug/AppOpenAdManager/HEAD/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ItzNotABug/AppOpenAdManager/HEAD/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png -------------------------------------------------------------------------------- /app/src/main/res/values/strings.xml: -------------------------------------------------------------------------------- 1 | 2 | AppOpenAds 3 | AppOpenAds Sample 4 | -------------------------------------------------------------------------------- /.idea/codeStyles/codeStyleConfig.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 5 | -------------------------------------------------------------------------------- /.idea/compiler.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /.idea/vcs.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /aoa_manager/src/main/java/com/lazygeniouz/aoa/idelay/DelayType.kt: -------------------------------------------------------------------------------- 1 | package com.lazygeniouz.aoa.idelay 2 | 3 | /** 4 | * Delay by Hour, Days, or None 5 | */ 6 | enum class DelayType { 7 | DAYS, HOURS, MINUTES, SECONDS, NONE 8 | } -------------------------------------------------------------------------------- /app/src/main/res/values/styles.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 7 | 8 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | #Fri Oct 16 16:18:05 IST 2020 2 | distributionBase=GRADLE_USER_HOME 3 | distributionPath=wrapper/dists 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | distributionUrl=https\://services.gradle.org/distributions/gradle-8.4-all.zip 7 | -------------------------------------------------------------------------------- /.idea/dictionaries/itznotabug.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | appopenads 5 | darshan 6 | itznotabug 7 | lazygeniouz 8 | pandya 9 | 10 | 11 | -------------------------------------------------------------------------------- /app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | -------------------------------------------------------------------------------- /app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | -------------------------------------------------------------------------------- /app/src/main/res/drawable/splash.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 5 | 6 | 9 | 10 | -------------------------------------------------------------------------------- /app/src/main/res/values/colors.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | #FFBB86FC 4 | #FF6200EE 5 | #FF3700B3 6 | #FF03DAC5 7 | #FF018786 8 | #FF000000 9 | #FFFFFFFF 10 | -------------------------------------------------------------------------------- /aoa_manager/src/main/AndroidManifest.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /app/src/main/java/com/lazygeniouz/appopenads/activities/MainActivity.kt: -------------------------------------------------------------------------------- 1 | package com.lazygeniouz.appopenads.activities 2 | 3 | import android.app.Activity 4 | import android.os.Bundle 5 | import com.lazygeniouz.appopenads.R 6 | 7 | /** Sample App's Main Activity */ 8 | class MainActivity : Activity() { 9 | 10 | override fun onCreate(savedInstanceState: Bundle?) { 11 | super.onCreate(savedInstanceState) 12 | setContentView(R.layout.main) 13 | } 14 | 15 | override fun onBackPressed() { 16 | finish() 17 | } 18 | } -------------------------------------------------------------------------------- /.idea/misc.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 14 | -------------------------------------------------------------------------------- /app/src/main/res/layout/main.xml: -------------------------------------------------------------------------------- 1 | 2 | 8 | 9 | 16 | 17 | -------------------------------------------------------------------------------- /app/src/main/java/com/lazygeniouz/appopenads/AppJv.java: -------------------------------------------------------------------------------- 1 | package com.lazygeniouz.appopenads; 2 | 3 | import android.app.Application; 4 | 5 | import com.google.android.gms.ads.MobileAds; 6 | import com.lazygeniouz.aoa.AppOpenAdManager; 7 | 8 | /** 9 | * Sample App's Main Application 10 | * Java Version, not registered in the manifest. 11 | */ 12 | @SuppressWarnings({"unused", "RedundantSuppression"}) 13 | public class AppJv extends Application { 14 | 15 | @Override 16 | public void onCreate() { 17 | super.onCreate(); 18 | 19 | MobileAds.initialize(this); 20 | AppOpenAdManager manager = AppOpenAdManager.get(this); 21 | manager.loadAppOpenAd(); 22 | } 23 | } 24 | -------------------------------------------------------------------------------- /app/proguard-rules.pro: -------------------------------------------------------------------------------- 1 | # Add project specific ProGuard rules here. 2 | # You can control the set of applied configuration files using the 3 | # proguardFiles setting in build.gradle. 4 | # 5 | # For more details, see 6 | # http://developer.android.com/guide/developing/tools/proguard.html 7 | 8 | # If your project uses WebView with JS, uncomment the following 9 | # and specify the fully qualified class name to the JavaScript interface 10 | # class: 11 | #-keepclassmembers class fqcn.of.javascript.interface.for.webview { 12 | # public *; 13 | #} 14 | 15 | # Uncomment this to preserve the line number information for 16 | # debugging stack traces. 17 | #-keepattributes SourceFile,LineNumberTable 18 | 19 | # If you keep the line number information, uncomment this to 20 | # hide the original source file name. 21 | #-renamesourcefileattribute SourceFile -------------------------------------------------------------------------------- /aoa_manager/proguard-rules.pro: -------------------------------------------------------------------------------- 1 | # Add project specific ProGuard rules here. 2 | # You can control the set of applied configuration files using the 3 | # proguardFiles setting in build.gradle. 4 | # 5 | # For more details, see 6 | # http://developer.android.com/guide/developing/tools/proguard.html 7 | 8 | # If your project uses WebView with JS, uncomment the following 9 | # and specify the fully qualified class name to the JavaScript interface 10 | # class: 11 | #-keepclassmembers class fqcn.of.javascript.interface.for.webview { 12 | # public *; 13 | #} 14 | 15 | # Uncomment this to preserve the line number information for 16 | # debugging stack traces. 17 | #-keepattributes SourceFile,LineNumberTable 18 | 19 | # If you keep the line number information, uncomment this to 20 | # hide the original source file name. 21 | #-renamesourcefileattribute SourceFile -------------------------------------------------------------------------------- /gradle.properties: -------------------------------------------------------------------------------- 1 | org.gradle.jvmargs=-Xmx2048m -Dfile.encoding=UTF-8 2 | android.useAndroidX=true 3 | android.enableJetifier=true 4 | kotlin.code.style=official 5 | 6 | POM_PACKAGING=aar 7 | POM_NAME=aoa_manager 8 | POM_DESCRIPTION=A simple wrapper to handle the new AppOpenAds 9 | POM_INCEPTION_YEAR=2020 10 | POM_URL=https://github.com/ItzNotABug/AppOpenAdManager 11 | POM_SCM_URL=https://github.com/ItzNotABug/AppOpenAdManager 12 | POM_SCM_CONNECTION=scm:git@github.com:itznotabug/AppOpenAdManager.git 13 | POM_SCM_DEV_CONNECTION=scm:git@github.com:itznotabug/AppOpenAdManager.git 14 | 15 | POM_LICENCE_NAME=The Apache Software License, Version 2.0 16 | POM_LICENCE_URL=http://www.apache.org/licenses/LICENSE-2.0.txt 17 | POM_LICENCE_DIST=repo 18 | 19 | POM_DEVELOPER_ID=itznotabug 20 | POM_DEVELOPER_NAME=Darshan Pandya 21 | POM_DEVELOPER_URL=https://github.com/itznotabug -------------------------------------------------------------------------------- /aoa_manager/build.gradle: -------------------------------------------------------------------------------- 1 | plugins { 2 | id 'com.android.library' 3 | id 'com.vanniktech.maven.publish.base' 4 | id 'kotlin-android' 5 | } 6 | 7 | android { 8 | compileSdk 34 9 | namespace 'com.lazygeniouz.aoa' 10 | 11 | defaultConfig { 12 | minSdk 21 13 | targetSdk 34 14 | } 15 | 16 | buildTypes { 17 | release { 18 | minifyEnabled false 19 | proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro' 20 | } 21 | } 22 | 23 | compileOptions { 24 | sourceCompatibility JavaVersion.VERSION_17 25 | targetCompatibility JavaVersion.VERSION_17 26 | } 27 | } 28 | 29 | dependencies { 30 | implementation "androidx.lifecycle:lifecycle-process:2.7.0" 31 | implementation 'com.google.android.gms:play-services-ads:23.0.0' 32 | } -------------------------------------------------------------------------------- /.idea/gradle.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 22 | 23 | -------------------------------------------------------------------------------- /app/build.gradle: -------------------------------------------------------------------------------- 1 | plugins { 2 | id 'com.android.application' 3 | id 'kotlin-android' 4 | } 5 | 6 | android { 7 | compileSdkVersion 31 8 | 9 | defaultConfig { 10 | applicationId "com.lazygeniouz.appopenads" 11 | minSdkVersion 16 12 | targetSdkVersion 31 13 | versionCode 1 14 | versionName "1.0" 15 | } 16 | 17 | buildTypes { 18 | release { 19 | minifyEnabled false 20 | proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro' 21 | } 22 | } 23 | 24 | compileOptions { 25 | sourceCompatibility JavaVersion.VERSION_1_8 26 | targetCompatibility JavaVersion.VERSION_1_8 27 | } 28 | 29 | kotlinOptions { 30 | jvmTarget = '1.8' 31 | } 32 | } 33 | 34 | dependencies { 35 | 36 | api 'androidx.work:work-runtime:2.7.0' 37 | 38 | implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version" 39 | implementation 'com.google.android.gms:play-services-ads:20.4.0' 40 | implementation project(":library") 41 | } -------------------------------------------------------------------------------- /app/src/main/java/com/lazygeniouz/appopenads/activities/SplashActivity.kt: -------------------------------------------------------------------------------- 1 | package com.lazygeniouz.appopenads.activities 2 | 3 | import android.app.Activity 4 | import android.content.Intent 5 | import android.os.Bundle 6 | 7 | /** 8 | * Demonstrating the usage of [com.lazygeniouz.aoa.configs.Configs.showInActivities] 9 | * 10 | * We use this class to show the Ad only when the App is loaded from a hard cold start. 11 | * 12 | * The current AppOpenAd has the architecture to show Ad every-time 13 | * the [android.app.Application] starts, & sometimes, that is not what we want. 14 | * 15 | * So, the [com.lazygeniouz.aoa.configs.Configs.showInActivities] will only show the AppOpenAd 16 | * when the specified activity shows up in the stack. 17 | * 18 | * [SplashActivity] to show a Android Icon for App's cold start, 19 | * 20 | * Has a **noHistory** tag in Manifest for this Activity. 21 | */ 22 | class SplashActivity : Activity() { 23 | override fun onCreate(savedInstanceState: Bundle?) { 24 | super.onCreate(savedInstanceState) 25 | startActivity(Intent(this, MainActivity::class.java)) 26 | } 27 | } -------------------------------------------------------------------------------- /.idea/jarRepositories.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 9 | 10 | 14 | 15 | 19 | 20 | 24 | 25 | -------------------------------------------------------------------------------- /app/src/main/java/com/lazygeniouz/appopenads/AppKt.kt: -------------------------------------------------------------------------------- 1 | @file:Suppress("unused") 2 | 3 | package com.lazygeniouz.appopenads 4 | 5 | import android.app.Application 6 | import com.google.android.gms.ads.MobileAds 7 | import com.lazygeniouz.aoa.configs.Configs 8 | import com.lazygeniouz.aoa.extensions.getAppOpenAdManager 9 | import com.lazygeniouz.aoa.idelay.InitialDelay 10 | import com.lazygeniouz.aoa.listener.AppOpenAdListener 11 | import com.lazygeniouz.appopenads.activities.SplashActivity 12 | 13 | /** 14 | * Sample App's Main Application 15 | * Kotlin Version, registered in the Manifest. 16 | * */ 17 | class AppKt : Application() { 18 | 19 | override fun onCreate() { 20 | super.onCreate() 21 | 22 | MobileAds.initialize(this) 23 | getAppOpenAdManager( 24 | Configs( 25 | InitialDelay.NONE, 26 | showInActivities = arrayListOf(SplashActivity::class.java), 27 | ) 28 | ).setAppOpenAdListener(object : AppOpenAdListener() { 29 | override fun onAdShown() = println("AppOpenAdListener#onAdShown") 30 | override fun onAdLoaded() = println("AppOpenAdListener#onAdLoaded") 31 | override fun onAdWillShow() = println("AppOpenAdListener#onAdWillShow") 32 | }).loadAppOpenAd() 33 | } 34 | } -------------------------------------------------------------------------------- /aoa_manager/src/main/java/com/lazygeniouz/aoa/extensions/Extensions.kt: -------------------------------------------------------------------------------- 1 | @file:Suppress("unused") 2 | 3 | package com.lazygeniouz.aoa.extensions 4 | 5 | import android.app.Application 6 | import android.util.Log 7 | import com.lazygeniouz.aoa.AppOpenAdManager 8 | import com.lazygeniouz.aoa.configs.Configs 9 | 10 | internal const val TAG = "AppOpenAdManager" 11 | 12 | internal fun logDebug(message: Any) = Log.d(TAG, message.toString()) 13 | 14 | /** 15 | * Extension function to use [AppOpenAdManager.get] 16 | * directly in a class that extends the [Application] class 17 | * 18 | * @param configs Configurations for the AppOpenAd 19 | * @see Configs for more info. 20 | * 21 | * @return [AppOpenAdManager] 22 | */ 23 | fun Application.getAppOpenAdManager(configs: Configs = Configs.DEFAULT): AppOpenAdManager { 24 | return AppOpenAdManager.get(this, configs) 25 | } 26 | 27 | /** 28 | * Handy extension variable with default [Configs]. 29 | * 30 | * To customize the [Configs], use [Application.getAppOpenAdManager] extension function. 31 | * 32 | * **Note: This is not a singleton & will return a new instance everytime this is called, so be 33 | * careful!** 34 | * 35 | * @see [Configs] 36 | * @return [AppOpenAdManager] 37 | */ 38 | val Application.appOpenAdManager 39 | get() = AppOpenAdManager.get(this, Configs.DEFAULT) -------------------------------------------------------------------------------- /app/src/main/AndroidManifest.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 6 | 7 | 8 | 16 | 17 | 20 | 21 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | -------------------------------------------------------------------------------- /aoa_manager/src/main/java/com/lazygeniouz/aoa/listener/AppOpenAdListener.kt: -------------------------------------------------------------------------------- 1 | package com.lazygeniouz.aoa.listener 2 | 3 | import com.google.android.gms.ads.AdError 4 | import com.google.android.gms.ads.LoadAdError 5 | 6 | /** 7 | * Interface to listen to the AppOpenAd's events 8 | */ 9 | abstract class AppOpenAdListener { 10 | 11 | /** 12 | * Callback fired when the Ad is loaded & ready to be shown on the next app resume. 13 | */ 14 | open fun onAdLoaded() {} 15 | 16 | /** 17 | * AppOpenAd failed to load, see **loadAdError** for more info. 18 | * 19 | * @param loadAdError Contains info. as to what went wrong with loading Ad 20 | * @see LoadAdError 21 | */ 22 | open fun onAdFailedToLoad(loadAdError: LoadAdError) {} 23 | 24 | /** 25 | * Fired sometime before the Ad is shown 26 | * 27 | * The Ad will be shown after a delay of a 1000ms or the time provided 28 | * post this callback so that an action can be performed if needed before showing the Ad 29 | */ 30 | open fun onAdWillShow() {} 31 | 32 | /** 33 | * Fired when the AppOpenAd is shown 34 | */ 35 | open fun onAdShown() {} 36 | 37 | /** 38 | * Fired when the AppOpenAd is dismissed 39 | */ 40 | open fun onAdDismissed() {} 41 | 42 | /** 43 | * Fired when there was a problem showing AppOpenAd 44 | * @param error [AdError] that is passed on from the AppOpenAd's callback stating the reason 45 | */ 46 | open fun onAdShowFailed(error: AdError?) {} 47 | } -------------------------------------------------------------------------------- /aoa_manager/src/main/java/com/lazygeniouz/aoa/configs/Configs.kt: -------------------------------------------------------------------------------- 1 | package com.lazygeniouz.aoa.configs 2 | 3 | import android.app.Activity 4 | import com.google.android.gms.ads.AdRequest 5 | import com.google.android.gms.ads.appopen.AppOpenAd 6 | import com.lazygeniouz.aoa.AppOpenAdManager 7 | import com.lazygeniouz.aoa.idelay.InitialDelay 8 | 9 | /** 10 | * Bundle class to pass required data to [AppOpenAdManager] 11 | * 12 | * @param adUnitId Pass your created AdUnitId 13 | * @param initialDelay for setting up an Initial Delay 14 | * @param adRequest Pass a customised AdRequest if you have any 15 | * @param showOnColdStart Show Ad as soon as it load on the first Cold start if true, 16 | * this will ignore the Initial Activity irrespective of what is passed in the [showInActivities] 17 | * @param showOnCondition Show AppOpenAd only when a specific condition is met 18 | * @param showInActivities Show [AppOpenAd] only when the visible Activity is in this list 19 | * 20 | */ 21 | data class Configs @JvmOverloads constructor( 22 | val initialDelay: InitialDelay = InitialDelay(), 23 | val adUnitId: String = AppOpenAdManager.TEST_AD_UNIT_ID, 24 | val adRequest: AdRequest = AdRequest.Builder().build(), 25 | val showOnColdStart: (() -> Boolean)? = null, 26 | val showOnCondition: (() -> Boolean)? = null, 27 | val showInActivities: ArrayList>? = null, 28 | ) { 29 | companion object { 30 | 31 | /** 32 | * Should **only be used for testing** as the 33 | * default parameter values are not meant for Production use. 34 | */ 35 | @JvmField 36 | val DEFAULT = Configs() 37 | } 38 | } -------------------------------------------------------------------------------- /app/src/main/res/drawable-v24/ic_launcher_foreground.xml: -------------------------------------------------------------------------------- 1 | 7 | 8 | 9 | 15 | 18 | 21 | 22 | 23 | 24 | 30 | -------------------------------------------------------------------------------- /aoa_manager/src/main/java/com/lazygeniouz/aoa/idelay/InitialDelay.kt: -------------------------------------------------------------------------------- 1 | package com.lazygeniouz.aoa.idelay 2 | 3 | import com.lazygeniouz.aoa.extensions.logDebug 4 | import java.util.concurrent.TimeUnit 5 | 6 | /** 7 | * Allowing the developer to have an initial delay for showing the Ad after the app is first installed. 8 | * The InitialDelay class can pass on the information of initial delay. 9 | * 10 | * Default delay is set to 1 Day as it is a good practise to 11 | * allow the user to first explore the App & therefore 1 Day is fine. 12 | * Use InitialDelay.NONE for no Initial Delay. 13 | * @see InitialDelay.NONE 14 | * 15 | * @param delayCount Integer value used as initial delay 16 | * @param delayPeriodType Can either be "DelayType.HOUR" for Delay by X Hours, or "DelayType.DAYS" for Delay by X Days. 17 | * 18 | */ 19 | class InitialDelay( 20 | private val delayCount: Int = 1, 21 | internal val delayPeriodType: DelayType = DelayType.DAYS 22 | ) { 23 | init { 24 | // Zero is fine 25 | if (delayCount < 0) throw IllegalArgumentException("Delay Count cannot be Negative.") 26 | 27 | // Just a harmless warning message. 28 | if (delayPeriodType == DelayType.DAYS && delayCount > 2) logDebug( 29 | "You sure that the InitialDelay set by you is correct?" 30 | ) 31 | } 32 | 33 | 34 | internal fun getTime(): Long { 35 | val periodTypeToMillis = when (delayPeriodType) { 36 | DelayType.DAYS -> TimeUnit.DAYS.toMillis(1) 37 | DelayType.HOURS -> TimeUnit.HOURS.toMillis(1) 38 | DelayType.MINUTES -> TimeUnit.MINUTES.toMillis(1) 39 | DelayType.SECONDS -> TimeUnit.SECONDS.toMillis(1) 40 | else -> 0 41 | } 42 | return (delayCount * periodTypeToMillis) 43 | } 44 | 45 | companion object { 46 | @JvmField 47 | val NONE = InitialDelay(0, DelayType.NONE) 48 | } 49 | } -------------------------------------------------------------------------------- /aoa_manager/src/main/java/com/lazygeniouz/aoa/base/BaseObserver.kt: -------------------------------------------------------------------------------- 1 | package com.lazygeniouz.aoa.base 2 | 3 | import android.app.Activity 4 | import android.app.Application 5 | import android.os.Bundle 6 | 7 | /** 8 | * Base Observer class to identify the Current visible Activity 9 | * @param application Required to register Activity Lifecycle Callbacks 10 | * 11 | * We only need onActivityStarted, onActivityResumed & onActivityDestroyed 12 | * to track the Current visible Activity & therefore it was meaningless 13 | * to add all those abstract methods in a single class. 14 | * 15 | * Extended ahead by: 16 | * @see BaseAdManager 17 | */ 18 | open class BaseObserver(application: Application) : 19 | Application.ActivityLifecycleCallbacks { 20 | 21 | protected var currentActivity: Activity? = null 22 | 23 | init { 24 | // Cannot directly use `this` 25 | // Issue : Leaking 'this' in constructor of non-final class BaseObserver 26 | registerActivityLifecycleCallbacks(application) 27 | } 28 | 29 | private fun registerActivityLifecycleCallbacks(application: Application) { 30 | application.registerActivityLifecycleCallbacks(this) 31 | } 32 | 33 | override fun onActivityStarted(activity: Activity) { 34 | currentActivity = activity 35 | } 36 | 37 | override fun onActivityResumed(activity: Activity) { 38 | currentActivity = activity 39 | } 40 | 41 | override fun onActivityDestroyed(activity: Activity) { 42 | // this is required for [Configs.showOnColdStart] 43 | if (currentActivity?.javaClass?.simpleName.equals(activity.javaClass.simpleName)) { 44 | currentActivity = null 45 | } 46 | } 47 | 48 | override fun onActivityPaused(activity: Activity) {} 49 | override fun onActivityStopped(activity: Activity) {} 50 | override fun onActivitySaveInstanceState(activity: Activity, outState: Bundle) {} 51 | override fun onActivityCreated(activity: Activity, savedInstanceState: Bundle?) {} 52 | } -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @if "%DEBUG%" == "" @echo off 2 | @rem ########################################################################## 3 | @rem 4 | @rem Gradle startup script for Windows 5 | @rem 6 | @rem ########################################################################## 7 | 8 | @rem Set local scope for the variables with windows NT shell 9 | if "%OS%"=="Windows_NT" setlocal 10 | 11 | set DIRNAME=%~dp0 12 | if "%DIRNAME%" == "" set DIRNAME=. 13 | set APP_BASE_NAME=%~n0 14 | set APP_HOME=%DIRNAME% 15 | 16 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 17 | set DEFAULT_JVM_OPTS= 18 | 19 | @rem Find java.exe 20 | if defined JAVA_HOME goto findJavaFromJavaHome 21 | 22 | set JAVA_EXE=java.exe 23 | %JAVA_EXE% -version >NUL 2>&1 24 | if "%ERRORLEVEL%" == "0" goto init 25 | 26 | echo. 27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 28 | echo. 29 | echo Please set the JAVA_HOME variable in your environment to match the 30 | echo location of your Java installation. 31 | 32 | goto fail 33 | 34 | :findJavaFromJavaHome 35 | set JAVA_HOME=%JAVA_HOME:"=% 36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 37 | 38 | if exist "%JAVA_EXE%" goto init 39 | 40 | echo. 41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 42 | echo. 43 | echo Please set the JAVA_HOME variable in your environment to match the 44 | echo location of your Java installation. 45 | 46 | goto fail 47 | 48 | :init 49 | @rem Get command-line arguments, handling Windows variants 50 | 51 | if not "%OS%" == "Windows_NT" goto win9xME_args 52 | 53 | :win9xME_args 54 | @rem Slurp the command line arguments. 55 | set CMD_LINE_ARGS= 56 | set _SKIP=2 57 | 58 | :win9xME_args_slurp 59 | if "x%~1" == "x" goto execute 60 | 61 | set CMD_LINE_ARGS=%* 62 | 63 | :execute 64 | @rem Setup the command line 65 | 66 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 67 | 68 | @rem Execute Gradle 69 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% 70 | 71 | :end 72 | @rem End local scope for the variables with windows NT shell 73 | if "%ERRORLEVEL%"=="0" goto mainEnd 74 | 75 | :fail 76 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 77 | rem the _cmd.exe /c_ return code! 78 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 79 | exit /b 1 80 | 81 | :mainEnd 82 | if "%OS%"=="Windows_NT" endlocal 83 | 84 | :omega 85 | -------------------------------------------------------------------------------- /Readme.md: -------------------------------------------------------------------------------- 1 | # AppOpenAdManager 2 | 3 | [![Codacy Badge](https://api.codacy.com/project/badge/Grade/af51d9b73c4544cca0be5e0af1b2669c)](https://app.codacy.com/gh/ItzNotABug/AppOpenAdManager?utm_source=github.com&utm_medium=referral&utm_content=ItzNotABug/AppOpenAdManager&utm_campaign=Badge_Grade) 4 | 5 | `AppOpenAdManager` is just a simple wrapper to handle the new `AppOpenAd` Format by **Google AdMob**.\ 6 | If you look at the [tutorial](https://developers.google.com/admob/android/app-open-ads), you'll see the detailed guide to create a `Helper Class` to manage `AppOpenAd`. 7 | 8 | ## Dependency 9 | **Gradle:** 10 | ```groovy 11 | implementation 'com.lazygeniouz:aoa_manager:$latest_version' 12 | ``` 13 | 14 | ## Usage 15 | ```kotlin 16 | val configs = Configs(InitialDelay.NONE, adUnitId, adRequest, showInActivity) 17 | val adManager = AppOpenAdManager.get(application, configs) 18 | adManager.setAppOpenAdListener(appOpenAdlistener) 19 | adManager.setAdTransition(R.anim.enterAnim, R.anim.exitAnim) 20 | adManager.setOnPaidEventListener(paidEventListener) 21 | adManager.showAdWithDelay(false) 22 | adManager.setImmersiveMode(true) 23 | adManager.loadAppOpenAd() 24 | ``` 25 | 26 | The arguments for the static method `get` are: 27 | * `@NonNull application: Application`\ 28 | Your class extending `android.app.Application` 29 | 30 | * `@NonNull configs: Configs` (Optional)\ 31 | You can pass a `Configs` object which is a `data` class to pass relevant options.\ 32 | Relevant options are: 33 | * `@NonNull initialDelay: InitialDelay`\ 34 | You can specify an **Initial Delay** to load & display the Ad for **the first time**.\ 35 | If you do not need a delay, simple pass `InitialDelay.NONE`\ 36 | But it is a good practise to allow the user to first explore the App &\ 37 | therefore 1 Day should be fine which is also the Default if you pass `InitialDelay()` 38 | 39 | * `adUnitId: String`\ 40 | Your `adUnitId`\ 41 | (Optional for Testing) Default is a Test AdUnitId 42 | 43 | * `adRequest: AdRequest`\ 44 | (Optional) If you have a customised AdRequest 45 | 46 | * `showOnColdStart: Boolean`\ 47 | (Optional) Show Ad as soon as it load on the first Cold start if true, 48 | this will ignore the Activities passed in the [showInActivities] 49 | 50 | * `showOnCondition: (() -> Boolean)`\ 51 | (Optional) Show the AppOpenAd only when a specific condition is met. 52 | AppOpenAd will be shown only when this block returns `true`. 53 | 54 | * `showInActivities: Class`\ 55 | (Optional) If you want to show the Ad only in specific Activities (e.g: SplashActivity).\ 56 | See: [this issue](https://github.com/ItzNotABug/AppOpenAdManager/issues/5) & the Example App for more info. 57 | 58 | Other available methods: 59 | * `getAppOpenAd: AppOpenAd?`: Returns the `AppOpenAd` instance, can be null. 60 | 61 | * `clearAdInstance(): Unit`: Sets the `AppOpenAd` instance to `null` if it is not. 62 | 63 | * `isAdAvailable(): Boolean`: Returns `true` if a valid `AppOpenAd` is available 64 | 65 | * `setImmersiveMode(Boolean): Unit`: Sets whether to show the `AdOpenAd` in immersive mode. 66 | 67 | * `showAdWithDelay(Boolean): Unit`: Delays showing the `AdOpenAd` by 1 second if true. 68 | 69 | * `showAdWithDelay(Long): Unit`: Delays showing the `AdOpenAd` by the provided time in milliseconds. 70 | 71 | * `setAdTransition(Int, Int): Unit`: Use an activity animation when the Ad is shown, similar to 72 | `Activity.overridePendingTransition` or `Activity.overrideActivityTransition`. 73 | 74 | * `getAdListener(): AppOpenAdListener?`: Returns the currently set Ad Listener, can be null. 75 | 76 | * `setAppOpenAdListener(listener: AppOpenAdListener)`:\ 77 | There are several callbacks with respect to the AppOpenAd. 78 | * `onAdLoaded()` = Invoked when the Ad is loaded successfully. 79 | * `onAdFailedToLoad(LoadAdError)` = Invoked when the Ad failed to load with supplied LoadAdError. 80 | * `onAdWillShow()` = Invoked before the Ad is shown, a default delay of 1000ms or value provided. 81 | * `onAdShown()` = Invoked when the Ad is shown 82 | * `onAdDismissed()` = Invoked after the Ad is dismissed from the screen 83 | * `onAdShowFailed(AdError)` = Invoked when there was an error showing the Ad with supplied AdError 84 | 85 | * `setOnPaidEventListener(listener: OnPaidEventListener)`: 86 | * `onPaidEvent(AdValue)` = Called when an ad is estimated to have earned money. 87 | * `AdValue` = Contains information about the monetary value earned from an ad. 88 | 89 | * `getPaidEventListener(): OnPaidEventListener?`: Returns the currently set Ad's PaidEventListener, can be null.. 90 | -------------------------------------------------------------------------------- /.idea/codeStyles/Project.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 11 | 20 | 22 | 23 | 135 | 136 | 138 | 139 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | 3 | ############################################################################## 4 | ## 5 | ## Gradle start up script for UN*X 6 | ## 7 | ############################################################################## 8 | 9 | # Attempt to set APP_HOME 10 | # Resolve links: $0 may be a link 11 | PRG="$0" 12 | # Need this for relative symlinks. 13 | while [ -h "$PRG" ] ; do 14 | ls=`ls -ld "$PRG"` 15 | link=`expr "$ls" : '.*-> \(.*\)$'` 16 | if expr "$link" : '/.*' > /dev/null; then 17 | PRG="$link" 18 | else 19 | PRG=`dirname "$PRG"`"/$link" 20 | fi 21 | done 22 | SAVED="`pwd`" 23 | cd "`dirname \"$PRG\"`/" >/dev/null 24 | APP_HOME="`pwd -P`" 25 | cd "$SAVED" >/dev/null 26 | 27 | APP_NAME="Gradle" 28 | APP_BASE_NAME=`basename "$0"` 29 | 30 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 31 | DEFAULT_JVM_OPTS="" 32 | 33 | # Use the maximum available, or set MAX_FD != -1 to use that value. 34 | MAX_FD="maximum" 35 | 36 | warn () { 37 | echo "$*" 38 | } 39 | 40 | die () { 41 | echo 42 | echo "$*" 43 | echo 44 | exit 1 45 | } 46 | 47 | # OS specific support (must be 'true' or 'false'). 48 | cygwin=false 49 | msys=false 50 | darwin=false 51 | nonstop=false 52 | case "`uname`" in 53 | CYGWIN* ) 54 | cygwin=true 55 | ;; 56 | Darwin* ) 57 | darwin=true 58 | ;; 59 | MINGW* ) 60 | msys=true 61 | ;; 62 | NONSTOP* ) 63 | nonstop=true 64 | ;; 65 | esac 66 | 67 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 68 | 69 | # Determine the Java command to use to start the JVM. 70 | if [ -n "$JAVA_HOME" ] ; then 71 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 72 | # IBM's JDK on AIX uses strange locations for the executables 73 | JAVACMD="$JAVA_HOME/jre/sh/java" 74 | else 75 | JAVACMD="$JAVA_HOME/bin/java" 76 | fi 77 | if [ ! -x "$JAVACMD" ] ; then 78 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 79 | 80 | Please set the JAVA_HOME variable in your environment to match the 81 | location of your Java installation." 82 | fi 83 | else 84 | JAVACMD="java" 85 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 86 | 87 | Please set the JAVA_HOME variable in your environment to match the 88 | location of your Java installation." 89 | fi 90 | 91 | # Increase the maximum file descriptors if we can. 92 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then 93 | MAX_FD_LIMIT=`ulimit -H -n` 94 | if [ $? -eq 0 ] ; then 95 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 96 | MAX_FD="$MAX_FD_LIMIT" 97 | fi 98 | ulimit -n $MAX_FD 99 | if [ $? -ne 0 ] ; then 100 | warn "Could not set maximum file descriptor limit: $MAX_FD" 101 | fi 102 | else 103 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 104 | fi 105 | fi 106 | 107 | # For Darwin, add options to specify how the application appears in the dock 108 | if $darwin; then 109 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 110 | fi 111 | 112 | # For Cygwin, switch paths to Windows format before running java 113 | if $cygwin ; then 114 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 115 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 116 | JAVACMD=`cygpath --unix "$JAVACMD"` 117 | 118 | # We build the pattern for arguments to be converted via cygpath 119 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 120 | SEP="" 121 | for dir in $ROOTDIRSRAW ; do 122 | ROOTDIRS="$ROOTDIRS$SEP$dir" 123 | SEP="|" 124 | done 125 | OURCYGPATTERN="(^($ROOTDIRS))" 126 | # Add a user-defined pattern to the cygpath arguments 127 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 128 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 129 | fi 130 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 131 | i=0 132 | for arg in "$@" ; do 133 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 134 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 135 | 136 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 137 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 138 | else 139 | eval `echo args$i`="\"$arg\"" 140 | fi 141 | i=$((i+1)) 142 | done 143 | case $i in 144 | (0) set -- ;; 145 | (1) set -- "$args0" ;; 146 | (2) set -- "$args0" "$args1" ;; 147 | (3) set -- "$args0" "$args1" "$args2" ;; 148 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;; 149 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 150 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 151 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 152 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 153 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 154 | esac 155 | fi 156 | 157 | # Escape application args 158 | save () { 159 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done 160 | echo " " 161 | } 162 | APP_ARGS=$(save "$@") 163 | 164 | # Collect all arguments for the java command, following the shell quoting and substitution rules 165 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" 166 | 167 | # by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong 168 | if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then 169 | cd "$(dirname "$0")" 170 | fi 171 | 172 | exec "$JAVACMD" "$@" 173 | -------------------------------------------------------------------------------- /app/src/main/res/drawable/ic_launcher_background.xml: -------------------------------------------------------------------------------- 1 | 2 | 7 | 10 | 15 | 20 | 25 | 30 | 35 | 40 | 45 | 50 | 55 | 60 | 65 | 70 | 75 | 80 | 85 | 90 | 95 | 100 | 105 | 110 | 115 | 120 | 125 | 130 | 135 | 140 | 145 | 150 | 155 | 160 | 165 | 170 | 171 | -------------------------------------------------------------------------------- /aoa_manager/src/main/java/com/lazygeniouz/aoa/base/BaseAdManager.kt: -------------------------------------------------------------------------------- 1 | package com.lazygeniouz.aoa.base 2 | 3 | import android.app.Application 4 | import android.content.Context 5 | import android.content.SharedPreferences 6 | import android.os.Build 7 | import androidx.lifecycle.Lifecycle 8 | import androidx.lifecycle.LifecycleEventObserver 9 | import androidx.lifecycle.LifecycleOwner 10 | import androidx.lifecycle.ProcessLifecycleOwner 11 | import com.google.android.gms.ads.AdRequest 12 | import com.google.android.gms.ads.FullScreenContentCallback 13 | import com.google.android.gms.ads.LoadAdError 14 | import com.google.android.gms.ads.OnPaidEventListener 15 | import com.google.android.gms.ads.appopen.AppOpenAd 16 | import com.lazygeniouz.aoa.AppOpenAdManager 17 | import com.lazygeniouz.aoa.AppOpenAdManager.Companion.TEST_AD_UNIT_ID 18 | import com.lazygeniouz.aoa.configs.Configs 19 | import com.lazygeniouz.aoa.idelay.InitialDelay 20 | import com.lazygeniouz.aoa.listener.AppOpenAdListener 21 | import java.time.Instant 22 | import java.util.* 23 | import java.util.concurrent.TimeUnit 24 | 25 | /** 26 | * A Base class that extends [BaseObserver] to handle Activity Lifecycle. 27 | * 28 | * This class is created to declare a few helper methods and variables, 29 | * so that our main usable class does not have a lot of methods and variables. 30 | * @see com.lazygeniouz.aoa.AppOpenAdManager 31 | */ 32 | abstract class BaseAdManager( 33 | private val application: Application, 34 | private val configs: Configs 35 | ) : BaseObserver(application), 36 | LifecycleEventObserver { 37 | 38 | init { 39 | initPrefs() 40 | addProcessObserver() 41 | } 42 | 43 | /** 44 | * Why is this required? 45 | * Example: When the user initially starts the app, it will hit **ON_RESUME**, 46 | * and suppose the app then asks for some sort of Runtime Permission then after that, 47 | * the app will hit the **ON_RESUME** again, which will trigger the lifecycle callback 48 | * & that will **load** / **show** the Ad which is not what a user would like. 49 | * 50 | * So we limit the ad loading in the **ON_RESUME** callback until the user has manually, 51 | * at-least once, has called the [AppOpenAdManager.loadAppOpenAd] method. 52 | */ 53 | protected var isManuallyCalled = false 54 | private lateinit var sharedPreferences: SharedPreferences 55 | 56 | // Callbacks 57 | protected var listener: AppOpenAdListener? = null 58 | protected var adPaidEventListener: OnPaidEventListener? = null 59 | 60 | protected var isImmersive: Boolean = false 61 | protected var adShowDelayPeriod: Long = 1000 62 | protected var coldShowListener: (() -> Unit)? = null 63 | protected var adEnterTransition: Pair = 0 to 0 64 | 65 | protected var isLoading = false 66 | protected var isShowingAd = false 67 | protected var coldStartShown = false 68 | 69 | @Volatile 70 | protected var appOpenAdInstance: AppOpenAd? = null 71 | protected val loadCallback: AppOpenAd.AppOpenAdLoadCallback = 72 | object : AppOpenAd.AppOpenAdLoadCallback() { 73 | override fun onAdLoaded(loadedAd: AppOpenAd) { 74 | loadTime = getCurrentTime() 75 | 76 | // set listeners and other options 77 | loadedAd.setImmersiveMode(isImmersive) 78 | loadedAd.onPaidEventListener = adPaidEventListener 79 | loadedAd.fullScreenContentCallback = getFullScreenCallback() 80 | appOpenAdInstance = loadedAd 81 | 82 | if (!coldStartShown 83 | && isInitialDelayOver() 84 | && configs.showOnColdStart?.invoke() == true 85 | ) { 86 | coldShowListener?.invoke() 87 | coldStartShown = true 88 | } 89 | 90 | listener?.onAdLoaded() 91 | isLoading = false 92 | } 93 | 94 | override fun onAdFailedToLoad(loadError: LoadAdError) { 95 | isLoading = false 96 | listener?.onAdFailedToLoad(loadError) 97 | } 98 | } 99 | 100 | protected var adUnitId: String = TEST_AD_UNIT_ID 101 | protected var initialDelay: InitialDelay = InitialDelay() 102 | protected var adRequest: AdRequest = AdRequest.Builder().build() 103 | 104 | protected fun getApplication(): Application = application 105 | 106 | // SharedPreferences keep a better track 107 | protected var loadTime: Long 108 | get() = sharedPreferences.getLong("lastTime", 0) 109 | set(value) = sharedPreferences.edit() 110 | .putLong("lastTime", value) 111 | .apply() 112 | 113 | private fun addProcessObserver() { 114 | ProcessLifecycleOwner.get().lifecycle.addObserver(this@BaseAdManager) 115 | } 116 | 117 | private fun initPrefs() { 118 | val settingsName = "appOpenAdsManager" 119 | // A few cases had multi-threading in use, so lazy getValue always returned null. 120 | sharedPreferences = application.getSharedPreferences(settingsName, Context.MODE_PRIVATE) 121 | } 122 | 123 | /** 124 | * `onResume` will be fired when the lifecycle event for **ON_RESUME** is triggered. 125 | */ 126 | abstract fun onResume() 127 | 128 | abstract fun getFullScreenCallback(): FullScreenContentCallback 129 | 130 | /** 131 | * State observer callback to handle relevant operations. 132 | */ 133 | override fun onStateChanged(source: LifecycleOwner, event: Lifecycle.Event) { 134 | if (event == Lifecycle.Event.ON_RESUME) onResume() 135 | if (event == Lifecycle.Event.ON_START && initialDelay != InitialDelay.NONE) saveInitialDelayTime() 136 | } 137 | 138 | /** 139 | * There's a platform issue on Android 8/8.1 when using `Date().time` 140 | * 141 | * Details: [https://itznotabug.dev/blog/short_standard_assertion_error/] 142 | */ 143 | protected fun getCurrentTime(): Long { 144 | return if (Build.VERSION.SDK_INT < Build.VERSION_CODES.O) Date().time 145 | else Instant.now().toEpochMilli() 146 | } 147 | 148 | private fun saveInitialDelayTime() { 149 | val initialDelayKey = "savedDelay" 150 | val savedDelay = sharedPreferences.getLong(initialDelayKey, 0L) 151 | if (savedDelay != 0L) return 152 | sharedPreferences.edit() 153 | .putLong(initialDelayKey, getCurrentTime()) 154 | .apply() 155 | } 156 | 157 | /** 158 | * The documentation says that the Ads are only cached for 4 Hours. 159 | * 160 | * [https://developers.google.com/admob/android/app-open#expiration] 161 | */ 162 | private fun notLongerThanFourHours(): Boolean { 163 | val dateDifference = getCurrentTime() - loadTime 164 | val fourHours: Long = TimeUnit.HOURS.toMillis(4) 165 | return dateDifference < fourHours 166 | } 167 | 168 | /** 169 | * Returns `true` if an Ad is available & valid, `false` otherwise. 170 | */ 171 | protected fun isAdAvailableInternal(): Boolean { 172 | return (appOpenAdInstance != null) && notLongerThanFourHours() 173 | } 174 | 175 | /** 176 | * Difference = Current Time `minus` Saved Time, 177 | * 178 | * therefore difference >= duration.getTime() 179 | */ 180 | protected fun isInitialDelayOver(): Boolean { 181 | val savedDelay = sharedPreferences.getLong("savedDelay", 0L) 182 | // Zero means first load & it shouldn't be marked as ad available, 183 | // so we flag that as well as a false value boolean for this specific condition. 184 | return if (initialDelay == InitialDelay.NONE) (getCurrentTime() - savedDelay) >= initialDelay.getTime() 185 | else savedDelay != 0L && (getCurrentTime() - savedDelay) >= initialDelay.getTime() 186 | } 187 | } -------------------------------------------------------------------------------- /aoa_manager/src/main/java/com/lazygeniouz/aoa/AppOpenAdManager.kt: -------------------------------------------------------------------------------- 1 | package com.lazygeniouz.aoa 2 | 3 | import android.app.Activity 4 | import android.app.Application 5 | import android.os.Build 6 | import android.os.Handler 7 | import com.google.android.gms.ads.AdError 8 | import com.google.android.gms.ads.FullScreenContentCallback 9 | import com.google.android.gms.ads.OnPaidEventListener 10 | import com.google.android.gms.ads.appopen.AppOpenAd 11 | import com.lazygeniouz.aoa.base.BaseAdManager 12 | import com.lazygeniouz.aoa.configs.Configs 13 | import com.lazygeniouz.aoa.extensions.logDebug 14 | import com.lazygeniouz.aoa.idelay.DelayType 15 | import com.lazygeniouz.aoa.listener.AppOpenAdListener 16 | 17 | /** 18 | * [AppOpenAdManager]: A class that handles all of the App Open Ad operations. 19 | * @param application Required to keep a track of App's state. 20 | * @param configs A Data class to pass required arguments. 21 | */ 22 | @Suppress("unused") 23 | class AppOpenAdManager private constructor( 24 | application: Application, 25 | private val configs: Configs 26 | ) : BaseAdManager(application, configs) { 27 | 28 | init { 29 | unpackConfigs() 30 | attachColdStartListener() 31 | } 32 | 33 | /** 34 | * Returns true if an **AppOpenAd** is available 35 | */ 36 | @Suppress("MemberVisibilityCanBePrivate") 37 | fun isAdAvailable(): Boolean { 38 | return !isShowingAd && isAdAvailableInternal() && isInitialDelayOver() 39 | } 40 | 41 | /** 42 | * Can be used to manually remove the Ad if you cannot directly use the [Configs.showOnCondition] 43 | */ 44 | fun clearAdInstance() { 45 | appOpenAdInstance = null 46 | } 47 | 48 | /** 49 | * Load Ad & optionally attach a listener. 50 | */ 51 | fun loadAppOpenAd() { 52 | logDebug("AppOpenAdManager#loadAppOpenAd, Is InitialDelay Over: ${isInitialDelayOver()}") 53 | if (!isInitialDelayOver()) return 54 | fetchAd() 55 | isManuallyCalled = true 56 | } 57 | 58 | /** 59 | * Assign a listener to observe AppOpenAd events. 60 | * @param adListener An optional listener if you want to listen to the Ad's visibility events 61 | */ 62 | fun setAppOpenAdListener(adListener: AppOpenAdListener) = apply { 63 | if (listener == null) this.listener = adListener 64 | } 65 | 66 | /** 67 | * Assign a listener to observe if the AppOpenAd earned any money. 68 | * @param paidListener An optional listener if you want to observe Ad's monetary values. 69 | */ 70 | fun setOnPaidEventListener(paidListener: OnPaidEventListener) = apply { 71 | if (adPaidEventListener == null) this.adPaidEventListener = paidListener 72 | } 73 | 74 | /** 75 | * Sets a flag that controls if this app open ad object will be displayed in immersive mode. 76 | * 77 | * During show time, if this flag is on and immersive mode is supported, 78 | * `SYSTEM_UI_FLAG_IMMERSIVE_STICKY` & `SYSTEM_UI_FLAG_HIDE_NAVIGATION` will be turned on for the app open ad. 79 | */ 80 | fun setImmersiveMode(isImmersiveMode: Boolean) { 81 | this.isImmersive = isImmersiveMode 82 | } 83 | 84 | /** 85 | * Use an activity animation when the Ad is shown, 86 | * similar to [Activity.overridePendingTransition] or [Activity.overrideActivityTransition]. 87 | */ 88 | fun setAdTransition(enterAnim: Int, exitAnim: Int) { 89 | this.adEnterTransition = enterAnim to exitAnim 90 | } 91 | 92 | /** 93 | * Set a delay for showing the AppOpenAd. 94 | * 95 | * The [AppOpenAdListener.onAdWillShow] will be invoked 96 | * before [AppOpenAdListener.onAdShown] with a default delay of 1 second. 97 | * 98 | * @param useDelay Use a delay of 1 second for showing the Ad if true 99 | */ 100 | fun showAdWithDelay(useDelay: Boolean) { 101 | // 1 second 102 | if (useDelay) this.adShowDelayPeriod = 1000 103 | else adShowDelayPeriod = 0 104 | } 105 | 106 | /** 107 | * Set a custom delay for showing the AppOpenAd. 108 | * 109 | * The [AppOpenAdListener.onAdWillShow] will be invoked 110 | * before [AppOpenAdListener.onAdShown] with a delay of provided time in milliseconds. 111 | * 112 | * @param timeInMillis Use a custom delay in milliseconds for delaying the Ad showing. 113 | */ 114 | fun showAdWithDelay(timeInMillis: Long) { 115 | this.adShowDelayPeriod = timeInMillis 116 | } 117 | 118 | /** 119 | * Returns the [AppOpenAd] instance, can be **null** if it is not loaded yet. 120 | * 121 | * **Note:** If you manually use `getAppOpenAd().show(activity)`, 122 | * then the [setAdTransition] will not work but you may also use 123 | * [Activity.overridePendingTransition] or [Activity.overrideActivityTransition]. 124 | * @return [AppOpenAd] 125 | */ 126 | fun getAppOpenAd(): AppOpenAd? { 127 | return appOpenAdInstance 128 | } 129 | 130 | /** 131 | * Returns the currently set Ad Listener, can be **null**. 132 | * @return [AppOpenAdListener] 133 | */ 134 | fun getAdListener(): AppOpenAdListener? { 135 | return this.listener 136 | } 137 | 138 | /** 139 | * Returns the currently set Ad's **PaidEventListener**, can be **null**. 140 | * @return [OnPaidEventListener] 141 | */ 142 | fun getPaidEventListener(): OnPaidEventListener? { 143 | return this.adPaidEventListener 144 | } 145 | 146 | override fun onResume() { 147 | if (!isManuallyCalled) return 148 | else { 149 | isManuallyCalled = true 150 | showAdIfAvailable() 151 | } 152 | } 153 | 154 | private fun unpackConfigs() = apply { 155 | adUnitId = configs.adUnitId 156 | adRequest = configs.adRequest 157 | initialDelay = configs.initialDelay 158 | } 159 | 160 | private fun attachColdStartListener() = apply { coldShowListener = { showAd() } } 161 | 162 | // Let's fetch the Ad 163 | private fun fetchAd() { 164 | if (isAdAvailable()) return 165 | loadAd() 166 | } 167 | 168 | // Show the Ad if the conditions are met. 169 | private fun showAdIfAvailable() { 170 | if (isAdAvailable()) { 171 | // Show Ad Conditionally, 172 | // If the passed activity class equals to the current activity, then show the Ad. 173 | if (configs.showInActivities != null) { 174 | if (currentActivity != null) { 175 | val activity = currentActivity!! 176 | if (activity.javaClass in configs.showInActivities) showAd() 177 | else logDebug("Current Activity (${activity.javaClass.simpleName}) not included in the Activity List provided in Configs.showInActivities") 178 | } else logDebug("Current Activity is @null, strange! *_*") 179 | } else showAd() 180 | } else { 181 | if (!isInitialDelayOver()) logDebug("The Initial Delay period is not over yet.") 182 | else { 183 | 184 | /** 185 | * If the next session happens after the delay period is over 186 | * & under 4 Hours, we can show a cached Ad. 187 | * However this will only work for DelayType.HOURS. 188 | */ 189 | if (initialDelay.delayPeriodType != DelayType.DAYS || 190 | initialDelay.delayPeriodType == DelayType.DAYS && 191 | isInitialDelayOver() 192 | ) fetchAd() 193 | } 194 | } 195 | } 196 | 197 | private fun showAd() { 198 | appOpenAdInstance?.let { appOpenAd -> 199 | if (configs.showOnCondition?.invoke() == false) { 200 | logDebug("Configs.showOnCondition lambda returned false, Ad will not be shown") 201 | return@let 202 | } 203 | 204 | currentActivity?.let { activity -> 205 | if (adShowDelayPeriod > 0L) { 206 | listener?.onAdWillShow() 207 | Handler(activity.mainLooper).postDelayed({ 208 | appOpenAd.show(activity) 209 | applyAdEnterTransition(activity) 210 | }, this.adShowDelayPeriod) 211 | } else { 212 | appOpenAd.show(activity) 213 | applyAdEnterTransition(activity) 214 | } 215 | } 216 | } 217 | } 218 | 219 | private fun applyAdEnterTransition(activity: Activity) { 220 | if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.UPSIDE_DOWN_CAKE) { 221 | activity.overrideActivityTransition( 222 | Activity.OVERRIDE_TRANSITION_OPEN, 223 | adEnterTransition.first, adEnterTransition.second 224 | ) 225 | } else { 226 | @Suppress("deprecation") 227 | activity.overridePendingTransition(adEnterTransition.first, adEnterTransition.second) 228 | } 229 | } 230 | 231 | private fun loadAd() { 232 | if (isLoading) return 233 | else isLoading = true 234 | 235 | // this is good for informing the user :) 236 | if (adUnitId == TEST_AD_UNIT_ID) 237 | logDebug("Current adUnitId is a Test Ad Unit Id, make sure to replace with yours in Production.") 238 | 239 | AppOpenAd.load(getApplication(), adUnitId, adRequest, loadCallback).also { 240 | logDebug("A pre-cached Ad was not available, loading one.") 241 | } 242 | } 243 | 244 | // Handling the visibility of the AppOpenAd 245 | override fun getFullScreenCallback(): FullScreenContentCallback { 246 | return object : FullScreenContentCallback() { 247 | override fun onAdDismissedFullScreenContent() { 248 | listener?.onAdDismissed() 249 | appOpenAdInstance = null 250 | isShowingAd = false 251 | fetchAd() 252 | } 253 | 254 | override fun onAdFailedToShowFullScreenContent(adError: AdError) { 255 | listener?.onAdShowFailed(adError) 256 | } 257 | 258 | override fun onAdShowedFullScreenContent() { 259 | listener?.onAdShown() 260 | isShowingAd = true 261 | } 262 | } 263 | } 264 | 265 | companion object { 266 | /** 267 | * The ad unit used for testing. 268 | */ 269 | const val TEST_AD_UNIT_ID = "ca-app-pub-3940256099942544/9257395921" 270 | 271 | /** 272 | * [get]: A static function that returns an instance of [AppOpenAdManager]. 273 | * @param application To initialize the AppOpenAd & keep a track of App's state. 274 | * @param configs A Data class to pass required arguments. 275 | */ 276 | @JvmStatic 277 | @JvmOverloads 278 | fun get( 279 | application: Application, 280 | configs: Configs = Configs.DEFAULT, 281 | ): AppOpenAdManager { 282 | return AppOpenAdManager(application, configs) 283 | } 284 | } 285 | } -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------