@quicktvui/ai 1.0.0

package/rules/.docs/zh-CN/module/iac.md

@@ -0,0 +1,51 @@
+---
+title: 应用间通信模块
+lang: zh-CN
+---
+
+# 应用间通信模块
+
+使用此模块用来可以用来进行多个快应用之间的通信。
+
+:::demo ## 基础用法
+
+module/iac/es-basic
+
+:::
+
+:::demo ## qt.iac 用法 ^(alpha)
+
+module/iac/qt-basic
+
+:::
+
+## API
+
+### DataStructure
+
+#### ESIACMessage
+
+应用间通信消息
+
+| Name          | Description                | Type                          |   Default   |
+| ------------------ | ------------------| ----------------------------|---------|
+| action             | 事件名称       | ^[string]                    |   -    |
+| package            | 需要接受事件的快应用包名| ^[string]                    |   -    |
+| extras             | 其他信息           | ^[any]                     |   -    |
+
+#### ESIACMessageFilter
+
+应用间通信消息过滤器
+
+| Name          | Description             | Type                          |   Default   |
+| ------------------ | ------------------| ----------------------------|---------|
+| action             | 需要接受的事件列表       | ^[Array<string>]        |   -    |
+
+### Exposes
+
+| Name                             | Description                 | Type                                           |
+| -------------------------------- | --------------------------- | -----------------------------------------------|
+| sendMessage             | 该方法发送消息          | ^[Function]`sendMessage(message: ESIACMessage) => Promise<boolean>`   |
+| registerReceiver        | 该方法注册消息监听       | ^[Function]`registerReceiver(receiver: ESIACReceiver, messageFilter: ESIACMessageFilter) => void`   |
+| unregisterReceiver        | 该方法取消注册消息监听       | ^[Function]`unregisterReceiver(receiver: ESIACReceiver) => void`   |
+

package/rules/.docs/zh-CN/module/local-storage.md

@@ -0,0 +1,35 @@
+---
+title: 本地存储模块
+lang: zh-CN
+---
+
+# 本地存储模块
+
+此模块用于快应用***少量数据***持久化存储。
+
+:::demo ## 基础用法
+
+module/local-storage/es-basic
+
+:::
+
+:::demo ## qt.storage 用法 ^(alpha)
+
+module/local-storage/qt-basic
+
+:::
+
+## API
+
+### Exposes
+
+| Name                             | Description                 | Type                                           |
+| -------------------------------- | --------------------------- | -----------------------------------------------|
+| getBoolean             | 该方法获取`Boolean`类型的值               | ^[Function]`getBoolean(key: string, defValue: boolean) => Promise<boolean>`   |
+| putBoolean               | 该方法存储`Boolean`类型的值             | ^[Function]`putBoolean(key: string, value: boolean) => Promise<boolean>`   |
+| getInt               | 该方法获取`Int`类型的值            | ^[Function]`getInt(key: string, defValue: number) => Promise<boolean>`   |
+| putInt               | 该方法存储`Int`类型的值            | ^[Function]`putInt(key: string, value: number) => Promise<boolean>`   |
+| getLong               | 该方法获取`Long`类型的值           | ^[Function]`getLong(key: string, defValue: number) => Promise<boolean>`   |
+| putLong               | 该方法存储`Long`类型的值           | ^[Function]`putLong(key: string, value: number) => Promise<boolean>`   |
+| getString               | 该方法获取`String`类型的值           | ^[Function]`getString(key: string, defValue: string) => Promise<boolean>`   |
+| putString               | 该方法存储`String`类型的值           | ^[Function]`putString(key: string, value: string) => Promise<boolean>`   |

package/rules/.docs/zh-CN/module/location.md

