DSBridge Android

https://github.com/wendux/dsbridge-android
Admin
DSBridge for Android is a modern cross-platform JavaScript bridge that enables synchronous or...
Tokens:3,257
Snippets:31
Trust Score:9
Update:1 year ago
Show doc for...
Tokens:
Raw
### Initialize dsBridge in Javascript

Source: https://github.com/wendux/dsbridge-android/blob/master/readme-chs.md

Include the dsBridge library in your Javascript code, either via CDN or by installing and requiring it via npm, to make the 'dsBridge' object available.

```Javascript
//cdn方式引入初始化代码(中国地区慢，建议下载到本地工程)
//<script src="https://unpkg.com/dsbridge@3.1.3/dist/dsbridge.js"> </script>
//npm方式安装初始化代码
//npm install dsbridge@3.1.3
var dsBridge=require("dsbridge")
```

--------------------------------

### Setting Javascript Close Window Listener - Java

Source: https://github.com/wendux/dsbridge-android/blob/master/readme.md

Provides an example of setting a listener in Java to intercept and handle JavaScript calls to `window.close`. Returning `false` from the `onClose` method prevents the default behavior (closing the current activity).

```java
dwebview.setJavascriptCloseWindowListener(new DWebView.JavascriptCloseWindowListener() {
    @Override
    public boolean onClose() {
        Log.d("jsbridge","window.close is called in Javascript");
        //If return false,the default handler will be prevented. 
        return false;
    }
});
```

--------------------------------

### Checking Native Method Existence - Javascript

Source: https://github.com/wendux/dsbridge-android/blob/master/readme.md

Provides examples of using `dsBridge.hasNativeMethod` from JavaScript to check if a specific native (Java/Kotlin) method or a method within a native namespace exists. It can optionally check for synchronous ('syn') or asynchronous ('asyn') types.

```javascript
dsBridge.hasNativeMethod('testAsyn') 
//test namespace method
dsBridge.hasNativeMethod('test.testAsyn')
// test if exist a asynchronous function that named "testSyn"
dsBridge.hasNativeMethod('testSyn','asyn') //false
```

--------------------------------

### Registering Javascript API Objects with Namespaces - Javascript

Source: https://github.com/wendux/dsbridge-android/blob/master/readme.md

Demonstrates registering a group of related synchronous and asynchronous JavaScript methods under namespaces (`test`, `test1`) by providing an object. This helps organize JavaScript APIs exposed to native code.

```javascript
//namespace test for synchronous
dsBridge.register("test",{
  tag:"test",
  test1:function(){
	return this.tag+"1"
  },
  test2:function(){
	return this.tag+"2"
  }
})
  
//namespace test1 for asynchronous calls  
dsBridge.registerAsyn("test1",{
  tag:"test1",
  test1:function(responseCallback){
	return responseCallback(this.tag+"1")
  },
  test2:function(responseCallback){
	return responseCallback(this.tag+"2")
  }
})
```

--------------------------------

### Add JitPack Repository in Gradle

Source: https://github.com/wendux/dsbridge-android/blob/master/readme-chs.md

Add the JitPack Maven repository to your project's top-level or app-level build.gradle file under the 'repositories' block to fetch the DSBridge library.

```Groovy
allprojects {
  repositories {
   ...
   maven { url 'https://jitpack.io' }
  }
}
```

--------------------------------

### Add DSBridge Dependency in Gradle

Source: https://github.com/wendux/dsbridge-android/blob/master/readme-chs.md

Include the DSBridge-Android library as a dependency in your app's build.gradle file. Choose the standard version or the version supporting Tencent X5 browser core.

```Groovy
dependencies {
	//compile 'com.github.wendux:DSBridge-Android:3.0-SNAPSHOT'
	//support the x5 browser core of tencent
	//compile 'com.github.wendux:DSBridge-Android:x5-3.0-SNAPSHOT'
}
```

--------------------------------

### Registering Javascript Methods for Native Call - Javascript

Source: https://github.com/wendux/dsbridge-android/blob/master/readme.md

Shows how to register synchronous (`dsBridge.register`) and asynchronous (`dsBridge.registerAsyn`) JavaScript functions that can be called from native code. Synchronous methods return a value, while asynchronous methods use a `responseCallback`.

