Added support to the functions to cache ads manually

Author: vegidio

CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.3.0
+
+* Added support to the functions to cache ads manually.
+* Renamed the function `isLoaded()` to `isReadyForShow()`.
+
 ## 0.2.3
 
 * Small improvements and fixed some typos in the documentation.

android/src/main/kotlin/io/vinicius/appodeal_flutter/AppodealFlutterPlugin.kt

@@ -37,7 +37,9 @@ class AppodealFlutterPlugin : FlutterPlugin, MethodCallHandler, ActivityAware
     override fun onMethodCall(@NonNull call: MethodCall, @NonNull result: Result) {
         when (call.method) {
             "initialize" -> initialize(call, result)
-            "isLoaded" -> isLoaded(call, result)
+            "setAutoCache" -> setAutoCache(call, result)
+            "cache" -> cache(call, result)
+            "isReadyForShow" -> isReadyForShow(call, result)
             "show" -> show(activity, call, result)
 
             "fetchConsentInfo" -> fetchConsentInfo(call, result)
@@ -83,7 +85,24 @@ class AppodealFlutterPlugin : FlutterPlugin, MethodCallHandler, ActivityAware
         result.success(null)
     }
 
-    private fun isLoaded(call: MethodCall, result: Result) {
+    private fun setAutoCache(call: MethodCall, result: Result) {
+        val args = call.arguments as Map<*, *>
+        val adType = getAdType(args["adType"] as Int)
+        val autoCache = args["autoCache"] as Boolean
+
+        Appodeal.setAutoCache(adType, autoCache)
+        result.success(null)
+    }
+
+    private fun cache(call: MethodCall, result: Result) {
+        val args = call.arguments as Map<*, *>
+        val adType = getAdType(args["adType"] as Int)
+
+        Appodeal.cache(activity, adType)
+        result.success(null)
+    }
+
+    private fun isReadyForShow(call: MethodCall, result: Result) {
         val args = call.arguments as Map<*, *>
         val adType = getAdType(args["adType"] as Int)
 

example/lib/main.dart

@@ -32,6 +32,9 @@ class _MyAppState extends State<MyApp> {
 
     // Request authorization to track the user
     Appodeal.requestIOSTrackingAuthorization().then((_) async {
+      // Set interstitial ads to be cached manually
+      await Appodeal.setAutoCache(AdType.INTERSTITIAL, false);
+
       // Initialize Appodeal after the authorization was granted or not
       await Appodeal.initialize(
         hasConsent: true,
@@ -96,14 +99,21 @@ class _Body extends StatelessWidget {
             ),
 
             RaisedButton(
-              child: Text('Check: Is Interstitial Ad loaded?'),
+              child: Text('Is Interstitial Ad ready for show?'),
               onPressed: () async {
-                var isLoaded = await Appodeal.isLoaded(AdType.INTERSTITIAL);
-                Toast.show(isLoaded ? 'Interstitial ad is loaded' : 'Interstitial ad is NOT loaded', context,
+                var isReady = await Appodeal.isReadyForShow(AdType.INTERSTITIAL);
+                Toast.show(isReady ? 'Interstitial ad is ready' : 'Interstitial ad is NOT ready', context,
                     duration: Toast.LENGTH_LONG, gravity: Toast.BOTTOM);
               },
             ),
 
+            RaisedButton(
+              child: Text('Cache Interstitial Ad'),
+              onPressed: () async {
+                await Appodeal.cache(AdType.INTERSTITIAL);
+              },
+            ),
+
             RaisedButton(
               child: Text('Show Interstitial Ad'),
               onPressed: () async {
@@ -112,10 +122,10 @@ class _Body extends StatelessWidget {
             ),
 
             RaisedButton(
-              child: Text('Check: Is Reward Ad loaded?'),
+              child: Text('Is Reward Ad ready for show?'),
               onPressed: () async {
-                var isLoaded = await Appodeal.isLoaded(AdType.REWARD);
-                Toast.show(isLoaded ? 'Reward ad is loaded' : 'Reward ad is NOT loaded', context,
+                var isReady = await Appodeal.isReadyForShow(AdType.REWARD);
+                Toast.show(isReady ? 'Reward ad is ready' : 'Reward ad is NOT ready', context,
                     duration: Toast.LENGTH_LONG, gravity: Toast.BOTTOM);
               },
             ),
@@ -129,10 +139,10 @@ class _Body extends StatelessWidget {
             ),
 
             RaisedButton(
-              child: Text('Check: Is Non-Skippable Ad loaded?'),
+              child: Text('Is Non-Skippable Ad ready?'),
               onPressed: () async {
-                var isLoaded = await Appodeal.isLoaded(AdType.NON_SKIPPABLE);
-                Toast.show(isLoaded ? 'Non-Skippable ad is loaded' : 'No-Skippable ad is NOT loaded', context,
+                var isReady = await Appodeal.isReadyForShow(AdType.NON_SKIPPABLE);
+                Toast.show(isReady ? 'Non-Skippable ad is ready' : 'No-Skippable ad is NOT ready', context,
                     duration: Toast.LENGTH_LONG, gravity: Toast.BOTTOM);
               },
             ),

example/pubspec.lock

@@ -7,7 +7,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "0.2.3"
+    version: "0.3.0"
   async:
     dependency: transitive
     description:

ios/Classes/SwiftAppodealFlutterPlugin.swift

@@ -19,7 +19,9 @@ public class SwiftAppodealFlutterPlugin: NSObject, FlutterPlugin
     public func handle(_ call: FlutterMethodCall, result: @escaping FlutterResult) {
         switch call.method {
         case "initialize": initialize(call, result)
-        case "isLoaded": isLoaded(call, result)
+        case "setAutoCache": setAutoCache(call, result)
+        case "cache": cache(call, result)
+        case "isReadyForShow": isReadyForShow(call, result)
         case "show": show(call, result)
 
         case "requestIOSTrackingAuthorization": requestIOSTrackingAuthorization(result)
@@ -31,7 +33,7 @@ public class SwiftAppodealFlutterPlugin: NSObject, FlutterPlugin
         default: result(FlutterMethodNotImplemented)
         }
     }
-    
+
     private func requestIOSTrackingAuthorization(_ result: @escaping FlutterResult) {
         if #available(iOS 14, *) {
             ATTrackingManager.requestTrackingAuthorization { status in
@@ -41,7 +43,7 @@ public class SwiftAppodealFlutterPlugin: NSObject, FlutterPlugin
             result(true)
         }
     }
-    
+
     // MARK: - Appodeal
     private func initialize(_ call: FlutterMethodCall, _ result: @escaping FlutterResult) {
         let args = call.arguments as! Dictionary<String, Any>
@@ -59,29 +61,48 @@ public class SwiftAppodealFlutterPlugin: NSObject, FlutterPlugin
 
         result(nil)
     }
-    
-    private func isLoaded(_ call: FlutterMethodCall, _ result: @escaping FlutterResult) {
+
+    private func setAutoCache(_ call: FlutterMethodCall, _ result: @escaping FlutterResult) {
+        let args = call.arguments as! Dictionary<String, Any>
+        let adType = getAdType(adId: args["adType"] as! Int)
+        let autoCache = args["autoCache"] as! Bool
+
+        Appodeal.setAutocache(autoCache, types: adType)
+        
+        result(nil)
+    }
+
+    private func cache(_ call: FlutterMethodCall, _ result: @escaping FlutterResult) {
+        let args = call.arguments as! Dictionary<String, Any>
+        let adType = getAdType(adId: args["adType"] as! Int)
+
+        Appodeal.cacheAd(adType)
+        
+        result(nil)
+    }
+
+    private func isReadyForShow(_ call: FlutterMethodCall, _ result: @escaping FlutterResult) {
         let args = call.arguments as! Dictionary<String, Any>
         let adType = getShowStyle(adType: getAdType(adId: args["adType"] as! Int))
 
         result(Appodeal.isReadyForShow(with: adType))
     }
-    
+
     private func show(_ call: FlutterMethodCall, _ result: @escaping FlutterResult) {
         let args = call.arguments as! Dictionary<String, Any>
         let adType = getShowStyle(adType: getAdType(adId: args["adType"] as! Int))
 
         let rootViewController = UIApplication.shared.keyWindow?.rootViewController
         result(Appodeal.showAd(adType, rootViewController: rootViewController))
     }
-    
+
     private func setCallbacks() {
         Appodeal.setBannerDelegate(self)
         Appodeal.setInterstitialDelegate(self)
         Appodeal.setRewardedVideoDelegate(self)
         Appodeal.setNonSkippableVideoDelegate(self)
     }
-    
+
     // MARK: - Consent Manager
     private func fetchConsentInfo(_ call: FlutterMethodCall, _ result: @escaping FlutterResult) {
         let args = call.arguments as! Dictionary<String, Any>

lib/src/appodeal.dart

@@ -57,13 +57,36 @@ class Appodeal {
     });
   }
 
-  /// Check if an ad of certain type [adType] is loaded and ready to be presented.
+  /// Enable or disable the auto caching of an ad of certain type [adType].
+  ///
+  /// When you initialize Appodeal all ads types are set to be downloaded automatically. If you want to prevent this
+  /// behaviour you can call this function before the initialization passing `false` to the parameter [autoCache].
+  ///
+  /// Use the constants in the class `AdType` to specify what ad should be loaded.
+  static Future<void> setAutoCache(int adType, bool autoCache) async {
+    return _channel.invokeMethod('setAutoCache', {
+      'adType': adType,
+      'autoCache': autoCache
+    });
+  }
+
+  /// Cache an ad of certain type [adType].
+  ///
+  /// If you disabled the auto caching (function `setAutoCache()`) then you must call this function before you can
+  /// display the ad type where auto cache has been disabled.
+  static Future<void> cache(int adType) async {
+    return _channel.invokeMethod('cache', {
+      'adType': adType
+    });
+  }
+
+  /// Check if an ad of certain type [adType] is ready to be presented.
   ///
   /// Use the constants in the class `AdType` to specify what ad should be loaded.
   ///
   /// Returns `true` if the ad is loaded.
-  static Future<bool> isLoaded(int adType) async {
-    return _channel.invokeMethod('isLoaded', {
+  static Future<bool> isReadyForShow(int adType) async {
+    return _channel.invokeMethod('isReadyForShow', {
       'adType': adType
     });
   }

lib/src/banner.dart

@@ -10,16 +10,16 @@ class AppodealBanner extends StatelessWidget {
       width: 320,
       height: 50,
       child: Platform.isIOS
-          ? UiKitView(
-              viewType: 'plugins.io.vinicius.appodeal/banner',
-              creationParams: {},
-              creationParamsCodec: const StandardMessageCodec(),
-            )
-          : AndroidView(
-              viewType: 'plugins.io.vinicius.appodeal/banner',
-              creationParams: {},
-              creationParamsCodec: const StandardMessageCodec(),
-            ),
+        ? UiKitView(
+            viewType: 'plugins.io.vinicius.appodeal/banner',
+            creationParams: {},
+            creationParamsCodec: const StandardMessageCodec(),
+          )
+        : AndroidView(
+            viewType: 'plugins.io.vinicius.appodeal/banner',
+            creationParams: {},
+            creationParamsCodec: const StandardMessageCodec(),
+          ),
     );
   }
 }

pubspec.yaml

@@ -1,6 +1,6 @@
 name: appodeal_flutter
 description: A Flutter plugin to display ads from Appodeal; it supports the new reqs for iOS 14+ and GDPR/CCPA consent.
-version: 0.2.3
+version: 0.3.0
 homepage: https://github.com/vegidio-flutter/appodeal
 
 environment: