Merge branch 'master' into v5

2026-04-13 00:00:10 +08:00 · 2018-09-17 18:23:18 +02:00
parent 46b1a7385c
commit 039c6d40af
76 changed files with 846 additions and 494 deletions
@@ -1,6 +1,6 @@
 import { Injectable } from '@angular/core';
 import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';
-import { fromEvent, Observable } from 'rxjs';
+import { Observable, fromEvent } from 'rxjs';

 export interface AdMobFreeBannerConfig {
  /**
@@ -63,6 +63,113 @@ export interface AdMobFreeRewardVideoConfig {
  autoShow?: boolean;
 }

+/**
+ * @name AdMob Free
+ * @description
+ * A free, no ad-sharing version of Google AdMob plugin for Cordova.
+ *
+ * Requires Cordova plugin: `cordova-plugin-admob-free`. For more info, please see the [AdMob Free plugin docs](https://github.com/ratson/cordova-plugin-admob-free).
+ *
+ * @usage
+ * ```typescript
+ * import { AdMobFree, AdMobFreeBannerConfig } from '@ionic-native/admob-free';
+ *
+ *
+ * constructor(private admobFree: AdMobFree) { }
+ *
+ *
+ * ...
+ *
+ *
+ * const bannerConfig: AdMobFreeBannerConfig = {
+ *  // add your config here
+ *  // for the sake of this example we will just use the test config
+ *  isTesting: true,
+ *  autoShow: true
+ * };
+ * this.admobFree.banner.config(bannerConfig);
+ *
+ * this.admobFree.banner.prepare()
+ *   .then(() => {
+ *     // banner Ad is ready
+ *     // if we set autoShow to false, then we will need to call the show method here
+ *   })
+ *   .catch(e => console.log(e));
+ *
+ *
+ * ```
+ * @interfaces
+ * AdMobFreeBannerConfig
+ * AdMobFreeInterstitialConfig
+ * AdMobFreeRewardVideoConfig
+ * @classes
+ * AdMobFreeBanner
+ * AdMobFreeInterstitial
+ * AdMobFreeRewardVideo
+ */
+@Plugin({
+  pluginName: 'AdMobFree',
+  plugin: 'cordova-plugin-admob-free',
+  pluginRef: 'admob',
+  repo: 'https://github.com/ratson/cordova-plugin-admob-free',
+  platforms: ['Android', 'iOS']
+})
+@Injectable()
+export class AdMobFree extends IonicNativePlugin {
+  /**
+   * Convenience object to get event names
+   * @type {Object}
+   */
+  events = {
+    BANNER_LOAD: 'admob.banner.events.LOAD',
+    BANNER_LOAD_FAIL: 'admob.banner.events.LOAD_FAIL',
+    BANNER_OPEN: 'admob.banner.events.OPEN',
+    BANNER_CLOSE: 'admob.banner.events.CLOSE',
+    BANNER_EXIT_APP: 'admob.banner.events.EXIT_APP',
+
+    INTERSTITIAL_LOAD: 'admob.interstitial.events.LOAD',
+    INTERSTITIAL_LOAD_FAIL: 'admob.interstitial.events.LOAD_FAIL',
+    INTERSTITIAL_OPEN: 'admob.interstitial.events.OPEN',
+    INTERSTITIAL_CLOSE: 'admob.interstitial.events.CLOSE',
+    INTERSTITIAL_EXIT_APP: 'admob.interstitial.events.EXIT_APP',
+
+    REWARD_VIDEO_LOAD: 'admob.rewardvideo.events.LOAD',
+    REWARD_VIDEO_LOAD_FAIL: 'admob.rewardvideo.events.LOAD_FAIL',
+    REWARD_VIDEO_OPEN: 'admob.rewardvideo.events.OPEN',
+    REWARD_VIDEO_CLOSE: 'admob.rewardvideo.events.CLOSE',
+    REWARD_VIDEO_EXIT_APP: 'admob.rewardvideo.events.EXIT_APP',
+    REWARD_VIDEO_START: 'admob.rewardvideo.events.START',
+    REWARD_VIDEO_REWARD: 'admob.rewardvideo.events.REWARD'
+  };
+
+  /**
+   * Watch an event
+   * @param event {string} event name
+   * @return {Observable<any>}
+   */
+  on(event: string): Observable<any> {
+    return fromEvent(document, event);
+  }
+
+  /**
+   * Returns the AdMobFreeBanner object
+   * @type {AdMobFreeBanner}
+   */
+  banner: AdMobFreeBanner = new AdMobFreeBanner();
+
+  /**
+   * Returns the AdMobFreeInterstitial object
+   * @type {AdMobFreeInterstitial}
+   */
+  interstitial: AdMobFreeInterstitial = new AdMobFreeInterstitial();
+
+  /**
+   * Returns the AdMobFreeRewardVideo object
+   * @type {AdMobFreeRewardVideo}
+   */
+  rewardVideo: AdMobFreeRewardVideo = new AdMobFreeRewardVideo();
+}
+
 /**
 * @hidden
 */