Xiaoe App SDK Android

https://github.com/xiaoeteam/xiaoeappsdk-android
Admin
Xiaoe App SDK is an embedded Android SDK that enables fast integration of Xiaoe's trading services...
Tokens:10,116
Snippets:86
Trust Score:5.9
Update:5 months ago
Show doc for...
Tokens:
Raw
### XiaoEWeb.init() - SDK Initialization

Source: https://context7.com/xiaoeteam/xiaoeappsdk-android/llms.txt

Initialize the SDK globally in your Application class's onCreate() method. This must be called after the user agrees to the privacy policy.

```APIDOC
## SDK Initialization

Call `XiaoEWeb.init()` in your custom `Application`'s `onCreate()` method.

```java
public class SdkDemoApplication extends Application {
    @Override
    public void onCreate() {
        super.onCreate();

        // If the user denies privacy authorization, call disableSensitiveApi() first
        // XiaoEWeb.disableSensitiveApi();

        // Initialize the SDK: context, app_id, client_id, WebView kernel type
        // WebViewType.X5 = Tencent X5 kernel (recommended); WebViewType.Android = System native kernel
        XiaoEWeb.init(this, "app38itOR341547", "883pzzGyzynE72G", XiaoEWeb.WebViewType.X5);

        // Enable debug logs (for development phase only)
        XiaoEWeb.isOpenLog(true);
    }
}
```
```

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

### Initialize XiaoE SDK

Source: https://github.com/xiaoeteam/xiaoeappsdk-android/wiki/1.-开始使用

Initialize the SDK in your custom Application class. Provide your app_id, client_id, and choose a WebView type (X5 is recommended).

```java
public class XXXplication extends Application{
    @Override
    public void onCreate(){
        super.onCreate();
	//初始化SDK
        XiaoEWeb.init(this, "app_id", "client_id", XiaoEWeb.WebViewType.X5);
    }
}
```

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

### 引入 SDK 依赖

Source: https://context7.com/xiaoeteam/xiaoeappsdk-android/llms.txt

在 project/build.gradle 中添加 mavenCentral() 仓库，并在子模块的 dependencies 中引入 SDK 和腾讯 X5 内核。

```groovy
// project/build.gradle
allprojects {
    repositories {
        mavenCentral()
    }
}

// app/build.gradle
dependencies {
    implementation 'com.xiaoetong.android.sdk:webcore:2.2.73' // 最新版本号
    implementation 'com.tencent.tbs.tbssdk:sdk:44115'
}
```

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

### Configure Activity for WebView

Source: https://github.com/xiaoeteam/xiaoeappsdk-android/wiki/1.-开始使用

Configure the activity that will host the XiaoE shop's WebView to enable hardware acceleration and handle screen rotation.

```xml
<activity android:name=".XXXActivity"
    android:configChanges="orientation|screenSize|keyboardHidden"
    android:hardwareAccelerated="true"/>
```

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

### XiaoEWeb.with() Builder - Loading Store Pages

Source: https://context7.com/xiaoeteam/xiaoeappsdk-android/llms.txt

Use the chainable builder to dynamically create and load WebView instances. This method allows loading store pages without pre-declaring WebView in XML.

```APIDOC
## Loading Store Pages

Use the `XiaoEWeb.with()` builder to load store pages.

```java
// Store homepage URL format: https://{{app_id}}.h5.xiaoeknow.com
// Other content page URL format: Replace the domain with {{app_id}}.h5.xiaoeknow.com
String shopUrl = "https://app38itOR341547.h5.xiaoeknow.com";

RelativeLayout webLayout = findViewById(R.id.web_layout);

XiaoEWeb xiaoEWeb = XiaoEWeb.with(this)
    // Set the WebView's parent container and layout parameters (MATCH_PARENT for full screen)
    .setWebParent(webLayout, new ViewGroup.LayoutParams(
            ViewGroup.LayoutParams.MATCH_PARENT,
            ViewGroup.LayoutParams.MATCH_PARENT))
    // Use default error and loading page UI (can be replaced with useCustomUI(errorLayoutId, loadingLayoutId))
    .useDefaultUI()
    // Set the color of the top loading progress bar
    .useDefaultTopIndicator(getResources().getColor(R.color.colorPrimaryDark))
    // Build the WebView
    .buildWeb()
    // Load the target URL
    .loadUrl(shopUrl);
