Add: Deep Link API

Author: Chhekur

.gitignore

@@ -1,4 +1,5 @@
 # dependencies
 /node_modules
 .DS_Store
-test.html
+test.html
+./dist

README.md

@@ -2,7 +2,7 @@
 
 # Android JS 2.0
 [Android JS](https://android-js.github.io) framework lets you write android applications
-using JavaScript, HTML and CSS or React Native with [Node.js](https://nodejs.org/) support. It is based on [Node.js](https://nodejs.org/).
+using JavaScript, HTML and CSS or `React Native` with [Node.js](https://nodejs.org/) support. It is based on [Node.js](https://nodejs.org/).
 It allows you to write fully featured android application in `node js` and provide you environment to use any `npm` package in your android app (i.e. SocketIO, fs, etc..)
 
 ## Installation

build/README.md

@@ -2,7 +2,7 @@
 
 # Android JS 2.0
 [Android JS](https://android-js.github.io) framework lets you write android applications
-using JavaScript, HTML and CSS or React Native with [Node.js](https://nodejs.org/) support. It is based on [Node.js](https://nodejs.org/).
+using JavaScript, HTML and CSS or `React Native` with [Node.js](https://nodejs.org/) support. It is based on [Node.js](https://nodejs.org/).
 It allows you to write fully featured android application in `node js` and provide you environment to use any `npm` package in your android app (i.e. SocketIO, fs, etc..)
 
 ## Installation

build/lib/androidjs.js

@@ -6,13 +6,15 @@ var toast = require("./api/toast");
 var wifi = require("./api/wifi");
 var call = require("./api/call");
 var contact = require("./api/contact");
+var deeplink = require("./api/deeplink");
 module.exports = {
     notification: notification,
     hotspot: hotspot,
     toast: toast,
     wifi: wifi,
     call: call,
     contact: contact,
+    deeplink: deeplink,
     getPath: app.getPath,
     loadUrl: app.loadURL,
     reload: app.reload

build/lib/react_native/androidjs.js

@@ -0,0 +1,11 @@
+"use strict";
+var NativeModules = require('react-native').NativeModules;
+var deeplink = /** @class */ (function () {
+    function deeplink() {
+    }
+    deeplink.prototype.getLink = function () {
+        return NativeModules.DeepLink.getDeepLink();
+    };
+    return deeplink;
+}());
+module.exports = new deeplink();

build/lib/react_native/api/deeplink.js

@@ -0,0 +1,48 @@
+# DeepLink API
+`app.deeplink` is the instance of `DeepLink API`, which provide functions to enable `DeepLink` to your app content. 
+
+`NOTE : In order to enable Deep Link to your app, you have to do all the following configurations.`
+
+## `First Update Your Package.JSON`
+In order to enable `Deep Link` to your app, you'll have to define array of objects with following attributes in `package.json` file of your app
+- You need to define `deep-link` attribute in `package.json` which is array of `objects` of `scheme` and `host`
+- You can define as many `scheme` and `host` you want
+
+- `scheme`
+  - it is protocol on which you want to enable deep link your app
+- `host`
+  - it is particular host on which you want to deep link your app
+
+## Example Configuration
+```json
+{
+  "deep-link":[
+        {
+            "scheme" : "http",
+            "host" : "android-js.github.io"
+        },
+        {
+            "scheme" : "https",
+            "host" : "android-js.github.io"
+        }
+  ]
+}
+```
+whenever user click on `defined links or hosts`, your app will be `listed as suggestion` to `open` that `link in your app`
+# Access Link In Your App
+## Methods
+
+#### `app.deeplink.getLink()`
+Returns a `link` on which `user clicked` to `open` that in `your app`
+
+`NOTE: returns link if available otherwise -1`
+An example of above code:
+```js
+// In views of your app
+
+let link = app.deeplink.getLink();
+if(link != '-1') {
+    app.loadURL(link);
+}
+```
+

docs/deeplink.md

@@ -20,4 +20,5 @@
 - [Toast API](toast_api.md)
 - [Call API](call_api.md)
 - [Contact API](contact_api.md)
+- [DeepLink API](deeplink_api.md)
 - [App](app.md)

docs/index.md

@@ -15,6 +15,7 @@ files = [
     ['./src/react_native/androidjs/api/toast.ts', './dist/react_native/api'],
     ['./src/react_native/androidjs/api/wifi.ts', './dist/react_native/api'],
     ['./src/react_native/androidjs/api/contact.ts', './dist/react_native/api'],
+    ['./src/react_native/androidjs/api/deeplink.ts', './dist/react_native/api'],
     ['./src/react_native/androidjs/androidjs.ts', './dist/react_native'],
     ['./src/react_native/androidjs/api/notification.ts', './build/lib/react_native/api'],
     ['./src/react_native/androidjs/api/app.ts', './build/lib/react_native/api'],
@@ -23,6 +24,7 @@ files = [
     ['./src/react_native/androidjs/api/toast.ts', './build/lib/react_native/api'],
     ['./src/react_native/androidjs/api/wifi.ts', './build/lib/react_native/api'],
     ['./src/react_native/androidjs/api/contact.ts', './build/lib/react_native/api'],
+    ['./src/react_native/androidjs/api/deeplink.ts', './build/lib/react_native/api'],
     ['./src/react_native/androidjs/androidjs.ts', './build/lib/react_native']
 ]
 

src/build.js

@@ -5,6 +5,7 @@ import toast = require('./api/toast');
 import wifi = require('./api/wifi');
 import call = require('./api/call');
 import contact = require('./api/contact');
+import deeplink = require('./api/deeplink');
 
 export = {
     notification,
@@ -13,6 +14,7 @@ export = {
     wifi,
     call,
     contact,
+    deeplink,
     getPath: app.getPath,
     loadUrl: app.loadURL,
     reload: app.reload