@@ -0,0 +1,48 @@
+---
+title: 定位模块
+lang: zh-CN
+---
+
+# 定位模块
+
+此模块用于调用容器定位功能。
+
+:::demo ## 基础用法
+
+module/location/es-basic
+
+:::
+
+:::demo ## qt.location 用法 ^(alpha)
+
+module/location/qt-basic
+
+:::
+
+## API
+
+### DataStructure
+
+#### ESLocationInfo
+
+位置信息
+
+| Name          | Description                | Type                          |   Default   |
+| ------------------ | ------------------| ----------------------------|---------|
+| address            | 地址               | ^[string]                    |   -    |
+| province           | 省份               | ^[string]                    |   -    |
+| city               | 城市               | ^[string]                    |   -    |
+| district           | 地区               | ^[string]                    |   -    |
+| name               | 名称               | ^[string]                    |   -    |
+| longitude          | 经度               | ^[number]                    |   -    |
+| latitude           | 纬度               | ^[number]                    |   -    |
+
+### Exposes
+
+| Name                             | Description                 | Type                                           |
+| -------------------------------- | --------------------------- | -----------------------------------------------|
+| getLocation             | 该方法获取位置信息          | ^[Function]`getLocation() => Promise<ESLocationInfo \| null>`   |
+| launchLocation               | 该方法打开定位设置             | ^[Function]`launchLocation() => void`   |
+| addListener               | 该方法添加定位监听             | ^[Function]`addListener(listener: ESLocationListener) => void`   |
+| removeListener               | 该方法删除定位监听             | ^[Function]`removeListener(listener: ESLocationListener) => void`   |
+

package/rules/.docs/zh-CN/module/log.md

@@ -0,0 +1,52 @@
+---
+title: 日志模块
+lang: zh-CN
+---
+
+# 日志模块
+
+使用此模块可以打印`Chrome`调试日志和`android logcat`日志。
+
+:::demo ## 基础用法
+
+module/log/es-basic
+
+:::
+
+:::demo ## qt.log 用法 ^(alpha)
+
+module/log/qt-basic
+
+:::
+
+## API
+
+### DataStructure
+
+#### ESLogLevel
+
+打印日志级别
+
+| Name           | Description                | Type                          |   Default   |
+| -------------- | ------------------| ----------------------------|---------|
+| VERBOSE        | 开发调试过程中一些详细信息，不应该编译进产品中，只在开发阶段使用。  | ^[number]                      |   2    |
+| DEBUG          | 用于调试的信息，编译进产品，但可以在运行时关闭。               | ^[number]                      |   3    |
+| INFO           | 运行时的状态信息，这些状态信息在出现问题的时候能提供帮助。         | ^[number]                      |   4    |
+| WARN           | 警告程序出现了异常，即将出现错误。                               | ^[number]                      |   5    |
+| ERROR          | 程序已经出现了错误。                                         | ^[number]                      |   6    |
+
+### Exposes
+
+| Name                             | Description                 | Type                                           |
+| -------------------------------- | --------------------------- | -----------------------------------------------|
+| isLoggable                    | 判断对应级别日志是否打印     | ^[Function]`isLoggable(level: ESLogLevel) => boolean`   |
+| setMinimumLoggingLevel         | 设置日志打印的最小级别      | ^[Function]`setMinimumLoggingLevel(level: ESLogLevel) => void`   |
+| enableConsoleLogging         | 设置是否打印控制台日志      | ^[Function]`enableConsoleLogging(enable: boolean) => void`   |
+| enableNativeLogging         | 设置是否打印安卓层日志      | ^[Function]`enableNativeLogging(enable: boolean) => void`   |
+| v                           | 打印`VERBOSE`级别日志      | ^[Function]`v(tag: string, ...args: any[]) => void`   |
+| d                           | 打印`DEBUG`级别日志      | ^[Function]`d(tag: string, ...args: any[]) => void`   |
+| i                           | 打印`INFO`级别日志      | ^[Function]`i(tag: string, ...args: any[]) => void`   |
+| w                           | 打印`WARN`级别日志      | ^[Function]`w(tag: string, ...args: any[]) => void`   |
+| e                           | 打印`ERROR`级别日志      | ^[Function]`e(tag: string, ...args: any[]) => void`   |
+
+

package/rules/.docs/zh-CN/module/network.md