```
```

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

### SDK 初始化

Source: https://context7.com/xiaoeteam/xiaoeappsdk-android/llms.txt

在自定义 Application 的 onCreate() 中调用，完成 SDK 全局初始化。需在用户同意隐私协议后调用；若用户拒绝授权，须先调用 disableSensitiveApi() 再初始化。

```java
public class SdkDemoApplication extends Application {
    @Override
    public void onCreate() {
        super.onCreate();

        // 若用户拒绝隐私授权，需先禁用敏感 API
        // XiaoEWeb.disableSensitiveApi();

        // 初始化 SDK：context、app_id、client_id、WebView 内核类型
        // WebViewType.X5 = 腾讯 X5 内核（推荐）；WebViewType.Android = 系统原生内核
        XiaoEWeb.init(this, "app38itOR341547", "883pzzGyzynE72G", XiaoEWeb.WebViewType.X5);

        // 开启调试日志（仅开发阶段使用）
        XiaoEWeb.isOpenLog(true);
    }
}
```

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

### Load Web Page with XiaoE SDK

Source: https://github.com/xiaoeteam/xiaoeappsdk-android/wiki/1.-开始使用

Dynamically add a WebView to load a web page. Specify the parent container and layout parameters, and optionally configure the UI and top indicator.

```java
XiaoEWeb.with(this)
        .setWebParent(webLayout, new ViewGroup.LayoutParams(ViewGroup.LayoutParams.MATCH_PARENT, ViewGroup.LayoutParams.MATCH_PARENT))
        .useDefaultUI()
        .useDefaultTopIndicator(getResources().getColor(R.color.colorPrimaryDark))
        .buildWeb()
        .loadUrl(Const.SHOP_URL);
```

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

### Add SDK Dependencies

Source: https://github.com/xiaoeteam/xiaoeappsdk-android/blob/master/README.md

Include the webcore and Tencent TBS SDK dependencies in your app's build.gradle file. Ensure you use the latest version for webcore.

```gradle
implementation 'com.xiaoetong.android.sdk:webcore:2.2.73'//最新版本号
```

```gradle
implementation 'com.tencent.tbs.tbssdk:sdk:44115'
```

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

### SDK Dependency and Manifest Configuration

Source: https://context7.com/xiaoeteam/xiaoeappsdk-android/llms.txt

Instructions for adding the SDK dependency to your project's build.gradle file and configuring necessary permissions and activity settings in AndroidManifest.xml.

```APIDOC
## Dependency Setup

In `project/build.gradle`:
```groovy
allprojects {
    repositories {
        mavenCentral()
    }
}
```

In `app/build.gradle`:
```groovy
dependencies {
    implementation 'com.xiaoetong.android.sdk:webcore:2.2.73' // Replace with the latest version
    implementation 'com.tencent.tbs.tbssdk:sdk:44115'
}
```

## AndroidManifest Configuration

Add permissions and activity settings to `AndroidManifest.xml`:

```xml
<!-- Permissions -->
<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
<uses-permission android:name="android.permission.CAMERA"/>
<uses-permission android:name="android.permission.READ_PHONE_STATE" />

<!-- Activity Configuration (for the Activity hosting the WebView) -->
<activity
    android:name=".XeSdkDemoActivity"
    android:configChanges="orientation|screenSize|keyboardHidden"
    android:hardwareAccelerated="true"/>
```
```

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

### Add SDK Dependencies

Source: https://github.com/xiaoeteam/xiaoeappsdk-android/wiki/2.Android端接入指南

Include these dependencies in your module's build.gradle file to incorporate the XiaoE SDK and its required components.

```java
implementation 'com.xiaoetong.android.sdk:webcore:2.2.19'//最新版本号
```

```java
implementation 'com.tencent.tbs.tbssdk:sdk:43993'
```

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

### Sync Login State with H5 Shop Page

Source: https://context7.com/xiaoeteam/xiaoeappsdk-android/llms.txt

Synchronizes login state to the H5 shop page after obtaining a business token. Clears login state on failure. Recommended to use server-side calls to the SDK login interface to avoid exposing secret keys on the client.

