# UTSAndroid

# 静态方法

# onAppConfigChange(callback)

监听 App配置发生变化, 对应 android原生 onAppConfigChange

Parameters

name type required description
callback (res:UTSJSONObject)=>void YES -

Return value

Type
void

Compatibility

Android version Android uni-app Android uni-app-x iOS version iOS uni-app iOS uni-app-x
4.4 3.9+ x x x

# offAppConfigChange(callback?)

onAppConfigChange 对应的反注册函数

Parameters

name type required description
callback (res:UTSJSONObject)=>void NO -

Return value

Type
void

Compatibility

Android version Android uni-app Android uni-app-x iOS version iOS uni-app iOS uni-app-x
4.4 3.9+ x x x

# onAppTrimMemory(callback?)

注册监听 App 内存不足时的系统回调函数 对应原生的API: onTrimMemory

Parameters

name type required description
callback (res:Number)=>void NO -

Return value

Type
void

Compatibility

Android version Android uni-app Android uni-app-x iOS version iOS uni-app iOS uni-app-x
4.4 3.9+ x x x

# offAppTrimMemory(callback?)

onAppTrimMemory 对应的反注册函数。

Parameters

name type required description
callback (res:Number)=>void NO -

Return value

Type
void

Compatibility

Android version Android uni-app Android uni-app-x iOS version iOS uni-app iOS uni-app-x
4.4 3.9+ x x x

# onAppActivityPause(callback)

注册监听 activity onPause事件

Parameters

name type required description
callback ()=>void YES -

Return value

Type
void

Compatibility

Android version Android uni-app Android uni-app-x iOS version iOS uni-app iOS uni-app-x
4.4 3.9+ x x x

# offAppActivityPause(callback?)

onAppActivityPause 对应的反注册函数

Parameters

name type required description
callback ()=>void NO -

Return value

Type
void

Compatibility

Android version Android uni-app Android uni-app-x iOS version iOS uni-app iOS uni-app-x
4.4 3.9+ x x x

# onAppActivityResume(callback)

注册监听 activity onResume事件

Parameters

name type required description
callback ()=>void YES -

Return value

Type
void

Compatibility

Android version Android uni-app Android uni-app-x iOS version iOS uni-app iOS uni-app-x
4.4 3.9+ x x x

# offAppActivityResume(callback?)

onAppActivityResume 对应的反注册函数

Parameters

name type required description
callback ()=>void NO -

Return value

Type
void

Compatibility

Android version Android uni-app Android uni-app-x iOS version iOS uni-app iOS uni-app-x
4.4 3.9+ x x x

# onAppActivityDestroy(callback)

注册监听 activity onDestroy事件

Parameters

name type required description
callback ()=>void YES -

Return value

Type
void

Compatibility

Android version Android uni-app Android uni-app-x iOS version iOS uni-app iOS uni-app-x
4.4 3.9+ x x x

# offAppActivityDestroy(callback?)

onAppActivityDestroy 对应的反注册函数。

Parameters

name type required description
callback ()=>void NO -

Return value

Type
void

Compatibility

Android version Android uni-app Android uni-app-x iOS version iOS uni-app iOS uni-app-x
4.4 3.9+ x x x

# onAppActivityResult(callback)

注册监听 activity onAppActivityResult 函数

Parameters

name type required description
callback (requestCode: Int, resultCode: Int, data: Intent?)=>void YES 用于监听的响应函数

Return value

Type
void

Compatibility

Android version Android uni-app Android uni-app-x iOS version iOS uni-app iOS uni-app-x
4.4 3.9+ x x x

# offAppActivityResult(callback?)

onAppActivityResult 对应的反注册函数。

Parameters

name type required description
callback (requestCode: Int, resultCode: Int, data: Intent?)=>void NO -

Return value

Type
void

Compatibility

Android version Android uni-app Android uni-app-x iOS version iOS uni-app iOS uni-app-x
4.4 3.9+ x x x

# onAppActivityBack(callback)

注册监听 activity onAppActivityBack 函数

