Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(native-view): add plugin #3418

Merged
merged 2 commits into from
May 15, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
160 changes: 160 additions & 0 deletions src/@ionic-native/plugins/native-view/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,160 @@
import { Injectable } from '@angular/core';
import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';

/**
* @name NativeView
* @description Shows the native view.
*
* @usage
* ```typescript
* import { NativeView } from '@ionic-native/native-view/ngx';
*
*
* constructor(private nativeView: NativeView) { }
*
* ...
*
*
* this.nativeView.functionName('Hello', 123)
* .then((res: any) => console.log(res))
* .catch((error: any) => console.error(error));
*
* ```
*/
export interface ResultView {
success: boolean;
name?: string;
message?: string;
uri?: string;
[key: string]: any;
}

export interface ResultAppInstalled extends ResultView {
packageName?: string;
applicationInfo?: string;
activityName?: string;
}

export interface NativeParams {
package?: string;
packageName?: string;
packageApp?: string;
className?: string;
uri?: string;
storyboardName?: string;
viewControllerName?: string;
params?: string;
}

export interface NativeMarketParams extends NativeParams {
marketId?: string;
}
@Plugin({
pluginName: 'NativeView',
plugin: 'cordova-plugin-nativeview',
pluginRef: 'cordova.plugins.NativeView',
repo: 'https://github.com/mfdeveloper/cordova-plugin-nativeview',
platforms: ['Android', 'iOS']
})
@Injectable()
export class NativeView extends IonicNativePlugin {
/**
* Shows the native view.
*
* Define the `packageOrClass` param to a package (Android) or a
* storyboard/classname (IOS)
*
* ```ts
*
* //Android
* cordova.plugins.NativeView.show('com.mycompany', 'MyActivity')
* .then(() => {
* // Do something
* });
*
* //IOS
* cordova.plugins.NativeView.show('MyStoryboard', 'MyUIViewController')
* .then(() => {
* // Do something
* });
*
* //OR Back to previous View (IOS only)
* cordova.plugins.NativeView.show().then(() => {
* // Do something
* });
*
* ```
*
* @param {NativeParams|string} packageOrClass Package or class name of view to open
* @param {string} className Class name of view to open
* @param {any} [extraParams] [Optional] Params to send to a Native view that will be opened
* @param {Function} [success] [Optional] Callback when success, if you don't want use promise "then()"
* @param {Function} [error] [Optional] Callback when error happens, if you don't want use promise "catch()"
*/
@Cordova()
show(
packageOrClass: NativeParams | string,
className?: string,
extraParams?: any,
success?: Function,
error?: Function
): Promise<ResultView> {
return;
}

/**
* Check if a specific app is installed
*
* @param {NativeParams} config
* @param {Function} [success] Callback when success. Use `.then()` Promise method, instead
* @param {Function} [error] Callback callbed when an error happens. Use `.catch()` Promise method, instead
* @returns {Promise<ResultAppInstalled>} Returns data information about the installed app
*/
@Cordova()
checkIfAppInstalled(
config: NativeParams,
success?: Function,
error?: Function
): Promise<ResultAppInstalled> {
return;
}

/**
* Shows a store/market fo install a specific app
*
* @param {NativeMarketParams} config Native package and/or marketId to show in Google Play/Apple Store
* @param {Function} [success] Callback when success. Use `.then()` Promise method, instead
* @param {Function} [error] Callback callbed when an error happens. Use `.catch()` Promise method, instead
* @returns {Promise<ResultView>}
*/
@Cordova()
showMarket(
config: NativeMarketParams,
success?: Function,
error?: Function
): Promise<ResultView> {
return;
}

/**
* ### ANDROID ONLY
*
* Get the **Android** current build variant FLAVOR
* This is great if you change the FLAVOR in compile time
*
* @param {Boolean} [config.catchError] `config.catchError` True, if you wish catch a JSON with error information
* @param {Function} [success] Callback when success. Use `.then()` Promise method, instead
* @param {Function} [error] Callback callbed when an error happens. Use `.catch()` Promise method, instead
* @returns {Promise<string>} Returns a current FLAVOR string
*/
@Cordova({
platforms: ['android']
})
getBuildVariant(
config: { catchError?: boolean },
success?: Function,
error?: Function
): Promise<string> {
return;
}
}