HarmonyOS API:已停止维护的接口
版本:v3.1 Beta
@system.network (网络状态)
更新时间: 2023-02-17 09:19
说明
- 从API Version 7 开始,该接口不再维护,推荐使用新接口@ohos.telephony.observer。
- 本模块首批接口从API version 3开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
导入模块
import network from '@system.network';
权限列表
ohos.permission.GET_WIFI_INFO
ohos.permission.GET_NETWORK_INFO
network.getType
getType(Object): void
获取当前设备的网络类型。
系统能力: SystemCapability.Communication.NetManager.Core
参数:
参数名 | 类型 | 必填 | 说明 |
success | Function | 否 | 接口调用成功的回调函数。 |
fail | Function | 否 | 接口调用失败的回调函数。 |
complete | Function | 否 | 接口调用结束的回调函数。 |
success返回值:
参数名 | 类型 | 说明 |
metered | boolean | 是否按照流量计费。 |
type | string | 网络类型,可能的值有2g,3g,4g,5g,wifi,none等。 |
fail返回值:
错误码 | 说明 |
602 | 当前权限未声明。 |
示例:
export default {
getType() {
network.getType({
success: function(data) {
console.log('success get network type:' + data.type);
},
fail: function(data, code) {
console.log('fail to get network type code:' + code + ', data:' + data);
},
});
},
}
network.subscribe
subscribe(Object): void
订阅当前设备的网络连接状态。如果多次调用,会覆盖前一次调用。
系统能力: SystemCapability.Communication.NetManager.Core
参数:
参数名 | 类型 | 必填 | 说明 |
success | Function | 否 | 网络发生变化的回调函数。 |
fail | Function | 否 | 接口调用失败的回调函数。 |
success返回值:
参数名 | 类型 | 说明 |
metered | boolean | 是否按照流量计费。 |
type | string | 网络类型,可能的值为2g,3g,4g,5g,wifi,none。 |
fail返回值:
错误码 | 说明 |
602 | 当前权限未声明。 |
200 | 订阅失败。 |
示例:
export default {
subscribe() {
network.subscribe({
success: function(data) {
console.log('network type change type:' + data.type);
},
fail: function(data, code) {
console.log('fail to subscribe network, code:' + code + ', data:' + data);
},
});
},
}
network.unsubscribe
unsubscribe(): void
取消订阅设备的网络连接状态。
系统能力: SystemCapability.Communication.NetManager.Core
示例:
export default {
unsubscribe() {
network.unsubscribe();
},
}
@system.package (应用管理)
更新时间: 2023-02-17 09:19
说明
- 从API version 9开始不再维护,推荐使用该模块@ohos.bundle.bundleManager。
- 本模块首批接口从API version 3开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
导入模块
import package from '@system.package';
package.hasInstalled(deprecated)
从API version 9开始不再维护,推荐使用该模块@ohos.bundle.bundleManager。
hasInstalled(Object): void
查询指定应用是否存在,或者原生应用是否安装。
需要权限: ohos.permission.GET_BUNDLE_INFO
系统能力: SystemCapability.BundleManager.BundleFramework
参数:
参数名 | 类型 | 必填 | 说明 |
options | 是 | 选项参数。 |
返回值:
参数名 | 类型 | 说明 |
result | boolean | 表示查询的应用是否存在,或者原生应用是否安装。 |
示例:
export default {
hasInstalled() {
package.hasInstalled({
bundleName: 'com.example.bundlename',
success: function(data) {
console.log('package has installed: ' + data);
},
fail: function(data, code) {
console.log('query package fail, code: ' + code + ', data: ' + data);
},
});
},
}
CheckPackageHasInstalledResponse
从API version 9开始不再维护。
指示应用包是否已安装。
系统能力: SystemCapability.BundleManager.BundleFramework。
名称 | 类型 | 说明 |
result | boolean | 指示应用是否已安装。 |
CheckPackageHasInstalledOptions
从API version 9开始不再维护。
查询包是否已安装时的选项。
名称 | 类型 | 必填 | 说明 |
bundleName | string | 是 | 应用包名。 |
success | Function | 否 | 接口调用成功的回调函数。 |
fail | Function | 否 | 接口调用失败的回调函数。 |
complete | Function | 否 | 接口调用结束的回调函数。 |
@system.prompt (弹窗)
更新时间: 2023-02-17 09:19
创建并显示文本提示框、对话框和操作菜单。
说明
- 从API Version 8 开始,该接口不再维护,推荐使用新接口@ohos.prompt。
- 本模块首批接口从API version 3开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
导入模块
import prompt from '@system.prompt';
prompt.showToast
showToast(options: ShowToastOptions): void
显示文本弹窗。
系统能力: SystemCapability.ArkUI.ArkUI.Full
参数:
参数名 | 类型 | 必填 | 说明 |
options | 是 | 定义ShowToast的选项。 |
示例:
export default {
showToast() {
prompt.showToast({
message: 'Message Info',
duration: 2000
});
}
}
prompt.showDialog
showDialog(options: ShowDialogOptions): void
显示对话框。
系统能力: SystemCapability.ArkUI.ArkUI.Full
参数:
参数名 | 类型 | 必填 | 说明 |
options | 是 | 定义显示对话框的选项。 |
示例:
export default {
showDialog() {
prompt.showDialog({
title: 'Title Info',
message: 'Message Info',
buttons: [
{
text: 'button',
color: '#666666',
},
],
success: function(data) {
console.log('dialog success callback,click button : ' + data.index);
},
cancel: function() {
console.log('dialog cancel callback');
},
});
}
}
prompt.showActionMenu6+
showActionMenu(options: ShowActionMenuOptions): void
显示操作菜单。
系统能力: SystemCapability.ArkUI.ArkUI.Full
参数:
参数名 | 类型 | 必填 | 说明 |
options | 是 | 定义ShowActionMenu的选项。 |
示例:
export default {
showActionMenu() {
prompt.showActionMenu({
title: 'Title Info',
buttons: [
{
text: 'item1',
color: '#666666',
},
{
text: 'item2',
color: '#000000',
},
],
success: function(tapIndex) {
console.log('dialog success callback,click button : ' + tapIndex);
},
fail: function(errMsg) {
console.log('dialog fail callback' + errMsg);
},
});
}
}
ShowToastOptions
定义ShowToast的选项。
系统能力: 以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full
名称 | 参数类型 | 必填 | 说明 |
message | string | 是 | 显示的文本信息。 |
duration | number | 否 | 默认值1500ms,建议区间:1500ms-10000ms。若小于1500ms则取默认值,最大取值为10000ms。 |
bottom5+ | string|number | 否 | 设置弹窗边框距离屏幕底部的位置。 |
Button
定义按钮的提示信息。
系统能力: 以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full
名称 | 参数类型 | 必填 | 说明 |
text | string | 是 | 定义按钮信息。 |
color | string | 是 | 定义按钮颜色。 |
ShowDialogSuccessResponse
定义ShowDialog的响应。
系统能力: 以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full
名称 | 参数类型 | 必填 | 说明 |
index | number | 是 | 定义数据的索引信息。 |
ShowDialogOptions
定义显示对话框的选项。
系统能力: 以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full
名称 | 参数类型 | 必填 | 说明 |
title | string | 否 | 标题文本。 |
message | string | 否 | 文本内容。 |
buttons | 否 | 对话框中按钮的数组,结构为:{text:'button', color: '#666666'},支持1-6个按钮。大于6个按钮时弹窗不显示。 | |
success | (data: ShowDialogSuccessResponse) => void | 否 | 接口调用成功的回调函数。 |
cancel | (data: string, code: string) => void | 否 | 接口调用失败的回调函数。 |
complete | (data: string) => void | 否 | 接口调用结束的回调函数。 |
ShowActionMenuOptions6+
定义ShowActionMenu的选项。
系统能力: 以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full
名称 | 参数类型 | 必填 | 说明 |
title | string | 否 | 标题文本。 |
buttons | [Button, Button?, Button?, Button?, Button?, Button?] | 是 | 对话框中按钮的数组,结构为:{text:'button', color: '#666666'},支持1-6个按钮。 |
success | (tapIndex: number, errMsg: string) => void | 否 | 弹出对话框时调用。 |
fail | (errMsg: string) => void | 否 | 接口调用失败的回调函数。 |
complete | (data: string) => void | 否 | 关闭对话框时调用。 |