Parameters

name type required description
callback ()=>void YES 用于监听的响应函数

Return value

Type
void

Compatibility

Android version Android uni-app Android uni-app-x iOS version iOS uni-app iOS uni-app-x
4.4 3.9+ x x x

# offAppActivityBack(callback?)

取消注册监听 activity onAppActivityBack 函数

Parameters

name type required description
callback ()=>void NO -

Return value

Type
void

Compatibility

Android version Android uni-app Android uni-app-x iOS version iOS uni-app iOS uni-app-x
4.4 3.9+ x x x

# getAppContext()

获取当前应用Application上下文,对应android平台 Context.getApplicationContext 函数实现

Return value

Type description
Context | null 当前应用程序 上下文实例对象

Compatibility

Android version Android uni-app Android uni-app-x iOS version iOS uni-app iOS uni-app-x
4.4 3.9+ x x x

# getUniActivity()

获取当前应用 栈顶的 Activity实例,对应android平台 getActivity 函数实现

Return value

Type description
Activity | null 当前应用程序 上下文实例对象

Compatibility

Android version Android uni-app Android uni-app-x iOS version iOS uni-app iOS uni-app-x
4.4 3.9+ x x x

# getResourcePath(resourceName)

获取H5资源文件的原生路径。

Parameters

name type required description
resourceName string YES H5资源文件相对于工程的绝对路径, 如:“/static/logo.png”

Return value

Type description
string 该资源在原生目录下的路径

Compatibility

Android version Android uni-app Android uni-app-x iOS version iOS uni-app iOS uni-app-x
4.4 x 9.0 x

# exit()

退出当前应用

Return value

Type
void

Compatibility

Android version Android uni-app Android uni-app-x iOS version iOS uni-app iOS uni-app-x
4.4 3.9+ x x x

# getDispatcher(threadName)

获取一个任务分发器实例

Parameters

name type required description
threadName string YES 任务组名称,可能为:main: ui thread / dom: 仅2.0生效,1.0会自动切换到 ui / io : io thread 匿名线程 / '': 来源线程,如果来源线程不支持任务分发,则会在当前线程执行执行. 这个场景下要求第一个参数必须是线程环境

Return value

Type description
UTSTaskDispatcher 一个任务分发器,可以用于分发协程任务

Compatibility

Android version Android uni-app Android uni-app-x iOS version iOS uni-app iOS uni-app-x
4.4 3.9+ x x x

# getAppId()

获取当前运行的app的AppId。

Return value

Type description
string 当前运行的app的AppId。

Compatibility

Android version Android uni-app Android uni-app-x iOS version iOS uni-app iOS uni-app-x
4.4 3.9+ x x x

# getOsTheme()

获取当前系统主题样式

Return value

Type description
string 系统主题样式 "dark":暗色模式 "light":亮色模式

Compatibility

Android version Android uni-app Android uni-app-x iOS version iOS uni-app iOS uni-app-x
4.4 3.9+ x x x

# isUniMp()

获取当前运行环境是否是unimp。

Return value

Type description
boolean 是否是unimp。

Compatibility

Android version Android uni-app Android uni-app-x iOS version iOS uni-app iOS uni-app-x
4.4 3.9+ x x x

# getAppName()

获取manifest.json 中配置的应用名称

Return value

Type description
string 应用名称。

Compatibility

Android version Android uni-app Android uni-app-x iOS version iOS uni-app iOS uni-app-x
4.4 3.9+ x x x

# getAppVersion()

获取manifest.json 中配置的应用版本信息

Return value

Type description
UTSJSONObject 应用版本信息

Compatibility

Android version Android uni-app Android uni-app-x iOS version iOS uni-app iOS uni-app-x
4.4 3.9+ x x x

# getInnerVersion()

获取引擎版本号。

Return value

Type description
string 引擎版本号。

Compatibility

Android version Android uni-app Android uni-app-x iOS version iOS uni-app iOS uni-app-x
4.4 3.9+ x x x

# isUniAppX()

