@capacitor-community/admob 5.3.1 → 6.1.0

package/dist/docs.json

@@ -352,7 +352,7 @@
       },
       {
         "name": "addListener",
-        "signature": "(eventName: BannerAdPluginEvents.SizeChanged, listenerFunc: (info: AdMobBannerSize) => void) => PluginListenerHandle",
+        "signature": "(eventName: BannerAdPluginEvents.SizeChanged, listenerFunc: (info: AdMobBannerSize) => void) => Promise<PluginListenerHandle>",
         "parameters": [
           {
             "name": "eventName",
@@ -365,7 +365,7 @@
             "type": "(info: AdMobBannerSize) => void"
           }
         ],
-        "returns": "PluginListenerHandle",
+        "returns": "Promise<PluginListenerHandle>",
         "tags": [
           {
             "name": "group",
@@ -422,7 +422,7 @@
       },
       {
         "name": "addListener",
-        "signature": "(eventName: BannerAdPluginEvents.Loaded, listenerFunc: () => void) => PluginListenerHandle",
+        "signature": "(eventName: BannerAdPluginEvents.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>",
         "parameters": [
           {
             "name": "eventName",
@@ -435,7 +435,7 @@
             "type": "() => void"
           }
         ],
-        "returns": "PluginListenerHandle",
+        "returns": "Promise<PluginListenerHandle>",
         "tags": [
           {
             "name": "group",
@@ -491,7 +491,7 @@
       },
       {
         "name": "addListener",
-        "signature": "(eventName: BannerAdPluginEvents.FailedToLoad, listenerFunc: (info: AdMobError) => void) => PluginListenerHandle",
+        "signature": "(eventName: BannerAdPluginEvents.FailedToLoad, listenerFunc: (info: AdMobError) => void) => Promise<PluginListenerHandle>",
         "parameters": [
           {
             "name": "eventName",
@@ -504,7 +504,7 @@
             "type": "(info: AdMobError) => void"
           }
         ],
-        "returns": "PluginListenerHandle",
+        "returns": "Promise<PluginListenerHandle>",
         "tags": [
           {
             "name": "group",
@@ -561,7 +561,7 @@
       },
       {
         "name": "addListener",
-        "signature": "(eventName: BannerAdPluginEvents.Opened, listenerFunc: () => void) => PluginListenerHandle",
+        "signature": "(eventName: BannerAdPluginEvents.Opened, listenerFunc: () => void) => Promise<PluginListenerHandle>",
         "parameters": [
           {
             "name": "eventName",
@@ -574,7 +574,7 @@
             "type": "() => void"
           }
         ],
-        "returns": "PluginListenerHandle",
+        "returns": "Promise<PluginListenerHandle>",
         "tags": [
           {
             "name": "group",
@@ -630,7 +630,7 @@
       },
       {
         "name": "addListener",
-        "signature": "(eventName: BannerAdPluginEvents.Closed, listenerFunc: () => void) => PluginListenerHandle",
+        "signature": "(eventName: BannerAdPluginEvents.Closed, listenerFunc: () => void) => Promise<PluginListenerHandle>",
         "parameters": [
           {
             "name": "eventName",
@@ -643,7 +643,7 @@
             "type": "() => void"
           }
         ],
-        "returns": "PluginListenerHandle",
+        "returns": "Promise<PluginListenerHandle>",
         "tags": [
           {
             "name": "group",
@@ -699,7 +699,7 @@
       },
       {
         "name": "addListener",
-        "signature": "(eventName: BannerAdPluginEvents.AdImpression, listenerFunc: () => void) => PluginListenerHandle",
+        "signature": "(eventName: BannerAdPluginEvents.AdImpression, listenerFunc: () => void) => Promise<PluginListenerHandle>",
         "parameters": [
           {
             "name": "eventName",
@@ -712,7 +712,7 @@
             "type": "() => void"
           }
         ],
-        "returns": "PluginListenerHandle",
+        "returns": "Promise<PluginListenerHandle>",
         "tags": [
           {
             "name": "group",
@@ -967,7 +967,7 @@
       },
       {
         "name": "addListener",
-        "signature": "(eventName: InterstitialAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => PluginListenerHandle",
+        "signature": "(eventName: InterstitialAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>",
         "parameters": [
           {
             "name": "eventName",
@@ -980,7 +980,7 @@
             "type": "(error: AdMobError) => void"
           }
         ],
-        "returns": "PluginListenerHandle",
+        "returns": "Promise<PluginListenerHandle>",
         "tags": [],
         "docs": "",
         "complexTypes": [
@@ -992,7 +992,7 @@
       },
       {
         "name": "addListener",
-        "signature": "(eventName: InterstitialAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => PluginListenerHandle",
+        "signature": "(eventName: InterstitialAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>",
         "parameters": [
           {
             "name": "eventName",
@@ -1005,7 +1005,7 @@
             "type": "(info: AdLoadInfo) => void"
           }
         ],
-        "returns": "PluginListenerHandle",
+        "returns": "Promise<PluginListenerHandle>",
         "tags": [],
         "docs": "",
         "complexTypes": [
@@ -1017,7 +1017,7 @@
       },
       {
         "name": "addListener",
-        "signature": "(eventName: InterstitialAdPluginEvents.Dismissed, listenerFunc: () => void) => PluginListenerHandle",
+        "signature": "(eventName: InterstitialAdPluginEvents.Dismissed, listenerFunc: () => void) => Promise<PluginListenerHandle>",
         "parameters": [
           {
             "name": "eventName",
@@ -1030,7 +1030,7 @@
             "type": "() => void"
           }
         ],
-        "returns": "PluginListenerHandle",
+        "returns": "Promise<PluginListenerHandle>",
         "tags": [],
         "docs": "",
         "complexTypes": [
@@ -1041,7 +1041,7 @@
       },
       {
         "name": "addListener",
-        "signature": "(eventName: InterstitialAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => PluginListenerHandle",
+        "signature": "(eventName: InterstitialAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>",
         "parameters": [
           {
             "name": "eventName",
@@ -1054,7 +1054,7 @@
             "type": "(error: AdMobError) => void"
           }
         ],
-        "returns": "PluginListenerHandle",
+        "returns": "Promise<PluginListenerHandle>",
         "tags": [],
         "docs": "",
         "complexTypes": [
@@ -1066,7 +1066,7 @@
       },
       {
         "name": "addListener",
-        "signature": "(eventName: InterstitialAdPluginEvents.Showed, listenerFunc: () => void) => PluginListenerHandle",
+        "signature": "(eventName: InterstitialAdPluginEvents.Showed, listenerFunc: () => void) => Promise<PluginListenerHandle>",
         "parameters": [
           {
             "name": "eventName",
@@ -1079,7 +1079,7 @@
             "type": "() => void"
           }
         ],
-        "returns": "PluginListenerHandle",
+        "returns": "Promise<PluginListenerHandle>",
         "tags": [],
         "docs": "",
         "complexTypes": [
@@ -1176,7 +1176,7 @@
       },
       {
         "name": "addListener",
-        "signature": "(eventName: RewardAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => PluginListenerHandle",
+        "signature": "(eventName: RewardAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>",
         "parameters": [
           {
             "name": "eventName",
@@ -1189,7 +1189,7 @@
             "type": "(error: AdMobError) => void"
           }
         ],
-        "returns": "PluginListenerHandle",
+        "returns": "Promise<PluginListenerHandle>",
         "tags": [],
         "docs": "",
         "complexTypes": [
@@ -1201,7 +1201,7 @@
       },
       {
         "name": "addListener",
-        "signature": "(eventName: RewardAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => PluginListenerHandle",
+        "signature": "(eventName: RewardAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>",
         "parameters": [
           {
             "name": "eventName",
@@ -1214,7 +1214,7 @@
             "type": "(info: AdLoadInfo) => void"
           }
         ],
-        "returns": "PluginListenerHandle",
+        "returns": "Promise<PluginListenerHandle>",
         "tags": [],
         "docs": "",
         "complexTypes": [
@@ -1226,7 +1226,7 @@
       },
       {
         "name": "addListener",
-        "signature": "(eventName: RewardAdPluginEvents.Rewarded, listenerFunc: (reward: AdMobRewardItem) => void) => PluginListenerHandle",
+        "signature": "(eventName: RewardAdPluginEvents.Rewarded, listenerFunc: (reward: AdMobRewardItem) => void) => Promise<PluginListenerHandle>",
         "parameters": [
           {
             "name": "eventName",
@@ -1239,7 +1239,7 @@
             "type": "(reward: AdMobRewardItem) => void"
           }
         ],
-        "returns": "PluginListenerHandle",
+        "returns": "Promise<PluginListenerHandle>",
         "tags": [],
         "docs": "",
         "complexTypes": [
@@ -1251,7 +1251,7 @@
       },
       {
         "name": "addListener",
-        "signature": "(eventName: RewardAdPluginEvents.Dismissed, listenerFunc: () => void) => PluginListenerHandle",
+        "signature": "(eventName: RewardAdPluginEvents.Dismissed, listenerFunc: () => void) => Promise<PluginListenerHandle>",
         "parameters": [
           {
             "name": "eventName",
@@ -1264,7 +1264,7 @@
             "type": "() => void"
           }
         ],
-        "returns": "PluginListenerHandle",
+        "returns": "Promise<PluginListenerHandle>",
         "tags": [],
         "docs": "",
         "complexTypes": [
@@ -1275,7 +1275,7 @@
       },
       {
         "name": "addListener",
-        "signature": "(eventName: RewardAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => PluginListenerHandle",
+        "signature": "(eventName: RewardAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>",
         "parameters": [
           {
             "name": "eventName",
@@ -1288,7 +1288,7 @@
             "type": "(error: AdMobError) => void"
           }
         ],
-        "returns": "PluginListenerHandle",
+        "returns": "Promise<PluginListenerHandle>",
         "tags": [],
         "docs": "",
         "complexTypes": [
@@ -1300,7 +1300,7 @@
       },
       {
         "name": "addListener",
-        "signature": "(eventName: RewardAdPluginEvents.Showed, listenerFunc: () => void) => PluginListenerHandle",
+        "signature": "(eventName: RewardAdPluginEvents.Showed, listenerFunc: () => void) => Promise<PluginListenerHandle>",
         "parameters": [
           {
             "name": "eventName",
@@ -1313,7 +1313,7 @@
             "type": "() => void"
           }
         ],
-        "returns": "PluginListenerHandle",
+        "returns": "Promise<PluginListenerHandle>",
         "tags": [],
         "docs": "",
         "complexTypes": [
@@ -1321,6 +1321,240 @@
           "RewardAdPluginEvents"
         ],
         "slug": "addlistenerrewardadplugineventsshowed-"
+      },
+      {
+        "name": "prepareRewardInterstitialAd",
+        "signature": "(options: RewardInterstitialAdOptions) => Promise<AdLoadInfo>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "RewardAdOptions",
+            "type": "RewardInterstitialAdOptions"
+          }
+        ],
+        "returns": "Promise<AdLoadInfo>",
+        "tags": [
+          {
+            "name": "group",
+            "text": [
+              {
+                "text": "RewardVideo",
+                "kind": "text"
+              }
+            ]
+          },
+          {
+            "name": "param",
+            "text": [
+              {
+                "text": "options",
+                "kind": "parameterName"
+              },
+              {
+                "text": " ",
+                "kind": "space"
+              },
+              {
+                "text": "RewardAdOptions",
+                "kind": "text"
+              }
+            ]
+          },
+          {
+            "name": "since",
+            "text": [
+              {
+                "text": "1.1.2",
+                "kind": "text"
+              }
+            ]
+          }
+        ],
+        "docs": "Prepare a reward video ad",
+        "complexTypes": [
+          "AdLoadInfo",
+          "RewardInterstitialAdOptions"
+        ],
+        "slug": "preparerewardinterstitialad"
+      },
+      {
+        "name": "showRewardInterstitialAd",
+        "signature": "() => Promise<AdMobRewardInterstitialItem>",
+        "parameters": [],
+        "returns": "Promise<AdMobRewardInterstitialItem>",
+        "tags": [
+          {
+            "name": "group",
+            "text": [
+              {
+                "text": "RewardVideo",
+                "kind": "text"
+              }
+            ]
+          },
+          {
+            "name": "since",
+            "text": [
+              {
+                "text": "1.1.2",
+                "kind": "text"
+              }
+            ]
+          }
+        ],
+        "docs": "Show a reward video ad",
+        "complexTypes": [
+          "AdMobRewardInterstitialItem"
+        ],
+        "slug": "showrewardinterstitialad"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: RewardInterstitialAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "RewardInterstitialAdPluginEvents.FailedToLoad"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(error: AdMobError) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "RewardInterstitialAdPluginEvents",
+          "AdMobError"
+        ],
+        "slug": "addlistenerrewardinterstitialadplugineventsfailedtoload-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: RewardInterstitialAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "RewardInterstitialAdPluginEvents.Loaded"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(info: AdLoadInfo) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "RewardInterstitialAdPluginEvents",
+          "AdLoadInfo"
+        ],
+        "slug": "addlistenerrewardinterstitialadplugineventsloaded-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: RewardInterstitialAdPluginEvents.Rewarded, listenerFunc: (reward: AdMobRewardInterstitialItem) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "RewardInterstitialAdPluginEvents.Rewarded"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(reward: AdMobRewardInterstitialItem) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "RewardInterstitialAdPluginEvents",
+          "AdMobRewardInterstitialItem"
+        ],
+        "slug": "addlistenerrewardinterstitialadplugineventsrewarded-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: RewardInterstitialAdPluginEvents.Dismissed, listenerFunc: () => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "RewardInterstitialAdPluginEvents.Dismissed"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "() => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "RewardInterstitialAdPluginEvents"
+        ],
+        "slug": "addlistenerrewardinterstitialadplugineventsdismissed-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: RewardInterstitialAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "RewardInterstitialAdPluginEvents.FailedToShow"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(error: AdMobError) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "RewardInterstitialAdPluginEvents",
+          "AdMobError"
+        ],
+        "slug": "addlistenerrewardinterstitialadplugineventsfailedtoshow-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: RewardInterstitialAdPluginEvents.Showed, listenerFunc: () => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "RewardInterstitialAdPluginEvents.Showed"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "() => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "RewardInterstitialAdPluginEvents"
+        ],
+        "slug": "addlistenerrewardinterstitialadplugineventsshowed-"
       }
     ],
     "properties": [],
@@ -1329,6 +1563,7 @@
       "AdmobConsentDefinitions",
       "InterstitialDefinitions",
       "RewardDefinitions",
+      "RewardInterstitialDefinitions",
       "TrackingAuthorizationStatusInterface",
       "AdMobDefinitions",
       "AdMobInitializationOptions",
@@ -1516,6 +1751,7 @@
         "AdmobConsentDefinitions",
         "InterstitialDefinitions",
         "RewardDefinitions",
+        "RewardInterstitialDefinitions",
         "TrackingAuthorizationStatusInterface",
         "AdMobDefinitions",
         "AdMobPlugin",
@@ -1594,6 +1830,7 @@
         "AdmobConsentDefinitions",
         "InterstitialDefinitions",
         "RewardDefinitions",
+        "RewardInterstitialDefinitions",
         "TrackingAuthorizationStatusInterface",
         "AdMobDefinitions",
         "AdMobPlugin",
@@ -1645,6 +1882,7 @@
         "AdmobConsentDefinitions",
         "InterstitialDefinitions",
         "RewardDefinitions",
+        "RewardInterstitialDefinitions",
         "TrackingAuthorizationStatusInterface",
         "AdMobDefinitions",
         "AdMobPlugin",
@@ -2141,6 +2379,66 @@
         }
       ],
       "importObject": []
+    },
+    {
+      "name": "RewardInterstitialAdOptions",
+      "slug": "rewardinterstitialadoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "ssv",
+          "tags": [
+            {
+              "text": [
+                {
+                  "text": "https",
+                  "kind": "text"
+                },
+                {
+                  "text": "://support.google.com/admob/answer/9603226?hl=en-GB",
+                  "kind": "text"
+                }
+              ],
+              "name": "see"
+            }
+          ],
+          "docs": "If you have enabled SSV in your AdMob Application. You can provide customData or\na userId be passed to your callback to do further processing on.\n\n*Important* You *HAVE* to define one of them.",
+          "complexTypes": [
+            "AtLeastOne"
+          ],
+          "type": "AtLeastOne<{\n    /**\n     * An optional UserId to pass to your SSV callback function.\n     */\n    userId: string;\n    /**\n     * An optional custom set of data to pass to your SSV callback function.\n     */\n    customData: string;\n  }>"
+        }
+      ],
+      "importObject": [
+        "AdOptions",
+        "AtLeastOne"
+      ]
+    },
+    {
+      "name": "AdMobRewardInterstitialItem",
+      "slug": "admobrewardinterstitialitem",
+      "docs": "For more information\nhttps://developers.google.com/admob/android/rewarded-video-adapters?hl=en",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "type",
+          "tags": [],
+          "docs": "Rewarded type user got",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "amount",
+          "tags": [],
+          "docs": "Rewarded amount user got",
+          "complexTypes": [],
+          "type": "number"
+        }
+      ],
+      "importObject": []
     }
   ],
   "enums": [
@@ -2429,6 +2727,48 @@
           "docs": "Emits when user get rewarded from AdReward"
         }
       ]
+    },
+    {
+      "name": "RewardInterstitialAdPluginEvents",
+      "slug": "rewardinterstitialadpluginevents",
+      "members": [
+        {
+          "name": "Loaded",
+          "value": "'onRewardedInterstitialAdLoaded'",
+          "tags": [],
+          "docs": "Emits after trying to prepare a RewardAd and the Video is loaded and ready to be show"
+        },
+        {
+          "name": "FailedToLoad",
+          "value": "'onRewardedInterstitialAdFailedToLoad'",
+          "tags": [],
+          "docs": "Emits after trying to prepare a RewardAd when it could not be loaded"
+        },
+        {
+          "name": "Showed",
+          "value": "'onRewardedInterstitialAdShowed'",
+          "tags": [],
+          "docs": "Emits when the AdReward video is visible to the user"
+        },
+        {
+          "name": "FailedToShow",
+          "value": "'onRewardedInterstitialAdFailedToShow'",
+          "tags": [],
+          "docs": "Emits when the AdReward video is failed to show"
+        },
+        {
+          "name": "Dismissed",
+          "value": "'onRewardedInterstitialAdDismissed'",
+          "tags": [],
+          "docs": "Emits when the AdReward video is not visible to the user anymore.\n\n**Important**: This has nothing to do with the reward it self. This event\nwill emits in this two cases:\n1. The user starts the video ad but close it before the reward emit.\n2. The user start the video and see it until end, then gets the reward\nand after that the ad is closed."
+        },
+        {
+          "name": "Rewarded",
+          "value": "'onRewardedInterstitialAdReward'",
+          "tags": [],
+          "docs": "Emits when user get rewarded from AdReward"
+        }
+      ]
     }
   ],
   "typeAliases": [