```java
// 服务端登录接口响应示例：
// { "code": 0, "msg": "成功", "data": { "token_key": "xe_sdk_token", "token_value": "d6a09cd4c0111e92..." } }

// 调用业务后台 SDK 登录接口
Map<String, Object> params = new HashMap<>();
params.put("user_id", "user_123");
params.put("app_user_id", "user_123");
params.put("secret_key", "your_secret_key");      // 建议由服务端持有，不在客户端暴露
params.put("sdk_app_id", "your_client_id");
params.put("app_id", "your_app_id");

OkHttpHelper.getInstance().post(SDK_LOGIN_URL, params, new SimpleCallBack<LoginEntity>(this) {
    @Override
    public void onSuccess(Response response, LoginEntity loginEntity) {
        if (loginEntity.getCode() == 0 && loginEntity.getData() != null) {
            // 登录成功：构建 XEToken 并同步到 H5
            XEToken token = new XEToken(
                loginEntity.getData().getToken_key(),   // "xe_sdk_token"
                loginEntity.getData().getToken_value()  // "d6a09cd4c0111e92..."
            );
            xiaoEWeb.sync(token);
        } else {
            // 登录失败：清除登录态，避免 H5 出现空白页
            xiaoEWeb.syncNot();
        }
    }

    @Override
    public void onFailure(Request request, IOException e) {
        xiaoEWeb.syncNot();
    }
});
```

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

### Handle Login and Share Callbacks

Source: https://github.com/xiaoeteam/xiaoeappsdk-android/wiki/1.-开始使用

Implement the onJsInteract method to handle login, share, title, and external link actions. Synchronize login status with XiaoEWeb.sync() or XiaoEWeb.syncNot() after handling login actions.

```java
xiaoEWeb.setJsBridgeListener(new JsBridgeListener() {
    @Override
    public void onJsInteract(int actionType, JsCallbackResponse response) {
        switch (actionType) {
            case JsInteractType.LOGIN_ACTION:
                //H5登录态请求 这里三方 APP 应该调用登陆接口，获取到token_key, token_value
                //如果登录成功，通过XiaoEWeb.sync(XEToken)方法同步登录态到H5页面
                //如果登录失败，通过XiaoEWeb.syncNot()清除登录态
                break;

            case JsInteractType.SHARE_ACTION:
                //H5分享请求回调，通过 response.getResponseData() 获取分享的数据，这里三方 APP 自行分享登录方法
                break;

            case JsInteractType.TITLE_RECEIVE:
                //H5标题回调，通过 response.getResponseData() 获取标题
                break;

            case JsInteractType.NOTICE_OUT_LINK_ACTION:
                //sdk通知需要外部打开的链接回调，通过 response.getResponseData() 获取外链
                //原来后台自定义链接：
                //1.本来不带参数的  http://www.baidu.com
                //2.本来带参数的  http://www.baidu.com?xxx=xxx
                //需要sdk通知外部打开，拼装带参数needoutlink=1
                //1.本来不带参数的 http://www.baidu.com?needoutlink=1
                //2.本来带参数的  http://www.baidu.com?xxx=xxx&needoutlink=1
                break;
            }
        }
});
```

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

### 加载店铺页面

Source: https://context7.com/xiaoeteam/xiaoeappsdk-android/llms.txt

使用链式构建器动态创建并加载 WebView，无需在 XML 布局中预先声明 WebView 控件，只需指定父容器即可。

```java
// 店铺首页 URL 规则：https://{{app_id}}.h5.xiaoeknow.com
// 其他内容页 URL 规则：将域名替换为 {{app_id}}.h5.xiaoeknow.com
String shopUrl = "https://app38itOR341547.h5.xiaoeknow.com";

RelativeLayout webLayout = findViewById(R.id.web_layout);

XiaoEWeb xiaoEWeb = XiaoEWeb.with(this)
    // 设置 WebView 的父容器及布局参数（MATCH_PARENT 全屏填充）
    .setWebParent(webLayout, new ViewGroup.LayoutParams(
            ViewGroup.LayoutParams.MATCH_PARENT,
            ViewGroup.LayoutParams.MATCH_PARENT))
    // 使用默认错误页和加载页 UI（可替换为 useCustomUI(errorLayoutId, loadingLayoutId)）
    .useDefaultUI()
    // 设置顶部加载进度条颜色
    .useDefaultTopIndicator(getResources().getColor(R.color.colorPrimaryDark))
    // 构建 WebView
    .buildWeb()
    // 加载目标 URL
    .loadUrl(shopUrl);
```

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