获取当前是否是uniapp x 环境

Return value

Type description
boolean uniapp x 环境 true, uniapp 环境: false。

Compatibility

Android version Android uni-app Android uni-app-x iOS version iOS uni-app iOS uni-app-x
4.4 3.9+ x x x

# rpx2px(rpx:number) : number;

rpx单位 转换为 逻辑像素px单位

Parameters

name type required description
rpx number YES -

Return value

Type description
number 返回对应的逻辑像素值

Compatibility

Android version Android uni-app Android uni-app-x iOS version iOS uni-app iOS uni-app-x
4.4 3.9+ 3.9+ x x x

# devicePX2px(devicePX:number) : number;

物理像素转换为页面的px像素

Parameters

name type required description
devicePX number YES 待转换的物理像素

Return value

Type description
number 转换后的页面px

Compatibility

Android version Android uni-app Android uni-app-x iOS version iOS uni-app iOS uni-app-x
4.4 3.95 3.95 x x x

# isPrivacyAgree() : boolean;

当前应用是否已取得用户同意隐私协议

Return value

Type description
boolean true 用户已同意 false 用户未同意

Compatibility

Android version Android uni-app Android uni-app-x iOS version iOS uni-app iOS uni-app-x
5 3.9+ 3.9+ x x x

# setPrivacyAgree(state:boolean):void;

设置当前应用是否已取得用户同意隐私协议

Parameters

name type required description
state boolean YES true 用户已同意 false 用户未同意

Return value

Type
void

Compatibility

Android version Android uni-app Android uni-app-x iOS version iOS uni-app iOS uni-app-x
5 3.9+ 3.9+ x x x

# resetPrivacyAgree():void;

重置当前应用至用户未同意隐私协议

Return value

Type
void

Compatibility

Android version Android uni-app Android uni-app-x iOS version iOS uni-app iOS uni-app-x
5 3.9+ 3.9+ x x x

# requestSystemPermission

请求系统权限

Parameters

name type required description
context Activity YES -
success (allRight:boolean, grantedList:Array<string>)=>void YES -
fail (doNotAskAgain:boolean, grantedList:Array<string>)=>void YES -

Return value

Type
void

Compatibility

Android version Android uni-app Android uni-app-x iOS version iOS uni-app iOS uni-app-x
4.4 3.9+ 3.9+ x x x

# checkSystemPermissionGranted

检查当前应用是否已经具备指定权限

Parameters

name type required description
context Activity YES -
requestPermission Array<string> YES 期望具备的权限

Return value

Type description
boolean 请求的权限列表中是否已经具备

Compatibility

Android version Android uni-app Android uni-app-x iOS version iOS uni-app iOS uni-app-x
4.4 3.9+ 3.9+ x x x

# gotoSystemPermissionActivity

跳转至系统权限手动设备列表

Parameters

name type required description
context Activity YES -
requestPermission Array<string> YES 期望请求的权限

Return value

Type
void

Compatibility

Android version Android uni-app Android uni-app-x iOS version iOS uni-app iOS uni-app-x
4.4 3.9+ 3.9+ x x x

# getSystemPermissionDenied

获取当前应用不具备的权限列表

Parameters

name type required description
context Activity YES -
requestPermission Array<string> YES 期望请求的权限

Return value

Type description
Array<string> 请求的权限列表中已经被禁用的部分

Compatibility

Android version Android uni-app Android uni-app-x iOS version iOS uni-app iOS uni-app-x
4.4 3.9+ 3.9+ x x x

# convert2AbsFullPath

eg. 'static/logo.png' -> '/storage/sdcard/0/apps/com.xxxx/files/logo.png'

Parameters

name type required description
inputPath string YES 待转换的资源相对路径

Return value

Type description
string 转换后文件绝对路径

Compatibility

Android version Android uni-app Android uni-app-x iOS version iOS uni-app iOS uni-app-x
4.4 3.9x 3.9x x x x

# getFileProviderUri

# # See also

Related Bug

// 使用外部应用打开项目内置图片资源
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);