@@ -0,0 +1,77 @@
+---
+title: 网络模块
+lang: zh-CN
+---
+
+# 网络模块
+
+此模块用于获取和监听系统的网络状态。
+
+:::demo ## 基础用法
+
+module/network/es-basic
+
+:::
+
+:::demo ## qt.network 用法 ^(alpha)
+
+module/network/qt-basic
+
+:::
+
+
+## API
+
+### DataStructure
+
+#### ESNetworkInfo
+
+网络信息
+
+| Name          | Description                | Type                          |   Default   |
+| ------------------------- | ----------------------| ----------------------------|---------|
+| type                      | 网络类型               | ^[ESNetworkInfoType]          |   -    |
+| typeName                  | 网络名称               | ^[string]                    |   -    |
+| state                     | 网络状态               | ^[ESNetworkInfoState]        |   -    |
+| extraInfo                 | 额外信息               | ^[string]                    |   -    |
+| isAvailable               | 网络是否可用            | ^[boolean]                    |   -    |
+| isConnected               | 网络是否链接            | ^[boolean]                    |   -    |
+| isConnectedOrConnecting   | 是否正在连接或者已经连接   | ^[boolean]                    |   -    |
+| isFailover                | isFailover            | ^[boolean]                    |   -    |
+| isRoaming                 | isRoaming             | ^[boolean]                    |   -    |
+| detailedState             | detailedState         | ^[boolean]                    |   -    |
+| describeContents          | describeContents      | ^[boolean]                    |   -    |
+
+#### ESNetworkInfoType
+
+网络类型信息
+
+| Name                         | Description       | Type                          |   Default   |
+| ------------------------- | ----------------------| ----------------------------|---------|
+| ES_NETWORK_INFO_TYPE_NONE  | 无网络               | ^[number]          |   -1    |
+| ES_NETWORK_INFO_TYPE_MOBILE | 移动网络              | ^[number]                    |   0    |
+| ES_NETWORK_INFO_TYPE_WIFI  | WIFI网络               | ^[number]        |   1    |
+| ES_NETWORK_INFO_TYPE_ETHERNET| 有线网络               | ^[number]                    |   9    |
+
+#### ESNetworkInfoState
+
+网络状态信息
+
+| Name                         | Description        | Type                        |   Default   |
+| ------------------------- | ----------------------| ----------------------------|---------|
+| ES_NETWORK_INFO_STATE_CONNECTING  | 正在连接               | ^[number]          |   0    |
+| ES_NETWORK_INFO_STATE_CONNECTED | 已连接              | ^[number]                    |   1    |
+| ES_NETWORK_INFO_STATE_SUSPENDED  | 挂起               | ^[number]        |   2    |
+| ES_NETWORK_INFO_STATE_DISCONNECTING| 正在断开连接               | ^[number]                    |   3    |
+| ES_NETWORK_INFO_STATE_DISCONNECTED| 断开连接               | ^[number]                    |   4    |
+| ES_NETWORK_INFO_STATE_UNKNOWN| 未知               | ^[number]                    |   5    |
+
+### Exposes
+
+| Name                             | Description                 | Type                                           |
+| -------------------------------- | --------------------------- | -----------------------------------------------|
+| getActiveNetworkInfo             | 该方法获取可用网络信息          | ^[Function]`getActiveNetworkInfo() => ESNetworkInfo \| null`   |
+| isNetworkConnected               | 该方法判断网络是否连接             | ^[Function]`isNetworkConnected() => boolean`   |
+| getWifiInfo               | 该方法获取WIFI信息             | ^[Function]`getWifiInfo() => Promise<ESWifiInfo>`   |
+| addListener               | 该方法添加网络监听             | ^[Function]`addListener(listener: ESNetworkListener) => void`   |
+| removeListener            | 该方法删除网络监听             | ^[Function]`removeListener(listener: ESNetworkListener) => void`   |

package/rules/.docs/zh-CN/module/overview.md

@@ -0,0 +1,10 @@
+---
+title: Overview
+lang: zh-CN
+---
+
+# Overview
+
+## 基础模块
+
+提供使用原生功能的能力

package/rules/.docs/zh-CN/module/permission.md