### AndroidManifest 权限与 Activity 配置

Source: https://context7.com/xiaoeteam/xiaoeappsdk-android/llms.txt

在 AndroidManifest.xml 中声明必要的权限，并为承载 WebView 的 Activity 开启硬件加速和屏幕旋转配置。

```xml
<!-- 权限声明 -->
<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
<uses-permission android:name="android.permission.CAMERA"/>
<uses-permission android:name="android.permission.READ_PHONE_STATE" />

<!-- Activity 配置：必须在加载小鹅店铺 WebView 的 Activity 上配置 -->
<activity
    android:name=".XeSdkDemoActivity"
    android:configChanges="orientation|screenSize|keyboardHidden"
    android:hardwareAccelerated="true"/>
```

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

### Page Back Handling

Source: https://context7.com/xiaoeteam/xiaoeappsdk-android/llms.txt

Provides two ways to handle back navigation: system back button and custom back button. It also supports checking if the current WebView can navigate back.

```APIDOC
## Page Back Handling

### Description
Provides two ways to handle back navigation: system back button and custom back button. It also supports checking if the current WebView can navigate back.

### Methods
- `xiaoEWeb.handlerKeyEvent(int keyCode, KeyEvent event)`: Handles system back key events. Returns `true` if the WebView handled the back navigation.
- `xiaoEWeb.canGoBack()`: Checks if the WebView has a history to go back to.
- `xiaoEWeb.handlerBack()`: Navigates the WebView back to the previous page.

### Usage Example
```java
// Intercept system back key, prioritize WebView back navigation, then close the page
@Override
public boolean onKeyDown(int keyCode, KeyEvent event) {
    if (xiaoEWeb.handlerKeyEvent(keyCode, event)) {
        return true; // WebView handled back navigation, do not close Activity
    }
    return super.onKeyDown(keyCode, event);
}

// Custom back button click handling (same logic as handlerKeyEvent, suitable for custom navigation bars)
backButton.setOnClickListener(v -> {
    if (xiaoEWeb.canGoBack()) {
        xiaoEWeb.handlerBack(); // WebView navigates back to the previous page
    } else {
        finish();               // No history to go back to, close Activity
    }
});
```
```

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

### WebView Lifecycle Management

Source: https://context7.com/xiaoeteam/xiaoeappsdk-android/llms.txt

Forwards corresponding lifecycle callbacks to `xiaoEWeb` in Activity or Fragment to prevent memory leaks and resource unreleased.

```APIDOC
## WebView Lifecycle Management

### Description
Forwards corresponding lifecycle callbacks to `xiaoEWeb` in Activity or Fragment to prevent memory leaks and resource unreleased.

### Methods
- `xiaoEWeb.onResume()`: Resumes WebView (e.g., resumes JS execution, media playback).
- `xiaoEWeb.onPause()`: Pauses WebView (saves resources).
- `xiaoEWeb.onDestroy()`: Destroys WebView and releases memory.
- `xiaoEWeb.onActivityResult(int requestCode, int resultCode, @Nullable Intent data)`: Handles file selection results (e.g., image uploads).

### Usage Example
```java
public class XeSdkDemoActivity extends AppCompatActivity {

    private XiaoEWeb xiaoEWeb;

    @Override
    protected void onResume() {
        super.onResume();
        xiaoEWeb.onResume();   // Resume WebView
    }

    @Override
    protected void onPause() {
        super.onPause();
        xiaoEWeb.onPause();    // Pause WebView
    }

    @Override
    protected void onDestroy() {
        super.onDestroy();
        xiaoEWeb.onDestroy();  // Destroy WebView and release memory
    }

    @Override
    protected void onActivityResult(int requestCode, int resultCode, @Nullable Intent data) {
        super.onActivityResult(requestCode, resultCode, data);
        xiaoEWeb.onActivityResult(requestCode, resultCode, data); // Handle file selection results
    }
}
```
```

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