```javascript
dsBridge.register('addValue',function(l,r){
     return l+r;
})
dsBridge.registerAsyn('append',function(arg1,arg2,arg3,responseCallback){
     responseCallback(arg1+" "+arg2+" "+arg3);
})
```

--------------------------------

### Call Javascript API from Java (Variations)

Source: https://github.com/wendux/dsbridge-android/blob/master/readme-chs.md

Demonstrates different overloads of the 'dWebView.callHandler' method for invoking Javascript functions with or without arguments and an optional callback to receive the return value.

```Java
dWebView.callHandler("append",new Object[]{"I","love","you"},new OnReturnValue<String>()){
    @Override
    public void onValue(String retValue) {
        Log.d("jsbridge","call succeed, append string is: "+retValue);
    }1
});
// call with namespace 'syn', More details to see the Demo project
dWebView.callHandler("syn.getInfo", new OnReturnValue<JSONObject>() {
    @Override
    public void onValue(JSONObject retValue) {
      showToast(retValue);
    }
});
```

--------------------------------

### Enable Web Contents Debugging

Source: https://github.com/wendux/dsbridge-android/blob/master/readme-chs.md

Activate DSBridge debugging mode. In this mode, errors will be shown in popups, and native API exceptions will not be automatically caught, aiding development.

```Java
DWebView.setWebContentsDebuggingEnabled(true)
```

--------------------------------

### Calling Namespaced Javascript API Objects from Native - Java

Source: https://github.com/wendux/dsbridge-android/blob/master/readme.md

Shows how to call the specific methods (`test1`, `test2`) within the namespaced JavaScript API objects (`test`, `test1`) registered in the previous step using the `namespace.methodName` format with `webView.callHandler`.

```java
webView.callHandler("test.test1",new OnReturnValue<String>(){
    @Override
    public void onValue(String retValue) {
        Log.d("jsbridge","Namespace test.test1: "+retValue);
    }
});

webView.callHandler("test1.test1",new OnReturnValue<String>(){
    @Override
    public void onValue(String retValue) {
        Log.d("jsbridge","Namespace test.test1: "+retValue);
    }
});
```

--------------------------------

### Calling Javascript Method with Callback - Java

Source: https://github.com/wendux/dsbridge-android/blob/master/readme.md

Demonstrates how to call a JavaScript handler method from Java using `dwebview.callHandler`. It includes passing arguments and handling the response asynchronously via an `OnReturnValue` callback. The callback is executed on the main thread.

```java
dWebView.callHandler("append",new Object[]{"I","love","you"},new OnReturnValue<String>((){
    @Override
    public void onValue(String retValue) {
        Log.d("jsbridge","call succeed, append string is: "+retValue);
    }
});
```

--------------------------------

### Calling Registered Javascript Methods from Native - Java

Source: https://github.com/wendux/dsbridge-android/blob/master/readme.md

Illustrates how to call the JavaScript methods (`addValue`, `append`) that were registered in the previous step using `webView.callHandler`. Results are handled via `OnReturnValue` callbacks.

```java
webView.callHandler("addValue",new Object[]{1,6},new OnReturnValue(){
  @Override
  public void onValue(String retValue) {
    Log.d("jsbridge","call succeed,return value is: "+retValue);
  }
});

 webView.callHandler("append",new Object[]{"I","love","you"},new OnReturnValue(){
   @Override
   public void onValue(String retValue) {
     Log.d("jsbridge","call succeed, append string is: "+retValue);
   }
 });
```

--------------------------------

### Add Java API Object to DWebView

Source: https://github.com/wendux/dsbridge-android/blob/master/readme-chs.md

Instantiate your Java API class and add it to the DWebView instance. A null namespace means methods are callable directly by name; a non-null string assigns a namespace.

```Java
import wendu.dsbridge.DWebView;
...
DWebView dwebView= (DWebView) findViewById(R.id.dwebview);
dwebView.addJavascriptObject(new JsApi(), null);
```

--------------------------------

### Add Java API Object with Namespace

Source: https://github.com/wendux/dsbridge-android/blob/master/readme-chs.md

Add an instance of your Java API class to the DWebView, specifying a namespace string. Javascript calls must then prepend the namespace to the method name.

```Java
//namespace is "echo"
dwebView.addJavascriptObject(new JsEchoApi(),"echo");
```

--------------------------------

### Implement Progress Callback in Java

