未验证 提交 9296d774 编写于 作者: O openharmony_ci 提交者: Gitee

!12764 monthly1018分支:apis各页面一级标题修改

Merge pull request !12764 from 葛亚芳/monthly_20221018
......@@ -333,7 +333,6 @@
- 定制管理
- [@ohos.configPolicy (配置策略)](js-apis-configPolicy.md)
- [@ohos.enterprise.deviceInfo (设备信息管理)](js-apis-enterprise-deviceInfo.md)
- [@ohos.enterprise.EnterpriseAdminExtensionAbility (EnterpriseAdminExtensionAbility)](js-apis-EnterpriseAdminExtensionAbility.md)
- [@ohos.enterprise.adminManager (企业设备管理)](js-apis-enterprise-adminManager.md)
- [@ohos.enterprise.dateTimeManager (系统时间管理)](js-apis-enterprise-dateTimeManager.md)
......
# EnterpriseAdminExtensionAbility
# @ohos.enterprise.EnterpriseAdminExtensionAbility (EnterpriseAdminExtensionAbility)
本模块提供企业管理员应用拓展能力。
......
# 手势路径
# @ohos.accessibility.GesturePath (手势路径)
GesturePath表示手势路径信息。
本模块用于创建辅助功能注入手势所需的手势路径信息。
>![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
>本模块首批接口从API version 9开始支持,后续版本的新增接口,采用上角标单独标记接口的起始版本。
> 本模块首批接口从API version 9开始支持,后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
......
# 手势触摸点
# @ohos.accessibility.GesturePoint (手势触摸点)
GesturePoint表示手势触摸点。
本模块用于创建辅助功能注入手势所需的手势路径的触摸点信息。
>![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
>本模块首批接口从API version 9开始支持,后续版本的新增接口,采用上角标单独标记接口的起始版本。
> 本模块首批接口从API version 9开始支持,后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
......
# 系统辅助功能配置
# @ohos.accessibility.config (系统辅助功能配置)
本模块提供系统辅助功能的配置,包括辅助扩展的启用与关闭、高对比度文字显示、鼠标键、无障碍字幕配置等。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从 API version 9 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> **说明:**
>
> - 本模块首批接口从 API version 9 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> - 本模块接口为系统接口。
## 导入模块
......
# 辅助功能
# @ohos.accessibility (辅助功能)
本模块提供辅助功能查询能力,包括获取辅助应用列表、辅助应用启用状态、无障碍字幕配置等。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
> 本模块首批接口从 API version 7 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
......
# 辅助功能扩展能力
# @ohos.application.AccessibilityExtensionAbility (辅助功能扩展能力)
**AccessibilityExtensionAbility**基于ExtensionAbility框架,提供辅助功能业务的能力。
>![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
>本模块首批接口从API version 9开始支持,后续版本的新增接口,采用上角标单独标记接口的起始版本。
> 本模块首批接口从API version 9开始支持,后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
......
# 电量信息
# @ohos.batteryInfo (电量信息)
该模块主要提供电池状态和充放电状态的查询接口。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
> 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
......
# 耗电统计
# @ohos.batteryStatistics (耗电统计)
该模块提供软硬件耗电统计信息的查询接口。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
> - 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
......
# 屏幕亮度
# @ohos.brightness (屏幕亮度)
该模块提供屏幕亮度的设置接口。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
> - 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
......
# 标准NFC-cardEmulation
# @ohos.nfc.cardEmulation (标准NFC-cardEmulation)
本模块主要提供NFC卡模拟业务,包括判断支持哪种卡模拟类型,HCE卡模拟的业务实现等。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
> 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
......
# 配置策略
# @ohos.configPolicy (配置策略)
配置策略提供按预先定义的定制配置层级获取对应定制配置目录和文件路径的能力。
......
# 有源标签
# @ohos.connectedTag (有源标签)
本模块提供有源标签的使用,包括初始化有源标签芯片、读取有源标签内容、写入内容到有源标签等。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
......
# 键鼠穿越
# @ohos.multimodalInput.inputDeviceCooperate (键鼠穿越)
键鼠穿越功能模块,提供两台或多台设备组网协同后键鼠共享能力,实现键鼠输入设备的跨设备协同操作。
> **说明**
>
> - 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> - 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
> - 本模块接口均为系统接口。
> - 本模块接口均为系统接口。
## 导入模块
......
# 设备信息
# @ohos.deviceInfo (设备信息)
本模块提供产品信息。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
> 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
......
# 设备管理
# @ohos.distributedHardware.deviceManager (设备管理)
本模块提供分布式设备管理能力。
......@@ -17,6 +14,7 @@
> **说明:**
>
> - 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
> - 本模块接口为系统接口,三方应用不支持调用。
......
# 分布式帐号管理
# @ohos.account.distributedAccount (分布式帐号管理)
本模块提供管理分布式帐号的一些基础功能,主要包括查询和更新帐号登录状态。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
......
# 企业设备管理
# @ohos.enterprise.adminManager (企业设备管理)
本模块提供企业设备管理能力,使设备具备企业场景下所需的定制能力。
......
# 系统时间管理
# @ohos.enterprise.dateTimeManager (系统时间管理)
本模块提供系统时间管理能力。仅企业设备管理员应用才能调用。
......
# 故障日志获取
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
# @ohos.faultLogger (故障日志获取)
> **说明:**
>
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
......
# 位置服务
# @ohos.geoLocationManager (位置服务)
位置服务提供GNSS定位、网络定位、地理编码、逆地理编码、国家码和地理围栏等基本功能。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 申请权限
......
# 检测模式
# @ohos.hichecker (检测模式)
HiChecker可以作为应用开发阶段使用的检测工具,用于检测代码运行过程中部分易忽略的问题,如应用线程出现耗时调用、应用进程中Ability资源泄露等问题。开发者可以通过日志记录或进程crash等形式查看具体问题并进行修改,提升应用的使用体验。
> **说明:**
>
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
......
# Debug调试
# @ohos.hidebug (Debug调试)
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
使用hidebug,可以获取应用内存的使用情况,包括应用进程的静态堆内存(native heap)信息、应用进程内存占用PSS(Proportional Set Size)信息等;可以完成虚拟机内存切片导出,虚拟机CPU Profiling采集等操作。
......
# Hilog日志打印
# @ohos.hilog (HiLog日志打印)
hilog日志系统,使应用/服务可以按照指定级别、标识和格式字符串输出日志内容,帮助开发者了解应用/服务的运行状态,更好地调试程序。
> **说明:**
>
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
......
# 系统事件打点
# @ohos.hiSysEvent (系统事件打点)
本模块提供了系统事件打点能力,包括系统事件的埋点、落盘系统事件的订阅及已落盘的系统事件的查询能力。
......
# 分布式跟踪
# @ohos.hiTraceChain (分布式跟踪)
本模块提供了端侧业务流程调用链跟踪的打点能力,包括业务流程跟踪的启动、结束、信息埋点等能力。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
......
# 性能打点
# @ohos.hiTraceMeter (性能打点)
本模块提供了跟踪进程轨迹,度量程序执行性能的打点能力。本模块打点的数据供hiTraceMeter工具分析使用。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
......
# 应用事件打点
# @ohos.hiviewdfx.hiAppEvent (应用事件打点)
本模块提供了应用事件打点能力,包括应用事件落盘、应用事件订阅、应用事件清理、打点功能配置等功能。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
......
# 数据请求
# @ohos.net.http (数据请求)
本模块提供HTTP数据请求能力。应用可以通过HTTP发起一个数据请求,支持常见的GET、POST、OPTIONS、HEAD、PUT、DELETE、TRACE、CONNECT方法。
......
# 辅助功能扩展上下文
# AccessibilityExtensionContext (辅助功能扩展上下文)
AccessibilityExtensionContext是AccessibilityExtensionAbility上下文环境,继承自ExtensionContext。
......
# 组合按键
# @ohos.multimodalInput.inputConsumer (组合按键)
组合按键订阅模块,用于处理组合按键的订阅。
......
# 输入设备
# @ohos.multimodalInput.inputDevice (输入设备)
输入设备管理模块,用于监听输入设备连接和断开状态,查询输入设备相关信息。
> **说明**:
>
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
```js
import inputDevice from '@ohos.multimodalInput.inputDevice';
```
......
# 输入事件
# @ohos.multimodalInput.inputEvent (输入事件)
设备上报的基本事件。
> **说明:**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
......
# 按键注入
# @ohos.multimodalInput.inputEventClient (按键注入)
按键注入模块,提供按键注入能力。
......
# InputMethodExtensionAbility
# @ohos.inputmethodextensionability (InputMethodExtensionAbility)
开发者可通过继承本模块开发自己的输入法应用并管理输入法应用生命周期。
......
# InputMethodExtensionContext
# @ohos.inputmethodextensioncontext (InputMethodExtensionContext)
InputMethodExtensionContext模块是InputMethodExtensionAbility的上下文环境,继承自ExtensionContext。
......@@ -6,7 +6,7 @@ InputMethodExtensionContext模块提供InputMethodExtensionAbility具有的能
> **说明:**
>
>本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
......
# 输入法子类型
# @ohos.inputmethodsubtype (输入法子类型)
本模块提供对输入法子类型的属性管理。输入法应用子类型的含义,如:输入法的中文版、英文版、大写模式、小写模式等都属于输入法的子类型。
......
# 输入法框架
# @ohos.inputmethod (输入法框架)
本模块提供对输入法框架的管理,包括隐藏输入法、查询已安装的输入法列表和显示输入法选择对话框。
......
# 输入监听
# @ohos.multimodalInput.inputMonitor (输入监听)
输入监听模块,提供了监听输入设备事件(当前支持触摸屏和鼠标)的能力。
......
# 键值
# @ohos.multimodalInput.keyCode (键值)
按键设备键值。
> **说明:**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
......
# 按键输入事件
# @ohos.multimodalInput.keyEvent (按键输入事件)
设备上报的按键事件。
......
# 日志打印
# console (日志打印)
本模块提供基础的日志打印能力,支持按照日志级别打印日志信息。
......
# 鼠标输入事件
# @ohos.multimodalInput.mouseEvent (鼠标输入事件)
设备上报的鼠标事件。
> **说明:**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
......
# 网络连接管理
# @ohos.net.connection (网络连接管理)
网络连接管理提供管理网络一些基础能力,包括获取默认激活的数据网络、获取所有激活数据网络列表、开启关闭飞行模式、获取网络能力信息等功能。
......
# 以太网连接管理
# @ohos.net.ethernet (以太网连接管理)
以太网连接管理主要提供有线网络能力,提供设置有线网络的IP地址,子网掩码,网关,DNS等信息
......
# 网络共享管理
# @ohos.net.sharing (网络共享管理)
网络共享管理分享设备已有网络给其他连接设备,支持Wi-Fi热点共享和蓝牙共享,同时提供网络共享状态、共享流量查询功能。
......
# 标准NFC
# @ohos.nfc.controller (标准NFC)
本模块主要用于管理NFC状态,包括打开和关闭NFC,读取NFC的状态等。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## **导入模块**
......
# 标准NFC-Tag
# @ohos.nfc.tag (标准NFC-Tag)
本模块主要用于操作及管理NFC Tag。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## **声明技术**
......
# 剪贴板
# @ohos.pasteboard (剪贴板)
本模块主要提供管理系统剪贴板的能力,为系统复制、粘贴功能提供支持。系统剪贴板支持对文本、HTML、URI、Want、PixelMap等内容的操作。
......
# 鼠标指针
# @ohos.multimodalInput.pointer (鼠标指针)
鼠标指针管理模块,用于查询和设置鼠标指针相关属性。
......
# 系统电源管理
# @ohos.power (系统电源管理)
该模块主要提供重启、关机、查询屏幕状态等接口。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
......
# RunningLock锁
# @ohos.runningLock (Runninglock锁)
该模块主要提供RunningLock锁相关操作的接口,包括创建、查询、持锁、释放锁等操作。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
......
# 锁屏管理
# @ohos.screenLock (锁屏管理)
锁屏管理服务是OpenHarmony中的系统服务,为锁屏应用提供注册亮屏、灭屏、开启屏幕、结束休眠、退出动画、请求解锁结果监听,并提供回调结果给锁屏应用。锁屏管理服务向三方应用提供请求解锁、查询锁屏状态、查询是否设置锁屏密码的能力。
......
# 设置数据项名称
# @ohos.settings (设置数据项名称)
本模块提供访问设置数据项的能力。
......
# 设备状态感知框架
# @ohos.stationary (设备状态感知框架)
设备状态感知框架提供设备状态感知能力,包括绝对静止和相对静止。
> **说明:**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
......
# 系统能力
# @ohos.systemCapability (系统能力)
系统能力(SystemCapability,简称SysCap),指操作系统中每一个相对独立的特性。不同的设备对应不同的系统能力集,每个系统能力对应多个接口。开发者可根据系统能力来判断是否可以使用某接口。本模块提供接口可查询系统能力的集合。
> **说明:**
>
> - 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
> - 本模块接口为系统接口。
......
# 系统参数
# @ohos.systemParameterV9 (系统属性)
系统参数(SystemParameter)是为各系统服务提供的简单易用的键值对访问接口,各个系统服务可以定义系统参数来描述该服务的状态信息,或者通过系统参数来改变系统服务的行为。其基本操作原语为get和set,通过get可以查询系统参数的值,通过set可以修改系统参数的值。
详细的系统参数设计原理及定义可参考
[系统参数](../../../device-dev/subsystems/subsys-boot-init-sysparam.md)
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
> - 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
> - 本模块接口为系统接口。
>
> - 由于系统参数都是各个系统服务的内部信息和控制参数,每个系统参数都有各自不同的DAC和MAC访问控制权限,三方应用不能使用此类接口。
## 导入模块
......
# 系统时间、时区
# @ohos.systemTime (系统时间、时区)
本模块主要由系统时间和系统时区功能组成。开发者可以设置、获取系统时间及系统时区。
......
# 系统定时器
# @ohos.systemTimer (系统定时器)
本模块主要由系统定时器功能组成。开发者可以使用定时功能实现定时服务,如闹钟等。
......
# 标准NFC-Tag TagSession
# tagSession (标准NFC-Tag TagSession)
本模块是对NFC TagSession的使用说明。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## **导入模块**
......
# 热管理
# @ohos.thermal (热管理)
该模块提供热管理相关的接口,包括热档位查询及注册回调等功能。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
......
# 定时器
# Timer (定时器)
本模块提供基础的定时器能力,支持按照指定的时间执行对应函数。
......
# 触摸输入事件
# @ohos.multimodalInput.touchEvent (触摸输入事件)
设备上报的触屏事件。
......
# USB管理
# @ohos.usbV9 (USB管理)
本模块主要提供管理USB设备的相关功能,包括主设备上查询USB设备列表、批量数据传输、控制命令传输、权限控制等;从设备上端口管理、功能切换及查询等。
......
# 振动
# @ohos.vibrator (振动)
vibrator模块提供控制马达振动启、停的能力。
......
# 壁纸
# @ohos.wallpaper (壁纸)
壁纸管理服务是OpenHarmony中系统服务,是主题框架的部分组成,主要为系统提供壁纸管理服务能力,支持系统显示、设置、切换壁纸等功能。
......
# WebSocket连接
# @ohos.net.webSocket (WebSocket连接)
>![](public_sys-resources/icon-note.gif) **说明:**
>本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> **说明:**
>
> 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
使用WebSocket建立服务器与客户端的双向连接,需要先通过[createWebSocket](#websocketcreatewebsocket)方法创建[WebSocket](#websocket)对象,然后通过[connect](#connect)方法连接到服务器。当连接成功后,客户端会收到[open](#onopen)事件的回调,之后客户端就可以通过[send](#send)方法与服务器进行通信。当服务器发信息给客户端时,客户端会收到[message](#onmessage)事件的回调。当客户端不要此连接时,可以通过调用[close](#close)方法主动断开连接,之后客户端会收到[close](#onclose)事件的回调。
......
# WLAN扩展接口
# @ohos.wifiManagerExt (WLAN扩展接口)
该模块主要提供WLAN扩展接口,供非通用类型产品使用。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
该文档中的接口只供非通用类型产品使用,如路由器等,对于常规类型产品,不应该使用这些接口。
......
# WLAN扩展接口
# @ohos.wifiext (WLAN扩展接口)
该模块主要提供WLAN扩展接口,供非通用类型产品使用。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> **说明:**
>
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
该文档中的接口只供非通用类型产品使用,如路由器等,对于常规类型产品,不应该使用这些接口。
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册