### Login State Synchronization

Source: https://context7.com/xiaoeteam/xiaoeappsdk-android/llms.txt

Synchronizes login state to H5 store pages after obtaining the business token. Clears login state on failure. It is recommended that the server calls the XiaoE SDK login interface and forwards the token to the App to avoid exposing the secret_key on the client.

```APIDOC
## `xiaoEWeb.sync()` / `xiaoEWeb.syncNot()` — Login State Synchronization

### Description
Synchronizes login state to H5 store pages after obtaining the business token. Clears login state on failure. It is recommended that the server calls the XiaoE SDK login interface and forwards the token to the App to avoid exposing the secret_key on the client.

### Method
`xiaoEWeb.sync(XEToken token)`: Synchronizes a valid token to the H5 store.
`xiaoEWeb.syncNot()`: Clears the login state.

### Parameters
#### `sync(XEToken token)` Parameters
- **token** (XEToken) - Required - The token object containing `token_key` and `token_value`.

### Request Example
```java
// Server-side login interface response example:
// { "code": 0, "msg": "Success", "data": { "token_key": "xe_sdk_token", "token_value": "d6a09cd4c0111e92..." } }

// Call the business backend SDK login interface
Map<String, Object> params = new HashMap<>();
params.put("user_id", "user_123");
params.put("app_user_id", "user_123");
params.put("secret_key", "your_secret_key");      // Recommended to be held by the server, not exposed on the client
params.put("sdk_app_id", "your_client_id");
params.put("app_id", "your_app_id");

OkHttpHelper.getInstance().post(SDK_LOGIN_URL, params, new SimpleCallBack<LoginEntity>(this) {
    @Override
    public void onSuccess(Response response, LoginEntity loginEntity) {
        if (loginEntity.getCode() == 0 && loginEntity.getData() != null) {
            // Login successful: construct XEToken and sync to H5
            XEToken token = new XEToken(
                loginEntity.getData().getToken_key(),   // "xe_sdk_token"
                loginEntity.getData().getToken_value()  // "d6a09cd4c0111e92..."
            );
            xiaoEWeb.sync(token);
        } else {
            // Login failed: clear login state to avoid a blank page in H5
            xiaoEWeb.syncNot();
        }
    }

    @Override
    public void onFailure(Request request, IOException e) {
        xiaoEWeb.syncNot();
    }
});
```

### Response
N/A (This is an action method)
```

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

### Configure Maven Central Repository

Source: https://github.com/xiaoeteam/xiaoeappsdk-android/wiki/2.Android端接入指南

Add this configuration to your project's top-level build.gradle file to ensure repositories like Maven Central are available for dependency resolution.

```java
allprojects {
    repositories {
            mavenCentral()
    }
}
```

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

### WebView Lifecycle Management

Source: https://context7.com/xiaoeteam/xiaoeappsdk-android/llms.txt

Forwards corresponding lifecycle callbacks to `xiaoEWeb` in Activity or Fragment to prevent memory leaks and resource unreleased.

```java
public class XeSdkDemoActivity extends AppCompatActivity {

    private XiaoEWeb xiaoEWeb;

    @Override
    protected void onResume() {
        super.onResume();
        xiaoEWeb.onResume();   // 恢复 WebView（如恢复 JS 执行、媒体播放等）
    }

    @Override
    protected void onPause() {
        super.onPause();
        xiaoEWeb.onPause();    // 暂停 WebView（节省资源）
    }

    @Override
    protected void onDestroy() {
        super.onDestroy();
        xiaoEWeb.onDestroy();  // 销毁 WebView，释放内存
    }

    @Override
    protected void onActivityResult(int requestCode, int resultCode, @Nullable Intent data) {
        super.onActivityResult(requestCode, resultCode, data);
        xiaoEWeb.onActivityResult(requestCode, resultCode, data); // 处理文件选择结果（如上传图片）
    }
}
```

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

### Implement JsBridgeListener

Source: https://github.com/xiaoeteam/xiaoeappsdk-android/wiki/1.-开始使用

Implement the JsBridgeListener interface to handle callback events from the XiaoE shop's JavaScript. Differentiate actions using actionType.

```java
public interface JsBridgeListener{
    void onJsInteract(int actionType, JsCallbackResponse response);
}
```

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

