import { IonicNativePlugin } from '@ionic-native/core'; import { Observable } from 'rxjs'; export interface DeeplinkMatch { /** * The route info for the matched route */ $route: any; /** * Any arguments passed either through route parameters or GET parameters */ $args: any; /** * The deeplink object processed from the plugin, along with any * any internal native data available as "extras" at the time * the route was matched (for example, Facebook sometimes adds extra data) */ $link: any; } export interface DeeplinkOptions { /** * Set the matched route as root page using `navCtrl.setRoot()` method. */ root: boolean; } /** * @name Deeplinks * @premier deeplinks * @description This plugin handles deeplinks on iOS and Android for both custom URL scheme links * and Universal App Links. * * Please read the [ionic plugin deeplinks docs](https://github.com/ionic-team/ionic-plugin-deeplinks) for iOS and Android integration. * You must add `universal-links` to your `config.xml` and set up Apple App Site Association (AASA) for iOS and Asset Links for Android. * * @usage * ```typescript * import { Deeplinks } from '@ionic-native/deeplinks/ngx'; * * constructor(private deeplinks: Deeplinks) { } * * this.deeplinks.route({ * '/about-us': AboutPage, * '/universal-links-test': AboutPage, * '/products/:productId': ProductPage * }).subscribe(match => { * // match.$route - the route we matched, which is the matched entry from the arguments to route() * // match.$args - the args passed in the link * // match.$link - the full link data * console.log('Successfully matched route', match); * }, nomatch => { * // nomatch.$link - the full link data * console.error('Got a deeplink that didn\'t match', nomatch); * }); * ``` * * Alternatively, if you're using Ionic, there's a convenience method that takes a reference to a `NavController` and handles * the actual navigation for you: * * ```typescript * this.deeplinks.routeWithNavController(this.navController, { * '/about-us': AboutPage, * '/products/:productId': ProductPage * }).subscribe(match => { * // match.$route - the route we matched, which is the matched entry from the arguments to route() * // match.$args - the args passed in the link * // match.$link - the full link data * console.log('Successfully matched route', match); * }, nomatch => { * // nomatch.$link - the full link data * console.error('Got a deeplink that didn\'t match', nomatch); * }); * ``` * * See the [Ionic Deeplinks Demo](https://github.com/ionic-team/ionic2-deeplinks-demo/blob/master/app/app.ts) for an example of how to * retrieve the `NavController` reference at runtime. * * @interfaces * DeeplinkMatch */ export declare class DeeplinksOriginal extends IonicNativePlugin { /** * Define a set of paths to match against incoming deeplinks. * * @param {paths} paths Define a set of paths to match against incoming deeplinks. * paths takes an object of the form { 'path': data }. If a deeplink * matches the path, the resulting path-data pair will be returned in the * promise result which you can then use to navigate in the app as you see fit. * @returns {Observable} Returns an Observable that is called each time a deeplink comes through, and * errors if a deeplink comes through that does not match a given path. */ route(paths: any): Observable; /** * * This is a convenience version of `route` that takes a reference to a NavController * from Ionic, or a custom class that conforms to this protocol: * * NavController.push = function(View, Params){} * * This handler will automatically navigate when a route matches. If you need finer-grained * control over the behavior of a matching deeplink, use the plain `route` method. * * @param {Nav} navController Define a set of paths to match against incoming deeplinks. * paths takes an object of the form { 'path': data }. If a deeplink * matches the path, the resulting path-data pair will be returned in the * promise result which you can then use to navigate in the app as you see fit. * * @param {Object} paths * * @param {DeeplinkOptions} options * * @returns {Observable} Returns an Observable that resolves each time a deeplink comes through, and * errors if a deeplink comes through that does not match a given path. */ routeWithNavController(navController: any, paths: any, options?: DeeplinkOptions): Observable; } export declare const Deeplinks: DeeplinksOriginal;