docs(admob-free): add missing documentation

This commit is contained in:
Daniel 2018-04-08 18:24:41 +02:00
parent 31c696d59d
commit 1c03c3ff3c

View File

@ -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 '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 { export interface AdMobFreeBannerConfig {
/** /**
* Ad Unit ID * Ad Unit ID
@ -114,12 +115,11 @@ export interface AdMobFreeRewardVideoConfig {
}) })
@Injectable() @Injectable()
export class AdMobFree extends IonicNativePlugin { export class AdMobFree extends IonicNativePlugin {
/** /**
* Convenience object to get event names * Convenience object to get event names
* @type {Object} * @type {Object}
*/ */
events: any = { events = {
BANNER_LOAD: 'admob.banner.events.LOAD', BANNER_LOAD: 'admob.banner.events.LOAD',
BANNER_LOAD_FAIL: 'admob.banner.events.LOAD_FAIL', BANNER_LOAD_FAIL: 'admob.banner.events.LOAD_FAIL',
BANNER_OPEN: 'admob.banner.events.OPEN', BANNER_OPEN: 'admob.banner.events.OPEN',
@ -167,7 +167,6 @@ export class AdMobFree extends IonicNativePlugin {
* @type {AdMobFreeRewardVideo} * @type {AdMobFreeRewardVideo}
*/ */
rewardVideo: AdMobFreeRewardVideo = new AdMobFreeRewardVideo(); rewardVideo: AdMobFreeRewardVideo = new AdMobFreeRewardVideo();
} }
/** /**
@ -176,46 +175,54 @@ export class AdMobFree extends IonicNativePlugin {
@Plugin({ @Plugin({
pluginName: 'AdMobFree', pluginName: 'AdMobFree',
plugin: 'cordova-plugin-admob-free', plugin: 'cordova-plugin-admob-free',
pluginRef: 'admob.banner', pluginRef: 'admob.banner'
}) })
export class AdMobFreeBanner { export class AdMobFreeBanner {
/** /**
* Update config. * Update config
* @param options * @param options
* @return {AdMobFreeBannerConfig} * @return {AdMobFreeBannerConfig}
*/ */
@Cordova({ sync: true }) @Cordova({ sync: true })
config(options: AdMobFreeBannerConfig): AdMobFreeBannerConfig { return; } config(options: AdMobFreeBannerConfig): AdMobFreeBannerConfig {
return;
}
/** /**
* Hide the banner. * Hide the banner
* @return {Promise<any>} * @return {Promise<any>}
*/ */
@Cordova({ otherPromise: true }) @Cordova({ otherPromise: true })
hide(): Promise<any> { return; } hide(): Promise<any> {
return;
}
/** /**
* Create banner. * Create banner
* @return {Promise<any>} * @return {Promise<any>}
*/ */
@Cordova({ otherPromise: true }) @Cordova({ otherPromise: true })
prepare(): Promise<any> { return; } prepare(): Promise<any> {
return;
}
/** /**
* Remove the banner. * Remove the banner
* @return {Promise<any>} * @return {Promise<any>}
*/ */
@Cordova({ otherPromise: true }) @Cordova({ otherPromise: true })
remove(): Promise<any> { return; } remove(): Promise<any> {
return;
}
/** /**
* Show the banner. * Show the banner
* @return {Promise<any>} * @return {Promise<any>}
*/ */
@Cordova({ otherPromise: true }) @Cordova({ otherPromise: true })
show(): Promise<any> { return; } show(): Promise<any> {
return;
}
} }
/** /**
@ -224,39 +231,45 @@ export class AdMobFreeBanner {
@Plugin({ @Plugin({
pluginName: 'AdMobFree', pluginName: 'AdMobFree',
plugin: 'cordova-plugin-admob-free', plugin: 'cordova-plugin-admob-free',
pluginRef: 'admob.interstitial', pluginRef: 'admob.interstitial'
}) })
export class AdMobFreeInterstitial { export class AdMobFreeInterstitial {
/** /**
* Update config. * Update config
* @param options * @param options
* @return {AdMobFreeInterstitialConfig} * @return {AdMobFreeInterstitialConfig}
*/ */
@Cordova({ sync: true }) @Cordova({ sync: true })
config(options: AdMobFreeInterstitialConfig): AdMobFreeInterstitialConfig { return; } config(options: AdMobFreeInterstitialConfig): AdMobFreeInterstitialConfig {
return;
}
/** /**
* Check if interstitial is ready * Check if interstitial is ready
* @return {Promise<any>} * @return {Promise<any>}
*/ */
@Cordova({ otherPromise: true }) @Cordova({ otherPromise: true })
isReady(): Promise<any> { return; } isReady(): Promise<any> {
return;
}
/** /**
* Prepare interstitial * Prepare interstitial
* @return {Promise<any>} * @return {Promise<any>}
*/ */
@Cordova({ otherPromise: true }) @Cordova({ otherPromise: true })
prepare(): Promise<any> { return; } prepare(): Promise<any> {
return;
}
/** /**
* Show the interstitial * Show the interstitial
* @return {Promise<any>} * @return {Promise<any>}
*/ */
@Cordova({ otherPromise: true }) @Cordova({ otherPromise: true })
show(): Promise<any> { return; } show(): Promise<any> {
return;
}
} }
/** /**
@ -265,37 +278,43 @@ export class AdMobFreeInterstitial {
@Plugin({ @Plugin({
pluginName: 'AdMobFree', pluginName: 'AdMobFree',
plugin: 'cordova-plugin-admob-free', plugin: 'cordova-plugin-admob-free',
pluginRef: 'admob.rewardvideo', pluginRef: 'admob.rewardvideo'
}) })
export class AdMobFreeRewardVideo { export class AdMobFreeRewardVideo {
/** /**
* Update config. * Update config
* @param options * @param {AdMobFreeRewardVideoConfig} options Admob reward config
* @return {AdMobFreeRewardVideoConfig} * @return {AdMobFreeRewardVideoConfig}
*/ */
@Cordova({ sync: true }) @Cordova({ sync: true })
config(options: AdMobFreeRewardVideoConfig): AdMobFreeRewardVideoConfig { return; } config(options: AdMobFreeRewardVideoConfig): AdMobFreeRewardVideoConfig {
return;
}
/** /**
* Check if reward video is ready * Check if reward video is ready
* @return {Promise<any>} * @return {Promise<any>}
*/ */
@Cordova({ otherPromise: true }) @Cordova({ otherPromise: true })
isReady(): Promise<any> { return; } isReady(): Promise<any> {
return;
}
/** /**
* Prepare reward video * Prepare reward video
* @return {Promise<any>} * @return {Promise<any>}
*/ */
@Cordova({ otherPromise: true }) @Cordova({ otherPromise: true })
prepare(): Promise<any> { return; } prepare(): Promise<any> {
return;
}
/** /**
* Show the reward video * Show the reward video
* @return {Promise<any>} * @return {Promise<any>}
*/ */
@Cordova({ otherPromise: true }) @Cordova({ otherPromise: true })
show(): Promise<any> { return; } show(): Promise<any> {
return;
}
} }