### Configure Maven Repository

Source: https://github.com/xiaoeteam/xiaoeappsdk-android/blob/master/README.md

Add the mavenCentral() repository to your project's allprojects block to ensure dependencies can be resolved.

```gradle
allprojects {
    repositories {
        mavenCentral()
    }
}
```

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

### Auxiliary Methods for SDK Functionality

Source: https://context7.com/xiaoeteam/xiaoeappsdk-android/llms.txt

Provides utility methods for cache clearing, login cancellation recovery, triggering shares, and disabling sensitive APIs.

```java
// 清除 WebView 加载缓存
xiaoEWeb.clearWebViewCache();

// 非首页登录失败时，调用此方法回到店铺首页，避免出现空白页
// 通常在用户点击"取消登录"时调用
mCancelBtn.setOnClickListener(v -> {
    mLoginDlg.dismiss();
    xiaoEWeb.loginCancel(); // 回退到店铺首页
});

// 主动触发获取当前页面分享内容（触发后通过 JsInteractType.SHARE_ACTION 回调返回数据）
xiaoEWeb.share();

// 刷新当前页面
xiaoEWeb.reload();

// 合规要求：用户拒绝隐私协议时，在 init() 之前调用，禁止 SDK 采集 IMEI、MAC 等敏感信息
XiaoEWeb.disableSensitiveApi();
```

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

### Handle Activity Result for File Selection

Source: https://github.com/xiaoeteam/xiaoeappsdk-android/wiki/1.-开始使用

Override the onActivityResult method in your activity and pass the result to the SDK using xiaoEWeb.onActivityResult() to handle file selection callbacks.

```java
@Override
    protected void onActivityResult(int requestCode, int resultCode, @Nullable Intent data) {
        super.onActivityResult(requestCode, resultCode, data);
        xiaoEWeb.onActivityResult(requestCode, resultCode, data);
    }
```

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

### Declare Permissions in AndroidManifest.xml

Source: https://github.com/xiaoeteam/xiaoeappsdk-android/wiki/1.-开始使用

Add these permissions to your AndroidManifest.xml file to ensure the SDK has the necessary access.

```xml
<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
<uses-permission android:name="android.permission.CAMERA"/>
<uses-permission android:name="android.permission.READ_PHONE_STATE" />
```

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

### Handle WebView Back Navigation

Source: https://github.com/xiaoeteam/xiaoeappsdk-android/wiki/1.-开始使用

Utilize the provided methods for handling back button presses in the WebView. handlerKeyEvent() is for the Android back button, and handlerBack() is for custom back buttons. Use canGoBack() to check if navigation is possible.

```java
handlerKeyEvent():   Android返回键对应的WebView的回退处理
handlerBack()：      自定义返回按钮对应的WebView的回退处理
canGoBack()：        判断当前网页是否可以回退
```

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

### Handle Page Back Navigation

Source: https://context7.com/xiaoeteam/xiaoeappsdk-android/llms.txt

Intercepts the system back button to prioritize WebView history navigation. If WebView cannot navigate back, it closes the page. Also supports custom back button handling.

```java
// 拦截系统返回键，优先让 WebView 回退历史，无法回退时再关闭页面
@Override
public boolean onKeyDown(int keyCode, KeyEvent event) {
    if (xiaoEWeb.handlerKeyEvent(keyCode, event)) {
        return true; // WebView 已处理回退，不关闭 Activity
    }
    return super.onKeyDown(keyCode, event);
}

// 自定义返回按钮点击处理（与 handlerKeyEvent 逻辑相同，适用于自定义导航栏）
backButton.setOnClickListener(v -> {
    if (xiaoEWeb.canGoBack()) {
        xiaoEWeb.handlerBack(); // WebView 回退到上一页
    } else {
        finish();               // 无历史可回退，关闭 Activity
    }
});
```

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

### Functional Auxiliary Methods

Source: https://context7.com/xiaoeteam/xiaoeappsdk-android/llms.txt

Provides auxiliary methods for cache clearing, login cancellation recovery, triggering sharing, and disabling sensitive APIs.