@@ -0,0 +1,42 @@
+---
+title: 权限模块
+lang: zh-CN
+---
+
+# 权限模块
+
+此模块用于管理`android`的应用权限。
+
+:::demo ## 基础用法
+
+module/permission/es-basic
+
+:::
+
+:::demo ## qt.permission 用法 ^(alpha)
+
+module/permission/qt-basic
+
+:::
+
+## API
+
+### DataStructure
+
+#### ESRequestPermissionsResult
+
+请求权限结果
+
+| Name                      | Description           | Type               |   Default   |
+| ------------------------- | ----------------------| ------------------ |---------|
+| granted                   | 是否授权               | ^[boolean]          |   -    |
+| grantedList               | 授权权限列表            | ^[Array<string>]    |   -    |
+| deniedList                | 拒绝权限列表            | ^[Array<string>]    |   -    |
+| deniedForeverList         | 永远拒绝权限列表         | ^[Array<string>]    |   -    |
+
+### Exposes
+
+| Name                             | Description                 | Type                                           |
+| -------------------------------- | --------------------------- | -----------------------------------------------|
+| isPermissionsGranted             | 该方法判断权限是否授权          | ^[Function]`isPermissionsGranted(permissionList: Array<string>) => Promise<ESRequestPermissionsResult>`   |
+| requestPermissions               | 该方法请求用户授权             | ^[Function]`requestPermissions(permissionList: Array<string>) => Promise<ESRequestPermissionsResult>`   |

package/rules/.docs/zh-CN/module/plugin.md

@@ -0,0 +1,38 @@
+---
+title: 插件模块
+lang: zh-CN
+---
+
+# 插件模块
+
+此模块用于使用容器的插件功能。
+
+:::demo ## 基础用法
+
+module/plugin/es-basic
+
+:::
+
+:::demo ## qt.plugin 用法 ^(alpha)
+
+module/plugin/qt-basic
+
+:::
+
+## API
+
+### DataStructure
+
+#### ESPluginInfo
+
+| Name                      | Description          | Type                          |   Default   |
+| ------------------------- | ----------------------| ----------------------------|---------|
+| pkg                       |   插件的包名             | ^[string]          |   -    |
+
+### Exposes
+
+| Name                             | Description                 | Type                                           |
+| -------------------------------- | --------------------------- | -----------------------------------------------|
+| installPlugin                    | 该方法安装插件                 | ^[Function]`installPlugin(plugin: ESPluginInfo) => void`   |
+| addListener                    | 该方法添加安装插件监听             | ^[Function]`addListener(plugin: ESPluginInfo, listener: ESPluginListener) => void`   |
+| removeListener                   | 该方法删除安装插件监听             | ^[Function]`removeListener(listener: ESPluginListener) => void`   |

package/rules/.docs/zh-CN/module/power.md

