public/awesome-cordova-plugins
public/awesome-cordova-plugins
9
0
Fork 0
forked from github/awesome-cordova-plugins
Code Pull Requests Activity

docs(admob-free): improve docs

Browse Source
This commit is contained in:
Ibby Hadeed 2017-03-28 06:54:03 -04:00
parent ffa37e2932
commit bc364d1cb1
1 changed files with 27 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
src/@ionic-native/plugins/admob-free/index.ts
View File

@ -9,23 +9,23 @@ export interface AdMobFreeBannerConfig {
*/ */
id?: string; id?: string;
/** /**
* receiving test ad * Receiving test ad
*/ */
isTesting?: boolean; isTesting?: boolean;
/** /**
* auto show ad when loaded * Auto show ad when loaded
*/ */
autoShow?: boolean; autoShow?: boolean;
/** /**
* set to true, to put banner at top * Set to true, to put banner at top
*/ */
bannerAtTop?: boolean; bannerAtTop?: boolean;
/** /**
* set to true, to allow banner overlap webview * Set to true, to allow banner overlap WebView
*/ */
overlap?: boolean; overlap?: boolean;
/** /**
* set to true to avoid ios7 status bar overlap * Set to true to avoid ios7 status bar overlap
*/ */
offsetTopBar?: boolean; offsetTopBar?: boolean;
/** /**
@ -40,11 +40,11 @@ export interface AdMobFreeInterstitialConfig {
*/ */
id?: string; id?: string;
/** /**
* receiving test ad * Receiving test ad
*/ */
isTesting?: boolean; isTesting?: boolean;
/** /**
* auto show ad when loaded * Auto show ad when loaded
*/ */
autoShow?: boolean; autoShow?: boolean;
} }
@ -55,11 +55,11 @@ export interface AdMobFreeRewardVideoConfig {
*/ */
id?: string; id?: string;
/** /**
* receiving test ad * Receiving test ad
*/ */
isTesting?: boolean; isTesting?: boolean;
/** /**
* auto show ad when loaded * Auto show ad when loaded
*/ */
autoShow?: boolean; autoShow?: boolean;
} }
@ -70,14 +70,31 @@ export interface AdMobFreeRewardVideoConfig {
* *
* @usage * @usage
* ``` * ```
* import { AdMobFree } from 'ionic-native'; * import { AdMobFree, AdMobFreeBannerConfig } from 'ionic-native';
* *
* *
* constructor(private admobFree: AdMobFree) { } * 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));
*
*
* ``` * ```
*/ */
@Plugin({ @Plugin({