Source: https://github.com/wendux/dsbridge-android/blob/master/readme-chs.md

Define a Java method using 'CompletionHandler.setProgressData' within an asynchronous call to send multiple progress updates back to Javascript before finally calling 'complete'.

```Java
@JavascriptInterface
public void callProgress(Object args, final CompletionHandler<Integer> handler) {
    new CountDownTimer(11000, 1000) {
        int i=10;
        @Override
        public void onTick(long millisUntilFinished) {
            //setProgressData can be called many times util complete be called.
            handler.setProgressData((i--));
        }
        @Override
        public void onFinish() {
           //complete the js invocation with data;
           //handler will invalid when complete is called
            handler.complete(0);
        }
    }.start();
}
```

--------------------------------

### Define Java API Class with Namespace

Source: https://github.com/wendux/dsbridge-android/blob/master/readme-chs.md

Create a Java class with @JavascriptInterface methods intended to be added under a specific namespace when exposed to Javascript.

```Java
public class JsEchoApi {
    @JavascriptInterface
    public Object syn(Object args) throws JSONException {
        return  args;
    }

    @JavascriptInterface
    public void asyn(Object args,CompletionHandler handler){
        handler.complete(args);
    }
}
```

--------------------------------

### Receive Progress Callback in Javascript

Source: https://github.com/wendux/dsbridge-android/blob/master/readme-chs.md

Call the Java method designed for progress updates using 'dsBridge.call' and provide a single callback function that will be invoked multiple times with progress data.

```Javascript
dsBridge.call("callProgress", function (value) {
    document.getElementById("progress").innerText = value
})
```

--------------------------------

### Define Java API Class

Source: https://github.com/wendux/dsbridge-android/blob/master/readme-chs.md

Create a Java class with methods annotated with @JavascriptInterface to be exposed to Javascript. Synchronous methods return a value; asynchronous methods use a CompletionHandler.

```Java
public class JsApi{
    //同步API
    @JavascriptInterface
    public String testSyn(Object msg)  {
        return msg + "［syn call］";
    }

    //异步API
    @JavascriptInterface
    public void testAsyn(Object msg, CompletionHandler<String> handler) {
        handler.complete(msg+" [ asyn call]");
    }
}
```

--------------------------------

### Register Javascript API for Native Calls (dsBridge.register)

Source: https://github.com/wendux/dsbridge-android/blob/master/readme-chs.md

The method in Javascript to expose functions or objects to be called from Java. Takes the method name or namespace and the corresponding function or object containing the API methods.

```Javascript
dsBridge.register(methodName|namespace,function|synApiObject)
```

--------------------------------

### Call Native API and Register Javascript API

Source: https://github.com/wendux/dsbridge-android/blob/master/readme-chs.md

Use 'dsBridge.call' in Javascript to invoke native Java methods synchronously or asynchronously. Use 'dsBridge.register' to expose a Javascript function that can be called from Java.

```Javascript
//同步调用
var str=dsBridge.call("testSyn","testSyn");

//异步调用
dsBridge.call("testAsyn","testAsyn", function (v) {
  alert(v);
})

//注册 javascript API 
dsBridge.register('addValue',function(l,r){
    return l+r;
})
```

--------------------------------

### Calling Namespaced Javascript Method - Java

Source: https://github.com/wendux/dsbridge-android/blob/master/readme.md

Illustrates calling a JavaScript handler method that belongs to a specific namespace (e.g., 'syn.getInfo') from Java using `dwebview.callHandler`. The result is handled asynchronously through an `OnReturnValue` callback.

```java
dWebView.callHandler("syn.getInfo", new OnReturnValue<JSONObject>() {
    @Override
    public void onValue(JSONObject retValue) {
      showToast(retValue);
    }
});
```

--------------------------------

### Checking Javascript Method Existence - Java

Source: https://github.com/wendux/dsbridge-android/blob/master/readme.md

Demonstrates how to check from Java if a specific JavaScript handler method exists in the loaded content using `dwebview.hasJavascriptMethod`. The result is received asynchronously via an `OnReturnValue<Boolean>` callback.

```java
 dWebView.hasJavascriptMethod("addValue", new OnReturnValue<Boolean>() {
    @Override
    public void onValue(Boolean retValue) {
     showToast(retValue);
    }
 });
```

