HarmonyOS API:已停止维护的接口
版本:v3.1 Beta
@system.configuration (应用配置)
更新时间: 2023-02-17 09:19
说明
- 从API Version 7 开始,该接口不再维护,推荐使用新接口@ohos.i18n和@ohos.intl。
- 本模块首批接口从API version 3开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
导入模块
import configuration from '@system.configuration';
configuration.getLocale
static getLocale(): LocaleResponse
获取应用当前的语言和地区。默认与系统的语言和地区同步。
系统能力: SystemCapability.ArkUI.ArkUI.Lite
返回值:
类型 | 说明 |
LocaleResponse | 应用当前Locale相关信息。 |
示例:
export default {
getLocale() {
const localeInfo = configuration.getLocale();
console.info(localeInfo.language);
}
}
LocaleResponse
表示应用当前Locale的属性。
系统能力:以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Lite
名称 | 参数类型 | 可读 | 可写 | 说明 |
language | string | 是 | 否 | 语言。例如:zh。 |
countryOrRegion | string | 是 | 否 | 国家或地区。例如:CN。 |
dir | string | 是 | 否 | 文字布局方向。取值范围: - ltr:从左到右; - rtl:从右到左。 |
unicodeSetting5+ | string | 是 | 否 | 语言环境定义的Unicode语言环境键集,如果此语言环境没有特定键集,则返回空集。 例如:{"nu":"arab"},表示当前环境下的数字采用阿拉伯语的数字。 |
@system.device (设备信息)
更新时间: 2023-02-17 09:19
本模块提供当前设备的信息。
说明
- 从API Version 6开始,该接口不再维护,推荐使用新接口@ohos.deviceInfo进行设备信息查询。
- 本模块首批接口从API version 3开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
导入模块
import device from '@system.device';
device.getInfo
getInfo(Object): void
获取当前设备的信息。
说明
在首页的onShow生命周期之前不建议调用device.getInfo接口。
系统能力: SystemCapability.Startup.SystemInfo
参数:
参数名 | 类型 | 必填 | 说明 |
success | Function | 否 | 接口调用成功的回调函数。 |
fail | Function | 否 | 接口调用失败的回调函数。 |
complete | Function | 否 | 接口调用结束的回调函数。 |
success返回值:
参数名 | 类型 | 说明 |
brand | string | 品牌。 |
manufacturer | string | 生产商。 |
model | string | 型号。 |
product | string | 代号。 |
language4+ | string | 系统语言。 |
region4+ | string | 系统地区。 |
windowWidth | number | 可使用的窗口宽度。 |
windowHeight | number | 可使用的窗口高度。 |
screenDensity4+ | number | 屏幕密度。 |
screenShape4+ | string | 屏幕形状。可取值: - rect:方形屏; - circle:圆形屏。 |
apiVersion4+ | number | 系统API版本号。 |
releaseType4+ | string | 版本发布类型,值为类型+版本号,如Beta1。 类型可能值有: - Canary:同一apiVersion下,canary版本之间保持API兼容,beta版本不对canary版本兼容。 - Beta:同一apiVersion下,beta版本之间保持API兼容,release版本不对beta版本兼容。 - Release:release版本会保持5个API版本兼容。 |
deviceType4+ | string | 设备类型。 |
fail返回错误代码:
错误码 | 说明 |
200 | 返回结果中存在无法获得的信息。 |
示例:
export default {
getInfo() {
device.getInfo({
success: function(data) {
console.log('Device information obtained successfully. Device brand:' + data.brand);
},
fail: function(data, code) {
console.log('Failed to obtain device information. Error code:'+ code + '; Error information: ' + data);
},
});
},
}
@system.fetch (数据请求)
更新时间: 2023-02-17 09:19
说明
- 从API Version 6开始,该接口不再维护,推荐使用新接口@ohos.net.http。
- 本模块首批接口从API version 3开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
导入模块
import fetch from '@system.fetch';
fetch.fetch
fetch(Object): void
通过网络获取数据。
需要权限: ohos.permission.INTERNET
系统能力: SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
url | string | 是 | 资源地址。 |
data | string | Object | 否 | 请求的参数,可选类型是字符串或者json对象。详见表 data与Content-Type关系。 |
header | Object | 否 | 设置请求的header。 |
method | string | 否 | 请求方法默认为GET,可选值为:OPTIONS、GET、HEAD、POST、PUT、DELETE、TRACE。 |
responseType | string | 否 | 默认会根据服务器返回header中的Content-Type确定返回类型,支持文本和json格式。详见success返回值。 |
success | Function | 否 | 接口调用成功的回调函数。 |
fail | Function | 否 | 接口调用失败的回调函数。 |
complete | Function | 否 | 接口调用结束的回调函数。 |
表1 data与Content-Type关系
data | Content-Type | 说明 |
string | 不设置 | Content-Type默认为 text/plain,data值作为请求的body。 |
string | 任意 Type | data值作为请求的body。 |
Object | 不设置 | Content-Type默认为application/x-www-form-urlencoded,data按照资源地址规则进行encode拼接作为请求的body。 |
Object | application/x-www-form-urlencoded | data按照资源地址规则进行encode拼接作为请求的body。 |
success返回值:
参数名 | 类型 | 说明 |
code | number | 表示服务器的状态code。 |
data | string | Object | 返回数据类型由responseType确定,详见表 responseType与success中data关系。 |
headers | Object | 表示服务器response的所有header。 |
表2 responseType与success中data关系
responseType | data | 说明 |
无 | string | 服务器返回的header中的type如果是text/*或application/json、application/javascript、application/xml,值为文本内容。 |
text | string | 返回文本内容。 |
json | Object | 返回json格式的对象。 |
示例:
export default {
data: {
responseData: 'NA',
url: "test_url",
},
fetch: function () {
var that = this;
fetch.fetch({
url: that.url,
success: function(response) {
console.info("fetch success");
that.responseData = JSON.stringify(response);
},
fail: function() {
console.info("fetch fail");
}
});
}
}
说明
默认支持https,如果要支持http,需要在config.json里增加network标签,属性标识 "cleartextTraffic": true。即:
{
"deviceConfig": {
"default": {
"network": {
"cleartextTraffic": true
}
...
}
}
...
}
@system.notification (通知消息)
更新时间: 2023-02-17 09:19
说明
- 从API Version 7 开始,该接口不再维护,推荐使用新接口@ohos.notification。
- 本模块首批接口从API version 3开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
导入模块
import notification from '@system.notification';
ActionResult
系统能力:以下各项对应的系统能力均为SystemCapability.Notification.Notification
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
bundleName | 是 | 是 | string | 是 | 单击通知后要重定向到的应用程序的Bundle名。 |
abilityName | 是 | 是 | string | 是 | 单击通知后要重定向到的应用程序的Ability名称。 |
uri | 是 | 是 | string | 否 | 要重定向到的页面的uri。 |
ShowNotificationOptions
系统能力:以下各项对应的系统能力均为SystemCapability.Notification.Notification
名称 | 可读 | 可写 | 类型 | 必填 | 描述 |
contentTitle | 是 | 是 | string | 否 | 通知标题。 |
contentText | 是 | 是 | string | 否 | 通知内容。 |
clickAction | 是 | 是 | ActionResult | 否 | 通知被点击后触发的行为。 |
notification.show
show(options?: ShowNotificationOptions): void
显示通知。
系统能力: SystemCapability.Notification.Notification
参数:
参数名 | 类型 | 必填 | 说明 |
options | ShowNotificationOptions | 否 | 通知标题。 |
示例:
export default {
show() {
notification.show({
contentTitle: 'title info',
contentText: 'text',
clickAction: {
bundleName: 'com.example.testapp',
abilityName: 'notificationDemo',
uri: '/path/to/notification',
},
});
},
}