@@ -0,0 +1,51 @@
+---
+title: Power
+lang: zh-CN
+---
+
+# 电源模块
+
+使用此模块可以控制`android`电源是否唤醒。
+
+`wakeLockAcquire` 和 `wakeLockRelease` 是与 Android 设备的电源管理相关的两个操作，它们通常用于控制设备的唤醒状态，确保应用在执行某些需要保持设备唤醒的任务时，设备不会进入休眠状态。
+
+### wakeLockAcquire
+
+`wakeLockAcquire` 指的是获取一个唤醒锁（Wake Lock）。在 Android
+中，唤醒锁是一种机制，允许应用请求系统保持CPU运行和屏幕亮起，即使在没有用户交互的情况下。这通常用于需要长时间运行的任务，比如下载文件、播放音乐或视频等。通过获取唤醒锁，应用可以防止设备在这些任务进行时进入休眠状态。
+
+### wakeLockRelease
+
+`wakeLockRelease` 指的是释放之前获取的唤醒锁。当应用完成需要保持设备唤醒的任务后，应该释放唤醒锁，以允许设备根据需要进入休眠状态。这是非常重要的，因为不释放唤醒锁会导致设备持续保持唤醒状态，从而消耗更多的电池电量。
+
+### 使用注意事项
+
+- **适时获取和释放**：确保在需要时获取唤醒锁，并在任务完成后立即释放。
+- **考虑电池消耗**：频繁或长时间地持有唤醒锁会显著影响电池寿命，因此应谨慎使用。
+- **权限要求**：获取唤醒锁需要相应的权限（`android.permission.WAKE_LOCK`），需要在应用的`AndroidManifest.xml`文件中声明。
+- **API版本兼容性**：不同版本的Android系统对唤醒锁的管理可能有所不同，开发时应考虑目标设备的API版本。
+
+正确使用唤醒锁对于提升用户体验和节省电池电量至关重要。开发者应根据应用的实际需求合理管理唤醒锁，避免不必要的电池消耗。
+
+:::demo ## 基础用法
+
+module/power/es-basic
+
+:::
+
+:::demo ## qt.power 用法 ^(alpha)
+
+module/power/qt-basic
+
+:::
+
+## API
+
+### Exposes
+
+| Name                             | Description                 | Type                                |
+| -------------------------------- | --------------------------- | ------------------------------------|
+| wakeLockAcquire                  | 获取一个唤醒锁                 | ^[Function]`() => Promise<boolean>`   |
+| wakeLockRelease                  | 释放之前获取的唤醒锁            | ^[Function]`() => Promise<boolean>`   |
+
+

package/rules/.docs/zh-CN/module/runtime.md

@@ -0,0 +1,41 @@
+---
+title: 运行环境模块
+lang: zh-CN
+---
+
+# 运行环境模块
+
+此模块用于获取快应用运行容器的机型信息和唯一标识符。
+
+:::demo ## 基础用法
+
+module/runtime/es-basic
+
+:::
+
+:::demo ## qt.runtime 用法 ^(alpha)
+
+module/runtime/qt-basic
+
+:::
+
+## API
+
+### DataStructure
+
+#### ESRuntimeDeviceInfo
+
+运行环境信息
+
+| Name          | Description       | Type         |   Default   |
+| -------------| -------------------| ------------|---------|
+| deviceId     | 设备ID              | ^[string]    |   -    |
+| deviceType   | 设备类型             | ^[string]    |   -     |
+
+### Exposes
+
+| Name                             | Description                 | Type                                           |
+| -------------------------------- | --------------------------- | -----------------------------------------------|
+| getRuntimeDeviceInfo             | 该方法获取运行环境信息           | ^[Function]`getRuntimeDeviceInfo() => ESRuntimeDeviceInfo \| null`   |
+| getRuntimeDeviceId               | 该方法获取运行环境唯一标识符      | ^[Function]`getRuntimeDeviceId() => string \| null`   |
+| getRuntimeDeviceType             | 该方法获取运行环境类型      | ^[Function]`getRuntimeDeviceType() => string \| null`   |

package/rules/.docs/zh-CN/module/service.md

