applications_app_samples/README.md
wangzhiyu 9916c0402a 整改readme
Signed-off-by: wangzhiyu <wangzhiyu12@huawei.com>
2023-07-07 16:39:46 +08:00

102 lines
7.3 KiB
Markdown
Executable File
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# App Samples<a name="EN-US_TOPIC_0000001115464207"></a>
- [Introduction](#section1470103520301)
- [Content](#sectionMenu)
- [Usage](#section17988202503116)
- [Limitations](#section18841871178)
## Introduction<a name="section1470103520301"></a>
We provide a series of app samples to help you quickly get familiar with the APIs and app development process of the OpenHarmony SDKs. Each app sample is an independent project in DevEco Studio. You can import a project into DevEco Studio to learn how to use APIs in the sample by browsing code, building the project, and installing and running the app.
## Content <a name="sectionMenu"></a>
- Basic
- [`Screenshot`Screenshot ArkTSAPI9](code/SystemFeature/Media/Screenshot)
- AppSample
- [`Chat`Chat SampleArkTSAPI9](code/Solutions/IM/Chat)
- Account
- [`AppAccountManager`App Account Manager ArkTSAPI9](code/BasicFeature/Security/AppAccountManager)
- Communication
- [`RPC`RPC Connection ArkTSAPI9](code/BasicFeature/Connectivity/RPC)
- [`Wlan`WLAN ArkTSAPI9](code/SystemFeature/Connectivity/Wlan)
- ability
- [`JsDistributedMusicPlayer`Distributed Music PlayerJSAPI10](code/SuperFeature/DistributedAppDev/JsDistributedMusicPlayer)
- [`FormExtAbility`Stage FormArkTSAPI9](code/SuperFeature/Widget/FormExtAbility)
- [`MissionManager`System Mission Manager(ArkTS)API9](code/SystemFeature/ApplicationModels/MissionManager)
- common
- [`Clock`ClockJSAPI10](code/Solutions/Tools/JsClock)
- [`DistributeCalc`Distributed CalculatorJSAPI10](code/SuperFeature/DistributedAppDev/DistributeCalc)
- [`ResourceManager`Resource ManagerArkTSAPI9](code/BasicFeature/Internationalnation/ResourceManager)
- [`JsHelloWorld`'Hello World'JSAPI8](common/JsHelloWorld)
- [`PowerManager`System Power ManagerArkTSAPI9](code/SystemFeature/DeviceManagement/PowerManager)
- [`International`i18nArkTSAPI9](code/SystemFeature/Internationalnation/International)
- data
- [`KvStore`Distributed DatabaseArkTSAPI9](code/SuperFeature/DistributedAppDev/Kvstore)
- [`DistributedRdb`Distributed RDBArkTSAPI9](code/SuperFeature/DistributedAppDev/DistributedRdb)
- [`Preferences`PreferenceArkTSAPI9](code/BasicFeature/DataManagement/Preferences)
- [`DistributedNote`Distributed Memo (ArkTS)API9](code/SuperFeature/DistributedAppDev/DistributedNote)
- device
- [`Sensor`SensorArkTSAPI9](code/BasicFeature/DeviceManagement/Sensor)
- [`Vibrator`VibratorArkTSAPI9](code/BasicFeature/DeviceManagement/Vibrator)
- [`DeviceUsageStatistics`Device Usage StatisticsArkTSAPI9](code/BasicFeature/DeviceUsageStatistics/DeviceUsageStatistics)
- [`Browser`BrowserArkTSAPI9](code/BasicFeature/Web/Browser)
- Graphics
- [`Window`Window(ArkTS)API9](code/BasicFeature/WindowManagement/WindowManage)
- media
- [`Recorder`RecorderArkTSAPI9](code/BasicFeature/Media/Recorder)
- [`MultiMedia`Multi MediaArkTSAPI9](code/Solutions/Media/MultiMedia)
- DFX
- [`FaultLogger`Fault LoggerArkTSAPI9](code/BasicFeature/DFX/FaultLogger)
- [`Logger`Logger(ArkTS)API9](code/BasicFeature/DFX/Logger)
- Telephony
- [`Call`CallArkTSAPI9](code/BasicFeature/Telephony/Call)
- [`Message`MessageArkTSAPI9](code/BasicFeature/Telephony/Message)
- [`RadioTech`Radio TechArkTSAPI9](code/BasicFeature/Telephony/RadioTech)
- [`SimManager`SIM Card ManagerArkTSAPI9](code/BasicFeature/Telephony/SimManager)
- [`MobileNetwork`Cellular Network(ArkTS)API9](code/BasicFeature/Telephony/MobileNetwork)
- thread
- [`JsWorker`Launch a workerJSAPI9](code/LaunguageBaseClassLibrary/JsWorker)
- CompleteApps
- [`KikaInput`Lite Input MethodJSAPI10](code/Solutions/InputMethod/KikaInput)
- [`FlipClock`Flip ClockArkTSAPI9](code/Solutions/Tools/FlipClock)
- ETSUI
- [`Canvas`CanvasArkTSAPI9](code/UI/ArkTsComponentCollection/Canvas)
- [`DefiningPageLayoutAndConnection`Defining Page Layout and ConnectionArkTSAPI9](code/UI/ArkTsComponentCollection/DefiningPageLayoutAndConnection)
- [`Drag`Drag ArkTSAPI9](code/UI/ArkTsComponentCollection/Drag)
- [`MediaQuery`Media Query ArkTSAPI9](code/UI/ArkTsComponentCollection/MediaQuery)
- [`AdaptiveCapabilities`AdaptiveCapabilitiesArkTSAPI9](code/SuperFeature/MultiDeviceAppDev/AdaptiveCapabilities)
- [`Game2048`2048 GameArkTSAPI9](code/Solutions/Game/Game2048)
- [`Lottie`LottieArkTSAPI9](code/Solutions/Game/Lottie)
- Notification
- [`CustomCommonEvent`Custom Common EventArkTSAPI9](code/BasicFeature/Notification/CustomCommonEvent)
- [`CustomEmitter`Custom Emitter ArkTSAPI9](code/BasicFeature/Notification/CustomEmitter)
- [`CustomNotification`Subscribe&Send Notification ArkTSAPI9](code/BasicFeature/Notification/CustomNotification)
- Network
- [`Http`http RequestArkTSAPI9](code/BasicFeature/Connectivity/Http)
- [`Socket`SocketArkTSAPI9](code/BasicFeature/Connectivity/Socket)
- Preset
- [`ArkTSClock`ClockArkTSAPI9](code/Solutions/Tools/ArkTSClock)
- [`ArkTSDistributeCalc`Distributed CalculatorArkTSAPI9](code/SuperFeature/DistributedAppDev/ArkTSDistributedCalc)
- [`ArkTSDistributedMusicPlayer`Distributed Music Player (ArkTS)API9](code/SuperFeature/DistributedAppDev/ArkTSDistributedMusicPlayer)
- PackageManagement
- [`ZipLib`zip&unzip(ArkTS)API9](code/LaunguageBaseClassLibrary/ZipLib)
- ResourcesSchedule
- [`Flybird`GameArkTSAPI9](code/BasicFeature/TaskManagement/Flybird)
- UI
- [`AtomicLayout`Atomic LayoutJSAPI8](UI/AtomicLayout)
- [`Badge`BadgeJSAPI8](UI/Badge)
- [`JsAnimationStyle`Animation StyleJSAPI8](UI/JsAnimationStyle)
## Usage<a name="section17988202503116"></a>
1. Import an independent app sample project into DevEco Studio for compilation, building, running, and debugging.
2. Some samples contain multiple modules. You can compile and build a single module to generate a HAP file or compile and build the entire project to generate multiple HAP files.
3. After HAP installation and execution, you can view the execution effect of the sample on the device and then conduct debugging.
## Limitations<a name="section18841871178"></a>
1. Before installing and running the sample, check the **deviceType** field in the **config.json** file to obtain the device types supported by the sample. You can modify this field to enable the sample to run on your target device. \(The **config.json** file is generally stored in the **entry/src/main** directory, which may be different depending on the samples.\)
2. If you want to run the app sample on OpenHarmony, configure the development environment by referring to [DevEco Studio \(OpenHarmony\) User Guide](https://gitee.com/openharmony/docs/blob/master/en/application-dev/quick-start/Readme-EN.md).
3. App samples that can run on standard-system or small-system devices (as stipulated in **Readme**) must run on OpenHarmony.