属性：
方法：
对象：
回调方法：
权限：
5+功能模块（permissions）
appid
当前应用的APPID
说明：
String 类型 只读属性
当前应用的APPID，字符串类型。注意，如果是在HBuilder真机运行获取的是固定值"HBuilder"，需要提交App云端打包后运行才能获取真实的APPID值。
示例：
uni-app使用plus注意事项
arguments
第三方程序调用时传递给程序的参数
说明：
String 类型 只读属性
第三方程序传递过来的参数，字符串格式类型数据。 不是由第三方程序调用启动，则返回空字符串。
平台支持：
- Android - 2.2+ (支持) :
如果是第三方APP调用，则把传递过来的参数组合成JSON格式字符串，如“{"name":"XiaoMing","password":"123456"}”； 如果是通过URL Scheme调用则将协议头（前缀）和参数组合成字符串，如“streamapp://name=XiaoMing&password=123456”。
- iOS - 4.3+ (支持) :
把第三方传递过来的参数组合成字符串，如“name=XiaoMing&password=123456”，建议第三方程序传递JSON格式字符串； 注：由于iOS平台原生传递参数与URL Scheme一致，通过URL Scheme启动应用时也没有协议头数据（前缀）。
示例：
uni-app使用plus注意事项
channel
应用的渠道标识
说明：
String 类型 只读属性
如果应用没有设置渠道标识，则返回空字符串。 以下是流应用环境中使用的特殊渠道标识：
- "qihoo:browser" - 表示360浏览器流应用
- "qihoo:appstore " - 表示360手机助手流应用
- "dcloud:streamapps" - 表示DCloud流应用基座
示例：
uni-app使用plus注意事项
launcher
应用启动来源
说明：
String 类型 只读属性
5+ APP启动类型，可取以下值：
- "default"：默认启动方式，通常表示应用列表启动（360手助中搜索启动）
- "scheme"：通过urlscheme方式触发启动
- "push"：通过点击系统通知方式触发启动
- "stream"：通过流应用api（plus.stream.open）启动
- "shortcut"：通过快捷方式启动，iOS平台表示通过3D Touch快捷方式，Android平台表示通过桌面快捷方式启动
- "barcode"：通过二维码扫描启动
- "myapp"：通过流应用"我的"应用列表或历史列表中触发启动
- "favorite"：通过流应用的"收藏"应用列表启动
- "browser"：通过流应用的内置浏览器导流启动的流应用（地址栏输入url启动应用、点击wap页面链接启动应用）
- "engines"：通过流应用的浏览器界面作为搜索引擎启动
- "search"：通过流应用的应用搜索启动应用（如iOS平台的T9键盘搜索）
- "speech"：通过流应用的语音识别启动应用
- "uniLink"：通过通用链接（universal link）启动应用
- "miniProgram"：通过微信小程序启动应用
平台支持：
origin
应用安装来源
说明：
String 类型 只读属性
5+应用安装来源，可取以下值：
- "default"：默认安装来源，apk/ipa安装包内置安装
- "stream"：通过流应用api（plus.stream.open）安装，仅流应用环境下支持
- "push"：通过点击系统通知方式触发安装，仅流应用环境下支持
- "scheme"：通过urlscheme方式触发安装，仅流应用环境下支持
- "barcode"：通过二维码扫描触发安装，仅流应用环境下支持
- "silent"：通过后台静默方式安装，仅流应用环境下支持
- "speech"：通过语音识别方式触发安装，仅流应用环境下支持
- "favorite"：通过收藏界面启动触发安装，仅流应用环境下支持
version
客户端的版本名称
说明：
String 类型 只读属性
字符串类型，在编译环境中设置的apk/ipa版本名称。 Android平台对应AndroidManifest.xml中的android:versionName属性值； iOS平台对应Info.plist中的CFBundleShortVersionString字段值。
示例：
uni-app使用plus注意事项
versionCode
客户端的版本号
说明：
String 类型 只读属性
字符串类型，仅包含数字。 Android平台对应AndroidManifest.xml中的android:versionCode属性值； iOS平台对应Info.plist中CFBundleVersion字段值。
示例：
uni-app使用plus注意事项
innerVersion
客户端5+运行环境的内部版本号
说明：
String 类型 只读属性
5+运行环境内部版本号，格式为：[主版本号].[次版本号].[修订版本号].[编译代号]。
示例：
uni-app使用plus注意事项
uniVersion
客户端uni-app运行环境的版本号
说明：
String 类型 只读属性
uni-app运行环境版本号，格式为：[主版本号].[次版本号].[修订版本号]。 注意：仅在uni-app应用中才能获取此版本号，非uni-app应用中返回空字符串。
示例：
uni-app使用plus注意事项
launchLoadedTime
获取当前应用首页加载的时间
说明：
Number 类型 只读属性
应用加载首页面的总时间，从开始加载首页面到首页面加载完成，单位为ms。 注意，应用首页为网络地址则包括网络传输时间。
示例：
uni-app使用plus注意事项
processId
获取当前应用的进程标识
说明：
String 类型 只读属性
当前应用所属系统进程标识。
示例：
uni-app使用plus注意事项
startupTime
获取当前应用的启动时间戳
说明：
Number 类型 只读属性
应用启动时间戳，距1970年1月1日之间的毫秒数。
示例：
uni-app使用plus注意事项
isRecovery
应用是否由于内核崩溃自动恢复
说明：
Boolean 类型 只读属性
如果应用是由于内核（WKWebview）崩溃恢复则返回true，否则返回false。 注意：仅iOS平台使用WKWebview内核时生效。
示例：
uni-app使用plus注意事项
agreePrivacy
用户同意隐私政策
说明：
HBuilderX2.5.11+版本支持，参考： Android平台隐私与政策提示框配置方法 - DCloud问答
设置应用状态为用户同意隐私政策，可通过plus.runtime.isAgreePrivacy判断是否已经同意。
参数：
无
返回值：
void : 无
disagreePrivacy
用户不同意隐私政策
说明：
HBuilderX2.5.11+版本支持，参考： Android平台隐私与政策提示框配置方法 - DCloud问答
设置应用状态为用户不同意隐私政策，可通过plus.runtime.isAgreePrivacy判断是否已经同意。
参数：
无
返回值：
void : 无
isAgreePrivacy
查询用户是否同意隐私政策
说明：
HBuilderX2.5.11+版本支持，参考： Android平台隐私与政策提示框配置方法 - DCloud问答
查询当前用户是否同意隐私政策。
参数：
无
返回值：
Boolean : 已同意返回true，否则返回false
平台支持：
showPrivacyDialog
显示隐私政策框
说明：
HBuilderX3.3.1+版本支持，参考： Android平台隐私与政策提示框配置方法 - DCloud问答
显示原生隐私政策提示框，并重置为用户未同意隐私协议状态。
参数：
- options: ( PrivacyDialogOptions ) 必选 隐私政策框配置项
返回值：
void : 无
平台支持：
getProperty
获取指定APPID对应的应用信息
参数：
返回值：
void : 无
示例：
uni-app使用plus注意事项
install
安装应用
说明：
支持以下类型安装包： 1. 应用资源安装包（wgt），扩展名为'.wgt'； 2. 应用资源差量升级包（wgtu），扩展名为'.wgtu'； 3. 系统程序安装包（apk），要求使用当前平台支持的安装包格式。 注意：仅支持本地地址，调用此方法前需把安装包从网络地址或其他位置放置到运行时环境可以访问的本地目录。
参数：
返回值：
void : 无
平台支持：
quit
退出应用
说明：
5+APP：退出应用，返回系统桌面； 流应用：在“流应用”中调用则退出当前流应用，返回进入应用前的界面（如应用列表）。
参数：
无
返回值：
void : 无
平台支持：
示例：
uni-app使用plus注意事项
restart
重启当前的应用
说明：
应用热重启，重新启动进入首页。
参数：
无
返回值：
void : 无
示例：
uni-app使用plus注意事项
setBadgeNumber
设置应用图标上显示的角标数字
参数：
返回值：
void : 无
平台支持：
示例：
uni-app使用plus注意事项
openURL
调用第三方程序打开指定的URL
参数：
返回值：
void : 无
平台支持：
- Android - 2.2+ (支持) :
支持
- iOS - 4.3+ (支持) :
支持，不支持identity参数
openWeb
使用内置Webview窗口打开URL
参数：
- url: ( String ) 必选 要打开的URL地址
字符串类型，仅支持http/https地址。
返回值：
void : 无
openFile
调用第三方程序打开指定的文件
参数：
返回值：
void : 无
示例：
uni-app使用plus注意事项
processDirectPage
处理直达页面链接参数
说明：
通过URL Scheme启动时，可以在?后面添加__direct_page参数自定义直达页面地址， 如“streamapp://m3w.cn/s/HelloH5?__direct_page=http%3a%2f%2fm.weibo.cn%2fu%2f3196963860”； 在流应用SDK集成时也可以通过direct_page参数（原生调用Intent）设置。 注意：仅第一次调用此API时返回直达页面链接地址，再次调用将返回空字符串；如果应用重新被带直达页面链接参数的URL Scheme启动/激活时，可再次调用此方法获取。
参数：
无
返回值：
String : 如果启动应用时传入直达页面，则返回直达页面链接地址； 否则返回空字符串。
示例：
uni-app使用plus注意事项
launchApplication
调用第三方程序
参数：
返回值：
void : 无
平台支持：
- Android - 2.2+ (支持) :
支持
- iOS - 4.3+ (支持) :
支持
示例：
uni-app使用plus注意事项
isApplicationExist
判断第三方程序是否已存在
说明：
如果第三方程序已安装则返回true，未安装则返回false。
参数：
返回值：
Boolean : 第三方程序已安装则返回true，否则返回false。
示例：
uni-app使用plus注意事项
isCustomLaunchPath
判断是否自定义应用启动页面加载地址
说明：
通过URL Scheme启动时，可以在?后面添加__launch_path参数自定义应用启动首页加载的页面地址， 如“streamapp://m3w.cn/s/HelloH5?__launch_path=http%3a%2f%2fm.weibo.cn%2fu%2f3196963860”； 在流SDK集成时也可以通过launch_path参数（原生调用Intent）设置。
参数：
无
返回值：
Boolean : 如果应用自定义页面地址则返回true，否则返回false。
示例：
uni-app使用plus注意事项
ApplicationInf
JSON对象，打开第三方程序参数
属性：
- pname: (String 类型 )第三方程序包名
仅Android平台支持，表示程序的包名，其它平台忽略此属性值。
平台支持
- action: (String 类型 )程序的操作行为
Android平台上与系统的action值一致；iOS平台为要调用程序的URLScheme格式字符串。
平台支持
- newTask: (Boolean 类型 )新任务模式标记
可取值： true-使用新任务模式标记（FLAG_ACTIVITY_NEW_TASK）启动应用； false-不使用新任务模式标记（FLAG_ACTIVITY_NEW_TASK）启动应用。 默认值为true。 注意：由于5+应用配置的launchMode为singleTask，所以另一个5+应用通过plus.runtime.launchApplication启动时如果应用已经在后台运行则不会触发newintent事件，为了避免此问题需要将newTask参数值设置为false。
平台支持
- Android - 2.2+ (支持)
- iOS - ALL (不支持) :
忽略此属性值。
- extra: (JSON 类型 )调用程序的参数
仅Android平台支持，为JSON格式，用于传递给要调用程序的参数，如extra:{url:"http://www.html5plus.org"}。
平台支持
BadgeOptions
JSON对象，应用角标显示需要的通知栏消息的参数
属性：
OpenFileOptions
JSON对象，打开文件参数
属性：
PrivacyDialogOptions
JSON对象，显示原生隐私政策提示框参数
属性：
WidgetInfo
JSON对象，应用信息
属性：
- appid: (String 类型 )应用的APPID
对应manifest.json中的id字段值。
- version: (String 类型 )应用的版本名称
对应manifest.json中的version->name字段值。
- versionCode: (String 类型 )应用的版本号
对应manifest.json中的version->code字段值。
- name: (String 类型 )应用的名称
对应manifest.json中的name字段值。
- description: (String 类型 )应用描述信息
对应manifest.json中的description字段值。
- author: (String 类型 )应用描述信息
对应manifest.json中的developer->name字段值。
- email: (String 类型 )开发者邮箱地址
对应manifest.json中的developer->email字段值。
- features: (String[] 类型 )应用许可特性列表
对应manifest.json中的permissions字段下所有键名的列表。
WidgetOptions
JSON对象，应用安装参数
说明：
可通过对象设置安装的应用是否进行appid校验、版本号校验等。
属性：
InstallSuccessCallback
安装应用成功回调函数
参数：
- widgetInfo: ( WidgetInfo ) 必选
应用信息，参见：WidgetInfo
返回值：
void : 无
平台支持：
- Android - 2.2+ (支持) :
支持，如安装文件为APK，则不触发此回调函数
- iOS - 4.3+ (支持) :
支持
InstallErrorCallback
安装应用失败回调函数
参数：
- error: ( Exception ) 必选
安装失败的错误信息
返回值：
void : 无
GetPropertyCallBack
获取应用属性成功回调函数
参数：
返回值：
void : 无
示例：
uni-app使用plus注意事项
OpenErrorCallback
打开本地文件或URL失败回调函数
参数：
- error: ( Exception ) 必选
打开操作失败的错误信息
返回值：
void : 无
LaunchErrorCallback
调用第三方程序失败回调函数
参数：
返回值：
void : 无
Callback
通用回调函数
参数：
- res: ( JSON ) 必选 回调参数
根据业务类型回调参数中的属性不同。
返回值：
void : 无
发表于 2023-2-16 18:54:46
提升卡
置顶卡
沉默卡
喧嚣卡
变色卡
千斤顶
照妖镜
