API references provide the description of APIs used for application development. This topic describes common fields in the API references to help you better use the reference document.
In API references, the earliest versions of APIs and components are specified in the following two ways:
Along its evolution, the system has provided two application models: FA model and stage model.
By default, applications can have only limited access to system resources. However, to provide extended features, an application may need to access excess data (including personal data) and functions of the system or another application. For details, see Application Permission Management Overview.
To call APIs to access these resources, you must apply for the corresponding permissions For details about the application method, see Application Access Control.
SystemCapability (SysCap) is a standalone feature in the operating system. Different devices provide different system capabilities, and multiple APIs implement a system capability. You can determine whether an API can be used based on system capabilities. For details, see SystemCapability.
The following description is provided for each API in the reference document to describe the system capability of the API: "System capability: SystemCapability.xxx.xxx"
You can use SystemCapability to query the devices supported by a specific capability set.
A service widget (also called widget) is a set of UI components that display important information or operations specific to an application or atomic service. It provides users with direct access to a desired service, without the need to open the application first.
For APIs that can be used in ArkTS widgets, the following description will be added: "Widget capability: This API can be used in ArkTS widgets since API version x."
A deprecated API is an API no longer recommended and is marked with the deprecated superscript.
While deprecated APIs can still be implemented in the five API levels immediately following the version when the API is deprecated, this is not recommended.
HarmonyOS supports two development languages: JS and TS.
Atomic services take a lightweight application form and feature instant access, cross-device hopping, and more.
Atomic services can be independently released, distributed, and executed to implement service closure, greatly improving the efficiency of obtaining information and services.
Atomic services are developed based on the HarmonyOS SDK (only the Atomic Service API Set can be used) and can run on 1+8+N devices in proper scenarios.
For APIs that can be used in atomic services, the following description will be added: "Atomic service API: This API can be used in atomic services since API version x."