```APIDOC
## Functional Auxiliary Methods

### Description
Provides auxiliary methods for cache clearing, login cancellation recovery, triggering sharing, and disabling sensitive APIs.

### Methods
- `xiaoEWeb.clearWebViewCache()`: Clears the WebView cache.
- `xiaoEWeb.loginCancel()`: Restores to the store homepage when login fails on a non-homepage, avoiding a blank page. Typically called when the user clicks 'Cancel Login'.
- `xiaoEWeb.share()`: Actively triggers fetching the current page's share content (data is returned via JsInteractType.SHARE_ACTION callback).
- `xiaoEWeb.reload()`: Reloads the current page.
- `XiaoEWeb.disableSensitiveApi()`: Compliance requirement: Call before `init()` when the user refuses the privacy agreement to prohibit the SDK from collecting sensitive information like IMEI, MAC, etc.

### Usage Example
```java
// Clear WebView loading cache
xiaoEWeb.clearWebViewCache();

// When login fails on a non-homepage, call this method to return to the store homepage, avoiding a blank page
// Usually called when the user clicks "Cancel Login"
mCancelBtn.setOnClickListener(v -> {
    mLoginDlg.dismiss();
    xiaoEWeb.loginCancel(); // Return to the store homepage
});

// Actively trigger fetching current page share content (data returned via JsInteractType.SHARE_ACTION callback)
xiaoEWeb.share();

// Refresh the current page
xiaoEWeb.reload();

// Compliance requirement: When the user refuses the privacy agreement, call this before init() to prohibit the SDK from collecting sensitive information such as IMEI, MAC, etc.
XiaoEWeb.disableSensitiveApi();
```
```

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

### Functional Methods for WebView

Source: https://github.com/xiaoeteam/xiaoeappsdk-android/wiki/1.-开始使用

Provides utility methods for managing the WebView, including clearing cache, canceling login requests, sharing content, and disabling sensitive API access for compliance.

```java
clearWebViewCache()：清除 WebView 加载缓存
loginCancel()：      如果在非首页请求登录失败时，为了避免出现空白页，调用这个方法可以回到首页
share()：            获取分享内容
disableSensitiveApi（）：禁用隐私数据获取（合规整改需求）
```

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

### User Logout

Source: https://github.com/xiaoeteam/xiaoeappsdk-android/wiki/1.-开始使用

Call XiaoEWeb.userLogout(context) when a user logs out or switches accounts in your app to prevent data confusion in the XiaoE shop.

```java
XiaoEWeb.userLogout(context);
```

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

### 注册 JS Bridge 回调

Source: https://context7.com/xiaoeteam/xiaoeappsdk-android/llms.txt

注册 H5 与原生之间的事件回调，处理登录授权、内容分享、页面标题、外链跳转等事件。

```java
xiaoEWeb.setJsBridgeListener(new JsBridgeListener() {
    @Override
    public void onJsInteract(int actionType, JsCallbackResponse response) {
        switch (actionType) {

            case JsInteractType.LOGIN_ACTION:
                // H5 请求登录鉴权，需调用业务登录接口获取 token 后同步到 SDK
                // 登录成功 → xiaoEWeb.sync(new XEToken(tokenKey, tokenValue))
                // 登录失败 → xiaoEWeb.syncNot()
                showLoginDialog();
                break;

            case JsInteractType.SHARE_ACTION:
                // H5 触发分享，通过 response.getResponseData() 获取分享数据（JSON）
                String shareData = response.getResponseData();
                // 调用第三方分享 SDK 进行分享
                Toast.makeText(context, shareData, Toast.LENGTH_SHORT).show();
                break;

            case JsInteractType.TITLE_RECEIVE:
                // 接收 H5 页面标题，用于更新原生 ActionBar 标题
                String title = response.getResponseData();
                getSupportActionBar().setTitle(title);
                break;

            case JsInteractType.NOTICE_OUT_LINK_ACTION:
                // SDK 通知需要外部打开的链接（后台自定义链接带 needoutlink=1 参数）
                // 示例：http://www.example.com?needoutlink=1
                String outLink = response.getResponseData();
                Intent intent = new Intent(Intent.ACTION_VIEW, Uri.parse(outLink));
                startActivity(intent);
                break;
        }
    }
});
```

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

### setJsBridgeListener() - Registering JS Bridge Callbacks