--------------------------------

### Call Javascript API from Java

Source: https://github.com/wendux/dsbridge-android/blob/master/readme-chs.md

Use 'dwebView.callHandler' in Java to invoke a Javascript function registered with dsBridge. Provide the handler name, an array of arguments, and an optional OnReturnValue handler for asynchronous results.

```Java
dwebView.callHandler("addValue",new Object[]{3,4},new OnReturnValue<Integer>(){
     @Override
     public void onValue(Integer retValue) {
        Log.d("jsbridge","call succeed,return value is "+retValue);
     }
 });
```

--------------------------------

### Call Native API from Javascript (dsBridge.call)

Source: https://github.com/wendux/dsbridge-android/blob/master/readme-chs.md

The primary method in Javascript to invoke Java API methods. It accepts the method name (with optional namespace), an argument (can be an object for multiple values), and an optional callback for asynchronous results.

```Javascript
dsBridge.call(method,[arg,callback])
```

--------------------------------

### Call Namespaced Native API in Javascript

Source: https://github.com/wendux/dsbridge-android/blob/master/readme-chs.md

Invoke a Java API method from Javascript when the corresponding Java object was added with a namespace. Use dot notation ('namespace.methodName') in the call.

```Javascript
// call echo.syn
var ret=dsBridge.call("echo.syn",{msg:" I am echoSyn call", tag:1})
alert(JSON.stringify(ret))
// call echo.asyn
dsBridge.call("echo.asyn",{msg:" I am echoAsyn call",tag:2},function (ret) {
      alert(JSON.stringify(ret));
})
```

--------------------------------

### Disabling Javascript Dialog Blocking - Javascript

Source: https://github.com/wendux/dsbridge-android/blob/master/readme.md

Shows how to use `dsBridge.disableJavascriptDialogBlock` from JavaScript to control the blocking behavior of `alert`, `confirm`, and `prompt` dialogs, mirroring the functionality available from the native side.

```javascript
//disable
dsBridge.disableJavascriptDialogBlock()
//enable
dsBridge.disableJavascriptDialogBlock(false)
```

--------------------------------

### Check for Javascript Method Existence

Source: https://github.com/wendux/dsbridge-android/blob/master/readme-chs.md

Asynchronously check if a specific Javascript API method exists on the page, optionally using its namespace. The result is delivered to the provided OnReturnValue callback.

```Java
 dWebView.hasJavascriptMethod("addValue", new OnReturnValue<Boolean>() {
    @Override
    public void onValue(Boolean retValue) {
     showToast(retValue);
    }
 });
```

--------------------------------

### Disabling Javascript Dialog Blocking - JavaScript

Source: https://github.com/wendux/dsbridge-android/blob/master/readme.md

Shows how to disable the default behavior where JavaScript popup boxes (`alert`, `confirm`, `prompt`) block the execution flow. Calling this with `true` makes the functions return immediately (`confirm` -> `true`, `prompt` -> empty string).

```javascript
dwebview.disableJavascriptDialogBlock(true);
```

--------------------------------

### Remove Java API Object by Namespace

Source: https://github.com/wendux/dsbridge-android/blob/master/readme-chs.md

Remove a previously added Java API object from the DWebView by providing the namespace it was registered under.

```Java
dwebview.removeJavascriptObject(String namespace)
```

--------------------------------

### Set Javascript Close Window Listener

Source: https://github.com/wendux/dsbridge-android/blob/master/readme-chs.md

Register a listener to be notified when 'window.close' is called in Javascript. Return 'false' in the listener's 'onClose' method to prevent the default behavior (closing the Activity).

```Java
dwebview.setJavascriptCloseWindowListener(new DWebView.JavascriptCloseWindowListener() {
    @Override
    public boolean onClose() {
        Log.d("jsbridge","window.close is called in Javascript");
        //如果返回false,则阻止DWebView默认处理.
        return false;
    }
});
```

--------------------------------

### Disable Javascript Dialog Blocking

Source: https://github.com/wendux/dsbridge-android/blob/master/readme-chs.md

Control whether Javascript alert/confirm/prompt dialogs block the UI thread. Setting 'disable' to true makes dialogs non-modal, preventing thread blocking but changing their default return behavior.

```Java
dwebview.disableJavascriptDialogBlock(true);
```
Tokens:
Raw