From 1c03c3ff3ccb769afa846af7fb58aca639b418f2 Mon Sep 17 00:00:00 2001 From: Daniel Date: Sun, 8 Apr 2018 18:24:41 +0200 Subject: [PATCH] docs(admob-free): add missing documentation --- src/@ionic-native/plugins/admob-free/index.ts | 91 +++++++++++-------- 1 file changed, 55 insertions(+), 36 deletions(-) diff --git a/src/@ionic-native/plugins/admob-free/index.ts b/src/@ionic-native/plugins/admob-free/index.ts index bcd059b3d..6d53c48fa 100644 --- a/src/@ionic-native/plugins/admob-free/index.ts +++ b/src/@ionic-native/plugins/admob-free/index.ts @@ -1,8 +1,9 @@ -import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core'; -import { Injectable } from '@angular/core'; -import { Observable } from 'rxjs/Observable'; import 'rxjs/add/observable/fromEvent'; +import { Injectable } from '@angular/core'; +import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core'; +import { Observable } from 'rxjs/Observable'; + export interface AdMobFreeBannerConfig { /** * Ad Unit ID @@ -114,12 +115,11 @@ export interface AdMobFreeRewardVideoConfig { }) @Injectable() export class AdMobFree extends IonicNativePlugin { - /** * Convenience object to get event names * @type {Object} */ - events: any = { + events = { BANNER_LOAD: 'admob.banner.events.LOAD', BANNER_LOAD_FAIL: 'admob.banner.events.LOAD_FAIL', BANNER_OPEN: 'admob.banner.events.OPEN', @@ -167,7 +167,6 @@ export class AdMobFree extends IonicNativePlugin { * @type {AdMobFreeRewardVideo} */ rewardVideo: AdMobFreeRewardVideo = new AdMobFreeRewardVideo(); - } /** @@ -176,46 +175,54 @@ export class AdMobFree extends IonicNativePlugin { @Plugin({ pluginName: 'AdMobFree', plugin: 'cordova-plugin-admob-free', - pluginRef: 'admob.banner', + pluginRef: 'admob.banner' }) export class AdMobFreeBanner { - /** - * Update config. + * Update config * @param options * @return {AdMobFreeBannerConfig} */ @Cordova({ sync: true }) - config(options: AdMobFreeBannerConfig): AdMobFreeBannerConfig { return; } + config(options: AdMobFreeBannerConfig): AdMobFreeBannerConfig { + return; + } /** - * Hide the banner. + * Hide the banner * @return {Promise} */ @Cordova({ otherPromise: true }) - hide(): Promise { return; } + hide(): Promise { + return; + } /** - * Create banner. + * Create banner * @return {Promise} */ @Cordova({ otherPromise: true }) - prepare(): Promise { return; } + prepare(): Promise { + return; + } /** - * Remove the banner. + * Remove the banner * @return {Promise} */ @Cordova({ otherPromise: true }) - remove(): Promise { return; } + remove(): Promise { + return; + } /** - * Show the banner. + * Show the banner * @return {Promise} */ @Cordova({ otherPromise: true }) - show(): Promise { return; } - + show(): Promise { + return; + } } /** @@ -224,39 +231,45 @@ export class AdMobFreeBanner { @Plugin({ pluginName: 'AdMobFree', plugin: 'cordova-plugin-admob-free', - pluginRef: 'admob.interstitial', + pluginRef: 'admob.interstitial' }) export class AdMobFreeInterstitial { - /** - * Update config. + * Update config * @param options * @return {AdMobFreeInterstitialConfig} */ @Cordova({ sync: true }) - config(options: AdMobFreeInterstitialConfig): AdMobFreeInterstitialConfig { return; } + config(options: AdMobFreeInterstitialConfig): AdMobFreeInterstitialConfig { + return; + } /** * Check if interstitial is ready * @return {Promise} */ @Cordova({ otherPromise: true }) - isReady(): Promise { return; } + isReady(): Promise { + return; + } /** * Prepare interstitial * @return {Promise} */ @Cordova({ otherPromise: true }) - prepare(): Promise { return; } + prepare(): Promise { + return; + } /** * Show the interstitial * @return {Promise} */ @Cordova({ otherPromise: true }) - show(): Promise { return; } - + show(): Promise { + return; + } } /** @@ -265,37 +278,43 @@ export class AdMobFreeInterstitial { @Plugin({ pluginName: 'AdMobFree', plugin: 'cordova-plugin-admob-free', - pluginRef: 'admob.rewardvideo', + pluginRef: 'admob.rewardvideo' }) export class AdMobFreeRewardVideo { - /** - * Update config. - * @param options + * Update config + * @param {AdMobFreeRewardVideoConfig} options Admob reward config * @return {AdMobFreeRewardVideoConfig} */ @Cordova({ sync: true }) - config(options: AdMobFreeRewardVideoConfig): AdMobFreeRewardVideoConfig { return; } + config(options: AdMobFreeRewardVideoConfig): AdMobFreeRewardVideoConfig { + return; + } /** * Check if reward video is ready * @return {Promise} */ @Cordova({ otherPromise: true }) - isReady(): Promise { return; } + isReady(): Promise { + return; + } /** * Prepare reward video * @return {Promise} */ @Cordova({ otherPromise: true }) - prepare(): Promise { return; } + prepare(): Promise { + return; + } /** * Show the reward video * @return {Promise} */ @Cordova({ otherPromise: true }) - show(): Promise { return; } - + show(): Promise { + return; + } }