Source: https://context7.com/xiaoeteam/xiaoeappsdk-android/llms.txt

Register callbacks to handle events between H5 and native code, such as login authentication, content sharing, page title updates, and external link handling.

```APIDOC
## JS Bridge Listener

Register a listener to handle communication between H5 and native code.

```java
xiaoEWeb.setJsBridgeListener(new JsBridgeListener() {
    @Override
    public void onJsInteract(int actionType, JsCallbackResponse response) {
        switch (actionType) {

            case JsInteractType.LOGIN_ACTION:
                // H5 requests login authentication. Call your business login interface to get the token
                // and then sync it to the SDK.
                // On successful login: xiaoEWeb.sync(new XEToken(tokenKey, tokenValue))
                // On failed login: xiaoEWeb.syncNot()
                showLoginDialog();
                break;

            case JsInteractType.SHARE_ACTION:
                // H5 triggers a share. Get share data (JSON) via response.getResponseData().
                String shareData = response.getResponseData();
                // Call your third-party sharing SDK to perform the share.
                Toast.makeText(context, shareData, Toast.LENGTH_SHORT).show();
                break;

            case JsInteractType.TITLE_RECEIVE:
                // Receive the H5 page title to update the native ActionBar title.
                String title = response.getResponseData();
                getSupportActionBar().setTitle(title);
                break;

            case JsInteractType.NOTICE_OUT_LINK_ACTION:
                // SDK notifies that an external link needs to be opened (backend custom link with needoutlink=1 parameter).
                // Example: http://www.example.com?needoutlink=1
                String outLink = response.getResponseData();
                Intent intent = new Intent(Intent.ACTION_VIEW, Uri.parse(outLink));
                startActivity(intent);
                break;
        }
    }
});
```
```

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

### User Logout

Source: https://context7.com/xiaoeteam/xiaoeappsdk-android/llms.txt

Clears XiaoE's user status when the third-party app switches or logs out a user to prevent information混淆. Can also clear H5 login state via an instance method.

```java
// 在用户退出或切换账号时调用
XiaoE.userLogout(context);

// 也可通过实例方法清除 H5 侧登录态
xiaoEWeb.syncNot();
```

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

### User Logout

Source: https://context7.com/xiaoeteam/xiaoeappsdk-android/llms.txt

Clears user status on the XiaoE side when the third-party App switches users or exits to prevent information混淆 between different users.

```APIDOC
## `XiaoEWeb.userLogout()` — User Logout

### Description
Clears user status on the XiaoE side when the third-party App switches users or exits to prevent information混淆 between different users.

### Method
`XiaoEWeb.userLogout(Context context)`: Logs out the current user from XiaoE.
`xiaoEWeb.syncNot()`: Also clears the H5-side login state.

### Parameters
#### `userLogout(Context context)` Parameters
- **context** (Context) - Required - The application context.

### Request Example
```java
// Call when the user logs out or switches accounts
XiaoEWeb.userLogout(context);

// Alternatively, clear H5-side login state via instance method
xiaoEWeb.syncNot();
```

### Response
N/A (This is an action method)
```

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

### Manage WebView Lifecycle

Source: https://github.com/xiaoeteam/xiaoeappsdk-android/wiki/1.-开始使用

Call the corresponding WebView lifecycle methods (onResume, onPause, onDestroy) within your activity or fragment's lifecycle methods to prevent memory leaks.

```java
XiaoEWeb.onResume();
XiaoEWeb.onPause();
XiaoEWeb.onDestroy();
XiaoEWeb.onActivityResult(requestCode, resultCode, data);     选择图片时需要调用这个方法
```

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

### JsInteractType Constants

Source: https://github.com/xiaoeteam/xiaoeappsdk-android/wiki/1.-开始使用

Defines constants for different JavaScript interaction callback event types.

```java
public class JsInteractType {
    public static final int SHARE_ACTION = 1;   //分享回调事件
    public static final int LOGIN_ACTION = 2;   //登录回调事件
    public static final int LOGOUT_ACTION = 3;  //登出回调事件
    public static final int TITLE_RECEIVE = 4;  //标题回调事件
    public static final int NOTICE_OUT_LINK_ACTION = 5;  //通知外部打开链接回调事件
}
```
Tokens:
Raw