# UTSAndroid app-android平台专有内置对象。在uni-app和uni-app x的uts环境中均可使用。 ## 静态方法 ### onAppConfigChange ### offAppConfigChange ### onAppTrimMemory ### offAppTrimMemory ### onAppActivityPause ```ts UTSAndroid.onAppActivityPause(() => { let eventName = "onAppActivityPause - " + Date.now(); console.log(eventName); }); ``` ### offAppActivityPause ```ts // 移除全部监听 UTSAndroid.offAppActivityPause(); // 移除指定监听 UTSAndroid.offAppActivityPause(() => { }); ``` ### onAppActivityResume ```ts UTSAndroid.onAppActivityResume(() => { let eventName = "onAppActivityResume - " + Date.now(); console.log(eventName); }); ``` ### offAppActivityResume ```ts // 移除全部监听 UTSAndroid.onAppActivityResume(); // 移除指定监听 UTSAndroid.onAppActivityResume(() => { }); ``` ### onAppActivityDestroy ```ts UTSAndroid.onAppActivityDestroy(() => { let eventName = "onAppActivityDestroy- " + Date.now(); console.log(eventName); }); ``` ### offAppActivityDestroy ```ts // 移除全部监听 UTSAndroid.offAppActivityDestroy(); // 移除指定监听 UTSAndroid.offAppActivityDestroy(() => { }); ``` ### onAppActivityResult App 的 activity 启动其他activity的回调结果监听 对应原生的 [onActivityResult](https://developer.android.com/training/basics/intents/result) 需要特别注意的是 `requestCode` 参数，这个参数用于区别 不同的请求来源,开发者应该只处理自己发起请求 ```ts let customRequestCode = 12000 UTSAndroid.onAppActivityResult((requestCode: Int, resultCode: Int, data?: Intent) => { if(requestCode == 12000){ // 我们发起的请求 let eventName = "onAppActivityResult - requestCode:" + requestCode + " -resultCode:"+resultCode + " -data:"+JSON.stringify(data); console.log(eventName); }else{ // 别的代码发起的请求，不要处理 } }); ``` ### offAppActivityResult ```ts // 移除全部监听 UTSAndroid.offAppActivityResult(); // 移除指定监听 UTSAndroid.offAppActivityResult(() => { }); ``` ### onAppActivityBack ```ts UTSAndroid.onAppActivityBack(() => { let eventName = "onAppActivityBack- " + Date.now(); console.log(eventName); }); ``` ### offAppActivityBack ```ts // 移除全部监听 UTSAndroid.offAppActivityBack(); // 移除指定监听 UTSAndroid.offAppActivityBack(() => { }); ``` ### getAppContext() ```uts let packageName = UTSAndroid.getAppContext()?.packageName console.log("packageName",packageName) ``` ### getUniActivity() ```uts // 获取第一个可以响应图像采集行为组件 let takePictureIntent = new Intent(MediaStore.ACTION_IMAGE_CAPTURE); if (takePictureIntent.resolveActivity(UTSAndroid.getUniActivity()!.getPackageManager()) != null) { UTSAndroid.getUniActivity()!.startActivityForResult(takePictureIntent, 1001); } ``` ### getResourcePath(resourceName:string) ::: warning 注意事项 `getResourcePath` 与 [convert2AbsFullPath](https://doc.dcloud.net.cn/uni-app-x/uts/utsandroid.html#convert2absfullpath-path-string) 区别在于： `getResourcePath` 屏蔽了读取`代码包文件`时 各平台/各模式下的底层细节，即使是存放在`asset`目录也会返回符合android 读取规范的协议地址 `convert2AbsFullPath` 没有实现这一点 当开发者需要读取`代码包文件`时，建议使用 `getResourcePath` - [代码包文件](../api/file-system-spec.md#package) - `代码包文件`在`真机运行`和`云打包`模式下的释放策略不同：\ 本地真机运行：会被存在放内置储存目录\ 云打包： `uni-app x`项目会被存放在`asset`目录, `uni-app` 项目默认会被存放在内置储存目录\ 因此 `uni-app`/`uni-app x` 平台对 `代码包文件` 均仅支持读取操作 - [本地磁盘文件](../api/file-system-spec.md#disk) - [沙盒文件](../api/file-system-spec.md#internalsandbox) - 不支持 - [沙盒外文件](../api/file-system-spec.md#%E6%B2%99%E7%9B%92%E5%A4%96%E7%9B%AE%E5%BD%95) - 不支持 ::: ```ts /** * 代码包文件在真机运行模式下： * /storage/emulated/0/Android/data/io.dcloud.uniappx/apps/__UNI__XXXXXXX/www/static/logo.png * 代码包文件在云打包模式下： * file:///android_asset/apps/__UNI__XXXXXXX/www/static/logo.png * / console.log(UTSAndroid.getResourcePath('static/logo.png')) // 沙盒文件,不支持，会返回不存在的路径 console.log(UTSAndroid.getResourcePath('unifile://sandbox/static/logo.png')) // 沙盒外文件,不支持，会返回不存在的路径 console.log(UTSAndroid.getResourcePath('/storage/emulated/0/Android/data/io.dcloud.HBuilder/apps/HBuilder/www/static/logo.png')) ``` ### exit() ```ts // 退出当前应用 UTSAndroid.exit() ``` ### getDispatcher ```uts // 不传任何参数，得到是当前代码运行线程 let currentDispatcher = UTSAndroid.getDispatcher() console.log("currentDispatcher",currentDispatcher) // 期望在 io 任务队列执行 UTSAndroid.getDispatcher("io").async(function(_){ console.log("当前任务执行在",Thread.currentThread().getName()) // 期望在 主线程 任务队列执行 UTSAndroid.getDispatcher("main").async(function(_){ console.log("当前任务执行在",Thread.currentThread().getName()) currentDispatcher.async(function(_){ console.log("起始任务执行在",Thread.currentThread().getName()) },null) },null) },null) ``` ### getAppId() ```uts let appid = UTSAndroid.getAppId() console.log("appid",appid) ``` ### getOsTheme() ```uts let theme = UTSAndroid.getOsTheme() console.log("OsTheme",theme) ``` ### isUniMp() ```uts let isUniMp = UTSAndroid.isUniMp() console.log("isUniMp",isUniMp) ``` ### getAppName() ```uts let appName = UTSAndroid.getAppName() console.log("AppName",appName) ``` ### getAppVersion() ```uts let appVersion = UTSAndroid.getAppVersion() console.log("AppVersion",appVersion) ``` ### getInnerVersion() ```uts let innerVersion = UTSAndroid.getInnerVersion() console.log("InnerVersion",innerVersion) ``` ### isUniAppX() ```uts let isUniAppX = UTSAndroid.isUniAppX() console.log("isUniAppX",isUniAppX) ``` ### getAppCachePath() ```uts let appCachePath = UTSAndroid.getAppCachePath() console.log("AppCachePath",appCachePath) ``` ### rpx2px(rpx:number) : number; 推荐使用uni.rpx2px来替代本API，[详见](https://doc.dcloud.net.cn/uni-app-x/api/rpx2px.html) ### devicePX2px(devicePX:number) : number; ```ts // 对 100物理像素长度 进行转换 let pagePX = UTSAndroid.devicePX2px(100) // 在特定设备返回值:36.3636360168457 console.log("pagePX",pagePX) ``` ### isPrivacyAgree() : boolean; ```ts // 手动标记用户已同意隐私协议 UTSAndroid.setPrivacyAgree(true) // 此时为 true console.log(UTSAndroid.isPrivacyAgree()) // 重置用户隐私协议状态 UTSAndroid.resetPrivacyAgree() // 此时为 false console.log(UTSAndroid.isPrivacyAgree()) ``` ### setPrivacyAgree(state:boolean):void; ```ts // 手动标记用户已同意隐私协议 UTSAndroid.setPrivacyAgree(true) // 此时为 true console.log(UTSAndroid.isPrivacyAgree()) // 重置用户隐私协议状态 UTSAndroid.resetPrivacyAgree() // 此时为 false console.log(UTSAndroid.isPrivacyAgree()) ``` ### resetPrivacyAgree():void; ```ts // 手动标记用户已同意隐私协议 UTSAndroid.setPrivacyAgree(true) // 此时为 true console.log(UTSAndroid.isPrivacyAgree()) // 重置用户隐私协议状态 UTSAndroid.resetPrivacyAgree() // 此时为 false console.log(UTSAndroid.isPrivacyAgree()) ``` ### requestSystemPermission ```uts let permissionNeed = ["android.permission.CAMERA"] // 请求拍照权限 UTSAndroid.requestSystemPermission(UTSAndroid.getUniActivity()!, permissionNeed, function (allRight : boolean, _ : string[]) { if (allRight) { // 权限请求成功 } else { //用户拒绝了部分权限 } }, function (_ : boolean, _ : string[]) { //用户拒绝了部分权限 }) ``` 请求权限后有三种情况: + 用户允许了全部权限请求，会通过 `success`回调通知调用者，并且此时`allRight`参数为 `true` + 用户拒绝了全部权限请求，会通过 `fail` 回调通知调用者，`doNotAskAgain` 参数标识了用户拒绝时是否选择了`不再询问` + 用户允许了部分请求，拒绝了部分权限请求,此时既会调用`success`也会调用`fail`。由其中的 string数组参数 标识具体被拒绝/允许的权限 ### checkSystemPermissionGranted ```uts let permissionCheck = ["android.permission.CAMERA"] // 请求拍照权限 if (UTSAndroid.checkSystemPermissionGranted(UTSAndroid.getUniActivity()!, permissionCheck)) { console.log("当前已具备指定权限") }else{ console.log("当前不具备指定权限") } ``` ### gotoSystemPermissionActivity ```ts // 前往系统权限设置界面 let permissionNeed = ["android.permission.READ_PHONE_STATE"] UTSAndroid.gotoSystemPermissionActivity(UTSAndroid.getUniActivity()!,permissionNeed) ``` ### getSystemPermissionDenied ```ts let permissionNeed = ["android.permission.READ_PHONE_STATE"] if (UTSAndroid.getSystemPermissionDenied(UTSAndroid.getUniActivity()!, permissionNeed).isEmpty()) { console.log("当前已具备指定权限") } ``` ### convert2AbsFullPath(path:string) ::: warning 注意事项 `convert2AbsFullPath` 与 [getResourcePath](https://doc.dcloud.net.cn/uni-app-x/uts/utsandroid.html#getresourcepath) 区别在于： `convert2AbsFullPath` 对文件路径支持范围更大，不仅支持 `代码包文件`内置储存目录的情况，还支持相对路径，沙盒路径，沙盒外路径（包括系统API返回的文件地址） 等形式。 `getResourcePath` 不支持这些 当开发者明确需要操作文件，而非代码包资源时，建议使用 `convert2AbsFullPath` - [代码包文件](../api/file-system-spec.md#package) - `代码包文件`在`真机运行`和`云打包`模式下的释放策略不同：\ 本地真机运行：会被存在放内置储存目录\ 云打包： `uni-app x`项目会被存放在`asset`目录, `uni-app` 项目会被存放在内置储存目录\ 因此在 `uni-app`/`uni-app x` 平台对 `代码包文件` 均仅支持读取操作 - [本地磁盘文件](../api/file-system-spec.md#disk) - [沙盒文件](../api/file-system-spec.md#internalsandbox) - `uni-app x`支持读写 - `uni-app`不支持 - [沙盒外文件](../api/file-system-spec.md#%E6%B2%99%E7%9B%92%E5%A4%96%E7%9B%AE%E5%BD%95) - 沙盒管理范围外的其他文件。 调用系统API返回的绝对地址属于此类。`uni-app`/`uni-app x`平台 均支持读写 ::: ```ts // 代码包文件 console.log(UTSAndroid.convert2AbsFullPath('static/logo.png')) // 沙盒文件 console.log(UTSAndroid.convert2AbsFullPath('unifile://sandbox/static/logo.png')) // 沙盒外文件 包含相对路径 console.log(UTSAndroid.convert2AbsFullPath('../../../io.dcloud.HBuilder/apps/HBuilder/www/static/logo.png')) ``` ### getFileProviderUri(file:File) ```ts // 使用外部应用打开项目内置图片资源 let file = new File(UTSAndroid.getResourcePath("static/logo.png")) const uri = UTSAndroid.getFileProviderUri(file) const intent = new Intent(Intent.ACTION_VIEW, uri) intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION) const context = UTSAndroid.getUniActivity()!; context.startActivity(intent); ``` ### getJavaClass(input:any) ```uts export function getJavaClassTest() : boolean { let dispatcherClass = UTSAndroid.getJavaClass(UTSAndroid.getDispatcher()) if("io.dcloud.uts.task.UTSTaskDispatcher" == dispatcherClass.name){ return true } let applicationClass = UTSAndroid.getJavaClass(UTSAndroid.getAppContext()!) if("io.dcloud.uniapp.UniApplication" == applicationClass.name){ return true } return false } ``` ### getTopPageActivity() ```ts // 获取当前栈顶activity console.log(UTSAndroid.getTopPageActivity()) ``` ### onActivityCallback(callback, pageRoute?) ### offActivityCallback(callback) ### onPrivacyAgreeChange(callback) ### offPrivacyAgreeChange(callback)