@@ -0,0 +1,33 @@
+---
+title: Service
+lang: zh-CN
+---
+
+# 服务模块
+
+使用此模块可以启动`android`系统中的服务。
+
+你可以在 [Android documentation](https://developer.android.google.cn/develop/background-work/services?hl=zh-cn)
+上查看更详细的介绍。
+
+:::demo ## 基础用法
+
+module/service/es-basic
+
+:::
+
+:::demo ## qt.service 用法 ^(alpha)
+
+module/service/qt-basic
+
+:::
+
+## API
+
+### Exposes
+
+| Name                             | Description                 | Type                                           |
+| -------------------------------- | --------------------------- | -----------------------------------------------|
+| startService                     | 启动服务                      | ^[Function]`(paramsArray: Array<Array<string \| number \| boolean>>) => void`   |
+
+

package/rules/.docs/zh-CN/module/share-data.md

@@ -0,0 +1,85 @@
+---
+title: 共享数据模块
+lang: zh-CN
+---
+
+# 共享数据模块
+
+此模块用于多个快应用之间的数据共享（内存共享）。
+
+:::demo ## 基础用法
+
+module/share-data/es-basic
+
+:::
+
+:::demo ## qt.shareData 用法 ^(alpha)
+
+module/share-data/qt-basic
+
+:::
+
+## API
+
+### DataStructure
+
+#### ESSharedData
+
+共享数据信息
+
+| Name            | Description        | Type                        |   Default   |
+| -------------- | -------------------| ----------------------------|---------|
+| mode           | 共享模式             | ^[ESSharedDataMode]          |   -    |
+| type           | 数据类型             | ^[ESSharedDataType]          |   -    |
+| secretKey      | 数据秘钥             | ^[string]                    |   -    |
+| data           | 数据                | ^[any]                      |   -    |
+
+#### ESSharedDataMode
+
+共享模式
+
+| Name                                  | Description       | Type                        |   Default   |
+| ------------------------------------ | -------------------| ----------------------------|---------|
+| ES_SHARED_DATA_MODE_PRIVATE           | 私有模式            | ^[number]          |   0    |
+| ES_SHARED_DATA_MODE_WORLD_READABLE    | 只读               | ^[number]          |   1    |
+| ES_SHARED_DATA_MODE_WORLD_WRITEABLE   | 可写               | ^[number]                    |   2    |
+
+#### ESSharedDataType
+
+共享数据类型
+
+| Name                                  | Description       | Type                        |   Default   |
+| ------------------------------------ | -------------------| ----------------------------|---------|
+| ES_SHARED_DATA_TYPE_INT               | int               | ^[number]          |   0    |
+| ES_SHARED_DATA_TYPE_LONG              | long              | ^[number]          |   1    |
+| ES_SHARED_DATA_TYPE_FLOAT             | float             | ^[number]          |   2    |
+| ES_SHARED_DATA_TYPE_STRING            | string            | ^[number]          |   3    |
+| ES_SHARED_DATA_TYPE_BOOLEAN           | boolean           | ^[number]          |   4    |
+| ES_SHARED_DATA_TYPE_MAP               | map               | ^[number]          |   5    |
+| ES_SHARED_DATA_TYPE_ARRAY             | array             | ^[number]          |   6    |
+
+#### ESSharedDataParams
+
+共享数据接口参数
+
+| Name            | Description                | Type              |   Default   |
+| -------------- | -------------------| ------------------|---------|
+| packageName    | 快应用包名           | ^[string]          |   -    |
+| secretKey      | 秘钥                | ^[string]          |   -    |
+
+### Exposes
+
+| Name                             | Description                 | Type                                           |
+| -------------------------------- | --------------------------- | -----------------------------------------------|
+| getBoolean                    | 该方法获取`boolean`类型共享数据    | ^[Function]`getBoolean(params: ESSharedDataParams, key: string, defValue: boolean) => Promise<boolean>`   |
+| putBoolean                    | 该方法存储`boolean`类型共享数据    | ^[Function]`putBoolean(params: ESSharedDataParams, key: string, value: boolean, mode: ESSharedDataMode) => Promise<boolean>`   |
+| getInt                        | 该方法获取`int`类型共享数据        | ^[Function]`getInt(params: ESSharedDataParams, key: string, defValue: number) => Promise<number>`   |
+| putInt                        | 该方法存储`int`类型共享数据        | ^[Function]`putInt(params: ESSharedDataParams, key: string, value: number, mode: ESSharedDataMode) => Promise<boolean>`   |
+| getLong                        | 该方法获取`long`类型共享数据        | ^[Function]`getLong(params: ESSharedDataParams, key: string, defValue: number) => Promise<number>`   |
+| putLong                        | 该方法存储`long`类型共享数据        | ^[Function]`putLong(params: ESSharedDataParams, key: string, value: number, mode: ESSharedDataMode) => Promise<boolean>`   |
+| getString                        | 该方法获取`string`类型共享数据        | ^[Function]`getString(params: ESSharedDataParams, key: string, defValue: string \| null \| undefined) => Promise<string>`   |
+| putString                        | 该方法存储`string`类型共享数据        | ^[Function]`putString(params: ESSharedDataParams, key: string, value: string, mode: ESSharedDataMode) => Promise<boolean>`   |
+| getArray                        | 该方法获取`Array`类型共享数据        | ^[Function]`getArray(params: ESSharedDataParams, key: string, defValue: Array<any> \| null \| undefined) => Promise<Array<any>>`   |
+| putArray                        | 该方法存储`Array`类型共享数据        | ^[Function]`putArray(params: ESSharedDataParams, key: string, value: Array<any>, mode: ESSharedDataMode) => Promise<boolean>`   |
+| getMap                        | 该方法获取`Map`类型共享数据        | ^[Function]`getMap(params: ESSharedDataParams, key: string, defValue: Map<any, any> \| undefined \| null) => Promise<Map<any, any>>`   |
+| putMap                        | 该方法存储`Map`类型共享数据        | ^[Function]`putMap(params: ESSharedDataParams, key: string, value: Map<any, any>, mode: ESSharedDataMode) => Promise<boolean>`   |

package/rules/.docs/zh-CN/module/toast.md

@@ -0,0 +1,30 @@
+---
+title: Toast模块
+lang: zh-CN
+---
+
+# Toast模块
+
+此模块调用显示`android`系统`Toast`。
+
+:::demo ## 基础用法
+
+module/toast/es-basic
+
+:::
+
+:::demo ## qt.toast 用法 ^(alpha)
+
+module/toast/qt-basic
+
+:::
+
+## API
+
+### Exposes
+
+| Name                             | Description                 | Type                                           |
+| -------------------------------- | --------------------------- | -----------------------------------------------|
+| showToast                    | 该方法显示吐司                 | ^[Function]`showToast(message: string) => void`   |
+| showLongToast                    | 该方法显示长时间吐司          | ^[Function]`showLongToast(message: string) => void`   |
+| showShortToast                    | 该方法显示短时间吐司          | ^[Function]`showShortToast(message: string) => void`   |

package/rules/.docs/zh-CN/module/upload.md

@@ -0,0 +1,53 @@
+---
+title: 文件上传模块
+lang: zh-CN
+---
+
+# 文件上传模块
+
+::: warning 注意：文件上传模块只能操作快应用自身的文件目录下的文件
+
+* 快应用自身的文件目录对应的`android`系统路径为：`/data/data/APK包名/app_rpk/apps/快应用包名/files`
+* 示例中上传文件的路径：`filePath: '/video/bbb.zip',`对应`android`目录：`/data/data/APK包名/app_rpk/apps/快应用包名/files/video/bbb.zip`文件。
+
+:::
+
+:::demo ## 基础用法
+
+module/upload/es-basic
+
+:::
+
+
+:::demo ## qt.upload 用法 ^(alpha)
+
+module/upload/qt-basic
+
+:::
+
+## API
+
+### DataStructure
+
+#### ESUploadInfo
+
+文件上传信息
+
+| Name           | Description       | Type                         |   Default   |
+| -------------- | ------------------ | ----------------------------|---------|
+| id             | 唯一标识符           | ^[string]                    |   -    |
+| url            | 上传地址            | ^[string]                    |   -    |
+| mediaType      | 媒资类型            | ^[string]                    |   -    |
+| fileParamsKey  | 渠道               | ^[string]                    |   -    |
+| filePath       | 文件存储目录         | ^[string]                    |   -    |
+| params         | 上传参数            | ^[Map<string, string>]       |   -    |
+| header         | 上传header参数      | ^[Map<string, string>]       |   -    |
+
+### Exposes
+
+| Name                             | Description                 | Type                                           |
+| -------------------------------- | --------------------------- | -----------------------------------------------|
+| upload                    | 该方法上传文件                 | ^[Function]`upload(info: ESUploadInfo) => void`   |
+| addListener                    | 该方法添加文件上传监听          | ^[Function]`addListener(info: ESUploadInfo, listener: ESUploadListener) => void`   |
+| removeListener                    | 该方法删除文件上传监听          | ^[Function]`removeListener(listener: ESUploadListener) => void`   |
+