diff --git a/zh-cn/application-dev/Readme-CN.md b/zh-cn/application-dev/Readme-CN.md new file mode 100644 index 0000000000000000000000000000000000000000..0301f1ec275a4bd4b20ede8a717ef4a55b2e4e5e --- /dev/null +++ b/zh-cn/application-dev/Readme-CN.md @@ -0,0 +1,193 @@ +# 应用开发 + +- [应用开发导读](application-dev-guide.md) +- DevEco Studio（OpenHarmony）使用指南 + - [概述](quick-start/deveco-studio-overview.md) + - [版本变更说明](quick-start/deveco-studio-release-notes.md) + - [配置OpenHarmony SDK](quick-start/configuring-openharmony-sdk.md) + - 创建OpenHarmony工程 + - [使用工程向导创建新工程](quick-start/use-wizard-to-create-project.md) + - [通过导入Sample方式创建新工程](quick-start/import-sample-to-create-project.md) + - [配置OpenHarmony应用签名信息](quick-start/configuring-openharmony-app-signature.md) + - [安装运行OpenHarmony应用](quick-start/installing-openharmony-app.md) +- [包结构说明](quick-start/package-structure.md) +- 快速入门 + - [开发准备](quick-start/start-overview.md) + - [使用JS语言开发](quick-start/start-with-js.md) +- JS UI框架 + - [JS UI框架概述](ui/ui-js-overview.md) + - 构建用户界面 + - [组件介绍](ui/ui-js-building-ui-component.md) + - 构建布局 + - [布局说明](ui/ui-js-building-ui-layout-intro.md) + - [添加标题行和文本区域](ui/ui-js-building-ui-layout-text.md) + - [添加图片区域](ui/ui-js-building-ui-layout-image.md) + - [添加留言区域](ui/ui-js-building-ui-layout-comment.md) + - [添加容器](ui/ui-js-building-ui-layout-external-container.md) + - [添加交互](ui/ui-js-building-ui-interactions.md) + - [动画](ui/ui-js-building-ui-animation.md) + - [事件](ui/ui-js-building-ui-event.md) + - [页面路由](ui/ui-js-building-ui-routes.md) + - [自定义组件](ui/ui-js-custom-components.md) +- 音频 + - [音频开发概述](media/audio-overview.md) + - [音频播放开发指导](media/audio-playback.md) + - [音频管理开发指导](media/audio-management.md) + - [音频录制开发指导](media/audio-recorder.md) +- IPC与RPC通信 + - [IPC与RPC通信概述](connectivity/ipc-rpc-overview.md) + - [IPC与RPC通信开发指导](connectivity/ipc-rpc-development-guideline.md) + - [远端状态订阅开发实例](connectivity/subscribe-remote-state.md) +- JS 开发参考 + - 框架说明 + - [文件组织](js-reference/js-framework-file.md) + - [js标签配置](js-reference/js-framework-js-tag.md) + - [app.js](js-reference/js-framework-js-file.md) + - 语法 + - [HML语法参考](js-reference/js-framework-syntax-hml.md) + - [CSS语法参考](js-reference/js-framework-syntax-css.md) + - [JS语法参考](js-reference/js-framework-syntax-js.md) + - [生命周期](js-reference/js-framework-lifecycle.md) + - [资源限定与访问](js-reference/js-framework-resource-restriction.md) + - [多语言支持](js-reference/js-framework-multiple-languages.md) + - 组件 + - 通用 + - [通用属性](js-reference/component/js-components-common-attributes.md) + - [通用样式](js-reference/component/js-components-common-styles.md) + - [通用事件](js-reference/component/js-components-common-events.md) + - [通用方法](js-reference/component/js-components-common-methods.md) + - [动画样式](js-reference/component/js-components-common-animation.md) + - [渐变样式](js-reference/component/js-components-common-gradient.md) + - [转场样式](js-reference/component/js-components-common-transition.md) + - [媒体查询](js-reference/component/js-components-common-mediaquery.md) + - [自定义字体样式](js-reference/component/js-components-common-customizing-font.md) + - [原子布局](js-reference/component/js-components-common-atomic-layout.md) + - 容器组件 + - [badge](js-reference/component/js-components-container-badge.md) + - [dialog](js-reference/component/js-components-container-dialog.md) + - [div](js-reference/component/js-components-container-div.md) + - [form](js-reference/component/js-components-container-form.md) + - [list](js-reference/component/js-components-container-list.md) + - [list-item](js-reference/component/js-components-container-list-item.md) + - [list-item-group](js-reference/component/js-components-container-list-item-group.md) + - [panel](js-reference/component/js-components-container-panel.md) + - [popup](js-reference/component/js-components-container-popup.md) + - [refresh](js-reference/component/js-components-container-refresh.md) + - [stack](js-reference/component/js-components-container-stack.md) + - [stepper](js-reference/component/js-components-container-stepper.md) + - [stepper-item](js-reference/component/js-components-container-stepper-item.md) + - [swiper](js-reference/component/js-components-container-swiper.md) + - [tabs](js-reference/component/js-components-container-tabs.md) + - [tab-bar](js-reference/component/js-components-container-tab-bar.md) + - [tab-content](js-reference/component/js-components-container-tab-content.md) + - 基础组件 + - [button](js-reference/component/js-components-basic-button.md) + - [chart](js-reference/component/js-components-basic-chart.md) + - [divider](js-reference/component/js-components-basic-divider.md) + - [image](js-reference/component/js-components-basic-image.md) + - [image-animator](js-reference/component/js-components-basic-image-animator.md) + - [input](js-reference/component/js-components-basic-input.md) + - [label](js-reference/component/js-components-basic-label.md) + - [marquee](js-reference/component/js-components-basic-marquee.md) + - [menu](js-reference/component/js-components-basic-menu.md) + - [option](js-reference/component/js-components-basic-option.md) + - [picker](js-reference/component/js-components-basic-picker.md) + - [picker-view](js-reference/component/js-components-basic-picker-view.md) + - [piece](js-reference/component/js-components-basic-piece.md) + - [progress](js-reference/component/js-components-basic-progress.md) + - [qrcode](js-reference/component/js-components-basic-qrcode.md) + - [rating](js-reference/component/js-components-basic-rating.md) + - [richtext](js-reference/component/js-components-basic-richtext.md) + - [search](js-reference/component/js-components-basic-search.md) + - [select](js-reference/component/js-components-basic-select.md) + - [slider](js-reference/component/js-components-basic-slider.md) + - [span](js-reference/component/js-components-basic-span.md) + - [switch](js-reference/component/js-components-basic-switch.md) + - [text](js-reference/component/js-components-basic-text.md) + - [textarea](js-reference/component/js-components-basic-textarea.md) + - [toolbar](js-reference/component/js-components-basic-toolbar.md) + - [toolbar-item](js-reference/component/js-components-basic-toolbar-item.md) + - [toggle](js-reference/component/js-components-basic-toggle.md) + - 媒体组件 + - [video](js-reference/component/js-components-media-video.md) + - 画布组件 + - [canvas组件](js-reference/component/js-components-canvas-canvas.md) + - [CanvasRenderingContext2D对象](js-reference/component/js-components-canvas-canvasrenderingcontext2d.md) + - [Image对象](js-reference/component/js-components-canvas-image.md) + - [CanvasGradient对象](js-reference/component/js-components-canvas-canvasgradient.md) + - [ImageData对象](js-reference/component/js-components-canvas-imagedata.md) + - [Path2D对象](js-reference/component/js-components-canvas-path2d.md) + - [ImageBitmap对象](js-reference/component/js-components-canvas-imagebitmap.md) + - [OffscreenCanvas对象](js-reference/component/js-components-canvas-offscreencanvas.md) + - [OffscreenCanvasRenderingContext2D对象](js-reference/component/js-components-canvas-offscreencanvasrenderingcontext2d.md) + - 栅格组件 + - [基本概念](js-reference/component/js-components-grid-basic-concepts.md) + - [grid-container](js-reference/component/js-components-grid-container.md) + - [grid-row](js-reference/component/js-components-grid-row.md) + - [grid-col](js-reference/component/js-components-grid-col.md) + - svg组件 + - [通用属性](js-reference/component/js-components-svg-common-attributes.md) + - [svg](js-reference/component/js-components-svg.md) + - [rect](js-reference/component/js-components-svg-rect.md) + - [circle](js-reference/component/js-components-svg-circle.md) + - [ellipse](js-reference/component/js-components-svg-ellipse.md) + - [path](js-reference/component/js-components-svg-path.md) + - [line](js-reference/component/js-components-svg-line.md) + - [polyline](js-reference/component/js-components-svg-polyline.md) + - [polygon](js-reference/component/js-components-svg-polygon.md) + - [text](js-reference/component/js-components-svg-text.md) + - [tspan](js-reference/component/js-components-svg-tspan.md) + - [textPath](js-reference/component/js-components-svg-textpath.md) + - [animate](js-reference/component/js-components-svg-animate.md) + - [animateMotion](js-reference/component/js-components-svg-animate-motion.md) + - [animateTransform](js-reference/component/js-components-svg-animate-transform.md) + - 自定义组件 + - [基本用法](js-reference/component/js-components-custom-basic-usage.md) + - [自定义事件](js-reference/component/js-components-custom-events.md) + - [Props](js-reference/component/js-components-custom-props.md) + - [事件参数](js-reference/component/js-components-custom-event-parameter.md) + - [slot插槽](js-reference/component/js-components-custom-slot.md) + - [生命周期定义](js-reference/component/js-components-custom-lifecycle.md) + - 接口 + - 基本功能 + - [应用上下文](js-reference/apis/js-apis-system-app.md) + - [日志打印](js-reference/apis/js-apis-basic-features-logs.md) + - [页面路由](js-reference/apis/js-apis-system-router.md) + - [弹窗](js-reference/apis/js-apis-system-prompt.md) + - [应用配置](js-reference/apis/js-apis-system-configuration.md) + - [定时器](js-reference/apis/js-apis-system-timer.md) + - [动画](js-reference/apis/js-apis-animator.md) + - [应用打点](js-reference/apis/js-apis-hiappevent.md) + - [性能打点](js-reference/apis/js-apis-bytrace.md) + - [分布式帐号管理](js-reference/apis/js-apis-distributedaccount.md) + - 媒体 + - [音频管理](js-reference/apis/js-apis-audio.md) + - [音频播放](js-reference/apis/js-apis-media.md) + - 数据管理 + - [文件管理](js-reference/apis/js-apis-fileio.md) + - [单版本分布式数据库](js-reference/apis/js-apis-data-singlekvstore.md) + - [创建和获取分布式数据库](js-reference/apis/js-apis-data-kvmanager.md) + - [KVManager配置信息](js-reference/apis/js-apis-data-kvmanager-config.md) + - [分布式数据库操作描述](js-reference/apis/js-apis-data-kvstore.md) + - [数据类型描述](js-reference/apis/js-apis-data-type.md) + - [轻量级存储](js-reference/apis/js-apis-data-storage.md) + - 设备管理 + - [设备信息](js-reference/apis/js-apis-deviceinfo.md) + - [系统属性](js-reference/apis/js-apis-systemparameter.md) + - [系统恢复](js-reference/apis/js-apis-update.md) + - [显示设备属性](js-reference/apis/js-apis-display.md) + - [电池和充电属性](js-reference/apis/js-apis-batteryinfo.md) + - [设置系统屏幕亮度](js-reference/apis/js-apis-brightness.md) + - [系统电源管理](js-reference/apis/js-apis-power.md) + - [Runninglock锁](js-reference/apis/js-apis-runninglock.md) + - [传感器](js-reference/apis/js-apis-sensor.md) + - [振动](js-reference/apis/js-apis-vibrate.md) + - [国际化（I18n）](js-reference/apis/js-apis-i18n.md) + - [国际化（Intl）](js-reference/apis/js-apis-intl.md) + - [资源管理](js-reference/apis/js-apis-resourcemanage.md) + - [时间设置](js-reference/apis/js-apis-systemtime.md) + - [升级](js-reference/apis/js-apis-libupdateclient.md) + - [获取进程相关的信息](js-reference/apis/js-apis-process.md) + - [字符串编解码](js-reference/apis/js-apis-util.md) + - [启动一个worker](js-reference/apis/js-apis-worker.md) + - [URL字符串解析](js-reference/apis/js-apis-url.md) diff --git a/zh-cn/application-dev/application-dev-guide.md b/zh-cn/application-dev/application-dev-guide.md index 7cd523be39e17b2323628402e546120fd7d90e20..fdbb963b5b3b34b7e2d6cf03723f5ca4e20622c9 100644 --- a/zh-cn/application-dev/application-dev-guide.md +++ b/zh-cn/application-dev/application-dev-guide.md @@ -1,10 +1,10 @@ -# 应用开发导读 +# 应用开发导读 应用开发文档用于指导开发者通过OpenHarmony提供的接口完成应用开发。当前应用开发文档提供了在标准系统上开发应用的JS接口。 -在这部分中，开发者可以通过“[入门](https://gitee.com/openharmony/docs/blob/5b6b26c33680dd1162a4df35c896e5ddefcb55b3/zh-cn/application-dev/quick-start/Readme-CN.md)”来了解应用开发的基本方法。完整的接口清单和参考使用指导可参见“[JS开发参考](https://gitee.com/openharmony/docs/blob/5b6b26c33680dd1162a4df35c896e5ddefcb55b3/zh-cn/application-dev/js-reference/Readme-CN.md)”。 +在这部分中，开发者可以通过“[入门](quick-start/Readme-CN.md)”来了解应用开发的基本方法。完整的接口清单和参考使用指导可参见“[JS开发参考](js-reference/Readme-CN.md)”。 -除此之外，为方便开发者对常用功能进行深入理解，还提供了[UI](https://gitee.com/openharmony/docs/blob/5b6b26c33680dd1162a4df35c896e5ddefcb55b3/zh-cn/application-dev/ui/Readme-CN.md)、[媒体](https://gitee.com/openharmony/docs/blob/5b6b26c33680dd1162a4df35c896e5ddefcb55b3/zh-cn/application-dev/media/Readme-CN.md)、[网络与连接](https://gitee.com/openharmony/docs/blob/5b6b26c33680dd1162a4df35c896e5ddefcb55b3/zh-cn/application-dev/connectivity/Readme-CN.md)三个模块的开发指南。 +除此之外，为方便开发者对常用功能进行深入理解，还提供了[UI](ui/Readme-CN.md)、[媒体](media/Readme-CN.md)、[网络与连接](connectivity/Readme-CN.md)三个模块的开发指南。 如果需要了解各子系统的原理和基本信息，可以参考“docs/zh-cn/readme”目录中各子系统readme的介绍。 diff --git a/zh-cn/application-dev/connectivity/Readme-CN.md b/zh-cn/application-dev/connectivity/Readme-CN.md index 846651b2554bc2f64eafb775b03b5d683a3f377d..f14d2382ace9dc34129fb0f79e693abfb0a9f5aa 100755 --- a/zh-cn/application-dev/connectivity/Readme-CN.md +++ b/zh-cn/application-dev/connectivity/Readme-CN.md @@ -1,7 +1,6 @@ # 网络与连接 -- [IPC与RPC通信](ipc-rpc.md) - - [IPC与RPC通信概述](ipc-rpc-overview.md) - - [IPC与RPC通信开发指导](ipc-rpc-development-guideline.md) - - [远端状态订阅开发实例](subscribe-remote-state.md) - +- IPC与RPC通信 + - [IPC与RPC通信概述](ipc-rpc-overview.md) + - [IPC与RPC通信开发指导](ipc-rpc-development-guideline.md) + - [远端状态订阅开发实例](subscribe-remote-state.md) diff --git a/zh-cn/application-dev/connectivity/ipc-rpc-development-guideline.md b/zh-cn/application-dev/connectivity/ipc-rpc-development-guideline.md index 548d6af38593dc3456c3a345283e6302cdd1cd77..b65b2d580b6e60d81c5f4c34a4fc88d2def101d2 100755 --- a/zh-cn/application-dev/connectivity/ipc-rpc-development-guideline.md +++ b/zh-cn/application-dev/connectivity/ipc-rpc-development-guideline.md @@ -1,165 +1,133 @@ -# IPC与RPC通信开发指导 +# IPC与RPC通信开发指导 -- [场景介绍](#section18502174174019) -- [接口说明](#section1633115419401) -- [开发步骤](#section4207112818418) +- [场景介绍](#场景介绍) +- [接口说明](#接口说明) +- [开发步骤](#开发步骤) -## 场景介绍 +## 场景介绍 IPC/RPC的主要工作是让运行在不同进程的Proxy和Stub互相通信，包括Proxy和Stub运行在不同设备的情况。 -## 接口说明 - -**表 1** Native侧IPC接口 - - - - - - - - - - - - - - - - - - - - -

类/接口

-

方法

-

功能说明

-

IRemoteBroker

-

sptr<IRemoteObject> AsObject()

-

返回通信对象。派生类需要实现，Stub端返回RemoteObject对象本身，Proxy端返回代理对象。

-

IRemoteStub

-

virtual int OnRemoteRequest(uint32_t code, MessageParcel &data, MessageParcel &reply, MessageOption &option)

-

请求处理方法，派生类需要重写，处理Proxy的请求并返回结果。

-

IRemoteProxy

-		  

业务Proxy类派生自IRemoteProxy类。

-
- -## 开发步骤 -**Native侧开发步骤** +## 接口说明 -1. 定义IPC接口ITestAbility +**表1** Native侧IPC接口 - SA接口继承IPC基类接口IRemoteBroker，接口里定义描述符、业务函数和消息码，其中业务函数在Proxy端和Stub端都需要实现。 +| 类/接口 | 方法 | 功能说明 | +| -------- | -------- | -------- | +| IRemoteBroker | sptr<IRemoteObject> AsObject() | 返回通信对象。派生类需要实现，Stub端返回RemoteObject对象本身，Proxy端返回代理对象。 | +| IRemoteStub | virtual int OnRemoteRequest(uint32_t code, MessageParcel &data, MessageParcel &reply, MessageOption &option) | 请求处理方法，派生类需要重写，处理Proxy的请求并返回结果。 | +| IRemoteProxy | | 业务Proxy类派生自IRemoteProxy类。 | - ``` - class ITestAbility : public IRemoteBroker { - public: - // DECLARE_INTERFACE_DESCRIPTOR是必须的， 入参需使用std::u16string； - DECLARE_INTERFACE_DESCRIPTOR(u"test.ITestAbility"); - int TRANS_ID_PING_ABILITY = 1; // 定义消息码 - virtual int TestPingAbility(const std::u16string &dummy) = 0; // 定义业务函数 - }; - ``` -2. 定义和实现服务端TestAbilityStub +## 开发步骤 - 该类是和IPC框架相关的实现，需要继承 IRemoteStub。Stub端作为接收请求的一端，需重写OnRemoteRequest方法用于接收客户端调用。 +**Native侧开发步骤** - ``` - class TestAbilityStub : public IRemoteStub { - public: - virtual int OnRemoteRequest(uint32_t code, MessageParcel &data, MessageParcel &reply, MessageOption &option) override; - int TestPingAbility(const std::u16string &dummy) override; +1. 定义IPC接口ITestAbility + SA接口继承IPC基类接口IRemoteBroker，接口里定义描述符、业务函数和消息码，其中业务函数在Proxy端和Stub端都需要实现。 + + ``` + class ITestAbility : public IRemoteBroker { + public: + // DECLARE_INTERFACE_DESCRIPTOR是必须的，入参需使用std::u16string； + DECLARE_INTERFACE_DESCRIPTOR(u"test.ITestAbility"); + int TRANS_ID_PING_ABILITY = 1; // 定义消息码 + virtual int TestPingAbility(const std::u16string &dummy) = 0; // 定义业务函数 + }; + ``` + +2. 定义和实现服务端TestAbilityStub + 该类是和IPC框架相关的实现，需要继承 IRemoteStub<ITestAbility>。Stub端作为接收请求的一端，需重写OnRemoteRequest方法用于接收客户端调用。 + + ``` + class TestAbilityStub : public IRemoteStub { + public: + virtual int OnRemoteRequest(uint32_t code, MessageParcel &data, MessageParcel &reply, MessageOption &option) override; + int TestPingAbility(const std::u16string &dummy) override; }; - - int TestServiceStub::OnRemoteRequest(uint32_t code, - MessageParcel &data, MessageParcel &reply, MessageOption &option) - { - switch (code) { - case TRANS_ID_PING_ABILITY: { - std::u16string dummy = data.ReadString16(); - int result = TestPingAbility(dummy); - reply.WriteInt32(result); - return 0; - } - default: - return IPCObjectStub::OnRemoteRequest(code, data, reply, option); - } - } - ``` - -3. 定义服务端业务函数具体实现类TestAbility - - ``` - class TestAbility : public TestAbilityStub { - public: - int TestPingAbility(const std::u16string &dummy); - } - - int TestAbility::TestPingAbility(const std::u16string &dummy) { - return 0; - } - ``` - -4. 定义和实现客户端TestAbilityProxy - - 该类是Proxy端实现，继承IRemoteProxy，调用SendRequest接口向Stub端发送请求，对外暴露服务端提供的能力。 - - ``` - class TestAbilityProxy : public IRemoteProxy { - public: - explicit TestAbilityProxy(const sptr &impl); - int TestPingService(const std::u16string &dummy) override; - private: - static inline BrokerDelegator delegator_; // 方便后续使用iface_cast宏 + + int TestServiceStub::OnRemoteRequest(uint32_t code, + MessageParcel &data, MessageParcel &reply, MessageOption &option) + { + switch (code) { + case TRANS_ID_PING_ABILITY: { + std::u16string dummy = data.ReadString16(); + int result = TestPingAbility(dummy); + reply.WriteInt32(result); + return 0; + } + default: + return IPCObjectStub::OnRemoteRequest(code, data, reply, option); + } + } + ``` + +3. 定义服务端业务函数具体实现类TestAbility + ``` + class TestAbility : public TestAbilityStub { + public: + int TestPingAbility(const std::u16string &dummy); + } + + int TestAbility::TestPingAbility(const std::u16string &dummy) { + return 0; + } + ``` + +4. 定义和实现客户端 TestAbilityProxy + 该类是Proxy端实现，继承IRemoteProxy<ITestAbility>，调用SendRequest接口向Stub端发送请求，对外暴露服务端提供的能力。 + + ``` + class TestAbilityProxy : public IRemoteProxy { + public: + explicit TestAbilityProxy(const sptr &impl); + int TestPingService(const std::u16string &dummy) override; + private: + static inline BrokerDelegator delegator_; // 方便后续使用iface_cast宏 + } + + TestAbilityProxy::TestAbilityProxy(const sptr &impl) + : IRemoteProxy(impl) + { + } + + int TestAbilityProxy::TestPingService(const std::u16string &dummy){ + MessageOption option; + MessageParcel dataParcel, replyParcel; + dataParcel.WriteString16(dummy); + int error = Remote()->SendRequest(TRANS_ID_PING_ABILITY, dataParcel, replyParcel, option); + int result = (error == ERR_NONE) ? replyParcel.ReadInt32() : -1; + return result; } - - TestAbilityProxy::TestAbilityProxy(const sptr &impl) - : IRemoteProxy(impl) - { - } - - int TestAbilityProxy::TestPingService(const std::u16string &dummy) { - MessageOption option; - MessageParcel dataParcel, replyParcel; - dataParcel.WriteString16(dummy); - int error = Remote()->SendRequest(TRANS_ID_PING_ABILITY, dataParcel, replyParcel, option); - int result = (error == ERR_NONE) ? replyParcel.ReadInt32() : -1; - return result; - } - ``` - -5. SA注册与启动 - - SA需要将自己的TestAbilityStub实例通过AddSystemAbility接口注册到SystemAbilityManager，设备内与分布式的注册参数不同。 - - ``` - // 注册到本设备内 - auto samgr = SystemAbilityManagerClient::GetInstance().GetSystemAbilityManager(); - samgr->AddSystemAbility(said, new TestAbility()); - - // 在组网场景下，会被同步到其他设备上 - auto samgr = SystemAbilityManagerClient::GetInstance().GetSystemAbilityManager(); - ISystemAbilityManager::SAExtraProp saExtra; - saExtra.isDistributed = true; // 设置为分布式SA - int result = samgr->AddSystemAbility(said, new TestAbility(), saExtra); - ``` - -6. SA获取与调用 - - 通过SystemAbilityManager的GetSystemAbility方法可获取到对应SA的代理IRemoteObject，然后构造TestAbilityProxy即可。 - - ``` - // 获取本设备内注册的SA的proxy - sptr samgr = SystemAbilityManagerClient::GetInstance().GetSystemAbilityManager(); - sptr remoteObject = samgr->GetSystemAbility(said); - sptr testAbility = iface_cast(remoteObject); // 使用iface_cast宏转换成具体类型 - - // 获取其他设备注册的SA的Proxy - sptr samgr = SystemAbilityManagerClient::GetInstance().GetSystemAbilityManager(); - sptr remoteObject = samgr->GetSystemAbility(sdid, deviceId); // deviceId是指定设备的标识符 - sptr proxy(new TestAbilityProxy(remoteObject)); // 直接构造具体Proxy - ``` - - + ``` + +5. SA 注册与启动 + SA 需要将自己的 TestAbilityStub实例通过 AddSystemAbility接口注册到 SystemAbilityManager，设备内与分布式的注册参数不同。 + + ``` + // 注册到本设备内 + auto samgr = SystemAbilityManagerClient::GetInstance().GetSystemAbilityManager(); + samgr->AddSystemAbility(said, new TestAbility()); + + // 在组网场景下，会被同步到其他设备上 + auto samgr = SystemAbilityManagerClient::GetInstance().GetSystemAbilityManager(); + ISystemAbilityManager::SAExtraProp saExtra; + saExtra.isDistributed = true; // 设置为分布式SA + int result = samgr->AddSystemAbility(said, new TestAbility(), saExtra); + ``` + +6. SA 获取与调用 + 通过SystemAbilityManager的GetSystemAbility方法可获取到对应SA的代理IRemoteObject，然后构造TestAbilityProxy即可。 + + ``` + // 获取本设备内注册的SA的proxy + sptr samgr = SystemAbilityManagerClient::GetInstance().GetSystemAbilityManager(); + sptr remoteObject = samgr->GetSystemAbility(said); + sptr testAbility = iface_cast(remoteObject); // 使用iface_cast宏转换成具体类型 + + // 获取其他设备注册的SA的Proxy + sptr samgr = SystemAbilityManagerClient::GetInstance().GetSystemAbilityManager(); + sptr remoteObject = samgr->GetSystemAbility(sdid, deviceId); // deviceId是指定设备的标识符 + sptr proxy(new TestAbilityProxy(remoteObject)); // 直接构造具体Proxy + ``` diff --git a/zh-cn/application-dev/connectivity/ipc-rpc-overview.md b/zh-cn/application-dev/connectivity/ipc-rpc-overview.md index 64a94f239d2242fde68f72636a792e762acd4f18..009802f340714aad691b72a6b46323af6c735ba2 100755 --- a/zh-cn/application-dev/connectivity/ipc-rpc-overview.md +++ b/zh-cn/application-dev/connectivity/ipc-rpc-overview.md @@ -1,20 +1,21 @@ -# IPC与RPC通信概述 +# IPC与RPC通信概述 -- [基本概念](#section175012297491) -- [约束与限制](#section2029921310472) -- [相关模块](#section1189019299446) +- [基本概念](#基本概念) +- [约束与限制](#约束与限制) +- [相关模块](#相关模块) -## 基本概念 +## 基本概念 IPC（Inter-Process Communication）与RPC（Remote Procedure Call）机制用于实现跨进程通信，不同的是前者使用Binder驱动，用于设备内的跨进程通信，而后者使用软总线驱动，用于跨设备跨进程通信。IPC和RPC通常采用客户端-服务器（Client-Server）模型，服务请求方（Client）可获取提供服务提供方（Server）的代理 （Proxy），并通过此代理读写数据来实现进程间的数据通信。通常，Server会先注册系统能力（System Ability）到系统能力管理者（System Ability Manager，缩写SAMgr）中，SAMgr负责管理这些SA并向Client提供相关的接口。Client要和某个具体的SA通信，必须先从SAMgr中获取该SA的代理，然后使用代理和SA通信。下文使用Proxy表示服务请求方，Stub表示服务提供方。 -## 约束与限制 + +## 约束与限制 目前暂不支持的场景： 跨设备RPC -## 相关模块 -分布式任务调度子系统 +## 相关模块 +分布式任务调度子系统 diff --git a/zh-cn/application-dev/connectivity/ipc-rpc.md b/zh-cn/application-dev/connectivity/ipc-rpc.md index eab1edb479701933c6112b64c3ac0c8e61a7578d..b28f4d1c71d5cfa7c7d09ca22ca904cb8fa85ca3 100644 --- a/zh-cn/application-dev/connectivity/ipc-rpc.md +++ b/zh-cn/application-dev/connectivity/ipc-rpc.md @@ -1,9 +1,8 @@ -# IPC与RPC通信 +# IPC与RPC通信 -- **[IPC与RPC通信概述](ipc-rpc-overview.md)** -- **[IPC与RPC通信开发指导](ipc-rpc-development-guideline.md)** - -- **[远端状态订阅开发实例](subscribe-remote-state.md)** +- **[IPC与RPC通信概述](ipc-rpc-overview.md)** +- **[IPC与RPC通信开发指导](ipc-rpc-development-guideline.md)** +- **[远端状态订阅开发实例](subscribe-remote-state.md)** \ No newline at end of file diff --git a/zh-cn/application-dev/connectivity/public_sys-resources/icon-caution.gif b/zh-cn/application-dev/connectivity/public_sys-resources/icon-caution.gif new file mode 100644 index 0000000000000000000000000000000000000000..6e90d7cfc2193e39e10bb58c38d01a23f045d571 Binary files /dev/null and b/zh-cn/application-dev/connectivity/public_sys-resources/icon-caution.gif differ diff --git a/zh-cn/application-dev/connectivity/public_sys-resources/icon-danger.gif b/zh-cn/application-dev/connectivity/public_sys-resources/icon-danger.gif new file mode 100644 index 0000000000000000000000000000000000000000..6e90d7cfc2193e39e10bb58c38d01a23f045d571 Binary files /dev/null and b/zh-cn/application-dev/connectivity/public_sys-resources/icon-danger.gif differ diff --git a/zh-cn/application-dev/connectivity/public_sys-resources/icon-note.gif b/zh-cn/application-dev/connectivity/public_sys-resources/icon-note.gif new file mode 100644 index 0000000000000000000000000000000000000000..6314297e45c1de184204098efd4814d6dc8b1cda Binary files /dev/null and b/zh-cn/application-dev/connectivity/public_sys-resources/icon-note.gif differ diff --git a/zh-cn/application-dev/connectivity/public_sys-resources/icon-notice.gif b/zh-cn/application-dev/connectivity/public_sys-resources/icon-notice.gif new file mode 100644 index 0000000000000000000000000000000000000000..86024f61b691400bea99e5b1f506d9d9aef36e27 Binary files /dev/null and b/zh-cn/application-dev/connectivity/public_sys-resources/icon-notice.gif differ diff --git a/zh-cn/application-dev/connectivity/public_sys-resources/icon-tip.gif b/zh-cn/application-dev/connectivity/public_sys-resources/icon-tip.gif new file mode 100644 index 0000000000000000000000000000000000000000..93aa72053b510e456b149f36a0972703ea9999b7 Binary files /dev/null and b/zh-cn/application-dev/connectivity/public_sys-resources/icon-tip.gif differ diff --git a/zh-cn/application-dev/connectivity/public_sys-resources/icon-warning.gif b/zh-cn/application-dev/connectivity/public_sys-resources/icon-warning.gif new file mode 100644 index 0000000000000000000000000000000000000000..6e90d7cfc2193e39e10bb58c38d01a23f045d571 Binary files /dev/null and b/zh-cn/application-dev/connectivity/public_sys-resources/icon-warning.gif differ diff --git a/zh-cn/application-dev/connectivity/subscribe-remote-state.md b/zh-cn/application-dev/connectivity/subscribe-remote-state.md index dd8ff7a0c26b5197e57b4d0a9e972bd420de6775..05ac640b376057a63d474156d587a70536722481 100755 --- a/zh-cn/application-dev/connectivity/subscribe-remote-state.md +++ b/zh-cn/application-dev/connectivity/subscribe-remote-state.md @@ -1,28 +1,34 @@ -# 远端状态订阅开发实例 +# 远端状态订阅开发实例 + +IPC/RPC 提供对远端 Stub对象状态的订阅机制， 在远端 Stub对象死亡时，可触发死亡通知告诉本地 Proxy对象。这种状态通知订阅并不会自动附加在每个本地 Proxy对象上，需要调用特定接口完成，当不再需要订阅时也需要调用特定接口取消。使用这种订阅机制的用户，需要实现死亡通知接口DeathRecipient并实现onRemoteDied方法，清理资源，该方法会在 远端 Stub对象所在进程死亡，或所在设备离开组网时被回调。值得注意的是，调用这些接口有一定的顺序。首先，必然需要 Proxy订阅 Stub死亡通知，若在订阅期间未发生 Stub死亡，则可在不再需要时取消订阅；若在订阅期间发生 Stub死亡，则会自动触发 Proxy自定义的后续操作，也无需再手动取消订阅。 + + +RPC目前不提供匿名 Stub对象的死亡通知，即只有向 SAMgr注册过的服务才能被订阅死亡通知。 IPC则支持匿名对象的死亡通知。 -IPC/RPC提供对远端Stub对象状态的订阅机制， 在远端Stub对象死亡时，可触发死亡通知告诉本地Proxy对象。这种状态通知订阅并不会自动附加在每个本地Proxy对象上，需要调用特定接口完成，当不再需要订阅时也需要调用特定接口取消。使用这种订阅机制的用户，需要实现死亡通知接口DeathRecipient并实现onRemoteDied方法，清理资源，该方法会在远端Stub对象所在进程死亡，或所在设备离开组网时被回调。值得注意的是，调用这些接口有一定的顺序。首先，必然需要Proxy订阅Stub死亡通知，若在订阅期间未发生Stub死亡，则可在不再需要时取消订阅；若在订阅期间发生Stub死亡，则会自动触发Proxy自定义的后续操作，也无需再手动取消订阅。 -RPC目前不提供匿名Stub对象的死亡通知，即只有向SAMgr注册过的服务才能被订阅死亡通知。IPC则支持匿名对象的死亡通知。 **Native侧接口** + 依次为添加对远端Stub对象状态订阅的接口，取消订阅的接口，及感知到远端Stub对象死亡而进行本地操作的接口： + ``` bool AddDeathRecipient(const sptr &recipient); bool RemoveDeathRecipient(const sptr &recipient); void OnRemoteDied(const wptr &object); ``` + 参考代码 + ``` class TestDeathRecipient : public IRemoteObject::DeathRecipient { public: virtual void OnRemoteDied(const wptr& remoteObject); } -sptr deathRecipient (new TestDeathRecipient()); // 构造一个死亡通知对象 +sptr deathRecipient (new TestDeathRecipient());// 构造一个死亡通知对象 bool result = proxy->AddDeathRecipient(deathRecipient); // 注册死亡通知 result = proxy->RemoveDeathRecipient(deathRecipient); // 移除死亡通知 ``` - diff --git a/zh-cn/application-dev/js-reference/Readme-CN.md b/zh-cn/application-dev/js-reference/Readme-CN.md index a8f7f743211df3b4b7cc7b164225c3f25dd05fd6..f6c0c2e1be171562930eb4287fcc7165366ce427 100755 --- a/zh-cn/application-dev/js-reference/Readme-CN.md +++ b/zh-cn/application-dev/js-reference/Readme-CN.md @@ -1,10 +1,10 @@ # JS开发参考 -- [框架说明](js-framework.md) +- 框架说明 - [文件组织](js-framework-file.md) - [js标签配置](js-framework-js-tag.md) - [app.js](js-framework-js-file.md) - - [语法](js-framework-syntax.md) + - 语法 - [HML语法参考](js-framework-syntax-hml.md) - [CSS语法参考](js-framework-syntax-css.md) - [JS语法参考](js-framework-syntax-js.md) @@ -14,7 +14,7 @@ - [多语言支持](js-framework-multiple-languages.md) - [组件](component/Readme-CN.md) - - [通用](component/js-components-common.md) + - 通用 - [通用属性](component/js-components-common-attributes.md) - [通用样式](component/js-components-common-styles.md) - [通用事件](component/js-components-common-events.md) @@ -26,7 +26,7 @@ - [自定义字体样式](component/js-components-common-customizing-font.md) - [原子布局](component/js-components-common-atomic-layout.md) - - [容器组件](component/js-components-container.md) + - 容器组件 - [badge](component/js-components-container-badge.md) - [dialog](component/js-components-container-dialog.md) - [div](component/js-components-container-div.md) @@ -45,7 +45,7 @@ - [tab-bar](component/js-components-container-tab-bar.md) - [tab-content](component/js-components-container-tab-content.md) - - [基础组件](component/js-components-basic.md) + - 基础组件 - [button](component/js-components-basic-button.md) - [chart](component/js-components-basic-chart.md) - [divider](component/js-components-basic-divider.md) @@ -74,10 +74,10 @@ - [toolbar-item](component/js-components-basic-toolbar-item.md) - [toggle](component/js-components-basic-toggle.md) - - [媒体组件](component/js-components-media.md) + - 媒体组件 - [video](component/js-components-media-video.md) - - [画布组件](component/js-components-canvas.md) + - 画布组件 - [canvas组件](component/js-components-canvas-canvas.md) - [CanvasRenderingContext2D对象](component/js-components-canvas-canvasrenderingcontext2d.md) - [Image对象](component/js-components-canvas-image.md) @@ -88,15 +88,15 @@ - [OffscreenCanvas对象](component/js-components-canvas-offscreencanvas.md) - [OffscreenCanvasRenderingContext2D对象](component/js-components-canvas-offscreencanvasrenderingcontext2d.md) - - [栅格组件](component/js-components-grid.md) + - 栅格组件 - [基本概念](component/js-components-grid-basic-concepts.md) - [grid-container](component/js-components-grid-container.md) - [grid-row](component/js-components-grid-row.md) - [grid-col](component/js-components-grid-col.md) - - [svg组件](component/js-components-svg.md) + - svg组件 - [通用属性](component/js-components-svg-common-attributes.md) - - [svg](component/js-components-svg-0.md) + - [svg](component/js-components-svg.md) - [rect](component/js-components-svg-rect.md) - [circle](component/js-components-svg-circle.md) - [ellipse](component/js-components-svg-ellipse.md) @@ -111,7 +111,7 @@ - [animateMotion](component/js-components-svg-animate-motion.md) - [animateTransform](component/js-components-svg-animate-transform.md) -- [自定义组件](component/js-components-custom.md) +- 自定义组件 - [基本用法](component/js-components-custom-basic-usage.md) - [自定义事件](component/js-components-custom-events.md) - [Props](component/js-components-custom-props.md) @@ -130,7 +130,7 @@ - [Notification模块](apis/js-apis-notification.md) - [Context模块](apis/js-apis-Context.md) - - [基本功能](apis/js-apis-basic-features.md) + - 基本功能 - [应用上下文](apis/js-apis-system-app.md) - [日志打印](apis/js-apis-basic-features-logs.md) - [页面路由](apis/js-apis-system-router.md) @@ -141,8 +141,8 @@ - [应用打点](apis/js-apis-hiappevent.md) - [性能打点](apis/js-apis-bytrace.md) - [分布式帐号管理](apis/js-apis-distributedaccount.md) - - - [媒体](apis/js-apis-multmedia.md) + + - 媒体 - [音频管理](apis/js-apis-audio.md) - [音频播放](apis/js-apis-media.md) @@ -152,7 +152,7 @@ - [SIM卡管理](apis/js-apis-sim.md) - [网络搜索](apis/js-apis-radio.md) - - [数据管理](apis/js-apis-data.md) + - 数据管理 - [文件管理](apis/js-apis-fileio.md) - [单版本分布式数据库](apis/js-apis-data-singlekvstore.md) - [创建和获取分布式数据库](apis/js-apis-data-kvmanager.md) @@ -160,8 +160,8 @@ - [分布式数据库操作描述](apis/js-apis-data-kvstore.md) - [数据类型描述](apis/js-apis-data-type.md) - [轻量级存储](apis/js-apis-data-storage.md) - - - [设备管理](apis/js-apis-device-mgmt.md) + + - 设备管理 - [设备信息](apis/js-apis-deviceinfo.md) - [系统属性](apis/js-apis-systemparameter.md) - [系统恢复](apis/js-apis-update.md) diff --git a/zh-cn/application-dev/js-reference/apis/js-apis-call.md b/zh-cn/application-dev/js-reference/apis/js-apis-call.md index 5ce29415fd0c56a82c9ec4bc5619c4995e4330e3..784b99569ae9f79002334812a3671a1250e81bbb 100755 --- a/zh-cn/application-dev/js-reference/apis/js-apis-call.md +++ b/zh-cn/application-dev/js-reference/apis/js-apis-call.md @@ -1,38 +1,40 @@ -# 拨打电话 - -- [导入模块](#section111401036143) -- [call.dial](#section1961259194312) -- [call.dial](#section387281814438) -- [call.dial](#section37173354913) -- [call.hasCall](#section19558123217015) -- [call.hasCall](#section12874319303) -- [call.getCallState](#section5882223124910) -- [call.getCallState](#section198597561794) -- [call.isEmergencyPhoneNumber7+](#section8560112174319) -- [call.isEmergencyPhoneNumber7+](#section9565131204319) -- [call.isEmergencyPhoneNumber7+](#section5569131234312) -- [call.formatPhoneNumber7+](#section1532018310579) -- [call.formatPhoneNumber7+](#section1832553165720) -- [call.formatPhoneNumber7+](#section1933033195716) -- [call.formatPhoneNumberToE1647+](#section10285180112418) -- [call.formatPhoneNumberToE1647+](#section142931509247) -- [DialOptions](#section12262183471518) -- [CallState](#section345181318300) -- [EmergencyNumberOptions7+](#section03689893518) -- [NumberFormatOptions7+](#section23348305716) +# 拨打电话 + +- [导入模块](#导入模块) +- [call.dial](#call.dial-callback1) +- [call.dial](#call.dial-callback2) +- [call.dial](#call.dial-promise) +- [call.hasCall](#call.hasCall-callback) +- [call.hasCall](#call.hasCall-promise) +- [call.getCallState](#call.getCallState-callback]) +- [call.getCallState](#call.getCallState-promise) +- [call.isEmergencyPhoneNumber7+](#call.isEmergencyPhoneNumber-callback1) +- [call.isEmergencyPhoneNumber7+](#call.isEmergencyPhoneNumber-callback2) +- [call.isEmergencyPhoneNumber7+](#call.isEmergencyPhoneNumber-promise) +- [call.formatPhoneNumber7+](#call.formatPhoneNumber-callback1) +- [call.formatPhoneNumber7+](#call.formatPhoneNumber-callback2) +- [call.formatPhoneNumber7+](#call.formatPhoneNumber-promise) +- [call.formatPhoneNumberToE1647+](#call.formatPhoneNumberToE164-callback) +- [call.formatPhoneNumberToE1647+](#call.formatPhoneNumberToE164-promise) +- [DialOptions](#DialOptions) +- [CallState](#CallState) +- [EmergencyNumberOptions7+](#EmergencyNumberOptions) +- [NumberFormatOptions7+](#NumberFormatOptions) >**说明：** > ->标记7+的表示从API Version 7开始支持，未标记的表示从API Version 6开始支持。 +>- 从 API Version 6 开始支持。 +> +>- 标记7+的接口从API Version 7开始支持。 -## 导入模块 +## 导入模块 ``` import call from '@ohos.telephony.call'; ``` -## call.dial +## call.dial dial\(phoneNumber: string, callback: AsyncCallback\): void @@ -40,41 +42,13 @@ dial\(phoneNumber: string, callback: AsyncCallback\): void 需要权限：ohos.permission.PLACE\_CALL权限，该权限为系统权限。 -- 参数 - - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

phoneNumber

-

string

-

是

-

电话号码。

-

callback

-

AsyncCallback<boolean>

-

是

-

回调函数：

-
  • true：成功。
  • false：失败。
-
- +- 参数 + + | 参数 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | phoneNumber | string | 是 |电话号码。| + | callback |AsyncCallback<boolean>|是|回调函数：
- true：成功。
- false：失败。| + - 示例 ``` @@ -84,7 +58,7 @@ dial\(phoneNumber: string, callback: AsyncCallback\): void ``` -## call.dial +## call.dial dial\(phoneNumber: string, options: DialOptions, callback: AsyncCallback\): void @@ -92,49 +66,14 @@ dial\(phoneNumber: string, options: DialOptions, callback: AsyncCallback - - - - - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

phoneNumber

-

string

-

是

-

电话号码。

-

options

-

DialOptions

-

是

-

通话参数，参考DialOptions。

-

callback

-

AsyncCallback<boolean>

-

是

-

回调函数：

-
  • true：成功。
  • false：失败。
-
+- 参数 + + | 参数 | 类型 | 必填 | 说明 | + | ----------- | ---------------------------- | ---- | ------------------------------------------------- | + | phoneNumber | string | 是 | 电话号码。 | + | options | DialOptions | 是 | 通话参数，参考[DialOptions](#DialOptions)。 | + | callback | AsyncCallback<boolean> | 是 | 回调函数：
- true：成功。
- false：失败。 | + - 示例 @@ -147,7 +86,7 @@ dial\(phoneNumber: string, options: DialOptions, callback: AsyncCallback +## call.dial dial\(phoneNumber: string, options?: DialOptions\): Promise @@ -157,55 +96,16 @@ dial\(phoneNumber: string, options?: DialOptions\): Promise - 参数 - - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

phoneNumber

-

string

-

是

-

电话号码。

-

options

-

DialOptions

-

否

-

通话参数，参考DialOptions。

-
- -- 返回值 - - - - - - - - - - -

类型

-

说明

-

Promise<boolean>

-

以Promise形式返回拨打电话的结果。

-
+ | 参数 | 类型 | 必填 | 说明 | + | ----------- | ----------- | ---- | ------------------------------------------- | + | phoneNumber | string | 是 | 电话号码。 | + | options | DialOptions | 是 | 通话参数，参考[DialOptions](#DialOptions)。 | + +- 返回值 + + | 类型 | 说明 | + | ---------------------- | --------------------------------- | + | Promise<boolean> | 以Promise形式返回拨打电话的结果。 | - 示例 @@ -220,37 +120,17 @@ dial\(phoneNumber: string, options?: DialOptions\): Promise }); ``` -## call.hasCall +## call.hasCall hasCall\(callback: AsyncCallback\): void 判断是否存在通话，使用callback方式作为异步方法。 -- 参数 - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

callback

-

AsyncCallback<boolean>

-

是

-

回调函数：

-
  • true：当前存在通话。
  • false：当前不存在通话。
-
+- 参数 + + | 参数 | 类型 | 必填 | 说明 | + | -------- | ---------------------------- | ---- | ------------------------------------------------------------ | + | callback | AsyncCallback<boolean> | 是 | 回调函数：
- true：当前存在通话。
- false：当前不存在通话。 | - 示例 @@ -261,28 +141,17 @@ hasCall\(callback: AsyncCallback\): void ``` -## call.hasCall +## call.hasCall hasCall\(\): Promise 判断是否存在通话，使用Promise方式作为异步方法。 -- 返回值 - - - - - - - - - - -

类型

-

说明

-

Promise<boolean>

-

以Promise形式异步返回判断是否存在通话。

-
+- 返回值 + + | 类型 | 说明 | + | ---------------------- | --------------------------------------- | + | Promise<boolean> | 以Promise形式异步返回判断是否存在通话。 | - 示例 @@ -296,36 +165,17 @@ hasCall\(\): Promise ``` -## call.getCallState +## call.getCallState getCallState\(callback: AsyncCallback\): void 获取通话状态，使用callback方式作为异步方法。 -- 参数 - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

callback

-

AsyncCallback<CallState>

-

是

-

回调函数，异步返回获取到的通话状态。

-
+- 参数 + + | 参数 | 类型 | 必填 | 说明 | + | -------- | -------------------------------------------- | ---- | ------------------------------------ | + | callback | AsyncCallback<[CallState](#CallState)> | 是 | 回调函数：异步返回获取到的通话状态。 | - 示例 @@ -336,28 +186,17 @@ getCallState\(callback: AsyncCallback\): void ``` -## call.getCallState +## call.getCallState getCallState\(\): Promise 获取通话状态，使用Promise方式作为异步方法。 -- 返回值 - - - - - - - - - - -

类型

-

说明

-

Promise<CallState>

-

以Promise形式异步返回获取通话状态的结果。

-
+- 返回值 + + | 类型 | 说明 | + | -------------------------------------- | ----------------------------------------- | + | Promise<[CallState](#CallState)> | 以Promise形式异步返回获取通话状态的结果。 | - 示例 @@ -370,46 +209,18 @@ getCallState\(\): Promise }); ``` -## call.isEmergencyPhoneNumber7+ +## call.isEmergencyPhoneNumber7+ isEmergencyPhoneNumber\(phoneNumber: string, callback: AsyncCallback\): void 判断是否是紧急电话号码，使用callback方式作为异步方法。 -- 参数 - - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

phoneNumber

-

string

-

是

-

电话号码。

-

callback

-

AsyncCallback<boolean>

-

是

-

回调函数，返回判断是否是紧急电话号码的结果：

-
  • true：是紧急电话号码。
  • false：不是紧急电话号码。
-
+- 参数 + + | 参数 | 类型 | 必填 | 说明 | + | ----------- | ---------------------------- | ---- | ------------------------------------------------------------ | + | phoneNumber | string | 是 | 电话号码。 | + | callback | AsyncCallback<boolean> | 是 | 回调函数，返回判断是否是紧急电话号码的结果：
- true：是紧急电话号码。
- false：不是紧急电话号码。 | - 示例 @@ -420,7 +231,7 @@ isEmergencyPhoneNumber\(phoneNumber: string, callback: AsyncCallback\) ``` -## call.isEmergencyPhoneNumber7+ +## call.isEmergencyPhoneNumber7+ isEmergencyPhoneNumber\(phoneNumber: string, options: EmergencyNumberOptions, callback: AsyncCallback\): void @@ -428,48 +239,11 @@ isEmergencyPhoneNumber\(phoneNumber: string, options: EmergencyNumberOptions, ca - 参数 - - - - - - - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

phoneNumber

-

string

-

是

-

电话号码。

-

options

-

EmergencyNumberOptions

-

是

-

手机参数，参考EmergencyNumberOptions。

-

callback

-

AsyncCallback<boolean>

-

是

-

回调函数，返回判断是否是紧急电话号码的结果：

-
  • true：是紧急电话号码。
  • false：不是紧急电话号码。
-
+ | 参数 | 类型 | 必填 | 说明 | + | ----------- | ---------------------------- | ---- | ------------------------------------------------------------ | + | phoneNumber | string | 是 | 电话号码。 | + | options | EmergencyNumberOptions | 是 | 手机参数，参考[EmergencyNumberOptions](#EmergencyNumberOptions)。 | + | callback | AsyncCallback<boolean> | 是 | 回调函数，返回判断是否是紧急电话号码的结果：
- true：是紧急电话号码。
- false：不是紧急电话号码。 | - 示例 @@ -480,7 +254,7 @@ isEmergencyPhoneNumber\(phoneNumber: string, options: EmergencyNumberOptions, ca ``` -## call.isEmergencyPhoneNumber7+ +## call.isEmergencyPhoneNumber7+ isEmergencyPhoneNumber\(phoneNumber: string, options?: EmergencyNumberOptions\): Promise @@ -488,56 +262,16 @@ isEmergencyPhoneNumber\(phoneNumber: string, options?: EmergencyNumberOptions\): - 参数 - - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

phoneNumber

-

string

-

是

-

电话号码。

-

options

-

EmergencyNumberOptions

-

否

-

手机参数，参考EmergencyNumberOptions。

-
+ | 参数 | 类型 | 必填 | 说明 | + | ----------- | ---------------------- | ---- | ------------------------------------------------------------ | + | phoneNumber | string | 是 | 电话号码。 | + | options | EmergencyNumberOptions | 是 | 手机参数，参考[EmergencyNumberOptions](#EmergencyNumberOptions)。 | - 返回值 - - - - - - - - - - -

类型

-

说明

-

Promise<boolean>

-

以Promise形式异步返回判断是否是紧急电话号码的结果。

-
+ | 类型 | 说明 | + | ---------------------- | --------------------------------------------------- | + | Promise<boolean> | 以Promise形式异步返回判断是否是紧急电话号码的结果。 | - 示例 @@ -550,45 +284,18 @@ isEmergencyPhoneNumber\(phoneNumber: string, options?: EmergencyNumberOptions\): }); ``` -## call.formatPhoneNumber7+ +## call.formatPhoneNumber7+ formatPhoneNumber\(phoneNumber: string, callback: AsyncCallback\): void 格式化电话号码，使用callback方式作为异步方法。 -- 参数 - - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

phoneNumber

-

string

-

是

-

电话号码。

-

callback

-

AsyncCallback<string>

-

是

-

回调函数，返回格式化电话号码的结果。

-
+- 参数 + + | 参数 | 类型 | 必填 | 说明 | + | ----------- | --------------------------- | ---- | ------------------------------------ | + | phoneNumber | string | 是 | 电话号码。 | + | callback | AsyncCallback<string> | 是 | 回调函数，返回格式化电话号码的结果。 | - 示例 @@ -599,54 +306,19 @@ formatPhoneNumber\(phoneNumber: string, callback: AsyncCallback\): void ``` -## call.formatPhoneNumber7+ +## call.formatPhoneNumber7+ formatPhoneNumber\(phoneNumber: string, options: NumberFormatOptions, callback: AsyncCallback\): void 格式化电话号码，可设置格式化参数，使用callback方式作为异步方法。 -- 参数 - - - - - - - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

phoneNumber

-

string

-

是

-

电话号码。

-

options

-

NumberFormatOptions

-

是

-

格式化参数，参考NumberFormatOptions。

-

callback

-

AsyncCallback<string>

-

是

-

回调函数，返回格式化电话号码的结果。

-
+- 参数 + + | 参数 | 类型 | 必填 | 说明 | + | ----------- | --------------------------- | ---- | ------------------------------------------------------------ | + | phoneNumber | string | 是 | 电话号码。 | + | options | NumberFormatOptions | 是 | 格式化参数，参考[NumberFormatOptions](#NumberFormatOptions)。 | + | callback | AsyncCallback<string> | 是 | 回调函数，返回格式化电话号码的结果。 | - 示例 @@ -659,62 +331,24 @@ formatPhoneNumber\(phoneNumber: string, options: NumberFormatOptions, callback: ``` -## call.formatPhoneNumber7+ +## call.formatPhoneNumber7+ formatPhoneNumber\(phoneNumber: string, options?: NumberFormatOptions\): Promise 格式化电话号码，可设置格式化参数，使用promise方式作为异步方法。 -- 参数 - - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

phoneNumber

-

string

-

是

-

电话号码。

-

options

-

NumberFormatOptions

-

否

-

格式化参数，参考NumberFormatOptions。

-
- -- 返回值 - - - - - - - - - - -

类型

-

说明

-

Promise<string>

-

以Promise形式异步返回格式化电话号码的结果。

-
+- 参数 + + | 参数 | 类型 | 必填 | 说明 | + | ----------- | ------------------- | ---- | ------------------------------------------------------------ | + | phoneNumber | string | 是 | 电话号码。 | + | options | NumberFormatOptions | 是 | 格式化参数，参考[NumberFormatOptions](#NumberFormatOptions)。 | + +- 返回值 + + | 类型 | 说明 | + | --------------------- | ------------------------------------------- | + | Promise<string> | 以Promise形式异步返回格式化电话号码的结果。 | - 示例 @@ -729,7 +363,7 @@ formatPhoneNumber\(phoneNumber: string, options?: NumberFormatOptions\): Promise }); ``` -## call.formatPhoneNumberToE1647+ +## call.formatPhoneNumberToE1647+ formatPhoneNumberToE164\(phoneNumber: string, countryCode: string, callback: AsyncCallback\): void @@ -739,48 +373,13 @@ formatPhoneNumberToE164\(phoneNumber: string, countryCode: string, callback: Asy 支持所有国家码。 -- 参数 - - - - - - - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

phoneNumber

-

string

-

是

-

电话号码。

-

countryCode

-

string

-

是

-

国家码，支持所有国家码，如：中国（CN）。

-

callback

-

AsyncCallback<string>

-

是

-

回调函数，返回将电话号码格式化为E.164表示形式的结果。

-
+- 参数 + + | 参数 | 类型 | 必填 | 说明 | + | ----------- | --------------------------- | ---- | ----------------------------------------------------- | + | phoneNumber | string | 是 | 电话号码。 | + | countryCode | string | 是 | 国家码，支持所有国家码，如：中国（CN）。 | + | callback | AsyncCallback<string> | 是 | 回调函数，返回将电话号码格式化为E.164表示形式的结果。 | - 示例 @@ -793,7 +392,7 @@ formatPhoneNumberToE164\(phoneNumber: string, countryCode: string, callback: Asy ``` -## call.formatPhoneNumberToE1647+ +## call.formatPhoneNumberToE1647+ formatPhoneNumberToE164\(phoneNumber: string, countryCode: string\): Promise @@ -803,56 +402,18 @@ formatPhoneNumberToE164\(phoneNumber: string, countryCode: string\): Promise - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

phoneNumber

-

string

-

是

-

电话号码。

-

countryCode

-

string

-

是

-

国家码，如：中国（CN）。

-
- -- 返回值 - - - - - - - - - - -

类型

-

说明

-

Promise<string>

-

以Promise形式异步返回将电话号码格式化为E.164表示形式的结果。

-
+- 参数 + + | 参数 | 类型 | 必填 | 说明 | + | ----------- | ------ | ---- | ---------------------------------------- | + | phoneNumber | string | 是 | 电话号码。 | + | countryCode | string | 是 | 国家码，支持所有国家码，如：中国（CN）。 | + +- 返回值 + + | 类型 | 说明 | + | --------------------- | ------------------------------------------------------------ | + | Promise<string> | 以Promise形式异步返回将电话号码格式化为E.164表示形式的结果。 | - 示例 @@ -867,130 +428,33 @@ formatPhoneNumberToE164\(phoneNumber: string, countryCode: string\): Promise +## DialOptions 拨打电话的可选参数。 +| 参数 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| extras | boolean | 否 |根据extras的值判断是否为视频通话，默认为语音通话。
- true：视频通话。
- fasle：语音通话。| - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

extras

-

boolean

-

否

-

根据extras的值判断是否为视频通话，默认为语音通话。

-
  • true：视频通话。
  • fasle：语音通话。
-
- -## CallState +## CallState 通话状态码。 +| 变量 | 值 | 说明 | +| -------- | -------- | -------- | +| CALL_STATE_UNKNOWN | -1 | 无效状态，当获取呼叫状态失败时返回。 | +| CALL_STATE_IDLE | 0 | 表示没有正在进行的呼叫。 | +| CALL_STATE_RINGING | 1 | 表示来电正在振铃或等待。 | +| CALL_STATE_OFFHOOK | 2 | 表示至少有一个呼叫处于拨号、通话中或呼叫保持状态，并且没有新的来电振铃或等待。 | - - - - - - - - - - - - - - - - - - - - - - - - -

变量

-

值

-

说明

-

CALL_STATE_UNKNOWN

-

-1

-

无效状态，当获取呼叫状态失败时返回。

-

CALL_STATE_IDLE

-

0

-

表示没有正在进行的呼叫。

-

CALL_STATE_RINGING

-

1

-

表示来电正在振铃或等待。

-

CALL_STATE_OFFHOOK

-

2

-

表示至少有一个呼叫处于拨号、通话中或呼叫保持状态，并且没有新的来电振铃或等待。

-
- -## EmergencyNumberOptions7+ +## EmergencyNumberOptions7+ 判断是否是紧急电话号码的可选参数。 +| 参数 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| slotId | number | 否 |卡槽ID：
- 0：卡槽1。
- 1：卡槽2。| - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

slotId

-

number

-

否

-

卡槽ID：

-
  • 0：卡槽1。
  • 1：卡槽2。
-
- -## NumberFormatOptions7+ +## NumberFormatOptions7+ 格式化号码的可选参数。 - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

countryCode

-

string

-

否

-

国家码，支持所有国家的国家码，如：中国（CN），默认为：CN。

-
\ No newline at end of file +| 参数 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| countryCode | string | 否 |国家码，支持所有国家的国家码，如：中国（CN）。默认为：CN。| diff --git a/zh-cn/application-dev/js-reference/apis/js-apis-fileio.md b/zh-cn/application-dev/js-reference/apis/js-apis-fileio.md index 67a01b0732b021ddc536964fb04ca5f3e73fbc77..ca0d2cae4deff1bf532f5d91b2d8569820c85218 100644 --- a/zh-cn/application-dev/js-reference/apis/js-apis-fileio.md +++ b/zh-cn/application-dev/js-reference/apis/js-apis-fileio.md @@ -57,7 +57,9 @@ >![](../../public_sys-resources/icon-note.gif) **说明：** ->从 API Version 6 开始支持。 +> +>- 从 API Version 6 开始支持。 +>- 标记7+的接口从API Version 7开始支持。 ## 导入模块 @@ -72,35 +74,8 @@ import fileio from '@ohos.fileio'; ## 使用说明 使用该功能模块对文件/目录进行操作前，需要先获取其绝对路径。 - - - - - - - - - - - - - - - - -

目录类型

-

说明

-

相关接口

-

内部存储的缓存目录

-

可读写，随时可能清除，不保证持久性。一般用作下载临时目录或缓存目录。

-

getCacheDir

-

内部存储目录

-

随应用卸载删除。

-

getFilesDir

-
- -“文件/目录绝对路径”=“应用目录路径”+“文件/目录名” - +“文件/目录绝对路径”=“应用目录路径”+“文件/目录名”。 +应用目录路径可通过[Context模块的接口getOrCreateLocalDir](js-apis-Context.md)获取。 通过上述接口获取到应用目录路径dir，文件名为“xxx.txt”，文件所在绝对路径为： ``` @@ -2129,4 +2104,3 @@ isSymbolicLink\(\): boolean let isSymbolicLink = dir.readSync().isSymbolicLink(); ``` - diff --git a/zh-cn/application-dev/js-reference/apis/js-apis-radio.md b/zh-cn/application-dev/js-reference/apis/js-apis-radio.md index c60062d5acc3eddfa36a6df2adc995447aaef028..2136539f9fe2e140accb65769d75c6255e787ae0 100644 --- a/zh-cn/application-dev/js-reference/apis/js-apis-radio.md +++ b/zh-cn/application-dev/js-reference/apis/js-apis-radio.md @@ -1,39 +1,40 @@ -# 网络搜索 - -- [导入模块](#s56d19203690d4782bfc74069abb6bd71) -- [radio.getRadioTech](#section18401172810207) -- [radio.getRadioTech](#section686385662419) -- [radio.getNetworkState](#section2090641619263) -- [radio.getNetworkState](#section392520433402) -- [radio.getNetworkState](#section20661545182918) -- [radio.getNetworkSelectionMode](#section79561056114711) -- [radio.getNetworkSelectionMode](#section553074612507) -- [radio.getISOCountryCodeForNetwork7+](#section16183194320525) -- [radio.getISOCountryCodeForNetwork7+](#section56144132559) -- [radio.getSignalInformation](#section1153532721018) -- [radio.getSignalInformation](#section1859512161511) -- [radio.isRadioOn7+](#section5456161711228) -- [radio.isRadioOn7+](#section178817520243) -- [RadioTechnology](#section1072135204020) -- [SignalInformation](#section10701756164212) -- [NetworkType](#section519718112466) -- [NetworkState](#section1691213911470) -- [RegState](#section18174131911514) -- [NsaState](#section448018155317) -- [NetworkSelectionMode](#section14219361268) +# 网络搜索 + +- [导入模块](#导入模块) +- [radio.getRadioTech](#radio.getRadioTech-callback) +- [radio.getRadioTech](#radio.getRadioTech-promise) +- [radio.getNetworkState](#radio.getNetworkState-callback1) +- [radio.getNetworkState](#radio.getNetworkState-callback2) +- [radio.getNetworkState](#radio.getNetworkState-promise) +- [radio.getNetworkSelectionMode](#radio.getNetworkSelectionMode-callback) +- [radio.getNetworkSelectionMode](#radio.getNetworkSelectionMode-promise) +- [radio.getISOCountryCodeForNetwork7+](#radio.getISOCountryCodeForNetwork-callback) +- [radio.getISOCountryCodeForNetwork7+](#radio.getISOCountryCodeForNetwork-promise) +- [radio.getSignalInformation](#radio.getSignalInformation-callback) +- [radio.getSignalInformation](#radio.getSignalInformation-promise) +- [radio.isRadioOn7+](#radio.isRadioOn-callback) +- [radio.isRadioOn7+](#radio.isRadioOn-promise) +- [RadioTechnology](#RadioTechnology) +- [SignalInformation](#SignalInformation) +- [NetworkType](#NetworkType) +- [NetworkState](#NetworkState) +- [RegState](#RegState) +- [NsaState](#NsaState) +- [NetworkSelectionMode](#NetworkSelectionMode) >**说明：** > ->标记7+的表示从API Version 7开始支持，未标记的表示从API Version 6开始支持。 +>- 从 API Version 6 开始支持。 +>- 标记7+的接口从API Version 7开始支持。 -## 导入模块 +## 导入模块 ``` import radio from '@ohos.telephony.radio' ``` -## radio.getRadioTech +## radio.getRadioTech getRadioTech\(slotId: number, callback: AsyncCallback<\{psRadioTech: RadioTechnology, csRadioTech: RadioTechnology\}\>\): void @@ -41,41 +42,12 @@ getRadioTech\(slotId: number, callback: AsyncCallback<\{psRadioTech: RadioTechno 需要ohos.permission.GET\_NETWORK\_INFO权限。 -- 参数 - - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

slotId

-

number

-

是

-

卡槽ID。

-

0：卡槽1

-

1：卡槽2

-

callback

-

AsyncCallback<{psRadioTech: RadioTechnology, csRadioTech: RadioTechnology}>

-

是

-

回调函数。

-
+- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | ------------------------------------------------------------ | ---- | -------------------------------------- | + | slotId | number | 是 | 卡槽ID。
- 0：卡槽1
- 1：卡槽2 | + | callback | AsyncCallback\<{psRadioTech: [RadioTechnology](#RadioTechnology), csRadioTech:[RadioTechnology](#RadioTechnology)}\> | 是 | 回调函数。 | - 示例 @@ -87,7 +59,7 @@ getRadioTech\(slotId: number, callback: AsyncCallback<\{psRadioTech: RadioTechno ``` -## radio.getRadioTech +## radio.getRadioTech getRadioTech\(slotId: number\): Promise<\{psRadioTech: RadioTechnology, csRadioTech: RadioTechnology\}\> @@ -95,49 +67,17 @@ getRadioTech\(slotId: number\): Promise<\{psRadioTech: RadioTechnology, csRadioT 需要ohos.permission.GET\_NETWORK\_INFO权限。 -- 参数 - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

slotId

-

number

-

是

-

卡槽ID。

-

0：卡槽1

-

1：卡槽2

-
- -- 返回值 - - - - - - - - - - -

类型

-

说明

-

Promise<{psRadioTech: RadioTechnology, csRadioTech: RadioTechnology}>

-

以Promise形式返回获取当前接入的CS域和PS域技术。

-
+- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | ------ | ------ | ---- | -------------------------------------- | + | slotId | number | 是 | 卡槽ID。
- 0：卡槽1
- 1：卡槽2 | + +- 返回值 + + | 类型 | 说明 | + | ------------------------------------------------------------ | ----------------------------------------------- | + | Promise<{psRadioTech: [RadioTechnology](#RadioTechnology), csRadioTech: [RadioTechnology](#RadioTechnology)}> | 以Promise形式返回获取当前接入的CS域和PS域技术。 | - 示例 @@ -152,7 +92,7 @@ getRadioTech\(slotId: number\): Promise<\{psRadioTech: RadioTechnology, csRadioT ``` -## radio.getNetworkState +## radio.getNetworkState getNetworkState\(callback: AsyncCallback\): void @@ -160,30 +100,11 @@ getNetworkState\(callback: AsyncCallback\): void 需要ohos.permission.GET\_NETWORK\_INFO权限。 -- 参数 - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

callback

-

AsyncCallback<NetworkState>

-

是

-

回调函数。

-
+- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | ---------------------------------------------- | ---- | ---------- | + | callback | AsyncCallback\<[NetworkState](#NetworkState)\> | 是 | 回调函数。 | - 示例 @@ -194,7 +115,7 @@ getNetworkState\(callback: AsyncCallback\): void ``` -## radio.getNetworkState +## radio.getNetworkState getNetworkState\(slotId: number, callback: AsyncCallback\): void @@ -202,41 +123,12 @@ getNetworkState\(slotId: number, callback: AsyncCallback\): void 需要ohos.permission.GET\_NETWORK\_INFO权限。 -- 参数 - - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

slotId

-

number

-

是

-

卡槽ID。

-

0：卡槽1

-

1：卡槽2

-

callback

-

AsyncCallback<NetworkState>

-

是

-

回调函数。

-
+- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | ---------------------------------------------- | ---- | -------------------------------------- | + | slotId | number | 是 | 卡槽ID。
- 0：卡槽1
- 1：卡槽2 | + | callback | AsyncCallback\<[NetworkState](#NetworkState)\> | 是 | 回调函数。 | - 示例 @@ -248,7 +140,7 @@ getNetworkState\(slotId: number, callback: AsyncCallback\): void ``` -## radio.getNetworkState +## radio.getNetworkState getNetworkState\(slotId?: number\): Promise @@ -256,49 +148,17 @@ getNetworkState\(slotId?: number\): Promise 需要ohos.permission.GET\_NETWORK\_INFO权限。 -- 参数 - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

slotId

-

number

-

否

-

卡槽ID。

-

0：卡槽1

-

1：卡槽2

-
- -- 返回值 - - - - - - - - - - -

类型

-

说明

-

Promise<NetworkState>

-

以Promise形式返回网络状态。

-
+- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | ------ | ------ | ---- | -------------------------------------- | + | slotId | number | 否 | 卡槽ID。
- 0：卡槽1
- 1：卡槽2 | + +- 返回值 + + | 类型 | 说明 | + | ---------------------------------------- | --------------------------- | + | Promise\<[NetworkState](#NetworkState)\> | 以Promise形式返回网络状态。 | - 示例 @@ -313,47 +173,18 @@ getNetworkState\(slotId?: number\): Promise ``` -## radio.getNetworkSelectionMode +## radio.getNetworkSelectionMode getNetworkSelectionMode\(slotId: number, callback: AsyncCallback\): void 获取当前选网模式，使用callback方式作为异步方法。 -- 参数 - - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

slotId

-

number

-

是

-

卡槽ID。

-

0：卡槽1

-

1：卡槽2

-

callback

-

AsyncCallback<NetworkSelectionMode>

-

是

-

回调函数。

-
+- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | ------------------------------------------------------------ | ---- | -------------------------------------- | + | slotId | number | 是 | 卡槽ID。
- 0：卡槽1
- 1：卡槽2 | + | callback | AsyncCallback\<[NetworkSelectionMode](#NetworkSelectionMode)\> | 是 | 回调函数。 | - 示例 @@ -365,55 +196,23 @@ getNetworkSelectionMode\(slotId: number, callback: AsyncCallback +## radio.getNetworkSelectionMode getNetworkSelectionMode\(slotId: number\): Promise 获取当前选网模式，使用Promise方式作为异步方法。 -- 参数 - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

slotId

-

number

-

是

-

卡槽ID。

-

0：卡槽1

-

1：卡槽2

-
- -- 返回值 - - - - - - - - - - -

类型

-

说明

-

Promise<NetworkSelectionMode>

-

以Promise形式返回当前选网模式。

-
+- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | ------ | ------ | ---- | -------------------------------------- | + | slotId | number | 是 | 卡槽ID。
- 0：卡槽1
- 1：卡槽2 | + +- 返回值 + + | 类型 | 说明 | + | -------------------------------------------------------- | ------------------------------- | + | Promise\<[NetworkSelectionMode](#NetworkSelectionMode)\> | 以Promise形式返回当前选网模式。 | - 示例 @@ -428,47 +227,18 @@ getNetworkSelectionMode\(slotId: number\): Promise ``` -## radio.getISOCountryCodeForNetwork7+ +## radio.getISOCountryCodeForNetwork7+ getISOCountryCodeForNetwork\(slotId: number, callback: AsyncCallback\): void 获取注册网络所在国家的ISO国家码，使用callback方式作为异步方法。 -- 参数 - - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

slotId

-

number

-

是

-

卡槽ID。

-

0：卡槽1

-

1：卡槽2

-

callback

-

AsyncCallback<string>

-

是

-

回调函数。返回国家码，例如：CN（中国）。

-
+- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | ----------------------- | ---- | ---------------------------------------- | + | slotId | number | 是 | 卡槽ID。
- 0：卡槽1
- 1：卡槽2 | + | callback | AsyncCallback\ | 是 | 回调函数。返回国家码，例如：CN（中国）。 | - 示例 @@ -480,55 +250,23 @@ getISOCountryCodeForNetwork\(slotId: number, callback: AsyncCallback\): ``` -## radio.getISOCountryCodeForNetwork7+ +## radio.getISOCountryCodeForNetwork7+ getISOCountryCodeForNetwork\(slotId: number\): Promise 获取注册网络所在国家的ISO国家码，使用Promise方式作为异步方法。 -- 参数 - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

slotId

-

number

-

是

-

卡槽ID。

-

0：卡槽1

-

1：卡槽2

-
- -- 返回值 - - - - - - - - - - -

类型

-

说明

-

Promise<string>

-

以Promise形式返回注册网络所在国家的ISO国家码，例如CN（中国）。

-
+- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | ------ | ------ | ---- | -------------------------------------- | + | slotId | number | 是 | 卡槽ID。
- 0：卡槽1
- 1：卡槽2 | + +- 返回值 + + | 类型 | 说明 | + | ----------------- | ------------------------------------------------------------ | + | Promise\ | 以Promise形式返回注册网络所在国家的ISO国家码，例如CN（中国）。 | - 示例 @@ -543,47 +281,18 @@ getISOCountryCodeForNetwork\(slotId: number\): Promise ``` -## radio.getSignalInformation +## radio.getSignalInformation getSignalInformation\(slotId: number, callback: AsyncCallback\>\): void 获取指定SIM卡槽对应的注册网络信号强度信息列表，使用callback方式作为异步方法。 -- 参数 - - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

slotId

-

number

-

是

-

卡槽ID。

-

0：卡槽1

-

1：卡槽2

-

callback

-

AsyncCallback<Array<SignalInformation>>

-

是

-

回调函数，返回SignalInformation对象的数组。

-
+- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | + | slotId | number | 是 | 卡槽ID。
- 0：卡槽1
- 1：卡槽2 | + | callback | AsyncCallback\\> | 是 | 回调函数，返回[SignalInformation](#SignalInformation)对象的数组。 | - 示例 @@ -595,55 +304,23 @@ getSignalInformation\(slotId: number, callback: AsyncCallback +## radio.getSignalInformation getSignalInformation\(slotId: number\): Promise\> 获取指定SIM卡槽对应的注册网络信号强度信息列表，使用Promise方式作为异步方法。 -- 参数 - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

slotId

-

number

-

是

-

卡槽ID。

-

0：卡槽1

-

1：卡槽2

-
- -- 返回值 - - - - - - - - - - -

类型

-

说明

-

Promise<Array<SignalInformation>>

-

以Promise形式返回网络信号强度SignalInformation对象的数组。

-
+- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | ------ | ------ | ---- | -------------------------------------- | + | slotId | number | 是 | 卡槽ID。
- 0：卡槽1
- 1：卡槽2 | + +- 返回值 + + | 类型 | 说明 | + | ----------------------------------------------------------- | ------------------------------------------------------------ | + | Promise\\> | 以Promise形式返回网络信号强度[SignalInformation](#SignalInformation)对象的数组。 | - 示例 @@ -658,7 +335,7 @@ getSignalInformation\(slotId: number\): Promise\> ``` -## radio.isRadioOn7+ +## radio.isRadioOn7+ isRadioOn\(callback: AsyncCallback\): void @@ -666,32 +343,11 @@ isRadioOn\(callback: AsyncCallback\): void 需要ohos.permission.GET\_NETWORK\_INFO权限。 -- 参数 - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

callback

-

AsyncCallback<boolean>

-

是

-

回调函数。

-

true：Radio打开

-

false：Radio关闭

-
+- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | ------------------------ | ---- | ------------------------------------------------------- | + | callback | AsyncCallback\ | 是 | 回调函数。
- true：Radio打开
- false：Radio关闭 | - 示例 @@ -702,7 +358,7 @@ isRadioOn\(callback: AsyncCallback\): void ``` -## radio.isRadioOn7+ +## radio.isRadioOn7+ isRadioOn\(\): Promise @@ -710,24 +366,11 @@ isRadioOn\(\): Promise 需要ohos.permission.GET\_NETWORK\_INFO权限。 -- 返回值 - - - - - - - - - - -

类型

-

说明

-

Promise<boolean>

-

以Promise形式返回判断Radio是否打开的结果。

-

true：Radio打开

-

false：Radio关闭

-
+- 返回值 + + | 类型 | 说明 | + | ------------------ | ------------------------------------------------------------ | + | Promise\ | 以Promise形式返回判断Radio是否打开的结果。
- true：Radio打开
- false：Radio关闭 | - 示例 @@ -741,419 +384,99 @@ isRadioOn\(\): Promise ``` -## RadioTechnology +## RadioTechnology 无线接入技术。 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

变量

-

值

-

说明

-

RADIO_TECHNOLOGY_UNKNOWN

-

0

-

未知无线接入技术（RAT）。

-

RADIO_TECHNOLOGY_GSM

-

1

-

无线接入技术GSM（Global System For Mobile Communication）。

-

RADIO_TECHNOLOGY_1XRTT

-

2

-

无线接入技术1XRTT（Single-Carrier Radio Transmission Technology）。

-

RADIO_TECHNOLOGY_WCDMA

-

3

-

无线接入技术WCDMA（Wideband Code Division Multiple Access）。

-

RADIO_TECHNOLOGY_HSPA

-

4

-

无线接入技术HSPA（High Speed Packet Access）。

-

RADIO_TECHNOLOGY_HSPAP

-

5

-

无线接入技术HSPAP（High Speed packet access (HSPA+) ）。

-

RADIO_TECHNOLOGY_TD_SCDMA

-

6

-

无线接入技术TDSCDMA（TimeDivision-Synchronous Code Division Multiple Access）。

-

RADIO_TECHNOLOGY_EVDO

-

7

-

无线接入技术EVDO（Evolution、Data Only）。

-

RADIO_TECHNOLOGY_EHRPD

-

8

-

无线接入技术EHRPD（Evolved High Rate Package Data）。

-

RADIO_TECHNOLOGY_LTE

-

9

-

无线接入技术LTE（Long Term Evolution）。

-

RADIO_TECHNOLOGY_LTE_CA

-

10

-

无线接入技术LTE_CA（Long Term Evolution_Carrier Aggregation）。

-

RADIO_TECHNOLOGY_IWLAN

-

11

-

无线接入技术IWLAN（Industrial Wireless LAN）。

-

RADIO_TECHNOLOGY_NR

-

12

-

无线接入技术NR（New Radio）。

-
- -## SignalInformation +| 变量 | 值 | 说明 | +| ------------------------- | ---- | ------------------------------------------------------------ | +| RADIO_TECHNOLOGY_UNKNOWN | 0 | 未知无线接入技术（RAT）。 | +| RADIO_TECHNOLOGY_GSM | 1 | 无线接入技术GSM（Global System For Mobile Communication）。 | +| RADIO_TECHNOLOGY_1XRTT | 2 | 无线接入技术1XRTT（Single-Carrier Radio Transmission Technology）。 | +| RADIO_TECHNOLOGY_WCDMA | 3 | 无线接入技术WCDMA（Wideband Code Division Multiple Access）。 | +| RADIO_TECHNOLOGY_HSPA | 4 | 无线接入技术HSPA（High Speed Packet Access）。 | +| RADIO_TECHNOLOGY_HSPAP | 5 | 无线接入技术HSPAP（High Speed packet access (HSPA+) ）。 | +| RADIO_TECHNOLOGY_TD_SCDMA | 6 | 无线接入技术TDSCDMA（TimeDivision-Synchronous Code Division Multiple Access）。 | +| RADIO_TECHNOLOGY_EVDO | 7 | 无线接入技术EVDO（Evolution、Data Only）。 | +| RADIO_TECHNOLOGY_EHRPD | 8 | 无线接入技术EHRPD（Evolved High Rate Package Data）。 | +| RADIO_TECHNOLOGY_LTE | 9 | 无线接入技术LTE（Long Term Evolution）。 | +| RADIO_TECHNOLOGY_LTE_CA | 10 | 无线接入技术LTE_CA（Long Term Evolution_Carrier Aggregation）。 | +| RADIO_TECHNOLOGY_IWLAN | 11 | 无线接入技术IWLAN（Industrial Wireless LAN）。 | +| RADIO_TECHNOLOGY_NR | 12 | 无线接入技术NR（New Radio）。 | + + +## SignalInformation 网络信号强度信息对象。 - - - - - - - - - - - - - - - -

属性名

-

类型

-

说明

-

signalType

-

NetworkType

-

网络信号强度类型。

-

signalLevel

-

number

-

网络信号强度等级。

-
- -## NetworkType +| 属性名 | 类型 | 说明 | +| ----------- | --------------------------- | ------------------ | +| signalType | [NetworkType](#NetworkType) | 网络信号强度类型。 | +| signalLevel | number | 网络信号强度等级。 | + + +## NetworkType 网络类型。 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

变量

-

值

-

说明

-

NETWORK_TYPE_UNKNOWN

-

0

-

未知网络类型。

-

NETWORK_TYPE_GSM

-

1

-

网络类型为GSM（Global System For Mobile Communication）。

-

NETWORK_TYPE_CDMA

-

2

-

网络类型为CDMA（Code Division Multiple Access）。

-

NETWORK_TYPE_WCDMA

-

3

-

网络类型为WCDMA（Wideband Code Division Multiple Access）。

-

NETWORK_TYPE_TDSCDMA

-

4

-

网络类型为TDSCDMA（TimeDivision-Synchronous Code Division Multiple Access）。

-

NETWORK_TYPE_LTE

-

5

-

网络类型为LTE（Long Term Evolution）。

-

NETWORK_TYPE_NR

-

6

-

网络类型为5G NR（New Radio）。

-
- - -## NetworkState +| 变量 | 值 | 说明 | +| -------------------- | ---- | ------------------------------------------------------------ | +| NETWORK_TYPE_UNKNOWN | 0 | 未知网络类型。 | +| NETWORK_TYPE_GSM | 1 | 网络类型为GSM（Global System For Mobile Communication）。 | +| NETWORK_TYPE_CDMA | 2 | 网络类型为CDMA（Code Division Multiple Access）。 | +| NETWORK_TYPE_WCDMA | 3 | 网络类型为WCDMA（Wideband Code Division Multiple Access）。 | +| NETWORK_TYPE_TDSCDMA | 4 | 网络类型为TDSCDMA（TimeDivision-Synchronous Code Division Multiple Access）。 | +| NETWORK_TYPE_LTE | 5 | 网络类型为LTE（Long Term Evolution）。 | +| NETWORK_TYPE_NR | 6 | 网络类型为5G NR（New Radio）。 | + +## NetworkState 网络注册状态。 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

变量

-

类型

-

说明

-

longOperatorName

-

string

-

注册网络的长运营商名称。

-

shortOperatorName

-

string

-

注册网络的短运营商名称。

-

plmnNumeric

-

string

-

注册网络的PLMN码。

-

isRoaming

-

boolean

-

是否处于漫游状态。

-

regState

-

RegState

-

设备的网络注册状态。

-

nsaState

-

NsaState

-

设备的NSA网络注册状态。

-

isCaActive

-

boolean

-

CA的状态。

-

isEmergency

-

boolean

-

此设备是否只允许拨打紧急呼叫。

-
- -## RegState +| 变量 | 类型 | 说明 | +| ----------------- | --------------------- | ------------------------------ | +| longOperatorName | string | 注册网络的长运营商名称。 | +| shortOperatorName | string | 注册网络的短运营商名称。 | +| plmnNumeric | string | 注册网络的PLMN码。 | +| isRoaming | boolean | 是否处于漫游状态。 | +| regState | [RegState](#RegState) | 设备的网络注册状态。 | +| nsaState | [NsaState](#NsaState) | 设备的NSA网络注册状态。 | +| isCaActive | boolean | CA的状态。 | +| isEmergency | boolean | 此设备是否只允许拨打紧急呼叫。 | + + +## RegState 网络注册状态。 - - - - - - - - - - - - - - - - - - - - - - - -

变量

-

值

-

说明

-

REG_STATE_NO_SERVICE

-

0

-

设备不能使用任何服务。

-

REG_STATE_IN_SERVICE

-

1

-

设备可以正常使用业务。

-

REG_STATE_EMERGENCY_CALL_ONLY

-

2

-

设备只能使用紧急呼叫业务。

-

REG_STATE_POWER_OFF

-

3

-

蜂窝无线电已关闭。

-
- -## NsaState +| 变量 | 值 | 说明 | +| ----------------------------- | ---- | -------------------------- | +| REG_STATE_NO_SERVICE | 0 | 设备不能使用任何服务。 | +| REG_STATE_IN_SERVICE | 1 | 设备可以正常使用业务。 | +| REG_STATE_EMERGENCY_CALL_ONLY | 2 | 设备只能使用紧急呼叫业务。 | +| REG_STATE_POWER_OFF | 3 | 蜂窝无线电已关闭。 | + + +## NsaState 非独立组网状态。 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

变量

-

值

-

说明

-

NSA_STATE_NOT_SUPPORT

-

1

-

设备在不支持NSA的LTE小区下处于空闲状态或连接状态。

-

NSA_STATE_NO_DETECT

-

2

-

在支持NSA但不支持NR覆盖检测的LTE小区下，设备处于空闲状态。

-

NSA_STATE_CONNECTED_DETECT

-

3

-

设备在LTE小区下连接到LTE网络支持NSA和NR覆盖检测。

-

NSA_STATE_IDLE_DETECT

-

4

-

支持NSA和NR覆盖检测的LTE小区下设备处于空闲状态。

-

NSA_STATE_DUAL_CONNECTED

-

5

-

设备在支持NSA的LTE小区下连接到LTE + NR网络。

-

NSA_STATE_SA_ATTACHED

-

6

-

设备在5GC附着时在NG-RAN小区下空闲或连接到NG-RAN小区。

-
- -## NetworkSelectionMode +| 变量 | 值 | 说明 | +| -------------------------- | ---- | ---------------------------------------------------------- | +| NSA_STATE_NOT_SUPPORT | 1 | 设备在不支持NSA的LTE小区下处于空闲状态或连接状态。 | +| NSA_STATE_NO_DETECT | 2 | 在支持NSA但不支持NR覆盖检测的LTE小区下，设备处于空闲状态。 | +| NSA_STATE_CONNECTED_DETECT | 3 | 设备在LTE小区下连接到LTE网络支持NSA和NR覆盖检测。 | +| NSA_STATE_IDLE_DETECT | 4 | 支持NSA和NR覆盖检测的LTE小区下设备处于空闲状态。 | +| NSA_STATE_DUAL_CONNECTED | 5 | 设备在支持NSA的LTE小区下连接到LTE + NR网络。 | +| NSA_STATE_SA_ATTACHED | 6 | 设备在5GC附着时在NG-RAN小区下空闲或连接到NG-RAN小区。 | + + +## NetworkSelectionMode 选网模式。 - - - - - - - - - - - - - - - - - - - - -

变量

-

值

-

说明

-

NETWORK_SELECTION_UNKNOWN

-

0

-

未知选网模式。

-

NETWORK_SELECTION_AUTOMATIC

-

1

-

自动选网模式。

-

NETWORK_SELECTION_MANUAL

-

2

-

手动选网模式。

-
\ No newline at end of file +| 变量 | 值 | 说明 | +| --------------------------- | ---- | -------------- | +| NETWORK_SELECTION_UNKNOWN | 0 | 未知选网模式。 | +| NETWORK_SELECTION_AUTOMATIC | 1 | 自动选网模式。 | +| NETWORK_SELECTION_MANUAL | 2 | 手动选网模式。 | \ No newline at end of file diff --git a/zh-cn/application-dev/js-reference/apis/js-apis-sim.md b/zh-cn/application-dev/js-reference/apis/js-apis-sim.md index 1daf3a6529e13551917c445a2e926eb552ab60cb..94b83aa123add20ccd0eee25ba59e1a219193ee1 100755 --- a/zh-cn/application-dev/js-reference/apis/js-apis-sim.md +++ b/zh-cn/application-dev/js-reference/apis/js-apis-sim.md @@ -1,33 +1,34 @@ -# SIM卡管理 - -- [导入模块](#s56d19203690d4782bfc74069abb6bd71) -- [sim.getSimIccId](#section18529027065) -- [sim.getSimIccId](#section9200164911401) -- [sim.getDefaultVoiceSlotId7+](#section3313193864611) -- [sim.getDefaultVoiceSlotId7+](#section19013665018) -- [sim.getISOCountryCodeForSim](#section1429719645712) -- [sim.getISOCountryCodeForSim](#section1087375135713) -- [sim.getSimOperatorNumeric](#section1245831911019) -- [sim.getSimOperatorNumeric](#section450711512119) -- [sim.getSimSpn](#section18826326532) -- [sim.getSimSpn](#section1862714201148) -- [sim.getSimState](#section19837481195) -- [sim.getSimState](#section1763675061914) -- [sim.getSimGid1](#section18536193963119) -- [sim.getSimGid1](#section14446155983211) -- [SimState](#section17389192625218) +# SIM卡管理 + +- [导入模块](#导入模块) +- [sim.getSimIccId](#sim.getSimIccId-callback) +- [sim.getSimIccId](#sim.getSimIccId-promise) +- [sim.getDefaultVoiceSlotId7+](#sim.getDefaultVoiceSlotId-callback) +- [sim.getDefaultVoiceSlotId7+](#sim.getDefaultVoiceSlotId-promise) +- [sim.getISOCountryCodeForSim](#sim.getISOCountryCodeForSim-callback) +- [sim.getISOCountryCodeForSim](#sim.getISOCountryCodeForSim-promise) +- [sim.getSimOperatorNumeric](#sim.getSimOperatorNumeric-callback) +- [sim.getSimOperatorNumeric](#sim.getSimOperatorNumeric-promise) +- [sim.getSimSpn](#sim.getSimSpn-callback) +- [sim.getSimSpn](#sim.getSimSpn-promise) +- [sim.getSimState](#sim.getSimState-callback) +- [sim.getSimState](#sim.getSimState-promise) +- [sim.getSimGid1](#sim.getSimGid1-callback) +- [sim.getSimGid1](#sim.getSimGid1-promise) +- [SimState](#SimState) >**说明：** > ->标记7+的表示从API Version 7开始支持，未标记的表示从API Version 6开始支持。 +>- 从 API Version 6 开始支持。 +>- 标记7+的接口从API Version 7开始支持。 -## 导入模块 +## 导入模块 ``` import sim from '@ohos.telephony.sim'; ``` -## sim.getSimIccId +## sim.getSimIccId getSimIccId\(slotId: number, callback: AsyncCallback\): void @@ -37,39 +38,10 @@ getSimIccId\(slotId: number, callback: AsyncCallback\): void - 参数 - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

slotId

-

number

-

是

-

卡槽ID。

-

0：卡槽1

-

1：卡槽2

-

callback

-

AsyncCallback<string>

-

是

-

回调函数。

-
+ | 参数名 | 类型 | 必填 | 说明 | + | -------- | --------------------------- | ---- | -------------------------------------- | + | slotId | number | 是 | 卡槽ID。
- 0：卡槽1
- 1：卡槽2 | + | callback | AsyncCallback<string> | 是 | 回调函数。 | - 示例 @@ -81,7 +53,7 @@ getSimIccId\(slotId: number, callback: AsyncCallback\): void ``` -## sim.getSimIccId +## sim.getSimIccId getSimIccId\(slotId: number\): Promise @@ -89,49 +61,17 @@ getSimIccId\(slotId: number\): Promise 需要ohos.permission.GET\_TELEPHONY\_STATE权限，该权限为系统权限。 -- 参数 +- 参数 - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

slotId

-

number

-

是

-

卡槽ID。

-

0：卡槽1

-

1：卡槽2

-
+ | 参数名 | 类型 | 必填 | 说明 | + | ------ | ------ | ---- | -------------------------------------- | + | slotId | number | 是 | 卡槽ID。
- 0：卡槽1
- 1：卡槽2 | - 返回值 - - - - - - - - - -

类型

-

说明

-

Promise<string>

-

以Promise形式返回指定卡槽的ICCID。

-
+ | 类型 | 说明 | + | --------------------- | ---------------------------------- | + | Promise<string> | 以Promise形式返回指定卡槽的ICCID。 | - 示例 @@ -144,36 +84,17 @@ getSimIccId\(slotId: number\): Promise }); ``` -## sim.getDefaultVoiceSlotId7+ +## sim.getDefaultVoiceSlotId7+ -getDefaultVoiceSlotId\(callback: AsyncCallback\): void7+ +getDefaultVoiceSlotId\(callback: AsyncCallback\): void 获取默认语音业务的卡槽ID，使用callback方式作为异步方法。 -- 参数 +- 参数 - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

callback

-

AsyncCallback<number>

-

是

-

回调函数。

-
+ | 参数名 | 类型 | 必填 | 说明 | + | -------- | --------------------------- | ---- | ---------- | + | callback | AsyncCallback<number> | 是 | 回调函数。 | - 示例 @@ -184,28 +105,17 @@ getDefaultVoiceSlotId\(callback: AsyncCallback\): void7+ ``` -## sim.getDefaultVoiceSlotId7+ +## sim.getDefaultVoiceSlotId7+ -getDefaultVoiceSlotId\(\): Promise7+ +getDefaultVoiceSlotId\(\): Promise 获取默认语音业务的卡槽ID，使用Promise方式作为异步方法。 -- 返回值 - - - - - - - - - - -

类型

-

说明

-

Promise<number>

-

以Promise形式返回默认语音业务的卡槽ID。

-
+- 返回值 + + | 类型 | 说明 | + | ----------------- | --------------------------------------- | + | Promise\ | 以Promise形式返回默认语音业务的卡槽ID。 | - 示例 @@ -218,47 +128,18 @@ getDefaultVoiceSlotId\(\): Promise7+ }); ``` -## sim.getISOCountryCodeForSim +## sim.getISOCountryCodeForSim getISOCountryCodeForSim\(slotId: number, callback: AsyncCallback\): void 获取指定卡槽SIM卡的ISO国家码，使用callback方式作为异步方法。 -- 参数 +- 参数 - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

slotId

-

number

-

是

-

卡槽ID。

-

0：卡槽1

-

1：卡槽2

-

callback

-

AsyncCallback<string>

-

是

-

回调函数。返回国家码，例如：CN（中国）。

-
+ | 参数名 | 类型 | 必填 | 说明 | + | -------- | ----------------------- | ---- | ---------------------------------------- | + | slotId | number | 是 | 卡槽ID。
- 0：卡槽1
- 1：卡槽2 | + | callback | AsyncCallback\ | 是 | 回调函数。返回国家码，例如：CN（中国）。 | - 示例 @@ -269,55 +150,23 @@ getISOCountryCodeForSim\(slotId: number, callback: AsyncCallback\): voi ``` -## sim.getISOCountryCodeForSim +## sim.getISOCountryCodeForSim getISOCountryCodeForSim\(slotId: number\): Promise 获取指定卡槽SIM卡的ISO国家码，使用Promise方式作为异步方法。 -- 参数 +- 参数 - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

slotId

-

number

-

是

-

卡槽ID。

-

0：卡槽1

-

1：卡槽2

-
- -- 返回值 - - - - - - - - - - -

类型

-

说明

-

Promise<string>

-

以Promise形式返回获取指定卡槽SIM卡的ISO国家码，例如：CN（中国）。

-
+ | 参数名 | 类型 | 必填 | 说明 | + | ------ | ------ | ---- | -------------------------------------- | + | slotId | number | 是 | 卡槽ID。
- 0：卡槽1
- 1：卡槽2 | + +- 返回值 + + | 类型 | 说明 | + | ----------------- | ------------------------------------------------------------ | + | Promise\ | 以Promise形式返回获取指定卡槽SIM卡的ISO国家码，例如：CN（中国）。 | - 示例 @@ -331,47 +180,18 @@ getISOCountryCodeForSim\(slotId: number\): Promise ``` -## sim.getSimOperatorNumeric +## sim.getSimOperatorNumeric getSimOperatorNumeric\(slotId: number, callback: AsyncCallback\): void 获取指定卡槽SIM卡的归属PLMN（Public Land Mobile Network）号，使用callback方式作为异步方法。 -- 参数 +- 参数 - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

slotId

-

number

-

是

-

卡槽ID。

-

0：卡槽1

-

1：卡槽2

-

callback

-

AsyncCallback<string>

-

是

-

回调函数。

-
+ | 参数名 | 类型 | 必填 | 说明 | + | -------- | ----------------------- | ---- | -------------------------------------- | + | slotId | number | 是 | 卡槽ID。
- 0：卡槽1
- 1：卡槽2 | + | callback | AsyncCallback\ | 是 | 回调函数。 | - 示例 @@ -382,55 +202,23 @@ getSimOperatorNumeric\(slotId: number, callback: AsyncCallback\): void ``` -## sim.getSimOperatorNumeric +## sim.getSimOperatorNumeric getSimOperatorNumeric\(slotId: number\): Promise 获取指定卡槽SIM卡的归属PLMN（Public Land Mobile Network）号，使用Promise方式作为异步方法。 -- 参数 +- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | ------ | ------ | ---- | -------------------------------------- | + | slotId | number | 是 | 卡槽ID。
- 0：卡槽1
- 1：卡槽2 | + +- 返回值 - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

slotId

-

number

-

是

-

卡槽ID。

-

0：卡槽1

-

1：卡槽2

-
- -- 返回值 - - - - - - - - - - -

类型

-

说明

-

Promise<string>

-

以Promise形式返回获取指定卡槽SIM卡的归属PLMN号。

-
+ | 类型 | 说明 | + | ----------------- | ------------------------------------------------ | + | Promise\ | 以Promise形式返回获取指定卡槽SIM卡的归属PLMN号。 | - 示例 @@ -444,47 +232,18 @@ getSimOperatorNumeric\(slotId: number\): Promise ``` -## sim.getSimSpn +## sim.getSimSpn getSimSpn\(slotId: number, callback: AsyncCallback\): void 获取指定卡槽SIM卡的服务提供商名称（Service Provider Name，SPN），使用callback方式作为异步方法。 -- 参数 +- 参数 - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

slotId

-

number

-

是

-

卡槽ID。

-

0：卡槽1

-

1：卡槽2

-

callback

-

AsyncCallback<string>

-

是

-

回调函数。

-
+ | 参数名 | 类型 | 必填 | 说明 | + | -------- | ----------------------- | ---- | -------------------------------------- | + | slotId | number | 是 | 卡槽ID。
- 0：卡槽1
- 1：卡槽2 | + | callback | AsyncCallback\ | 是 | 回调函数。 | - 示例 @@ -495,7 +254,7 @@ getSimSpn\(slotId: number, callback: AsyncCallback\): void ``` -## sim.getSimSpn +## sim.getSimSpn getSimSpn\(slotId: number\): Promise @@ -503,49 +262,15 @@ getSimSpn\(slotId: number\): Promise - 参数 - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

slotId

-

number

-

是

-

卡槽ID。

-

0：卡槽1

-

1：卡槽2

-
+ | 参数名 | 类型 | 必填 | 说明 | + | ------ | ------ | ---- | -------------------------------------- | + | slotId | number | 是 | 卡槽ID。
- 0：卡槽1
- 1：卡槽2 | - 返回值 - - - - - - - - - - -

类型

-

说明

-

Promise<string>

-

以Promise形式返回获取指定卡槽SIM卡的SPN。

-
+ | 类型 | 说明 | + | ----------------- | ----------------------------------------- | + | Promise\ | 以Promise形式返回获取指定卡槽SIM卡的SPN。 | - 示例 @@ -559,47 +284,18 @@ getSimSpn\(slotId: number\): Promise ``` -## sim.getSimState +## sim.getSimState getSimState\(slotId: number, callback: AsyncCallback\): void 获取指定卡槽的SIM卡状态，使用callback方式作为异步方法。 -- 参数 +- 参数 - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

slotId

-

number

-

是

-

卡槽ID。

-

0：卡槽1

-

1：卡槽2

-

callback

-

AsyncCallback<SimState>

-

是

-

回调函数。参考SimState。

-
+ | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------------------------------------- | ---- | ----------------------------------------- | + | slotId | number | 是 | 卡槽ID。
- 0：卡槽1
- 1：卡槽2 | + | callback | AsyncCallback\<[SimState](#SimState)\> | 是 | 回调函数。参考[SimState](#SimState)。 | - 示例 @@ -610,56 +306,23 @@ getSimState\(slotId: number, callback: AsyncCallback\): void ``` -## sim.getSimState +## sim.getSimState getSimState\(slotId: number\): Promise 获取指定卡槽的SIM卡状态，使用Promise方式作为异步方法。 -- 参数 +- 参数 - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

slotId

-

number

-

是

-

卡槽ID。

-

0：卡槽1

-

1：卡槽2

-
+ | 参数名 | 类型 | 必填 | 说明 | + | ------ | ------ | ---- | -------------------------------------- | + | slotId | number | 是 | 卡槽ID。
- 0：卡槽1
- 1：卡槽2 | - 返回值 - - - - - - - - - - -

类型

-

说明

-

Promise<SimState>

-

以Promise形式返回获取指定卡槽的SIM卡状态。

-
+ | 类型 | 说明 | + | -------------------------------- | ------------------------------------------ | + | Promise\<[SimState](#SimState)\> | 以Promise形式返回获取指定卡槽的SIM卡状态。 | - 示例 @@ -672,7 +335,7 @@ getSimState\(slotId: number\): Promise }); ``` -## sim.getSimGid1 +## sim.getSimGid1 getSimGid1\(slotId: number, callback: AsyncCallback\): void @@ -680,41 +343,12 @@ getSimGid1\(slotId: number, callback: AsyncCallback\): void 需要ohos.permission.GET\_TELEPHONY\_STATE权限，该权限为系统权限。 -- 参数 +- 参数 - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

slotId

-

number

-

是

-

卡槽ID。

-

0：卡槽1

-

1：卡槽2

-

callback

-

AsyncCallback<string>

-

是

-

回调函数。

-
+ | 参数名 | 类型 | 必填 | 说明 | + | -------- | ----------------------- | ---- | -------------------------------------- | + | slotId | number | 是 | 卡槽ID。
- 0：卡槽1
- 1：卡槽2 | + | callback | AsyncCallback\ | 是 | 回调函数。 | - 示例 @@ -725,7 +359,7 @@ getSimGid1\(slotId: number, callback: AsyncCallback\): void ``` -## sim.getSimGid1 +## sim.getSimGid1 getSimGid1\(slotId: number\): Promise @@ -733,50 +367,17 @@ getSimGid1\(slotId: number\): Promise 需要ohos.permission.GET\_TELEPHONY\_STATE权限，该权限为系统权限。 -- 参数 +- 参数 - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

slotId

-

number

-

是

-

卡槽ID。

-

0：卡槽1

-

1：卡槽2

-
+ | 参数名 | 类型 | 必填 | 说明 | + | ------ | ------ | ---- | -------------------------------------- | + | slotId | number | 是 | 卡槽ID。
- 0：卡槽1
- 1：卡槽2 | - 返回值 - - - - - - - - - - -

类型

-

说明

-

Promise<string>

-

以Promise形式返回获取指定卡槽SIM卡的GID1(Group Identifier Level 1)。

-
+ | 类型 | 说明 | + | ----------------- | ------------------------------------------------------------ | + | Promise\ | 以Promise形式返回获取指定卡槽SIM卡的GID1(Group Identifier Level 1)。 | - 示例 @@ -790,47 +391,15 @@ getSimGid1\(slotId: number\): Promise ``` -## SimState +## SimState SIM卡状态。 - - - - - - - - - - - - - - - - - - - - - - - - - -

变量

-

说明

-

SIM_STATE_UNKNOWN

-

SIM卡状态未知，即无法获取准确的状态。

-

SIM_STATE_NOT_PRESENT

-

表示SIM卡处于not present状态，即卡槽中没有插入SIM卡。

-

SIM_STATE_LOCKED

-

表示SIM卡处于locked状态，即SIM卡被PIN、PUK或网络锁锁定。

-

SIM_STATE_NOT_READY

-

表示SIM卡处于not ready状态，即SIM卡在位但无法正常工作。

-

SIM_STATE_READY

-

表示SIM卡处于ready状态，即SIM卡在位且工作正常。

-

SIM_STATE_LOADED

-

表示SIM卡处于loaded状态，即SIM卡在位且所有卡文件加载完毕。

-
\ No newline at end of file +| 变量 | 说明 | +| --------------------- | ---------------------------------------------------------- | +| SIM_STATE_UNKNOWN | SIM卡状态未知，即无法获取准确的状态。 | +| SIM_STATE_NOT_PRESENT | 表示SIM卡处于not present状态，即卡槽中没有插入SIM卡。 | +| SIM_STATE_LOCKED | 表示SIM卡处于locked状态，即SIM卡被PIN、PUK或网络锁锁定。 | +| SIM_STATE_NOT_READY | 表示SIM卡处于not ready状态，即SIM卡在位但无法正常工作。 | +| SIM_STATE_READY | 表示SIM卡处于ready状态，即SIM卡在位且工作正常。 | +| SIM_STATE_LOADED | 表示SIM卡处于loaded状态，即SIM卡在位且所有卡文件加载完毕。 | \ No newline at end of file diff --git a/zh-cn/application-dev/js-reference/apis/js-apis-sms.md b/zh-cn/application-dev/js-reference/apis/js-apis-sms.md index 5f399841c018bdb97a1440fa34ae172a32796bb9..f2f20864b711bfff00a2fe0a88658b442a7b7022 100755 --- a/zh-cn/application-dev/js-reference/apis/js-apis-sms.md +++ b/zh-cn/application-dev/js-reference/apis/js-apis-sms.md @@ -1,33 +1,35 @@ -# 短信服务 - -- [导入模块](#section111401036143) -- [sms.createMessage](#section3831173019331) -- [sms.createMessage](#section9796242123511) -- [sms.sendMessage](#section128401423810) -- [sms.getDefaultSmsSlotId7+](#section46193383478) -- [sms.getDefaultSmsSlotId7+](#section19981626114817) -- [sms.setSmscAddr7+](#section155849574485) -- [sms.setSmscAddr7+](#section7801426144910) -- [sms.getSmscAddr7+](#section347174613494) -- [sms.getSmscAddr7+](#section1178428175016) -- [ShortMessage](#section345181318300) -- [ShortMessageClass](#section141712166453) -- [SendMessageOptions](#section12262183471518) -- [ISendShortMessageCallback](#section16646146115317) -- [IDeliveryShortMessageCallback](#section12183749531) -- [SendSmsResult](#section13290132311575) +# 短信服务 + +- [导入模块](#导入模块) +- [sms.createMessage](#sms.createMessage-callback) +- [sms.createMessage](#sms.createMessage-promise) +- [sms.sendMessage](#sms.sendMessage) +- [sms.getDefaultSmsSlotId7+](#sms.getDefaultSmsSlotId-callback) +- [sms.getDefaultSmsSlotId7+](#sms.getDefaultSmsSlotId-promise) +- [sms.setSmscAddr7+](#sms.setSmscAddr-callback) +- [sms.setSmscAddr7+](#sms.setSmscAddr-promise) +- [sms.getSmscAddr7+](#sms.getSmscAddr-callback) +- [sms.getSmscAddr7+](#sms.getSmscAddr-promise) +- [ShortMessage](#ShortMessage) +- [ShortMessageClass](#ShortMessageClass) +- [SendMessageOptions](#SendMessageOptions) +- [ISendShortMessageCallback](#ISendShortMessageCallback) +- [IDeliveryShortMessageCallback](#IDeliveryShortMessageCallback) +- [SendSmsResult](#SendSmsResult) >**说明：** > ->标记7+的表示从API Version 7开始支持，未标记的表示从API Version 6开始支持。 +>- 从 API Version 6 开始支持。 +> +>- 标记7+的接口从API Version 7开始支持。 -## 导入模块 +## 导入模块 ``` import sms from '@ohos.telephony.sms'; ``` -## sms.createMessage +## sms.createMessage createMessage\(pdu: Array, specification: string, callback: AsyncCallback\): void @@ -35,48 +37,11 @@ createMessage\(pdu: Array, specification: string, callback: AsyncCallba - 参数 - - - - - - - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

pdu

-

Array<number>

-

是

-

协议数据单元，从收到的信息中获取。

-

specification

-

string

-

是

-

短信协议类型。

-
  • 3gpp表示GSM/UMTS/LTE SMS
  • 3gpp2表示CDMA SMS
-

callback

-

AsyncCallback<ShortMessage>

-

是

-

回调函数。

-
+ | 参数名 | 类型 | 必填 | 说明 | + | ------------- | -------------------------------------------------- | ---- | ------------------------------------------------------------ | + | pdu | Array<number> | 是 | 协议数据单元，从收到的信息中获取。 | + | specification | string | 是 | 短信协议类型。
- 3gpp表示GSM/UMTS/LTE SMS
- 3gpp2表示CDMA SMS | + | callback | AsyncCallback<[ShortMessage](#ShortMessage)> | 是 | 回调函数。 | - 示例 @@ -89,63 +54,24 @@ createMessage\(pdu: Array, specification: string, callback: AsyncCallba ``` -## sms.createMessage +## sms.createMessage createMessage\(pdu: Array, specification: string\): Promise 根据协议数据单元（PDU）和指定的短信协议创建短信实例，使用Promise方式作为异步方法。 -- 参数 - - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

pdu

-

Array<number>

-

是

-

协议数据单元，从收到的信息中获取。

-

specification

-

string

-

是

-

短信协议类型。

-
  • 3gpp表示GSM/UMTS/LTE SMS
  • 3gpp2表示CDMA SMS
-
- -- 返回值 - - - - - - - - - - -

类型

-

说明

-

Promise<ShortMessage>

-

以Promise形式返回创建的短信实例。

-
+- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | ------------- | ------------------- | ---- | ------------------------------------------------------------ | + | pdu | Array<number> | 是 | 协议数据单元，从收到的信息中获取。 | + | specification | string | 是 | 短信协议类型。
- 3gpp表示GSM/UMTS/LTE SMS
- 3gpp2表示CDMA SMS | + +- 返回值 + + | 类型 | 说明 | + | -------------------------------------------- | --------------------------------- | + | Promise<[ShortMessage](#ShortMessage)> | 以Promise形式返回创建的短信实例。 | - 示例 @@ -160,90 +86,50 @@ createMessage\(pdu: Array, specification: string\): Promise - -sendMessage\(options: SendMessageOptions\): void +sendMessage(options: SendMessageOptions): void 发送短信。 -需要ohos.permission.SEND\_MESSAGES权限。 - -- 参数 - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

options

-

SendMessageOptions

-

是

-

发送短信的参数和回调，参考SendMessageOptions。

-
+需要ohos.permission.SEND_MESSAGES权限。 -- 示例 +- 参数 - ``` - let sendCallback = function (err, data) { - console.log(`sendCallback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); - } - let deliveryCallback = function (err, data) { - console.log(`deliveryCallback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); - } - let slotId = 0; - let content = '短信内容'; - let destinationHost = '+861xxxxxxxxxx'; - let serviceCenter = '+861xxxxxxxxxx'; - let destinationPort = 1000; - let options = {slotId, content, destinationHost, serviceCenter, destinationPort, sendCallback, deliveryCallback}; - sms.sendMessage(options); - ``` + | 参数名 | 类型 | 必填 | 说明 | + | ------- | ----------------------------------------- | ---- | ------------------------------------------------------------ | + | options | [SendMessageOptions](#SendMessageOptions) | 是 | 发送短信的参数和回调，参考[SendMessageOptions](#SendMessageOptions)。 | +- 示例 -## sms.getDefaultSmsSlotId7+ + ``` + let sendCallback = function (err, data) { + console.log(`sendCallback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); + } + let deliveryCallback = function (err, data) { + console.log(`deliveryCallback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); + } + let slotId = 0; + let content = '短信内容'; + let destinationHost = '+861xxxxxxxxxx'; + let serviceCenter = '+861xxxxxxxxxx'; + let destinationPort = 1000; + let options = {slotId, content, destinationHost, serviceCenter, destinationPort, sendCallback, deliveryCallback}; + sms.sendMessage(options); + ``` + + +## sms.getDefaultSmsSlotId7+ getDefaultSmsSlotId\(callback: AsyncCallback\): void 获取发送短信的默认SIM卡槽ID，使用callback方式作为异步方法。 -- 参数 - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

callback

-

AsyncCallback<number>

-

是

-

回调函数。

-
  • 0：卡槽1
  • 1：卡槽2
-
+- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | --------------------------- | ---- | ---------------------------------------- | + | callback | AsyncCallback<number> | 是 | 回调函数。
- 0：卡槽1
- 1：卡槽2 | - 示例 @@ -254,29 +140,17 @@ getDefaultSmsSlotId\(callback: AsyncCallback\): void ``` -## sms.getDefaultSmsSlotId7+ +## sms.getDefaultSmsSlotId7+ getDefaultSmsSlotId\(\): Promise 获取发送短信的默认SIM卡槽ID，使用Promise方式作为异步方法。 -- 返回值 - - - - - - - - - - -

类型

-

说明

-

Promise<number>

-

以Promise形式返回发送短信的默认SIM卡：

-
  • 0：卡槽1
  • 1：卡槽2
-
+- 返回值 + + | 类型 | 说明 | + | --------------- | ------------------------------------------------------------ | + | Promise | 以Promise形式返回发送短信的默认SIM卡：
- 0：卡槽1
- 1：卡槽2 | - 示例 @@ -290,7 +164,7 @@ getDefaultSmsSlotId\(\): Promise ``` -## sms.setSmscAddr7+ +## sms.setSmscAddr7+ setSmscAddr\(slotId: number, smscAddr: string, callback: AsyncCallback\): void @@ -298,49 +172,13 @@ setSmscAddr\(slotId: number, smscAddr: string, callback: AsyncCallback\): 需要ohos.permission.SET\_TELEPHONY\_STATE权限，该权限为系统权限。 -- 参数 - - - - - - - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

slotId

-

number

-

是

-

SIM卡槽ID：

-
  • 0：卡槽1
  • 1：卡槽2
-

smscAddr

-

string

-

是

-

短信服务中心地址。

-

callback

-

AsyncCallback<void>

-

是

-

回调函数。

-
+- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | ------------------------- | ---- | ----------------------------------------- | + | slotId | number | 是 | SIM卡槽ID：
- 0：卡槽1
- 1：卡槽2 | + | smscAddr | string | 是 | 短信服务中心地址。 | + | callback | AsyncCallback<void> | 是 | 回调函数。 | - 示例 @@ -353,7 +191,7 @@ setSmscAddr\(slotId: number, smscAddr: string, callback: AsyncCallback\): ``` -## sms.setSmscAddr7+ +## sms.setSmscAddr7+ setSmscAddr\(slotId: number, smscAddr: string\): Promise @@ -361,57 +199,18 @@ setSmscAddr\(slotId: number, smscAddr: string\): Promise 需要ohos.permission.SET\_TELEPHONY\_STATE权限，该权限为系统权限。 -- 参数 - - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

slotId

-

number

-

是

-

SIM卡槽ID：

-
  • 0：卡槽1
  • 1：卡槽2
-

smscAddr

-

string

-

是

-

短信服务中心地址。

-
- -- 返回值 - - - - - - - - - - -

类型

-

说明

-

Promise<void>

-

以Promise形式异步返回设置结果。

-
+- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | ------ | ---- | ----------------------------------------- | + | slotId | number | 是 | SIM卡槽ID：
- 0：卡槽1
- 1：卡槽2 | + | smscAddr | string | 是 | 短信服务中心地址。 | + +- 返回值 + + | 类型 | 说明 | + | ------------------- | ------------------------------- | + | Promise<void> | 以Promise形式异步返回设置结果。 | - 示例 @@ -427,7 +226,7 @@ setSmscAddr\(slotId: number, smscAddr: string\): Promise ``` -## sms.getSmscAddr7+ +## sms.getSmscAddr7+ getSmscAddr\(slotId: number, callback: AsyncCallback\): void @@ -435,40 +234,12 @@ getSmscAddr\(slotId: number, callback: AsyncCallback\): void 需要ohos.permission.GET\_TELEPHONY\_STATE权限，该权限为系统权限。 -- 参数 - - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

slotId

-

number

-

是

-

SIM卡槽ID：

-
  • 0：卡槽1
  • 1：卡槽2
-

callback

-

AsyncCallback<string>

-

是

-

回调函数。

-
+- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | --------------------------- | ---- | ----------------------------------------- | + | slotId | number | 是 | SIM卡槽ID：
- 0：卡槽1
- 1：卡槽2 | + | callback | AsyncCallback<string> | 是 | 回调函数。 | - 示例 @@ -480,7 +251,7 @@ getSmscAddr\(slotId: number, callback: AsyncCallback\): void ``` -## sms.getSmscAddr7+ +## sms.getSmscAddr7+ getSmscAddr\(slotId: number\): Promise @@ -488,48 +259,17 @@ getSmscAddr\(slotId: number\): Promise 需要ohos.permission.GET\_TELEPHONY\_STATE权限，该权限为系统权限。 -- 参数 - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

slotId

-

number

-

是

-

SIM卡槽ID：

-
  • 0：卡槽1
  • 1：卡槽2
-
- -- 返回值 - - - - - - - - - - -

类型

-

说明

-

Promise<string>

-

以Promise形式返回获取短信服务中心地址的结果。

-
+- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | ------ | ------ | ---- | ----------------------------------------- | + | slotId | number | 是 | SIM卡槽ID：
- 0：卡槽1
- 1：卡槽2 | + +- 返回值 + + | 类型 | 说明 | + | --------------------- | --------------------------------------------- | + | Promise<string> | 以Promise形式返回获取短信服务中心地址的结果。 | - 示例 @@ -544,381 +284,87 @@ getSmscAddr\(slotId: number\): Promise ``` -## ShortMessage - -短信实例 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

变量

-

类型

-

说明

-

emailAddress

-

string

-

电子邮件地址。

-

emailMessageBody

-

string

-

电子邮件正文。

-

hasReplyPath

-

boolean

-

收到的短信是否包含“TP-Reply-Path”，默认为false。

-
  • “TP-Reply-Path”：移动电话根据发送SMS消息的短消息中心进行回复。
-

isEmailMessage

-

boolean

-

收到的短信是否为电子邮件。

-

isReplaceMessage

-

boolean

-

收到的短信是否为“替换短信”，默认为false。

-
  • “替换短信”有关详细信息，参见 “3GPP TS 23.040 9.2.3.9”。
-

isSmsStatusReportMessage

-

boolean

-

当前消息是否为“短信状态报告”，默认为false。

-
  • “短信状态报告”是一种特定格式的短信，被用来从Service Center到Mobile Station传送状态报告。
-

messageClass

-

ShortMessageClass

-

短信类型。

-

pdu

-

Array<number>

-

SMS消息中的协议数据单元 （PDU）。

-

protocolId

-

number

-

发送短信时使用的协议标识。

-

scAddress

-

string

-

短消息服务中心（SMSC）地址。

-

scTimestamp

-

number

-

SMSC时间戳。

-

status

-

number

-

SMS-STATUS-REPORT消息中的短信状态指示短信服务中心（SMSC）发送的短信状态。

-

userRawData

-

Array<number>

-

除数据头外的用户数据。

-

visibleMessageBody

-

string

-

短信正文。

-

visibleRawAddress

-

string

-

发送者地址。

-
- -## ShortMessageClass +## ShortMessage + +短信实例。 + +| 变量 | 类型 | 说明 | +| ------------------------ | --------------------------------------- | ------------------------------------------------------------ | +| emailAddress | string | 电子邮件地址。 | +| emailMessageBody | string | 电子邮件正文。 | +| hasReplyPath | boolean | 收到的短信是否包含“TP-Reply-Path”，默认为false。
“TP-Reply-Path”：移动电话根据发送SMS消息的短消息中心进行回复。 | +| isEmailMessage | boolean | 收到的短信是否为电子邮件。 | +| isReplaceMessage | boolean | 收到的短信是否为“替换短信”，默认为false。
“替换短信”有关详细信息，参见 “3GPP TS 23.040 9.2.3.9”。 | +| isSmsStatusReportMessage | boolean | 当前消息是否为“短信状态报告”，默认为false。
“短信状态报告”是一种特定格式的短信，被用来从Service Center到Mobile Station传送状态报告。 | +| messageClass | [ShortMessageClass](#ShortMessageClass) | 短信类型。 | +| pdu | Array<number> | SMS消息中的协议数据单元 （PDU）。 | +|protocolId|number|发送短信时使用的协议标识。| +|scAddress|string|短消息服务中心（SMSC）地址。| +|scTimestamp|number|SMSC时间戳。| +|status|number|SMS-STATUS-REPORT消息中的短信状态指示短信服务中心（SMSC）发送的短信状态。| +|userRawData|Array<number>|除数据头外的用户数据。| +|visibleMessageBody|string|短信正文。| +|visibleRawAddress|string|发送者地址。| + + +## ShortMessageClass 短信类型。 - - - - - - - - - - - - - - - - - - - - - - - - - - - -

变量

-

值

-

说明

-

UNKNOWN

-

0

-

未知类型。

-

INSTANT_MESSAGE

-

1

-

即时消息，收到后立即显示。

-

OPTIONAL_MESSAGE

-

2

-

存储在设备或SIM卡上的短信。

-

SIM_MESSAGE

-

3

-

包含SIM卡信息的短信，需要存储在SIM卡中。

-

FORWARD_MESSAGE

-

4

-

要转发到另一台设备的短信。

-
- -## SendMessageOptions +| 变量 | 值 | 说明 | +| ---------------- | ---- | ---------------------------------------- | +| UNKNOWN | 0 | 未知类型。 | +| INSTANT_MESSAGE | 1 | 即时消息，收到后立即显示。 | +| OPTIONAL_MESSAGE | 2 | 存储在设备或SIM卡上的短信。 | +| SIM_MESSAGE | 3 | 包含SIM卡信息的短信，需要存储在SIM卡中。 | +| FORWARD_MESSAGE | 4 | 要转发到另一台设备的短信。 | + + +## SendMessageOptions 发送短信的参数和回调。 根据SendMessageOptions中的可选参数content的值判断短信类型。 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

slotId

-

number

-

是

-

用于发送短信的SIM卡槽ID：

-
  • 0：卡槽1
  • 1：卡槽2
-

destinationHost

-

string

-

是

-

短信的发送地址。

-

content

-

string | Array<number>

-

是

-

如果内容是字符串，则这是一条文本短信。

-

如果内容是字节数组，则这是一条数据短信。

-

serviceCenter

-

string

-

否

-

短信中心地址。默认使用SIM卡中的短信中心地址。

-

destinationPort

-

number

-

否

-

如果发送数据消息，destinationPort 是必需的。否则是可选的。

-

sendCallback

-

AsyncCallback

-

<ISendShortMessageCallback>

-

否

-

短信发送结果回调，返回短信发送的结果，参考ISendShortMessageCallback。

-

deliveryCallback

-

AsyncCallback

-

<IDeliveryShortMessageCallback>

-

否

-

短信送达结果回调，返回短信递送报告，参考IDeliveryShortMessageCallback。

-
- -## ISendShortMessageCallback +| 参数名 | 类型 | 必填 | 说明 | +| ---------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | +| slotId | number | 是 | 用于发送短信的SIM卡槽ID：
- 0：卡槽1
- 1：卡槽2 | +| destinationHost | string | 是 | 短信的发送地址。 | +| content | string \| Array<number> | 是 | 如果内容是字符串，则这是一条文本短信。如果内容是字节数组，则这是一条数据短信。 | +| serviceCenter | string | 否 | 短信中心地址。默认使用SIM卡中的短信中心地址。 | +| destinationPort | number | 否 | 如果发送数据消息，destinationPort 是必需的。否则是可选的。 | +| sendCallback | AsyncCallback<[ISendShortMessageCallback](#ISendShortMessageCallback)> | 否 | 短信发送结果回调，返回短信发送的结果，参考[ISendShortMessageCallback](#ISendShortMessageCallback)。 | +| deliveryCallback | AsyncCallback<[IDeliveryShortMessageCallback](#IDeliveryShortMessageCallback)> | 否 | 短信送达结果回调，返回短信递送报告，参考[IDeliveryShortMessageCallback](#IDeliveryShortMessageCallback)。 | + + +## ISendShortMessageCallback 回调实例。返回短信发送结果、存储已发送短信的URI和是否为长短信的最后一部分。 - - - - - - - - - - - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

isLastPart

-

boolean

-

否

-

指定这是否是长短信的最后一部分。true表示这是长短信的最后一部分，false表示不是。默认为false。

-

result

-

SendSmsResult

-

是

-

短信发送结果。

-

url

-

string

-

是

-

存储发送短信的URI。

-
- -## IDeliveryShortMessageCallback +| 参数名 | 类型 | 必填 | 说明 | +| ---------- | ------------------------------- | ---- | ------------------------------------------------------------ | +| isLastPart | boolean | 否 | 指定这是否是长短信的最后一部分。true表示这是长短信的最后一部分，false表示不是。默认为false。 | +| result | [SendSmsResult](#SendSmsResult) | 是 | 短信发送结果。 | +| url | string | 是 | 存储发送短信的URI。 | + + +## IDeliveryShortMessageCallback 回调实例。返回短信送达报告。 - - - - - - - - - - - - - -

参数名

-

类型

-

必填

-

说明

-

pdu

-

Array<number>

-

是

-

短信送达报告。

-
- -## SendSmsResult +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------------------- | ---- | -------------- | +| pdu | Array<number> | 是 | 短信送达报告。 | + + +## SendSmsResult 短信发送结果。 - - - - - - - - - - - - - - - - - - - - - - - -

参数名

-

值

-

说明

-

SEND_SMS_SUCCESS

-

0

-

发送短信成功。

-

SEND_SMS_FAILURE_UNKNOWN

-

1

-

发送短信失败，原因未知。

-

SEND_SMS_FAILURE_RADIO_OFF

-

2

-

发送短信失败，原因为调制解调器关机。

-

SEND_SMS_FAILURE_SERVICE_UNAVAILABLE

-

3

-

发送短信失败，原因为网络不可用、不支持发送或接收短信。

-
+| 参数名 | 值 | 说明 | +| ------------------------------------ | ---- | ------------------------------------------------------ | +| SEND_SMS_SUCCESS | 0 | 发送短信成功。 | +| SEND_SMS_FAILURE_UNKNOWN | 1 | 发送短信失败，原因未知。 | +| SEND_SMS_FAILURE_RADIO_OFF | 2 | 发送短信失败，原因为调制解调器关机。 | +| SEND_SMS_FAILURE_SERVICE_UNAVAILABLE | 3 | 发送短信失败，原因为网络不可用、不支持发送或接收短信。 | + diff --git a/zh-cn/application-dev/js-reference/component/Readme-CN.md b/zh-cn/application-dev/js-reference/component/Readme-CN.md index 303e5ae59ab62b0085f4187d38cac47c50208c0e..006e4f6126ff6eca16bb2acd57e4d2d70f7b7c87 100644 --- a/zh-cn/application-dev/js-reference/component/Readme-CN.md +++ b/zh-cn/application-dev/js-reference/component/Readme-CN.md @@ -80,9 +80,9 @@ - [grid-row](js-components-grid-row.md) - [grid-col](js-components-grid-col.md) -- [svg组件](js-components-svg.md) +- [svg组件](js-svg.md) - [通用属性](js-components-svg-common-attributes.md) - - [svg](js-components-svg-0.md) + - [svg](js-components-svg.md) - [rect](js-components-svg-rect.md) - [circle](js-components-svg-circle.md) - [ellipse](js-components-svg-ellipse.md) diff --git a/zh-cn/application-dev/js-reference/component/js-components-svg-0.md b/zh-cn/application-dev/js-reference/component/js-components-svg-0.md deleted file mode 100644 index f80eadf13c5187a7c5e72b1a90545537fc4bf6bd..0000000000000000000000000000000000000000 --- a/zh-cn/application-dev/js-reference/component/js-components-svg-0.md +++ /dev/null @@ -1,128 +0,0 @@ -# svg - -- [权限列表](#zh-cn_topic_0000001173164705_section11257113618419) -- [子组件](#zh-cn_topic_0000001173164705_section9288143101012) -- [属性](#zh-cn_topic_0000001173164705_section2907183951110) -- [示例](#zh-cn_topic_0000001173164705_section360556124815) - -基础容器，主要作为svg的根节点使用，也可以在svg中嵌套使用。 - ->![](../../public_sys-resources/icon-note.gif) **说明：** ->从API Version 7 开始支持。 ->约束条件：svg父组件或者svg组件需要定义宽高值，否则不进行绘制。 - -## 权限列表 - -无 - -## 子组件 - -支持svg、rect、circle、ellipse、path、line、polygon、polyline、text、animate、animateTransform。 - -## 属性 - -支持所列的Svg组件通用属性和以下表格的属性，设置的通用属性会传递给子组件。 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

名称

-

类型

-

默认值

-

必填

-

描述

-

id

-

string

-

-

-

否

-

组件的唯一标识。

-

width

-

<length>|<percentage>

-

-

-

否

-

设置组件的宽度

-

height

-

<length>|<percentage>

-

-

-

否

-

设置组件的高度

-

x

-

<length>|<percentage>

-

-

-

否

-

设置当前svg的x轴坐标，根svg节点无效

-

y

-

<length>|<percentage>

-		  

否

-

设置当前svg的y轴坐标，根svg节点无效

-

viewBox

-

string

-

-

-

否

-

设置当前svg的视口。支持的格式为<number number number number>，4个参数分别表示min-x, min-y, width and height，viewBox的宽高和svg的宽高不一致，会以中心对齐进行缩放。

-
- -## 示例 - -``` - -
- - - - - - - - - - - - -
-``` - -![](figures/zh-cn_image_0000001173164789.png) - diff --git a/zh-cn/application-dev/js-reference/component/js-components-svg.md b/zh-cn/application-dev/js-reference/component/js-components-svg.md index 301c0c79800d7522ab111b2b496a9c99e383ed55..f80eadf13c5187a7c5e72b1a90545537fc4bf6bd 100644 --- a/zh-cn/application-dev/js-reference/component/js-components-svg.md +++ b/zh-cn/application-dev/js-reference/component/js-components-svg.md @@ -1,33 +1,128 @@ -# svg组件 - -- **[通用属性](js-components-svg-common-attributes.md)** - -- **[svg](js-components-svg-0.md)** - -- **[rect](js-components-svg-rect.md)** - -- **[circle](js-components-svg-circle.md)** - -- **[ellipse](js-components-svg-ellipse.md)** - -- **[path](js-components-svg-path.md)** - -- **[line](js-components-svg-line.md)** - -- **[polyline](js-components-svg-polyline.md)** - -- **[polygon](js-components-svg-polygon.md)** - -- **[text](js-components-svg-text.md)** - -- **[tspan](js-components-svg-tspan.md)** - -- **[textPath](js-components-svg-textpath.md)** - -- **[animate](js-components-svg-animate.md)** - -- **[animateMotion](js-components-svg-animate-motion.md)** - -- **[animateTransform](js-components-svg-animate-transform.md)** - +# svg + +- [权限列表](#zh-cn_topic_0000001173164705_section11257113618419) +- [子组件](#zh-cn_topic_0000001173164705_section9288143101012) +- [属性](#zh-cn_topic_0000001173164705_section2907183951110) +- [示例](#zh-cn_topic_0000001173164705_section360556124815) + +基础容器，主要作为svg的根节点使用，也可以在svg中嵌套使用。 + +>![](../../public_sys-resources/icon-note.gif) **说明：** +>从API Version 7 开始支持。 +>约束条件：svg父组件或者svg组件需要定义宽高值，否则不进行绘制。 + +## 权限列表 + +无 + +## 子组件 + +支持svg、rect、circle、ellipse、path、line、polygon、polyline、text、animate、animateTransform。 + +## 属性 + +支持所列的Svg组件通用属性和以下表格的属性，设置的通用属性会传递给子组件。 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

名称

+

类型

+

默认值

+

必填

+

描述

+

id

+

string

+

-

+

否

+

组件的唯一标识。

+

width

+

<length>|<percentage>

+

-

+

否

+

设置组件的宽度

+

height

+

<length>|<percentage>

+

-

+

否

+

设置组件的高度

+

x

+

<length>|<percentage>

+

-

+

否

+

设置当前svg的x轴坐标，根svg节点无效

+

y

+

<length>|<percentage>

+		  

否

+

设置当前svg的y轴坐标，根svg节点无效

+

viewBox

+

string

+

-

+

否

+

设置当前svg的视口。支持的格式为<number number number number>，4个参数分别表示min-x, min-y, width and height，viewBox的宽高和svg的宽高不一致，会以中心对齐进行缩放。

+
+ +## 示例 + +``` + +
+ + + + + + + + + + + + +
+``` + +![](figures/zh-cn_image_0000001173164789.png) diff --git a/zh-cn/application-dev/js-reference/component/js-svg.md b/zh-cn/application-dev/js-reference/component/js-svg.md new file mode 100644 index 0000000000000000000000000000000000000000..c5803b40ab16956542b49f48fad9783e96842b38 --- /dev/null +++ b/zh-cn/application-dev/js-reference/component/js-svg.md @@ -0,0 +1,33 @@ +# svg组件 + +- **[通用属性](js-components-svg-common-attributes.md)** + +- **[svg](js-components-svg.md)** + +- **[rect](js-components-svg-rect.md)** + +- **[circle](js-components-svg-circle.md)** + +- **[ellipse](js-components-svg-ellipse.md)** + +- **[path](js-components-svg-path.md)** + +- **[line](js-components-svg-line.md)** + +- **[polyline](js-components-svg-polyline.md)** + +- **[polygon](js-components-svg-polygon.md)** + +- **[text](js-components-svg-text.md)** + +- **[tspan](js-components-svg-tspan.md)** + +- **[textPath](js-components-svg-textpath.md)** + +- **[animate](js-components-svg-animate.md)** + +- **[animateMotion](js-components-svg-animate-motion.md)** + +- **[animateTransform](js-components-svg-animate-transform.md)** + + diff --git a/zh-cn/application-dev/media/Readme-CN.md b/zh-cn/application-dev/media/Readme-CN.md index 455153bc1f59280c64862a45d903d2d0e37ee3e4..f4c1c506f20fc22be84dc8822ab63b20a9f3d4b2 100755 --- a/zh-cn/application-dev/media/Readme-CN.md +++ b/zh-cn/application-dev/media/Readme-CN.md @@ -1,8 +1,8 @@ # 媒体 -- [音频](audio.md) - - [音频开发概述](audio-overview.md) - - [音频播放开发指导](audio-playback.md) - - [音频管理开发指导](audio-management.md) - - [音频录制开发指导](audio-recorder.md) +- 音频 + - [音频开发概述](audio-overview.md) + - [音频播放开发指导](audio-playback.md) + - [音频管理开发指导](audio-management.md) + - [音频录制开发指导](audio-recorder.md) diff --git a/zh-cn/application-dev/media/audio-management.md b/zh-cn/application-dev/media/audio-management.md index 266eb37ed4f31bbc4b2451cfb8fd5462d8cd0d8b..32846506db59fb5daa9f0e13307dfcef80323f01 100644 --- a/zh-cn/application-dev/media/audio-management.md +++ b/zh-cn/application-dev/media/audio-management.md @@ -1,277 +1,98 @@ -# 音频管理开发指导 +# 音频管理开发指导 -- [场景介绍](#section1269212236329) -- [接口说明](#section5122103123215) -- [开发步骤](#section1772415410138) +- [场景介绍](#场景介绍) +- [接口说明](#接口说明) +- [开发步骤](#开发步骤) -## 场景介绍 +## 场景介绍 音频管理的主要工作是音量调节与音量查询，以及输入/输出设备查询。 -## 接口说明 - -**表 1** audio的相关接口 - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

接口名

-

描述

-

getAudioManager(): AudioManager

-

获得音频管理器。

-

AudioManager

-

音频管理器。具体参考表 音频管理相关的interface AudioManager。

-

AudioDeviceDescriptor

-

描述音频设备。

-

AudioVolumeType

-

表示音频流类型的枚举。

-

DeviceFlag

-

表示可获取的设备种类的枚举。

-

DeviceRole

-

表示设备角色的枚举。

-

DeviceType

-

表示设备类型的枚举。

-
- -**表 2** 音频管理相关的interface **AudioManager** - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

接口名

-

描述

-

setVolume(audioType: AudioVolumeType,volume: number,callback: AsyncCallback<void>): void

-

改变某个流的音量。

-

setVolume(audioType: AudioVolumeType,volume: number): Promise<void>

-

改变某个流的音量。

-

getVolume(audioType: AudioVolumeType, callback: AsyncCallback<number>): void

-

获得某个流的音量。

-

getVolume(audioType: AudioVolumeType): Promise<number>

-

获得某个流的音量。

-

getMinVolume(audioType: AudioVolumeType, callback: AsyncCallback<number>): void

-

获得某个流的最小音量。

-

getMinVolume(audioType: AudioVolumeType): Promise<number>

-

获得某个流的最小音量。

-

getMaxVolume(audioType: AudioVolumeType, callback: AsyncCallback<number>): void

-

获得某个流的最大音量。

-

getMaxVolume(audioType: AudioVolumeType): Promise<number>

-

获得某个流的最大音量。

-

getDevices(deviceFlag: DeviceFlag, callback: AsyncCallback<AudioDeviceDescriptors>): void

-

获得设备列表。

-

getDevices(deviceFlag: DeviceFlag): Promise<AudioDeviceDescriptors>

-

获得设备列表。

-
- -**表 3** 表示音频设备的interface AudioDeviceDescriptor - - - - - - - - - - - - - -

属性

-

描述

-

deviceRole: DeviceRole

-

设备角色。

-

deviceType: DeviceType

-

设备类型。

-
- -**表 4** 表示音频流类型的枚举AudioVolumeType - - - - - - - - - - - - - -

枚举值

-

描述

-

MEDIA = 1

-

媒体声音。

-

RINGTONE = 2

-

铃声。

-
- -**表 5** 表示可获取的设备种类的枚举DeviceFlag - - - - - - - - - - - - - - - - -

枚举值

-

描述

-

OUTPUT_DEVICES_FLAG = 1

-

输出设备。

-

INPUT_DEVICES_FLAG = 2

-

输入设备。

-

ALL_DEVICES_FLAG = 3

-

所有设备。

-
- -**表 6** 表示设备角色的枚举DeviceRole - - - - - - - - - - - - - -

枚举值

-

描述

-

INPUT_DEVICE = 1

-

输入设备。

-

OUTPUT_DEVICE = 2

-

输出设备。

-
- -**表 7** 表示设备类型的枚举DeviceType - - - - - - - - - - - - - - - - - - - - - - - - - -

枚举值

-

描述

-

INVALID = 0

-

无效。

-

SPEAKER = 1

-

扬声器。

-

WIRED_HEADSET = 2

-

有线耳机。

-

BLUETOOTH_SCO = 3

-

蓝牙设备。

-

BLUETOOTH_A2DP = 4

-

支持A2DP的蓝牙设备。

-

MIC = 5

-

麦克风。

-
- -## 开发步骤 - -1. 获取音频控制器。 - - ``` - const audioManager = audio.getAudioManager(); - ``` - -2. 改变媒体流的声音。 - - ``` - audioManager.getVolume(audio.AudioVolumeType.MEDIA, (err, value) => { - if (err) { - console.error(`failed to get volume ${err.message}`); - return; - } - console.log(`Media getVolume ${value}`); - }); - ``` - +## 接口说明 + +**表1** audio的相关接口 + +| 接口名 | 描述 | +| -------- | -------- | +| getAudioManager(): AudioManager | 获得音频管理器。 | +| AudioManager | 音频管理器。具体参考表 音频管理相关的interface AudioManager。 | +| AudioDeviceDescriptor | 描述音频设备。 | +| AudioVolumeType | 表示音频流类型的枚举。 | +| DeviceFlag | 表示可获取的设备种类的枚举。 | +| DeviceRole | 表示设备角色的枚举。 | +| DeviceType | 表示设备类型的枚举。 | + +**表2** 音频管理相关的interface **AudioManager** + +| 接口名 | 描述 | +| -------- | -------- | +| setVolume(audioType: AudioVolumeType,volume: number,callback: AsyncCallback<void>): void | 改变某个流的音量。 | +| setVolume(audioType: AudioVolumeType,volume: number): Promise<void> | 改变某个流的音量。 | +| getVolume(audioType: AudioVolumeType, callback: AsyncCallback<number>): void | 获得某个流的音量。 | +| getVolume(audioType: AudioVolumeType): Promise<number> | 获得某个流的音量。 | +| getMinVolume(audioType: AudioVolumeType, callback: AsyncCallback<number>): void | 获得某个流的最小音量。 | +| getMinVolume(audioType: AudioVolumeType): Promise<number> | 获得某个流的最小音量。 | +| getMaxVolume(audioType: AudioVolumeType, callback: AsyncCallback<number>): void | 获得某个流的最大音量。 | +| getMaxVolume(audioType: AudioVolumeType): Promise<number> | 获得某个流的最大音量。 | +| getDevices(deviceFlag: DeviceFlag, callback: AsyncCallback<AudioDeviceDescriptors>): void | 获得设备列表。 | +| getDevices(deviceFlag: DeviceFlag): Promise<AudioDeviceDescriptors> | 获得设备列表。 | + +**表3** 表示音频设备的interface **AudioDeviceDescriptor** + +| 属性 | 描述 | +| -------- | -------- | +| deviceRole: DeviceRole | 设备角色。 | +| deviceType: DeviceType | 设备类型。 | + +**表4** 表示音频流类型的枚举**AudioVolumeType** + +| 枚举值 | 描述 | +| -------- | -------- | +| MEDIA = 1 | 媒体声音。 | +| RINGTONE = 2 | 铃声。 | + +**表5** 表示可获取的设备种类的枚举**DeviceFlag** + +| 枚举值 | 描述 | +| -------- | -------- | +| OUTPUT_DEVICES_FLAG = 1 | 输出设备。 | +| INPUT_DEVICES_FLAG = 2 | 输入设备。 | +| ALL_DEVICES_FLAG = 3 | 所有设备。 | + +**表6** 表示设备角色的枚举**DeviceRole** + +| 枚举值 | 描述 | +| -------- | -------- | +| INPUT_DEVICE = 1 | 输入设备。 | +| OUTPUT_DEVICE = 2 | 输出设备。 | + +**表7** 表示设备类型的枚举**DeviceType** + +| 枚举值 | 描述 | +| -------- | -------- | +| INVALID = 0 | 无效。 | +| SPEAKER = 1 | 扬声器。 | +| WIRED_HEADSET = 2 | 有线耳机。 | +| BLUETOOTH_SCO = 3 | 蓝牙设备。 | +| BLUETOOTH_A2DP = 4 | 支持A2DP的蓝牙设备。 | +| MIC = 5 | 麦克风。 | + + +## 开发步骤 + +1. 获取音频控制器。 + ``` + const audioManager = audio.getAudioManager(); + ``` + +2. 改变媒体流的声音。 + ``` + audioManager.getVolume(audio.AudioVolumeType.MEDIA, (err, value) => { + if (err) { + console.error(`failed to get volume ${err.message}`); + return; + } + console.log(`Media getVolume ${value}`); + }); + ``` diff --git a/zh-cn/application-dev/media/audio-overview.md b/zh-cn/application-dev/media/audio-overview.md index a7fd845931212d0eab6c4e3a39d19e70f9ef1fa2..0ed6864c602c4d88b9abe7f7dceb7abb673a43da 100644 --- a/zh-cn/application-dev/media/audio-overview.md +++ b/zh-cn/application-dev/media/audio-overview.md @@ -1,32 +1,23 @@ -# 音频开发概述 +# 音频开发概述 -- [基本概念](#section296512102281) +- [基本概念](#基本概念) OpenHarmony音频模块支持音频业务的开发，提供音频相关的功能，主要包括音频播放、音量管理等。 ->![](../public_sys-resources/icon-note.gif) **说明：** ->由于权限问题，此部分功能在标准系统暂不可用。 -## 基本概念 +## 基本概念 -- **采样** +- **采样**
+ 采样是指将连续时域上的模拟信号按照一定的时间间隔采样，获取到离散时域上离散信号的过程。 - 采样是指将连续时域上的模拟信号按照一定的时间间隔采样，获取到离散时域上离散信号的过程。 +- **采样率**
+ 采样率为每秒从连续信号中提取并组成离散信号的采样次数，单位用赫兹（Hz）来表示。通常人耳能听到频率范围大约在20Hz～20kHz之间的声音。常用的音频采样频率有：8kHz、11.025kHz、22.05kHz、16kHz、37.8kHz、44.1kHz、48kHz、96kHz、192kHz等。 -- **采样率** - - 采样率为每秒从连续信号中提取并组成离散信号的采样次数，单位用赫兹（Hz）来表示。通常人耳能听到频率范围大约在20Hz～20kHz之间的声音。常用的音频采样频率有：8kHz、11.025kHz、22.05kHz、16kHz、37.8kHz、44.1kHz、48kHz、96kHz、192kHz等。 - -- **声道** - - 声道是指声音在录制或播放时在不同空间位置采集或回放的相互独立的音频信号，所以声道数也就是声音录制时的音源数量或回放时相应的扬声器数量。 - -- **音频帧** - - 音频数据是流式的，本身没有明确的一帧帧的概念，在实际的应用中，为了音频算法处理/传输的方便，一般约定俗成取2.5ms\~60ms为单位的数据量为一帧音频。这个时间被称之为“采样时间”，其长度没有特别的标准，它是根据编解码器和具体应用的需求来决定的。 - -- **PCM** - - PCM（Pulse Code Modulation），即脉冲编码调制，是一种将模拟信号数字化的方法，是将时间连续、取值连续的模拟信号转换成时间离散、抽样值离散的数字信号的过程。 +- **声道**
+ 声道是指声音在录制或播放时在不同空间位置采集或回放的相互独立的音频信号，所以声道数也就是声音录制时的音源数量或回放时相应的扬声器数量。 +- **音频帧**
+ 音频数据是流式的，本身没有明确的一帧帧的概念，在实际的应用中，为了音频算法处理/传输的方便，一般约定俗成取2.5ms~60ms为单位的数据量为一帧音频。这个时间被称之为“采样时间”，其长度没有特别的标准，它是根据编解码器和具体应用的需求来决定的。 +- **PCM**
+ PCM（Pulse Code Modulation），即脉冲编码调制，是一种将模拟信号数字化的方法，是将时间连续、取值连续的模拟信号转换成时间离散、抽样值离散的数字信号的过程。 diff --git a/zh-cn/application-dev/media/audio-playback.md b/zh-cn/application-dev/media/audio-playback.md index 26fc1ceccdacb7fbb84b1fee85b1e2b8fbe5261d..d6a6b72cee39a7569cd0a5efe6ef532ee6e7412e 100644 --- a/zh-cn/application-dev/media/audio-playback.md +++ b/zh-cn/application-dev/media/audio-playback.md @@ -1,240 +1,131 @@ -# 音频播放开发指导 +# 音频播放开发指导 -- [场景介绍](#section910413166166) -- [接口说明](#section1225204317126) +- [场景介绍](#场景介绍) +- [接口说明](#接口说明) -## 场景介绍 +## 场景介绍 音频播放的主要工作是将音频数据转码为可听见的音频模拟信号并通过输出设备进行播放，同时对播放任务进行管理。 -**图 1** 音频播放状态机 -![](figures/音频播放状态机.png "音频播放状态机") - -## 接口说明 - -**表 1** media - - - - - - - - - - - - - -

接口名

-

描述

-

media.createAudioPlayer()

-

创建AudioPlayer实例。

-

AudioPlayer

-

提供音频播放相关功能，具体见表 音频播放相关的interface AudioPlayer。

-
- -**表 2** 音频播放相关的interface **AudioPlayer** - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

接口名

-

描述

-

release()

-

释放音频资源。

-

play()

-

开始播放音频源。

-

pause()

-

暂停播放。

-

stop()

-

停止播放。

-

reset()7+

-

重置播放音频源。

-

setVolume(vol: number)

-

改变音频播放音量

-

seek(timeMs: number)

-

改变播放位置。

-

src:string

-

音频播放的媒体URI。

-

state:AudioState

-

播放的状态属性。

-

currentTime:number

-

音频的当前播放位置。

-

duration:number

-

音频播放的时长。

-

loop:boolean

-

音频的循环播放属性。

-

on('play', function callback)

-

订阅音频播放开始事件。

-

on('pause', function callback)

-

订阅音频播放暂停事件。

-

on('stop', function callback)

-

订阅音频播放停止事件。

-

on('reset', function callback)

-

订阅音频播放重置事件。

-

on('finish',function callback)

-

订阅音频播放结束事件。

-

on('error', function callback)

-

订阅音频播放错误事件。

-

on('dataload', function callback)

-

订阅音频播放加载数据事件。

-

on('volumeChange', function callback)

-

订阅音频播放音量变化事件。

-

on('timeUpdate', function callback)

-

订阅音频播放进度改变事件。

-
- -1. 创建音频播放器。 - - ``` - import media from '@ohos.multimedia.media'; - var player = media.createAudioPlayer(); - ``` - -2. 设置消息订阅事件。 - - ``` - player.on('play', (err, action) => { +**图1** 音频播放状态机 +![zh-cn_image_0000001182608857](figures/zh-cn_image_0000001182608857.png) + + +## 接口说明 + +**表1** media + +| 接口名 | 描述 | +| -------- | -------- | +| media.createAudioPlayer() | 创建AudioPlayer实例。 | +| AudioPlayer | 提供音频播放相关功能，具体见表 音频播放相关的interface AudioPlayer。 | + +**表2** 音频播放相关的interface **AudioPlayer** + +| 接口名 | 描述 | +| -------- | -------- | +| release() | 释放音频资源。 | +| play() | 开始播放音频源。 | +| pause() | 暂停播放。 | +| stop() | 停止播放。 | +| reset()7+ | 重置播放音频源。 | +| setVolume(vol: number) | 改变音频播放音量 | +| seek(timeMs: number) | 改变播放位置。 | +| src:string | 音频播放的媒体URI。 | +| state:AudioState | 播放的状态属性。 | +| currentTime:number | 音频的当前播放位置。 | +| duration:number | 音频播放的时长。 | +| loop:boolean | 音频的循环播放属性。 | +| on('play', function callback) | 订阅音频播放开始事件。 | +| on('pause', function callback) | 订阅音频播放暂停事件。 | +| on('stop', function callback) | 订阅音频播放停止事件。 | +| on('reset', function callback) | 订阅音频播放重置事件。 | +| on('finish',function callback) | 订阅音频播放结束事件。 | +| on('error', function callback) | 订阅音频播放错误事件。 | +| on('dataload', function callback) | 订阅音频播放加载数据事件。 | +| on('volumeChange', function callback) | 订阅音频播放音量变化事件。 | +| on('timeUpdate', function callback) | 订阅音频播放进度改变事件。 | + + +1. 创建音频播放器。 + ``` + import media from '@ohos.multimedia.media'; + var player = media.createAudioPlayer(); + ``` + +2. 设置消息订阅事件。 + ``` + player.on('play', (err, action) => { + if (err) { + console.error('Error returned in the play() callback.'); + return; + } + console.info('Current player duration: '+ player.duration); + console.info('Current player time: ' + player.currentTime); + console.info('Current player status: '+player.state); + console.info('Pause MP3'); + player.pause(); + }); + player.on('pause', (err, action) => { if (err) { - console.error('Error returned in the play() callback.'); + console.error('Error returned in the pause() callback.'); return; } - console.info('Current player duration: '+ player.duration); + console.info('Current player status: ' + player.state); console.info('Current player time: ' + player.currentTime); - console.info('Current player status: '+player.state); - console.info('Pause MP3'); - player.pause(); - }); - player.on('pause', (err, action) => { - if (err) { - console.error('Error returned in the pause() callback.'); - return; - } - console.info('Current player status: ' + player.state); - console.info('Current player time: ' + player.currentTime); - player.seek(30000); // Seek for 30 seconds. - }); - player.on('stop', (err, action) => { + player.seek(30000); // Seek for 30 seconds. + }); + player.on('stop', (err, action) => { + if (err) { + console.error('Error returned in the stop() callback.'); + return; + } + console.info('stop callback invoked. State:' + player.state); + player.reset(); + }); + player.on('dataLoad', (err, action) => { + if (err) { + console.error('Error returned in the dataLoad() callback.'); + return; + } + console.info('dataLoad callback invoked. Current time: ' + player.currentTime); + console.info('Duration of the source:' + player.duration); + player.play(); + }); + player.on('reset', (err, action) => { + if (err) { + console.error('Error returned in the reset() callback.'); + return; + } + console.info('reset callback invoked.'); + player.release(); + }); + player.on('finish', (err, action) => { if (err) { - console.error('Error returned in the stop() callback.'); - return; + console.error('Error returned in the finish() callback.'); + return; } - console.info('stop callback invoked. State:' + player.state); - player.reset(); - }); - player.on('dataLoad', (err, action) => { - if (err) { - console.error('Error returned in the dataLoad() callback.'); - return; - } - console.info('dataLoad callback invoked. Current time: ' + player.currentTime); - console.info('Duration of the source:' + player.duration); - player.play(); - }); - player.on('reset', (err, action) => { - if (err) { - console.error('Error returned in the reset() callback.'); - return; + console.info('finish callback invoked.'); + }); + player.on('timeUpdate', (seekTime, action) => { + console.info('Seek time: ' + seekTime); + console.info('Current player time: ' + player.currentTime); + var newTime = player.currentTime; + if(newTime == 30000) { + console.info('Seek succeeded. New time: ' + newTime); + } else { + console.error('Seek failed: ', + newTime); } - console.info('reset callback invoked.'); - player.release(); - }); - player.on('finish', (err, action) => { - if (err) { - console.error('Error returned in the finish() callback.'); - return; - } - console.info('finish callback invoked.'); - }); - player.on('timeUpdate', (seekTime, action) => { - console.info('Seek time: ' + seekTime); - console.info('Current player time: ' + player.currentTime); - var newTime = player.currentTime; - if(newTime == 30000) { - console.info('Seek succeeded. New time: ' + newTime); - } else { - console.error('Seek failed: ', + newTime); - } - player.stop(); - }); - player.on('error', (err) => { - console.error('Player error: ${err.message}'); - }); - ``` - -3. 启动播放。 - - ``` - var audioSourceMp3 = 'file://test.mp3'; - player.src = audioSourceMp3; - player.loop = true; - ``` - - + player.stop(); + }); + player.on('error', (err) => { + console.error('Player error: ${err.message}'); + }); + ``` + +3. 启动播放。 + ``` + var audioSourceMp3 = 'file://test.mp3'; + player.src = audioSourceMp3; + player.loop = true; + ``` diff --git a/zh-cn/application-dev/media/audio-recorder.md b/zh-cn/application-dev/media/audio-recorder.md index c5262d67f16e999307fc0bfc3deb48fb9f3b4b11..4f08a8fae8ae08644b6a8b8231cd9558c013bb7a 100644 --- a/zh-cn/application-dev/media/audio-recorder.md +++ b/zh-cn/application-dev/media/audio-recorder.md @@ -1,267 +1,120 @@ -# 音频录制开发指导 +# 音频录制开发指导 -- [场景介绍](#section910413166166) -- [接口说明](#section1225204317126) +- [场景介绍](#场景介绍) +- [接口说明](#接口说明) -## 场景介绍 +## 场景介绍 音频录制的主要工作是将音频信号记录并保存下来，同时提供包括采样率、声道数、码率、编码格式、封装格式、文件路径等设置功能。 -## 接口说明 - -**表 1** media - - - - - - - - - - - - - - - - -

接口名

-

描述

-

media.createAudioRecorder()

-

创建AudioRecorder实例。

-

AudioRecorder

-

提供音频录制相关功能。

-

AudioRecorderConfig

-

提供音频录制相关参数设置。

-
- -**表 2** 音频录制相关的interface AudioRecorder - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

接口名

-

描述

-

prepare(config: AudioRecorderConfig): void

-

准备音频录制并设置参数。

-

start(): void

-

开始音频录制。

-

pause(): void

-

暂停音频录制。(暂不支持)

-

resume(): void

-

恢复音频录制。(暂不支持)

-

stop(): void

-

停止音频录制。

-

release(): void

-

释放音频录制资源。

-

reset(): void

-

重置音频录制。

-

on('prepare', function callback)

-

订阅音频录制准备事件。

-

on('start', function callback)

-

订阅音频录制开始事件。

-

on('pause', function callback)

-

订阅音频录制暂停事件。

-

on('resume', function callback)

-

订阅音频录制恢复事件。

-

on('stop',function callback)

-

订阅音频录制结束事件。

-

on('release', function callback)

-

订阅音频录制释放资源事件。

-

on('reset', function callback)

-

订阅音频录制重置事件。

-

on('error', function callback)

-

订阅音频录制错误事件。

-
- -**表 3** 音频录制的相关参数的interface AudioRecorderConfig - - - - - - - - - - - - - - - - - - - - - - - - - -

接口名

-

描述

-

audioEncoder?: AudioEncoder

-

音频编码格式,默认值是AAC_LC。

-

audioEncodeBitRate?: number

-

音频编码的比特率，默认值为48000。

-

audioSampleRate?: number

-

音频编码的采样率，默认值为48000。

-

numberOfChannels?：number

-

音频的声道数，默认值为2。

-

format?: AudioOutputFormat

-

音频的输出格式，默认值是MPEG_4。

-

uri: string

-

音频的输出路径。（file://path 或者 file://fd）

-
- -**表 4** AudioEncoder的相关参数的interface AudioEncoder - - - - - - - - - - -

接口名

-

描述

-

AAC_LC = 3

-

表示AAC_LC编码格式。

-
- -**表 5** 音频输出格式的相关参数的interface AudioOutputFormat - - - - - - - - - - - - - -

接口名

-

描述

-

MPEG_4 = 2

-

表示MPEG_4编码格式。

-

AAC_ADTS= 6

-

表示AAC_ADTS编码格式。

-
- -1. 创建音频录制器。 - - ``` - import media from '@ohos.multimedia.media'; - var recorder = media.createAudioRecorder(); - ``` - -2. 准备音频录制参数。 - - ``` - let audioRecorderConfig = { - audioEncoder : AAC_LC , - audioEncodeBitRate : 22050, - audioSampleRate : 22050, - numberOfChannels : 2, - format : AAC_ADTS, - uri : 'file:///data/accounts/account_0/appdata/appdata/recorder/test.m4a', - } - recorder.prepare(audioRecorderConfig); - ``` - -3. 设置消息订阅事件。 - - ``` - recorder.on('prepare', () => { - console.info('setCallback prepare() case callback is called'); - recorder.start(); - }); - recorder.on('start', () => { - console.info('setCallback start() case callback is called'); - setTimeout(function(){ - recorder.pause(); - }, 10000); // 开始录音10秒后，暂停录音。 - }); - recorder.on('pause', () => { - console.info('setCallback pause() case callback is called'); - setTimeout(function(){ - recorder.resume(); - }, 10000); // 暂停录音10秒后，恢复录音。 - }); - recorder.on('resume', () => { - console.info('setCallback resume() case callback is called'); - setTimeout(function(){ - recorder.stop(); - }, 10000); // 恢复录音10秒后，停止录音。 - }); - recorder.on('stop', () => { - console.info('setCallback stop() case callback is called'); - recorder.release(); - }); - recorder.on('release', () => { - console.info('setCallback release() case callback is called'); - }); - recorder.on('error', (err) => { - console.info(`case error called,errCode is ${err.code}`); - console.info(`case error called,errMessage is ${err.message}`); - recorder.reset(); - }); - ``` - +## 接口说明 + +**表1** media + +| 接口名 | 描述 | +| -------- | -------- | +| media.createAudioRecorder() | 创建AudioRecorder实例。 | +| AudioRecorder | 提供音频录制相关功能。 | +| AudioRecorderConfig | 提供音频录制相关参数设置。 | + +**表2** 音频录制相关的interface **AudioRecorder** + +| 接口名 | 描述 | +| -------- | -------- | +| prepare(config: AudioRecorderConfig): void | 准备音频录制并设置参数。 | +| start(): void | 开始音频录制。 | +| pause(): void | 暂停音频录制。(暂不支持) | +| resume(): void | 恢复音频录制。(暂不支持) | +| stop(): void | 停止音频录制。 | +| release(): void | 释放音频录制资源。 | +| reset(): void | 重置音频录制。 | +| on('prepare', function callback) | 订阅音频录制准备事件。 | +| on('start', function callback) | 订阅音频录制开始事件。 | +| on('pause', function callback) | 订阅音频录制暂停事件。 | +| on('resume', function callback) | 订阅音频录制恢复事件。 | +| on('stop',function callback) | 订阅音频录制结束事件。 | +| on('release', function callback) | 订阅音频录制释放资源事件。 | +| on('reset', function callback) | 订阅音频录制重置事件。 | +| on('error', function callback) | 订阅音频录制错误事件。 | + +**表3** 音频录制的相关参数的interface **AudioRecorderConfig** + +| 接口名 | 描述 | +| -------- | -------- | +| audioEncoder?: AudioEncoder | 音频编码格式,默认值是AAC_LC。 | +| audioEncodeBitRate?: number | 音频编码的比特率，默认值为48000。 | +| audioSampleRate?: number | 音频编码的采样率，默认值为48000。 | +| numberOfChannels?：number | 音频的声道数，默认值为2。 | +| format?: AudioOutputFormat | 音频的输出格式，默认值是MPEG_4。 | +| uri: string | 音频的输出路径。（file://path 或者 file://fd） | + +**表4** AudioEncoder的相关参数的interface **AudioEncoder** + +| 接口名 | 描述 | +| -------- | -------- | +| AAC_LC = 3 | 表示AAC_LC编码格式。 | + +**表5** 音频输出格式的相关参数的interface **AudioOutputFormat** + +| 接口名 | 描述 | +| -------- | -------- | +| MPEG_4 = 2 | 表示MPEG_4编码格式。 | +| AAC_ADTS= 6 | 表示AAC_ADTS编码格式。 | + +1. 创建音频录制器。 + ``` + import media from '@ohos.multimedia.media'; + var recorder = media.createAudioRecorder(); + ``` + +2. 准备音频录制参数。 + ``` + let audioRecorderConfig = { + audioEncoder : AAC_LC , + audioEncodeBitRate : 22050, + audioSampleRate : 22050, + numberOfChannels : 2, + format : AAC_ADTS, + uri : 'file:///data/accounts/account_0/appdata/appdata/recorder/test.m4a', + } + recorder.prepare(audioRecorderConfig); + ``` + +3. 设置消息订阅事件。 + ``` + recorder.on('prepare', () => { + console.info('setCallback prepare() case callback is called'); + recorder.start(); + }); + recorder.on('start', () => { + console.info('setCallback start() case callback is called'); + setTimeout(function(){ + recorder.pause(); + }, 10000); // 开始录音10秒后，暂停录音。 + }); + recorder.on('pause', () => { + console.info('setCallback pause() case callback is called'); + setTimeout(function(){ + recorder.resume(); + }, 10000); // 暂停录音10秒后，恢复录音。 + }); + recorder.on('resume', () => { + console.info('setCallback resume() case callback is called'); + setTimeout(function(){ + recorder.stop(); + }, 10000); // 恢复录音10秒后，停止录音。 + }); + recorder.on('stop', () => { + console.info('setCallback stop() case callback is called'); + recorder.release(); + }); + recorder.on('release', () => { + console.info('setCallback release() case callback is called'); + }); + recorder.on('error', (err) => { + console.info(`case error called,errCode is ${err.code}`); + console.info(`case error called,errMessage is ${err.message}`); + recorder.reset(); + }); + ``` diff --git a/zh-cn/application-dev/media/audio.md b/zh-cn/application-dev/media/audio.md index 6a65ab2c8f643c56f8dca6dafad96ca4ece338af..4ac8b0a4fe3cca49e37cd66a0e617a32a743607a 100644 --- a/zh-cn/application-dev/media/audio.md +++ b/zh-cn/application-dev/media/audio.md @@ -1,11 +1,10 @@ -# 音频 +# 音频 -- **[音频开发概述](audio-overview.md)** -- **[音频播放开发指导](audio-playback.md)** +- **[音频开发概述](audio-overview.md)** -- **[音频管理开发指导](audio-management.md)** - -- **[音频录制开发指导](audio-recorder.md)** +- **[音频播放开发指导](audio-playback.md)** +- **[音频管理开发指导](audio-management.md)** +- **[音频录制开发指导](audio-recorder.md)** \ No newline at end of file diff --git "a/zh-cn/application-dev/media/figures/\351\237\263\351\242\221\346\222\255\346\224\276\347\212\266\346\200\201\346\234\272.png" b/zh-cn/application-dev/media/figures/zh-cn_image_0000001182608857.png old mode 100755 new mode 100644 similarity index 100% rename from "zh-cn/application-dev/media/figures/\351\237\263\351\242\221\346\222\255\346\224\276\347\212\266\346\200\201\346\234\272.png" rename to zh-cn/application-dev/media/figures/zh-cn_image_0000001182608857.png diff --git a/zh-cn/application-dev/media/public_sys-resources/icon-caution.gif b/zh-cn/application-dev/media/public_sys-resources/icon-caution.gif new file mode 100644 index 0000000000000000000000000000000000000000..6e90d7cfc2193e39e10bb58c38d01a23f045d571 Binary files /dev/null and b/zh-cn/application-dev/media/public_sys-resources/icon-caution.gif differ diff --git a/zh-cn/application-dev/media/public_sys-resources/icon-danger.gif b/zh-cn/application-dev/media/public_sys-resources/icon-danger.gif new file mode 100644 index 0000000000000000000000000000000000000000..6e90d7cfc2193e39e10bb58c38d01a23f045d571 Binary files /dev/null and b/zh-cn/application-dev/media/public_sys-resources/icon-danger.gif differ diff --git a/zh-cn/application-dev/media/public_sys-resources/icon-note.gif b/zh-cn/application-dev/media/public_sys-resources/icon-note.gif new file mode 100644 index 0000000000000000000000000000000000000000..6314297e45c1de184204098efd4814d6dc8b1cda Binary files /dev/null and b/zh-cn/application-dev/media/public_sys-resources/icon-note.gif differ diff --git a/zh-cn/application-dev/media/public_sys-resources/icon-notice.gif b/zh-cn/application-dev/media/public_sys-resources/icon-notice.gif new file mode 100644 index 0000000000000000000000000000000000000000..86024f61b691400bea99e5b1f506d9d9aef36e27 Binary files /dev/null and b/zh-cn/application-dev/media/public_sys-resources/icon-notice.gif differ diff --git a/zh-cn/application-dev/media/public_sys-resources/icon-tip.gif b/zh-cn/application-dev/media/public_sys-resources/icon-tip.gif new file mode 100644 index 0000000000000000000000000000000000000000..93aa72053b510e456b149f36a0972703ea9999b7 Binary files /dev/null and b/zh-cn/application-dev/media/public_sys-resources/icon-tip.gif differ diff --git a/zh-cn/application-dev/media/public_sys-resources/icon-warning.gif b/zh-cn/application-dev/media/public_sys-resources/icon-warning.gif new file mode 100644 index 0000000000000000000000000000000000000000..6e90d7cfc2193e39e10bb58c38d01a23f045d571 Binary files /dev/null and b/zh-cn/application-dev/media/public_sys-resources/icon-warning.gif differ diff --git a/zh-cn/application-dev/quick-start/Readme-CN.md b/zh-cn/application-dev/quick-start/Readme-CN.md index dde1c37653905335588ace7ff51a7bcdc1c4b875..ee2c9cdf2ab33a7709abfc3cc4ca0a86a3fb2b1b 100755 --- a/zh-cn/application-dev/quick-start/Readme-CN.md +++ b/zh-cn/application-dev/quick-start/Readme-CN.md @@ -1,17 +1,15 @@ # 入门 -- [DevEco Studio（OpenHarmony）使用指南](deveco-studio-user-guide-for-openharmony.md) - - [概述](deveco-studio-overview.md) - - [版本变更说明](deveco-studio-release-notes.md) - - [配置OpenHarmony SDK](configuring-openharmony-sdk.md) - - [创建OpenHarmony工程](create-openharmony-project.md) - - [使用工程向导创建新工程](use-wizard-to-create-project.md) - - [通过导入Sample方式创建新工程](import-sample-to-create-project.md) - - - [配置OpenHarmony应用签名信息](configuring-openharmony-app-signature.md) - - [安装运行OpenHarmony应用](installing-openharmony-app.md) -- [包结构说明](package-structure.md) -- [快速入门](start.md) - - [开发准备](start-overview.md) - - [使用JS语言开发](start-with-js.md) - +- DevEco Studio（OpenHarmony）使用指南 + - [概述](deveco-studio-overview.md) + - [版本变更说明](deveco-studio-release-notes.md) + - [配置OpenHarmony SDK](configuring-openharmony-sdk.md) + - 创建OpenHarmony工程 + - [使用工程向导创建新工程](use-wizard-to-create-project.md) + - [通过导入Sample方式创建新工程](import-sample-to-create-project.md) + - [配置OpenHarmony应用签名信息](configuring-openharmony-app-signature.md) + - [安装运行OpenHarmony应用](installing-openharmony-app.md) +- [包结构说明](package-structure.md) +- 快速入门 + - [开发准备](start-overview.md) + - [使用JS语言开发](start-with-js.md) diff --git a/zh-cn/application-dev/quick-start/configuring-openharmony-app-signature.md b/zh-cn/application-dev/quick-start/configuring-openharmony-app-signature.md index 2b6c107342a99b5d295b52c64a1564bc9117c94a..a5f9f2811796f18ffc02a57eb6f2433af2b888c8 100644 --- a/zh-cn/application-dev/quick-start/configuring-openharmony-app-signature.md +++ b/zh-cn/application-dev/quick-start/configuring-openharmony-app-signature.md @@ -1,23 +1,26 @@ -# 配置OpenHarmony应用签名信息 +# 配置OpenHarmony应用签名信息 -- [生成密钥和证书请求文件](#section153146467405) -- [生成应用证书文件](#section136609429562) -- [生成应用Profile文件](#section2048641015325) -- [配置应用签名信息](#section10152423193310) +- [生成密钥和证书请求文件](#生成密钥和证书请求文件) +- [生成应用证书文件](#生成应用证书文件) +- [生成应用Profile文件](#生成应用profile文件) +- [配置应用签名信息](#配置应用签名信息) 使用真机设备运行和调试OpenHarmony应用前，需要对应用进行签名才能正常运行。该指导用于OpenHarmony应用的签名配置。除此章节以外，DevEco Studio的其余操作指导无差别，具体请访问[HUAWEI DevEco Studio使用指南](https://developer.harmonyos.com/cn/docs/documentation/doc-guides/tools_overview-0000001053582387)。配置应用签名信息的流程如下图所示。 -![](figures/zh-cn_image_0000001113808114.png) -## 生成密钥和证书请求文件 +![zh-cn_image_0000001113808114](figures/zh-cn_image_0000001113808114.png) + + +## 生成密钥和证书请求文件 OpenHarmony应用通过数字证书（.cer文件）和Profile文件（.p7b文件）来保证应用的完整性，需要通过DevEco Studio来生成密钥文件（.p12文件）和证书请求文件（.csr文件）。同时，也可以使用命令行工具的方式来生成密钥文件和证书请求文件。具体操作请参考[生成密钥和证书请求文件](https://developer.harmonyos.com/cn/docs/documentation/doc-guides/publish_app-0000001053223745#section9752152162813)。 -## 生成应用证书文件 -使用[生成密钥和证书请求文件](#section153146467405)中生成的证书请求文件，来生成应用签名所需的数字证书文件。生成方法如下： +## 生成应用证书文件 -进入DevEco Studio安装目录的**Sdk\\toolchains\\lib**文件夹下（该SDK目录只能是OpenHarmony SDK，配置方法可参考[配置OpenHarmony SDK](configuring-openharmony-sdk.md)），打开命令行工具，执行如下命令（如果keytool命令不能执行，请在系统环境变量中添加JDK的环境变量）。其中，只需要修改输入和输出即可快速生成证书文件，即修改**-infile**指定证书请求文件csr文件路径，**-outfile**指定输出证书文件名及路径。 +使用[生成密钥和证书请求文件](#生成密钥和证书请求文件)中生成的证书请求文件，来生成应用签名所需的数字证书文件。生成方法如下： + +进入DevEco Studio安装目录的 **Sdk\toolchains\lib**文件夹下（该SDK目录只能是OpenHarmony SDK，配置方法可参考[配置OpenHarmony SDK](../quick-start/configuring-openharmony-sdk.md)），打开命令行工具，执行如下命令（如果keytool命令不能执行，请在系统环境变量中添加JDK的环境变量）。其中，只需要修改输入和输出即可快速生成证书文件，即修改 **-infile**指定证书请求文件csr文件路径， **-outfile**指定输出证书文件名及路径。 ``` keytool -gencert -alias "OpenHarmony Application CA" -infile myApplication_ohos.csr -outfile myApplication_ohos.cer -keystore OpenHarmony.p12 -sigalg SHA384withECDSA -storepass 123456 -ext KeyUsage:"critical=digitalSignature" -validity 3650 -rfc @@ -25,21 +28,30 @@ keytool -gencert -alias "OpenHarmony Application CA" -infile myApplication_ohos. 关于该命令的参数说明如下： -- **alias**：用于签发证书的CA私钥别名，OpenHarmony社区CA私钥存于OpenHarmony.p12密钥库文件中，该参数不能修改。 -- **infile**：证书请求（CSR）文件的路径。 -- **outfile**：输出证书链文件名及路径。 -- **keystore**：签发证书的CA密钥库路径，OpenHarmony密钥库文件名为OpenHarmony.p12，文件在OpenHarmony SDK中**Sdk\\toolchains\\lib**路径下，该参数不能修改。请注意，该OpenHarmony.p12文件并不是[生成密钥和证书请求文件](#section153146467405)中生成的.p12文件。 -- **sigalg**：证书签名算法，该参数不能修改。 -- **storepass**：密钥库密码，密码为123456，该参数不能修改。 -- **ext**：证书扩展项，该参数不能修改。 -- **validity**：证书有效期，自定义天数。 -- **rfc**：输出文件格式指定，该参数不能修改。 +- **alias**：用于签发证书的CA私钥别名，OpenHarmony社区CA私钥存于OpenHarmony.p12密钥库文件中，该参数不能修改。 + +- **infile**：证书请求（CSR）文件的路径。 + +- **outfile**：输出证书链文件名及路径。 + +- **keystore**：签发证书的CA密钥库路径，OpenHarmony密钥库文件名为OpenHarmony.p12，文件在OpenHarmony SDK中 **Sdk\toolchains\lib**路径下，该参数不能修改。请注意，该OpenHarmony.p12文件并不是[生成密钥和证书请求文件](#生成密钥和证书请求文件)中生成的.p12文件。 + +- **sigalg**：证书签名算法，该参数不能修改。 + +- **storepass**：密钥库密码，密码为123456，该参数不能修改。 -## 生成应用Profile文件 +- **ext**：证书扩展项，该参数不能修改。 + +- **validity**：证书有效期，自定义天数。 + +- **rfc**：输出文件格式指定，该参数不能修改。 + + +## 生成应用Profile文件 Profile文件包含OpenHarmony应用的包名、数字证书信息、描述应用允许申请的证书权限列表，以及允许应用调试的设备列表（如果应用类型为Release类型，则设备列表为空）等内容，每个应用包中均必须包含一个Profile文件。 -进入**Sdk\\toolchains\\lib**目录下，打开命令行工具，执行如下命令。 +进入 **Sdk\toolchains\lib**目录下，打开命令行工具，执行如下命令。 ``` java -jar provisionsigtool.jar sign --in UnsgnedReleasedProfileTemplate.json --out myApplication_ohos_Provision.p7b --keystore OpenHarmony.p12 --storepass 123456 --alias "OpenHarmony Application Profile Release" --sigAlg SHA256withECDSA --cert OpenHarmonyProfileRelease.pem --validity 365 --developer-id ohosdeveloper --bundle-name 包名 --permission 受限权限名（可选） --permission 受限权限名（可选） --distribution-certificate myApplication_ohos.cer @@ -47,45 +59,62 @@ java -jar provisionsigtool.jar sign --in UnsgnedReleasedProfileTemplate.json --o 关于该命令的参数说明如下： -- **provisionsigtool**：Profile文件生成工具，文件在OpenHarmony SDK的**Sdk\\toolchains\\lib**路径下。 -- **in**：Profile模板文件所在路径，文件在OpenHarmony SDK中**Sdk\\toolchains\\lib**路径下，该参数不能修改。 -- **out**：输出的Profile文件名和路径。 -- **keystore**：签发证书的密钥库路径，OpenHarmony密钥库文件名为OpenHarmony.p12，文件在OpenHarmony SDK中**Sdk\\toolchains\\lib**路径下，该参数不能修改。 -- **storepass**：密钥库密码，密码为123456，该参数不能修改。 -- **alias**：用于签名Profile私钥别名，OpenHarmony社区CA私钥存于OpenHarmony.p12密钥库文件中，该参数不能修改。 -- **sigalg**：证书签名算法，该参数不能修改。 -- **cert**：签名Profile的证书文件路径，文件在OpenHarmony SDK中**Sdk\\toolchains\\lib**路径下，该参数不能修改。 -- **validity**：证书有效期，自定义天数。 -- **developer-id**：开发者标识符，自定义一个字符串。 -- **bundle-name**：填写应用包名。 -- **permission**：可选字段，如果不需要，则可以不用填写此字段；如果需要添加多个受限权限，则如示例所示重复输入。受限权限列表如下：ohos.permission.READ\_CONTACTS、ohos.permission.WRITE\_CONTACTS。 -- **distribution-certificate**：[生成应用证书文件](#section136609429562)中生成的证书文件。 - -## 配置应用签名信息 +- **provisionsigtool**：Profile文件生成工具，文件在OpenHarmony SDK的 **Sdk\toolchains\lib**路径下。 + +- **in**：Profile模板文件所在路径，文件在OpenHarmony SDK中 **Sdk\toolchains\lib**路径下，该参数不能修改。 + +- **out**：输出的Profile文件名和路径。 + +- **keystore**：签发证书的密钥库路径，OpenHarmony密钥库文件名为OpenHarmony.p12，文件在OpenHarmony SDK中 **Sdk\toolchains\lib**路径下，该参数不能修改。 + +- **storepass**：密钥库密码，密码为123456，该参数不能修改。 + +- **alias**：用于签名Profile私钥别名，OpenHarmony社区CA私钥存于OpenHarmony.p12密钥库文件中，该参数不能修改。 + +- **sigalg**：证书签名算法，该参数不能修改。 + +- **cert**：签名Profile的证书文件路径，文件在OpenHarmony SDK中 **Sdk\toolchains\lib**路径下，该参数不能修改。 + +- **validity**：证书有效期，自定义天数。 + +- **developer-id**：开发者标识符，自定义一个字符串。 + +- **bundle-name**：填写应用包名。 + +- **permission**：可选字段，如果不需要，则可以不用填写此字段；如果需要添加多个受限权限，则如示例所示重复输入。受限权限列表如下：ohos.permission.READ_CONTACTS、ohos.permission.WRITE_CONTACTS。 + +- **distribution-certificate**：[生成应用证书文件](#生成应用证书文件)中生成的证书文件。 + + +## 配置应用签名信息 在真机设备上调试前，需要使用到制作的私钥（.p12）文件、证书（.cer）文件和Profile（.p7b）文件对调试的模块进行签名。 -打开**File \> Project Structure**，点击**Project \> Signing Configs \> debug**窗口中，去除勾选“Automatically generate signing”，然后配置指定模块的调试签名信息。 +打开 **File > Project Structure**，点击 **Project > Signing Configs > debug**窗口中，去除勾选“Automatically generate signing”，然后配置指定模块的调试签名信息。 +- **Store File**：选择密钥库文件，文件后缀为.p12，该文件为[生成密钥和证书请求文件](#生成密钥和证书请求文件)中生成的.p12文件。 + +- **Store Password**：输入密钥库密码，该密码为[生成密钥和证书请求文件](#生成密钥和证书请求文件)中填写的密钥库密码保持一致。 + +- **Key Alias**：输入密钥的别名信息，与[生成密钥和证书请求文件](#生成密钥和证书请求文件)中填写的别名保持一致。 -- **Store File**：选择密钥库文件，文件后缀为.p12，该文件为[生成密钥和证书请求文件](#section153146467405)中生成的.p12文件。 -- **Store Password**：输入密钥库密码，该密码为[生成密钥和证书请求文件](#section153146467405)中填写的密钥库密码保持一致。 -- **Key Alias**：输入密钥的别名信息，与[生成密钥和证书请求文件](#section153146467405)中填写的别名保持一致。 -- **Key Password**：输入密钥的密码，与**Store Password**保持一致。 -- **Sign Alg**：签名算法，固定为SHA256withECDSA。 -- **Profile File**：选择[生成应用Profile文件](#section2048641015325)中生成的Profile文件，文件后缀为.p7b。 -- **Certpath File**：选择[生成应用证书文件](#section136609429562)中生成的数字证书文件，文件后缀为.cer。 +- **Key Password**：输入密钥的密码，与 **Store Password**保持一致。 -![](figures/zh-cn_image_0000001155643492.png) +- **Sign Alg**：签名算法，固定为SHA256withECDSA。 -设置完签名信息后，点击**OK**进行保存，然后可以在工程下的build.gradle中查看签名的配置信息。 +- **Profile File**：选择[生成应用Profile文件](#生成应用profile文件)中生成的Profile文件，文件后缀为.p7b。 -![](figures/zh-cn_image_0000001202722349.png) +- **Certpath File**：选择[生成应用证书文件](#生成应用证书文件)中生成的数字证书文件，文件后缀为.cer。 + +![zh-cn_image_0000001155643492](figures/zh-cn_image_0000001155643492.png) + +设置完签名信息后，点击 **OK**进行保存，然后可以在工程下的build.gradle中查看签名的配置信息。 + +![zh-cn_image_0000001202722349](figures/zh-cn_image_0000001202722349.png) 默认情况下，DevEco Studio编译hap包的类型为debug类型，如果需要编译release类型的hap包，请打开工程左下角的OhosBuild Variants，设置模块的编译构建类型为release。关于编译构建hap的详细说明请参考[HUAWEI DevEco Studio使用指南](https://developer.harmonyos.com/cn/docs/documentation/doc-guides/build_hap-0000001053342418)。 -![](figures/zh-cn_image_0000001115066116.png) +![zh-cn_image_0000001115066116](figures/zh-cn_image_0000001115066116.png) 编译完成后，OpenHarmony应用的Hap包可以从工程的bulid目录下获取。 -![](figures/zh-cn_image_0000001163918627.png) - +![zh-cn_image_0000001163918627](figures/zh-cn_image_0000001163918627.png) diff --git a/zh-cn/application-dev/quick-start/configuring-openharmony-sdk.md b/zh-cn/application-dev/quick-start/configuring-openharmony-sdk.md index 7df6f77927e804d2d78b02852a6a23f44f4f68d9..9bdbfd644c6264b938928300c46925032c84125d 100644 --- a/zh-cn/application-dev/quick-start/configuring-openharmony-sdk.md +++ b/zh-cn/application-dev/quick-start/configuring-openharmony-sdk.md @@ -1,193 +1,175 @@ -# 配置OpenHarmony SDK - -- [前提条件](#section164161442154812) -- [配置SDK信息](#section1265592425017) -- [参考信息](#section0384143616409) - - [配置DevEco Studio代理](#section10129720184214) - - [配置NPM代理](#section19984059114316) - - [设置Gradle代理](#section164211820465) +# 配置OpenHarmony SDK +- [前提条件](#前提条件) +- [配置SDK信息](#配置sdk信息) +- [参考信息](#参考信息) + - [配置DevEco Studio代理](#配置deveco-studio代理) + - [配置NPM代理](#配置npm代理) + - [设置Gradle代理](#设置gradle代理) 在设置OpenHarmony应用开发环境时，需要开发者在DevEco Studio中配置对应的SDK信息。 ->![](../public_sys-resources/icon-note.gif) **说明：** ->请注意，OpenHarmony SDK版本精简了部分工具链，因此不适用于HarmonyOS应用开发。 - -## 前提条件 -已下载并安装好DevEco Studio 3.0 Beta1及以上版本，点击[链接下载](https://developer.harmonyos.com/cn/develop/deveco-studio#download)。 - -## 配置SDK信息 +>![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
+>请注意，OpenHarmony SDK版本精简了部分工具链，因此不适用于HarmonyOS应用开发。 -DevEco Studio通过SDK Manager统一管理SDK及工具链，OpenHarmony包含如下SDK包： - - - - - - - - - - - - - - - - - - -

类别

-

包名

-

说明

-

SDK

-

JS

-

JS语言SDK包。

-

SDK Tool

-

Toolchains

-

SDK工具链，OpenHarmony应用开发必备工具集，包括编译、打包、签名、数据库管理等工具的集合。

-

Previewer

-

OpenHarmony应用预览器，可以在应用开发过程中查看界面UI布局效果。

-
+## 前提条件 -1. 运行已安装的DevEco Studio，首次使用，请选择**Do not import settings**，点击OK。 -2. 进入配置向导页面，设置**npm registry**，DevEco Studio已预置对应的仓，直接点击**Start using DevEco Studio**进入下一步。 +已下载并安装好DevEco Studio 3.0 Beta1及以上版本，点击[链接下载](https://developer.harmonyos.com/cn/develop/deveco-studio#download)。 - >![](../public_sys-resources/icon-note.gif) **说明：** - >如果配置向导界面出现的是设置**Set up HTTP Proxy**界面，说明网络受限，请根据[参考信息](#section0384143616409)配置DevEco Studio代理、NPM代理和Gradle代理后，再下载OpenHarmony SDK。 - ![](figures/zh-cn_image_0000001163314102.png) +## 配置SDK信息 -3. DevEco Studio向导指引开发者下载SDK，默认下载OpenHarmony SDK。SDK下载到user目录下，也可以指定对应的存储路径，SDK存储路径不支持中文字符，然后点击**Next**。 +DevEco Studio通过SDK Manager统一管理SDK及工具链，OpenHarmony包含如下SDK包： - ![](figures/zh-cn_image_0000001208394019.png) +| 类别 | 包名 | 说明 | +| -------- | -------- | -------- | +| SDK | JS | JS语言SDK包。 | +| SDK Tool | Toolchains | SDK工具链，OpenHarmony应用开发必备工具集，包括编译、打包、签名、数据库管理等工具的集合。 | +| | Previewer | OpenHarmony应用预览器，可以在应用开发过程中查看界面UI布局效果。 | - >![](../public_sys-resources/icon-note.gif) **说明：** - >如果不是首次安装DevEco Studio，可能无法查看进入该界面，可通过欢迎页的**Configure （或**![](figures/zh-cn_image_0000001208274069.png)**图标）\> Settings \> SDK Manager \> OpenHarmony SDK**界面，点击**OpenHarmony SDK Location**加载SDK。 +1. 运行已安装的DevEco Studio，首次使用，请选择 **Do not import settings**，点击OK。 -4. 在弹出的SDK下载信息页面，点击**Next**，并在弹出的**License Agreement**窗口，点击**Accept**开始下载SDK。 +2. 进入配置向导页面，设置 **npm registry**，DevEco Studio已预置对应的仓，直接点击 **Start using DevEco Studio**进入下一步。 + > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
+ > 如果配置向导界面出现的是设置 **Set up HTTP Proxy**界面，说明网络受限，请根据[参考信息](#参考信息)配置DevEco Studio代理、NPM代理和Gradle代理后，再下载OpenHarmony SDK。 - >![](../public_sys-resources/icon-note.gif) **说明：** - >下载SDK过程中，如果出现下载JS SDK失败，提示“Install js dependencies failed”，请根据[JS SDK安装失败处理指导](https://developer.harmonyos.com/cn/docs/documentation/doc-guides/faq-development-environment-0000001168829643#section1311117111474)进行处理。 + + ![zh-cn_image_0000001163314102](figures/zh-cn_image_0000001163314102.png) - ![](figures/zh-cn_image_0000001163472654.png) +3. DevEco Studio向导指引开发者下载SDK，默认下载OpenHarmony SDK。SDK下载到user目录下，也可以指定对应的存储路径，SDK存储路径不支持中文字符，然后点击 **Next**。 + ![zh-cn_image_0000001208394019](figures/zh-cn_image_0000001208394019.png) -5. 等待OpenHarmony SDK及工具下载完成，点击**Finish**，界面会进入到DevEco Studio欢迎页。 + > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
+ > 如果不是首次安装DevEco Studio，可能无法查看进入该界面，可通过欢迎页的 **Configure （** **或**![zh-cn_image_0000001208274069](figures/zh-cn_image_0000001208274069.png) **图标** **）> Settings > SDK Manager > OpenHarmony SDK**界面，点击 **OpenHarmony SDK Location**加载SDK。 - ![](figures/zh-cn_image_0000001163632602.png) +4. 在弹出的SDK下载信息页面，点击 **Next**，并在弹出的 **License Agreement**窗口，点击 **Accept**开始下载SDK。 + + + > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
+ > 下载SDK过程中，如果出现下载JS SDK失败，提示“Install js dependencies failed”，请根据[JS SDK安装失败处理指导](https://developer.harmonyos.com/cn/docs/documentation/doc-guides/faq-development-environment-0000001168829643#section1311117111474)进行处理。 + + + ![zh-cn_image_0000001163472654](figures/zh-cn_image_0000001163472654.png) + +5. 等待OpenHarmony SDK及工具下载完成，点击 **Finish**，界面会进入到DevEco Studio欢迎页。 + ![zh-cn_image_0000001163632602](figures/zh-cn_image_0000001163632602.png) -## 参考信息 +## 参考信息 DevEco Studio开发环境需要依赖于网络环境，需要连接上网络才能确保工具的正常使用。 一般来说，如果使用的是个人或家庭网络，是不需要设置代理信息的；只有部分企业网络受限的情况下，才需要设置代理信息。 -如果是第一次打开DevEco Studio，配置向导界面出现设置**Set up HTTP Proxy**界面，说明网络受限，可以通过配置代理的方式来解决，需要配置DevEco Studio代理、NPM代理和Gradle代理。 - -![](figures/zh-cn_image_0000001123021842.png) - -### 配置DevEco Studio代理 - -1. 启动DevEco Studio，配置向导进入**Set up HTTP Proxy**界面，勾选**Manual proxy configuration**，设置DevEco Studio的HTTP Proxy。 - - >![](../public_sys-resources/icon-note.gif) **说明：** - >如果非首次设置向导进入HTTP Proxy，可以通过如下方式进入HTTP Proxy配置界面： - >- 在欢迎页点击**Configure（或**![](figures/zh-cn_image_0000001122862128.png)**图标） \> Settings \> Appearance & Behavior \> System Settings \> HTTP Proxy**进入HTTP Proxy设置界面（Mac系统为**Configure \> Preferences \> Appearance & Behavior \> System Settings \> HTTP Proxy**）。 - >- 在打开了工程的情况下，可以点击**File \> Settings \> Appearance & Behavior \> System Settings \> HTTP Proxy**进入HTTP Proxy设置界面（Mac系统为**DevEco Studio \> Preferences \> Appearance & Behavior \> System Settings \> HTTP Proxy**） +如果是第一次打开DevEco Studio，配置向导界面出现设置 **Set up HTTP Proxy**界面，说明网络受限，可以通过配置代理的方式来解决，需要配置DevEco Studio代理、NPM代理和Gradle代理。 - - **HTTP**配置项，设置代理服务器信息。**如果不清楚代理服务器信息，可以咨询你们的网络管理人员**。 - - **Host name**：代理服务器主机名或IP地址。 - - **Port number**：代理服务器对应的端口号。 - - **No proxy for**：不需要通过代理服务器访问的URL或者IP地址（地址之间用英文逗号分隔）。 +![zh-cn_image_0000001166582138](figures/zh-cn_image_0000001166582138.png) - - **Proxy authentication**配置项，如果代理服务器需要通过认证鉴权才能访问，则需要设置。否则，请跳过该配置项。 - - **Login**：访问代理服务器的用户名。 - - **Password**：访问代理服务器的密码。 - - **Remember**：勾选，记住密码。 - ![](figures/zh-cn_image_0000001123021962.png) +### 配置DevEco Studio代理 -2. 配置完成后，点击**Check connection**，输入网络地址（如：https://developer.harmonyos.com），检查网络连通性。提示“Connection successful“表示代理设置成功。 -3. 点击**Next: Configure npm**继续设置NPM代理信息，请参考[配置NPM代理](#section19984059114316)。 +1. 启动DevEco Studio，配置向导进入 **Set up HTTP Proxy**界面，勾选 **Manual proxy configuration**，设置DevEco Studio的HTTP Proxy。 + > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
+ > 如果非首次设置向导进入HTTP Proxy，可以通过如下方式进入HTTP Proxy配置界面： + > + > - 在欢迎页点击 **Configure（或**![zh-cn_image_0000001212142015](figures/zh-cn_image_0000001212142015.png) **图标） > Settings > Appearance & Behavior > System Settings > HTTP Proxy**进入HTTP Proxy设置界面（Mac系统为 **Configure > Preferences > Appearance & Behavior > System Settings > HTTP Proxy**)。 + > + > - 在打开了工程的情况下，可以点击 **File > Settings > Appearance & Behavior > System Settings > HTTP Proxy**进入HTTP Proxy设置界面（Mac系统为 **DevEco Studio > Preferences > Appearance & Behavior > System Settings > HTTP Proxy**） -### 配置NPM代理 + - **HTTP**配置项，设置代理服务器信息。 **如果不清楚代理服务器信息，可以咨询你们的网络管理人员**。 + - **Host name**：代理服务器主机名或IP地址。 + - **Port number**：代理服务器对应的端口号。 + - **No proxy for**：不需要通过代理服务器访问的URL或者IP地址（地址之间用英文逗号分隔）。 + - **Proxy authentication**配置项，如果代理服务器需要通过认证鉴权才能访问，则需要设置。否则，请跳过该配置项。 + - **Login**：访问代理服务器的用户名。 + - **Password**：访问代理服务器的密码。 + - **Remember**：勾选，记住密码。 + ![zh-cn_image_0000001212062065](figures/zh-cn_image_0000001212062065.png) -通过DevEco Studio的设置向导设置NPM代理信息，代理信息将写入用户“users/用户名/”目录下的**.npmrc**文件。 +2. 配置完成后，点击 **Check connection**，输入网络地址（如：https://developer.harmonyos.com），检查网络连通性。提示Connection successful表示代理设置成功。 ->![](../public_sys-resources/icon-note.gif) **说明：** ->该向导只有第一次安装DevEco Studio才会出现。如果未出现该向导，可以直接在“users/用户名/”目录下的**.npmrc**文件中，添加代理配置信息。 +3. 点击 **Next: Configure npm**继续设置NPM代理信息，请参考[配置NPM代理](#配置npm代理)。 -- npm registry：设置npm仓的地址信息，建议勾选。 -- HTTP proxy：代理服务器信息，默认会与DevEco Studio的HTTP proxy设置项保持一致。 -- Enable Https Proxy：同步设置HTTPS Proxy配置信息，建议勾选。 -![](figures/zh-cn_image_0000001164577336.png) +### 配置NPM代理 -然后点击**Start using DevEco Studio**继续下一步操作。 +通过DevEco Studio的设置向导设置NPM代理信息，代理信息将写入用户“users/用户名/”目录下的 **.npmrc**文件。 +> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
+> 该向导只有第一次安装DevEco Studio才会出现。如果未出现该向导，可以直接在“users/用户名/”目录下的 **.npmrc**文件中，添加代理配置信息。 -如果代理服务器需要认证（需要用户名和密码），请先根据如下指导配置代理服务器的用户名和密码信息，然后再下载OpenHarmony SDK；否则，请跳过该操作，参考[配置SDK信息](#section1265592425017)进行操作即可。 +- npm registry：设置npm仓的地址信息，建议勾选。 -![](figures/zh-cn_image_0000001209817299.png) +- HTTP proxy：代理服务器信息，默认会与DevEco Studio的HTTP proxy设置项保持一致。 -1. 进入用户的users目录，打开**.npmrc**文件。 -2. 修改npm代理信息，在proxy和https-proxy中，增加user和password字段，具体取值请以实际代理信息为准。示例如下所示： +- Enable Https Proxy：同步设置HTTPS Proxy配置信息，建议勾选。 - ``` - proxy=http://user:password@proxy.server.com:80 - https-proxy=http://user:password@proxy.server.com:80 - ``` +![zh-cn_image_0000001164577336](figures/zh-cn_image_0000001164577336.png) - >![](../public_sys-resources/icon-note.gif) **说明：** - >如果password中存在特殊字符，如@、\#、\*等符号，可能导致配置不生效，建议将特殊字符替换为ASCII码，并在ASCII码前加百分号%。常用符号替换为ASCII码对照表如下： - >- !：%21 - >- @：%40 - >- \#：%23 - >- ￥：%24 - >- &：%26 - >- \*：%2A +然后点击 **Start using DevEco Studio**继续下一步操作。 -3. 代理设置完成后，打开命令行工具，执行如下命令进行验证网络是否正常。 +如果代理服务器需要认证（需要用户名和密码），请先根据如下指导配置代理服务器的用户名和密码信息，然后再下载OpenHarmony SDK；否则，请跳过该操作，参考[配置SDK信息](#配置sdk信息)进行操作即可。 - ``` - npm info express - ``` +![zh-cn_image_0000001209817299](figures/zh-cn_image_0000001209817299.png) - 执行结果如下图所示，则说明代理设置成功。 +1. 进入用户的users目录，打开 **.npmrc**文件。 - ![](figures/zh-cn_image_0000001164417356.png) +2. 修改npm代理信息，在proxy和https-proxy中，增加user和password字段，具体取值请以实际代理信息为准。示例如下所示： + ``` + proxy=http://user:password@proxy.server.com:80 + https-proxy=http://user:password@proxy.server.com:80 + ``` -4. 网络设置完成后，然后再[配置SDK信息](#section1265592425017)。 + > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
+ > 如果password中存在特殊字符，如\@、\#、\*等符号，可能导致配置不生效，建议将特殊字符替换为ASCII码，并在ASCII码前加百分号%。常用符号替换为ASCII码对照表如下： + > + > - !：%21 + > + > - \@：%40 + > + > - \#：%23 + > + > - ￥：%24 + > + > - &：%26 + > + > - \*：%2A -### 设置Gradle代理 +3. 代理设置完成后，打开命令行工具，执行如下命令进行验证网络是否正常。 + ``` + npm info express + ``` -1. 打开“此电脑”，在文件夹地址栏中输入**%userprofile%**（Mac系统请点击**前往 \> 个人**），进入个人用户文件夹。 + 执行结果如下图所示，则说明代理设置成功。 - ![](figures/zh-cn_image_0000001123024482.png) + ![zh-cn_image_0000001164417356](figures/zh-cn_image_0000001164417356.png) -2. 创建一个文件夹，命名为**.gradle**。如果已有.gradle文件夹，请跳过此操作。 +4. 网络设置完成后，然后再[配置SDK信息](#配置sdk信息)。 - >![](../public_sys-resources/icon-note.gif) **说明：** - >macOS系统创建.gradle文件夹前，请将系统设置为“显示隐藏文件”。 -3. 进入.gradle文件夹，新建一个文本文档，命名为**gradle**，并修改后缀为**.properties**。 -4. 打开**gradle.properties**文件中，添加如下脚本，然后保存。 +### 设置Gradle代理 - 其中代理服务器、端口、用户名、密码和不使用代理的域名，请根据实际代理情况进行修改。其中不使用代理的“nonProxyHosts“的配置间隔符是 “|”。 +1. 打开“此电脑”，在文件夹地址栏中输入 **%userprofile%**（Mac系统请点击 **前往 > 个人**），进入个人用户文件夹。 + ![zh-cn_image_0000001166740700](figures/zh-cn_image_0000001166740700.png) - ``` - systemProp.http.proxyHost=proxy.server.com - systemProp.http.proxyPort=8080 - systemProp.http.nonProxyHosts=*.company.com|10.*|100.* - systemProp.http.proxyUser=userId - systemProp.http.proxyPassword=password - systemProp.https.proxyHost=proxy.server.com - systemProp.https.proxyPort=8080 - systemProp.https.nonProxyHosts=*.company.com|10.*|100.* - systemProp.https.proxyUser=userId - systemProp.https.proxyPassword=password - ``` +2. 创建一个文件夹，命名为 **.gradle**。如果已有.gradle文件夹，请跳过此操作。 + > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
+ > macOS系统创建.gradle文件夹前，请将系统设置为“显示隐藏文件”。 +3. 进入.gradle文件夹，新建一个文本文档，命名为 **gradle**，并修改后缀为 **.properties**。 +4. 打开 **gradle.properties**文件中，添加如下脚本，然后保存。 + 其中代理服务器、端口、用户名、密码和不使用代理的域名，请根据实际代理情况进行修改。其中不使用代理的nonProxyHosts的配置间隔符是 “|”。 + ``` + systemProp.http.proxyHost=proxy.server.com + systemProp.http.proxyPort=8080 + systemProp.http.nonProxyHosts=*.company.com|10.*|100.* + systemProp.http.proxyUser=userId + systemProp.http.proxyPassword=password + systemProp.https.proxyHost=proxy.server.com + systemProp.https.proxyPort=8080 + systemProp.https.nonProxyHosts=*.company.com|10.*|100.* + systemProp.https.proxyUser=userId + systemProp.https.proxyPassword=password + ``` diff --git a/zh-cn/application-dev/quick-start/create-openharmony-project.md b/zh-cn/application-dev/quick-start/create-openharmony-project.md index 2ba5f2d1ba897a3fefec48b40aa67df8ead2eaa4..106f04c687954ea3df849d6a1ccaf8ee6acb930d 100644 --- a/zh-cn/application-dev/quick-start/create-openharmony-project.md +++ b/zh-cn/application-dev/quick-start/create-openharmony-project.md @@ -1,7 +1,6 @@ -# 创建OpenHarmony工程 +# 创建OpenHarmony工程 -- **[使用工程向导创建新工程](use-wizard-to-create-project.md)** - -- **[通过导入Sample方式创建新工程](import-sample-to-create-project.md)** +- **[使用工程向导创建新工程](use-wizard-to-create-project.md)** +- **[通过导入Sample方式创建新工程](import-sample-to-create-project.md)** \ No newline at end of file diff --git a/zh-cn/application-dev/quick-start/deveco-studio-overview.md b/zh-cn/application-dev/quick-start/deveco-studio-overview.md index 40d3d26d1cb4ba6facda1e7826e64de25c19d9bb..9c22a824ee5172c6cbfdbb6e1baaba0b6240e625 100644 --- a/zh-cn/application-dev/quick-start/deveco-studio-overview.md +++ b/zh-cn/application-dev/quick-start/deveco-studio-overview.md @@ -1,100 +1,48 @@ -# 概述 +# 概述 -- [总体说明](#section189422248491) -- [使用约束](#section65191625782) -- [DevEco Studio演进路标](#section187875207166) +- [总体说明](#总体说明) +- [使用约束](#使用约束) +- [DevEco Studio演进路标](#deveco-studio演进路标) -## 总体说明 +## 总体说明 -DevEco Studio是HarmonyOS的配套的开发IDE，因为HarmonyOS是基于OpenHarmony开发的，因此，使用DevEco Studio（配套HarmonyOS）也可以进行OpenHarmony的应用开发。 +DevEco Studio 是 HarmonyOS 的配套的开发 IDE ，因为HarmonyOS 是基于OpenHarmony 开发的，因此，使用 DevEco Studio （配套 HarmonyOS ）也可以进行 OpenHarmony 的应用开发。 使用DevEco Studio开发OpenHarmony应用的流程与开发HarmonyOS的流程完全一样，本文档仅描述OpenHarmony应用开发与HarmonyOS应用开发的差异点。 -- **搭建开发环境差异**：OpenHarmony应用开发环境需要先安装OpenHarmony SDK，具体可参考[配置OpenHarmony SDK](configuring-openharmony-sdk.md)章节。 -- **导入OpenHarmony工程**：OpenHarmony应用开发，只能通过导入Sample工程的方式来创建一个新工程，具体可参考[通过导入Sample方式创建新工程](import-sample-to-create-project.md)。 -- **调试签名配置**：OpenHarmony应用运行在真机设备上，需要对应用进行签名，关于OpenHarmony应用的签名指导请参考[配置OpenHarmony应用签名信息](configuring-openharmony-app-signature.md)。 -- **在真机设备上运行应用**：需要使用hdc工具将OpenHarmony的hap包推送到真机设备上进行安装，具体可参考[安装运行OpenHarmony应用](installing-openharmony-app.md)。 +- **搭建开发环境差异**：OpenHarmony应用开发环境需要先安装OpenHarmony SDK，具体可参考[配置OpenHarmony SDK](../quick-start/configuring-openharmony-sdk.md)章节。 + +- **导入OpenHarmony工程**：OpenHarmony应用开发，只能通过导入Sample工程的方式来创建一个新工程，具体可参考[通过导入Sample方式创建新工程](../quick-start/import-sample-to-create-project.md)。 + +- **调试签名配置**：OpenHarmony应用运行在真机设备上，需要对应用进行签名，关于OpenHarmony应用的签名指导请参考[配置OpenHarmony应用签名信息](../quick-start/configuring-openharmony-app-signature.md)。 + +- **在真机设备上运行应用**：需要使用hdc工具将OpenHarmony的hap包推送到真机设备上进行安装，具体可参考[安装运行OpenHarmony应用](../quick-start/installing-openharmony-app.md)。 关于DevEco Studio的详细操作指导，请访问[HUAWEI DevEco Studio使用指南](https://developer.harmonyos.com/cn/docs/documentation/doc-guides/tools_overview-0000001053582387)。 -## 使用约束 -- OpenHarmony只支持使用JS语言开发应用，不支持Java、C/C++语言。 -- OpenHarmony开发环境DevEco Studio暂只支持Windows系统。 +## 使用约束 + +- OpenHarmony只支持使用JS语言开发应用，不支持Java、C/C++语言。 + +- OpenHarmony开发环境DevEco Studio暂只支持Windows系统。 OpenHarmony与HarmonyOS的开发工具都是DevEco Studio，下表为OpenHarmony相比HarmonyOS不支持的功能说明： - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

特性名称

-

HarmonyOS版本

-

OpenHarmony版本

-

创建Module

-

√

-

X

-

服务卡片

-

√

-

X

-

自动化签名

-

√

-

X

-

远程模拟器

-

√

-

X

-

本地模拟器

-

√

-

X

-

使用DevEco Studio运行调试、日志查看、调优

-

√

-

X

-

云测试

-

√

-

X

-

安全测试

-

√

-

X

-
- -## DevEco Studio演进路标 +| 特性名称 | HarmonyOS版本 | OpenHarmony版本 | +| -------- | -------- | -------- | +| 创建Module | **√** | **X** | +| 服务卡片 | **√** | **X** | +| 自动化签名 | **√** | **X** | +| 远程模拟器 | **√** | **X** | +| 本地模拟器 | **√** | **X** | +| 使用DevEco Studio运行调试、日志查看、调优 | **√** | **X** | +| 云测试 | **√** | **X** | +| 安全测试 | **√** | **X** | -Huawei DevEco Studio分阶段支持OpenHarmony应用开发的演进路标如下： -![](figures/zh-cn_image_0000001210018359.png) +## DevEco Studio演进路标 + +Huawei DevEco Studio分阶段支持OpenHarmony应用开发的演进路标如下： +![zh-cn_image_0000001210018359](figures/zh-cn_image_0000001210018359.png) diff --git a/zh-cn/application-dev/quick-start/deveco-studio-release-notes.md b/zh-cn/application-dev/quick-start/deveco-studio-release-notes.md index d37efb01603bf6f5013348585979ea90019434ee..d0bd3eb6e1c15625a37a47e348e47e61f3ada07c 100644 --- a/zh-cn/application-dev/quick-start/deveco-studio-release-notes.md +++ b/zh-cn/application-dev/quick-start/deveco-studio-release-notes.md @@ -1,15 +1,9 @@ -# 版本变更说明 +# 版本变更说明 -- [V3.0 Beta1（2021-09-29）](#section21092033115018) +- [V3.0 Beta1（2021-09-29）](#v3-0-beta1-2021-09-29-) -## V3.0 Beta1（2021-09-29） - - - - -
新增特性：
  • 新增支持OpenHarmony SDK的管理，开发者可通过DevEco Studio的SDK Manager功能来下载和管理OpenHarmony SDK。
  • 在编译构建HAP包时，新增支持对单个Module进行编译，对于多Module工程中只需要编译其中一个Module的场景，可以提升编译构建速度；同时还新增支持一键重构建HAP包，即在编译构建HAP前，会自动执行Clean Project操作。
-
-
增强特性：
  • 编译构建插件更新至3.0.3.2版本。
  • Json编辑器增强，资源索引错误支持快速修复，并支持快速查看资源的取值。
  • 工程视图支持Ohos视图，默认视图为Project视图，开发者可手动切换。
  • OpenHarmony工程支持ark方舟编译。
  • OpenHarmony工程类型标识字段supportSystem "standard"，由模块级build.gradle调整至工程级build.gradle。
-
-
+## V3.0 Beta1（2021-09-29） +| | +| -------- | +|  **新增特性：**
- 新增支持OpenHarmony SDK的管理，开发者可通过DevEco Studio的SDK Manager功能来下载和管理OpenHarmony SDK。
- 在编译构建HAP包时，新增支持对单个Module进行编译，对于多Module工程中只需要编译其中一个Module的场景，可以提升编译构建速度；同时还新增支持一键重构建HAP包，即在编译构建HAP前，会自动执行Clean Project操作。
 **增强特性：**
- 编译构建插件更新至3.0.3.2版本。
- Json编辑器增强，资源索引错误支持快速修复，并支持快速查看资源的取值。
- 工程视图支持Ohos视图，默认视图为Project视图，开发者可手动切换。
- OpenHarmony工程支持ark方舟编译。
- OpenHarmony工程类型标识字段supportSystem "standard"，由模块级build.gradle调整至工程级build.gradle。 | diff --git a/zh-cn/application-dev/quick-start/deveco-studio-user-guide-for-openharmony.md b/zh-cn/application-dev/quick-start/deveco-studio-user-guide-for-openharmony.md index 53fda8d36d321a96cc7a8f0ca1cf273fd001058f..2afa5a6c8bcfc6d79f7a5671a7f04ec8999679f8 100644 --- a/zh-cn/application-dev/quick-start/deveco-studio-user-guide-for-openharmony.md +++ b/zh-cn/application-dev/quick-start/deveco-studio-user-guide-for-openharmony.md @@ -1,15 +1,14 @@ -# DevEco Studio（OpenHarmony）使用指南 +# DevEco Studio（OpenHarmony）使用指南 -- **[概述](deveco-studio-overview.md)** -- **[版本变更说明](deveco-studio-release-notes.md)** +- **[概述](deveco-studio-overview.md)** -- **[配置OpenHarmony SDK](configuring-openharmony-sdk.md)** +- **[版本变更说明](deveco-studio-release-notes.md)** -- **[创建OpenHarmony工程](create-openharmony-project.md)** +- **[配置OpenHarmony SDK](configuring-openharmony-sdk.md)** -- **[配置OpenHarmony应用签名信息](configuring-openharmony-app-signature.md)** - -- **[安装运行OpenHarmony应用](installing-openharmony-app.md)** +- **[创建OpenHarmony工程](create-openharmony-project.md)** +- **[配置OpenHarmony应用签名信息](configuring-openharmony-app-signature.md)** +- **[安装运行OpenHarmony应用](installing-openharmony-app.md)** \ No newline at end of file diff --git a/zh-cn/application-dev/quick-start/figures/1-0.png b/zh-cn/application-dev/quick-start/figures/1-0.png deleted file mode 100644 index 7ff0d06f4af8d0cfe137995d5c37c661cff3887c..0000000000000000000000000000000000000000 Binary files a/zh-cn/application-dev/quick-start/figures/1-0.png and /dev/null differ diff --git a/zh-cn/application-dev/quick-start/figures/page-ability-lifecycle-callbacks.png b/zh-cn/application-dev/quick-start/figures/page-ability-lifecycle-callbacks.png deleted file mode 100644 index 4c94556b5c2516ad2978a9a31d833cfb2cf3dd01..0000000000000000000000000000000000000000 Binary files a/zh-cn/application-dev/quick-start/figures/page-ability-lifecycle-callbacks.png and /dev/null differ diff --git a/zh-cn/application-dev/quick-start/figures/page-ability-lifecycle.png b/zh-cn/application-dev/quick-start/figures/page-ability-lifecycle.png deleted file mode 100644 index d4fff2a49bf103cb5d8763f271c847fc1b711723..0000000000000000000000000000000000000000 Binary files a/zh-cn/application-dev/quick-start/figures/page-ability-lifecycle.png and /dev/null differ diff --git a/zh-cn/application-dev/quick-start/figures/zh-cn_image_0000001123021842.png b/zh-cn/application-dev/quick-start/figures/zh-cn_image_0000001166582138.png similarity index 100% rename from zh-cn/application-dev/quick-start/figures/zh-cn_image_0000001123021842.png rename to zh-cn/application-dev/quick-start/figures/zh-cn_image_0000001166582138.png diff --git a/zh-cn/application-dev/quick-start/figures/zh-cn_image_0000001123024482.png b/zh-cn/application-dev/quick-start/figures/zh-cn_image_0000001166740700.png similarity index 100% rename from zh-cn/application-dev/quick-start/figures/zh-cn_image_0000001123024482.png rename to zh-cn/application-dev/quick-start/figures/zh-cn_image_0000001166740700.png diff --git a/zh-cn/application-dev/quick-start/figures/zh-cn_image_0000001166744640.png b/zh-cn/application-dev/quick-start/figures/zh-cn_image_0000001166744640.png new file mode 100644 index 0000000000000000000000000000000000000000..469ca774dde99530329d5e7bd62a5a40fb16237b Binary files /dev/null and b/zh-cn/application-dev/quick-start/figures/zh-cn_image_0000001166744640.png differ diff --git a/zh-cn/application-dev/quick-start/figures/3.png b/zh-cn/application-dev/quick-start/figures/zh-cn_image_0000001166904552.png old mode 100755 new mode 100644 similarity index 100% rename from zh-cn/application-dev/quick-start/figures/3.png rename to zh-cn/application-dev/quick-start/figures/zh-cn_image_0000001166904552.png diff --git a/zh-cn/application-dev/quick-start/figures/2.png b/zh-cn/application-dev/quick-start/figures/zh-cn_image_0000001166904582.png old mode 100755 new mode 100644 similarity index 100% rename from zh-cn/application-dev/quick-start/figures/2.png rename to zh-cn/application-dev/quick-start/figures/zh-cn_image_0000001166904582.png diff --git a/zh-cn/application-dev/quick-start/figures/zh-cn_image_0000001123021962.png b/zh-cn/application-dev/quick-start/figures/zh-cn_image_0000001212062065.png similarity index 100% rename from zh-cn/application-dev/quick-start/figures/zh-cn_image_0000001123021962.png rename to zh-cn/application-dev/quick-start/figures/zh-cn_image_0000001212062065.png diff --git a/zh-cn/application-dev/quick-start/figures/1.png b/zh-cn/application-dev/quick-start/figures/zh-cn_image_0000001212066021.png old mode 100755 new mode 100644 similarity index 100% rename from zh-cn/application-dev/quick-start/figures/1.png rename to zh-cn/application-dev/quick-start/figures/zh-cn_image_0000001212066021.png diff --git a/zh-cn/application-dev/quick-start/figures/zh-cn_image_0000001122862128.png b/zh-cn/application-dev/quick-start/figures/zh-cn_image_0000001212142015.png similarity index 100% rename from zh-cn/application-dev/quick-start/figures/zh-cn_image_0000001122862128.png rename to zh-cn/application-dev/quick-start/figures/zh-cn_image_0000001212142015.png diff --git a/zh-cn/application-dev/quick-start/import-sample-to-create-project.md b/zh-cn/application-dev/quick-start/import-sample-to-create-project.md index 1c031207ad2c7f6cb0775dbaf9cf4b13aafd32db..ee58adb947117571b3ace15a07860b87455d1d61 100644 --- a/zh-cn/application-dev/quick-start/import-sample-to-create-project.md +++ b/zh-cn/application-dev/quick-start/import-sample-to-create-project.md @@ -1,33 +1,26 @@ -# 通过导入Sample方式创建新工程 +# 通过导入Sample方式创建新工程 ->![](../public_sys-resources/icon-note.gif) **说明：** ->该功能适用于通过DevEco Studio 2.1 Release及以上版本，创建OpenHarmony工程。 +> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** +> 该功能适用于通过DevEco Studio 2.1 Release及以上版本，创建OpenHarmony工程。 -OpenHarmony SDK配置完成后，便可以启动应用开发。针对OpenHarmony应用开发，**可以通过导入Sample工程的方式来创建一个新工程**。 -1. 在DevEco Studio的欢迎页，进入**Configure （或**![](figures/zh-cn_image_0000001118018452.png)**图标） \> Settings \> Version Control \> Git**界面，点击Test按钮检测是否安装Git工具。 - - 已安装，请根据[2](#li5947194711181)开始导入Sample。 +OpenHarmony SDK配置完成后，便可以启动应用开发。针对OpenHarmony应用开发， **可以通过导入Sample工程的方式来创建一个新工程**。 - ![](figures/zh-cn_image_0000001118018088.png) - - 未安装，请点击**Download and Install**，DevEco Studio会自动下载并安装。安装完成后，请根据[2](#li5947194711181)开始导入Sample。 +1. 在DevEco Studio的欢迎页，进入 **Configure （** **或**![zh-cn_image_0000001118018452](figures/zh-cn_image_0000001118018452.png) **图标** **） > Settings > Version Control > Git**界面，点击Test按钮检测是否安装Git工具。 + - 已安装，请根据**步骤2**开始导入Sample。 + ![zh-cn_image_0000001118018088](figures/zh-cn_image_0000001118018088.png) + - 未安装，请点击 **Download and Install**，DevEco Studio会自动下载并安装。安装完成后，请根据**步骤2**开始导入Sample。 + ![zh-cn_image_0000001164498191](figures/zh-cn_image_0000001164498191.png) - ![](figures/zh-cn_image_0000001164498191.png) +2. 在DevEco Studio的欢迎页，点击 **Import Sample**按钮，导入Sample工程。 + ![zh-cn_image_0000001208006117](figures/zh-cn_image_0000001208006117.png) -2. 在DevEco Studio的欢迎页，点击**Import Sample**按钮，导入Sample工程。 - - ![](figures/zh-cn_image_0000001208006117.png) - -3. 选择OpenHarmony Samples \> common下的**JsHelloWorld**工程，然后点击**Next**。 - - ![](figures/zh-cn_image_0000001152459178.png) - -4. 设置**App Name**和**Project Location**，然后点击**Finish**，等待Sample工程导入完成。 - - ![](figures/zh-cn_image_0000001207744539.png) - -5. 等待工程同步完成，同步成功后，便可以进行OpenHarmony应用开发了。 - - ![](figures/zh-cn_image_0000001163915523.png) +3. 选择OpenHarmony Samples > common下的 **JsHelloWorld**工程，然后点击 **Next**。 + ![zh-cn_image_0000001152459178](figures/zh-cn_image_0000001152459178.png) +4. 设置 **App Name**和 **Project Location**，然后点击 **Finish**，等待Sample工程导入完成。 + ![zh-cn_image_0000001207744539](figures/zh-cn_image_0000001207744539.png) +5. 等待工程同步完成，同步成功后，便可以进行OpenHarmony应用开发了。 + ![zh-cn_image_0000001163915523](figures/zh-cn_image_0000001163915523.png) diff --git a/zh-cn/application-dev/quick-start/installing-openharmony-app.md b/zh-cn/application-dev/quick-start/installing-openharmony-app.md index 8e921c8ce2fe0e2e5b97ef1dd8073cd92250569b..d7ece1e0766c046ab77b76938eef3153fcedc19f 100644 --- a/zh-cn/application-dev/quick-start/installing-openharmony-app.md +++ b/zh-cn/application-dev/quick-start/installing-openharmony-app.md @@ -1,41 +1,41 @@ -# 安装运行OpenHarmony应用 +# 安装运行OpenHarmony应用 安装OpenHarmony应用需要使用hdc工具，通过手动执行命令行完成应用的安装。 -hdc工具本身需要手动从开源仓中获取。然后使用工具将编译后的hap包发送至设备侧，然后通过hdc命令完成app的安装。 -相关命令如下： +hdc工具本身需要手动从开源仓中获取。然后使用工具将编译后的hap包发送至设备侧，然后通过hdc命令完成app的安装。 -- 文件发送命令 - **file send _localpath remotepath_** +相关命令如下： - 命令示例： - ``` - hdc_std file send E:\hwadmin.hap /data/local/tmp/hwadmin.hap - ``` +- 文件发送命令 + **file send *localpath remotepath*** -- 安装命令 + 命令示例： - **install \[-r/-d/-g\] _package_** + ``` + hdc_std file send E:\hwadmin.hap /data/local/tmp/hwadmin.hap + ``` - 命令示例： +- 安装命令 + **install [-r/-d/-g] *package*** - ``` - hdc_std install hwadmin.hap - ``` + 命令示例： -- 日志抓取命令 + ``` + hdc_std install hwadmin.hap + ``` - **hilog** +- 日志抓取命令 + **hilog** - 命令示例： + 命令示例： - ``` - hdc_std hilog - ``` + ``` + hdc_std hilog + ``` -完整的hdc工具使用指导及命令格式请参见开源仓“docs/zh-cn/device-dev/subsystems/hdc使用指导.md“。 +完整的hdc工具使用指导及命令格式请参见开源仓”docs/zh-cn/device-dev/subsystems/hdc使用指导.md“。 diff --git a/zh-cn/application-dev/quick-start/package-structure.md b/zh-cn/application-dev/quick-start/package-structure.md index 94c83987ac62055ee5a990bf83f18c995ddc354e..21eb8417d4debb4a85e61def0734714a568b0964 100644 --- a/zh-cn/application-dev/quick-start/package-structure.md +++ b/zh-cn/application-dev/quick-start/package-structure.md @@ -1,9 +1,11 @@ -# 包结构说明 +# 包结构说明 在应用开发的工程中，需要在config.json配置文件中对应用的包结构进行声明。 + 配置文件示例如下： + ``` { "app": { @@ -67,9 +69,12 @@ } ``` + **包结构声明需要注意以下约束：** -- "package"字段命名要保证在相同bundleName的应用内唯一。 -- "abilities"字段下只能声明一个ability。 -- "abilities"字段中ability的"name"字段命名要保证在相同bundleName的应用内唯一。 +- "package"字段命名要保证在相同bundleName的应用内唯一。 + +- "abilities"字段下只能声明一个ability。 + +- "abilities"字段中ability的"name"字段命名要保证在相同bundleName的应用内唯一。 diff --git a/zh-cn/application-dev/quick-start/public_sys-resources/icon-caution.gif b/zh-cn/application-dev/quick-start/public_sys-resources/icon-caution.gif new file mode 100644 index 0000000000000000000000000000000000000000..6e90d7cfc2193e39e10bb58c38d01a23f045d571 Binary files /dev/null and b/zh-cn/application-dev/quick-start/public_sys-resources/icon-caution.gif differ diff --git a/zh-cn/application-dev/quick-start/public_sys-resources/icon-danger.gif b/zh-cn/application-dev/quick-start/public_sys-resources/icon-danger.gif new file mode 100644 index 0000000000000000000000000000000000000000..6e90d7cfc2193e39e10bb58c38d01a23f045d571 Binary files /dev/null and b/zh-cn/application-dev/quick-start/public_sys-resources/icon-danger.gif differ diff --git a/zh-cn/application-dev/quick-start/public_sys-resources/icon-note.gif b/zh-cn/application-dev/quick-start/public_sys-resources/icon-note.gif new file mode 100644 index 0000000000000000000000000000000000000000..6314297e45c1de184204098efd4814d6dc8b1cda Binary files /dev/null and b/zh-cn/application-dev/quick-start/public_sys-resources/icon-note.gif differ diff --git a/zh-cn/application-dev/quick-start/public_sys-resources/icon-notice.gif b/zh-cn/application-dev/quick-start/public_sys-resources/icon-notice.gif new file mode 100644 index 0000000000000000000000000000000000000000..86024f61b691400bea99e5b1f506d9d9aef36e27 Binary files /dev/null and b/zh-cn/application-dev/quick-start/public_sys-resources/icon-notice.gif differ diff --git a/zh-cn/application-dev/quick-start/public_sys-resources/icon-tip.gif b/zh-cn/application-dev/quick-start/public_sys-resources/icon-tip.gif new file mode 100644 index 0000000000000000000000000000000000000000..93aa72053b510e456b149f36a0972703ea9999b7 Binary files /dev/null and b/zh-cn/application-dev/quick-start/public_sys-resources/icon-tip.gif differ diff --git a/zh-cn/application-dev/quick-start/public_sys-resources/icon-warning.gif b/zh-cn/application-dev/quick-start/public_sys-resources/icon-warning.gif new file mode 100644 index 0000000000000000000000000000000000000000..6e90d7cfc2193e39e10bb58c38d01a23f045d571 Binary files /dev/null and b/zh-cn/application-dev/quick-start/public_sys-resources/icon-warning.gif differ diff --git a/zh-cn/application-dev/quick-start/start-overview.md b/zh-cn/application-dev/quick-start/start-overview.md index 664004226b280c51e68ec9487fd0083a573697cd..85d00dcd6ceb9390f4557529f4fec8d24176b62e 100644 --- a/zh-cn/application-dev/quick-start/start-overview.md +++ b/zh-cn/application-dev/quick-start/start-overview.md @@ -1,23 +1,26 @@ -# 开发准备 +# 开发准备 -- [任务说明](#section2073881513322) -- [开发准备](#section11843205017326) +- [任务说明](#任务说明) +- [开发准备](#开发准备) -## 任务说明 +## 任务说明 本文档适用于OpenHarmony应用开发的初学者。通过构建一个简单的具有页面跳转功能的应用（如下图[预览器](https://developer.harmonyos.com/cn/docs/documentation/doc-guides/previewer-0000001054328973#ZH-CN_TOPIC_0000001056725592__section16523172216252)运行效果所示），熟悉OpenHarmony应用开发流程。 -为确保运行效果，请使用最新版本的**DevEco Studio**完成本任务，点击[此处](https://developer.harmonyos.com/cn/develop/deveco-studio#download)获取下载链接。 +为确保运行效果，请使用最新版本的 **DevEco Studio**完成本任务，点击[此处](https://developer.harmonyos.com/cn/develop/deveco-studio#download)获取下载链接。 -![](figures/3.png) +![zh-cn_image_0000001166904552](figures/zh-cn_image_0000001166904552.png) -## 开发准备 -1. 开始前请参考[配置OpenHarmony SDK](configuring-openharmony-sdk.md)，完成**DevEco Studio**的安装和开发环境配置。 -2. 开发环境配置完成后，请参考[创建OpenHarmony工程](use-wizard-to-create-project.md)创建工程。 - - 使用JS语言开发，模板选择“Empty Ability“，Language选择Js。 -3. 工程创建完成后，使用[预览器](https://developer.harmonyos.com/cn/docs/documentation/doc-guides/previewer-0000001054328973#ZH-CN_TOPIC_0000001056725592__section16523172216252)或[模拟器](https://developer.harmonyos.com/cn/docs/documentation/doc-guides/run_simulator-0000001053303709)运行该工程。 +## 开发准备 -完成上述操作后，请参考[使用JS语言开发](start-with-js.md)继续下一步的学习。 +1. 开始前请参考[配置OpenHarmony SDK](../quick-start/configuring-openharmony-sdk.md)，完成 **DevEco Studio**的安装和开发环境配置。 +2. 开发环境配置完成后，请参考[创建OpenHarmony工程](../quick-start/use-wizard-to-create-project.md)创建工程。 + - 使用JS语言开发，模板选择Empty Ability，Language选择Js。 + + +3. 工程创建完成后，使用[预览器](https://developer.harmonyos.com/cn/docs/documentation/doc-guides/previewer-0000001054328973#ZH-CN_TOPIC_0000001056725592__section16523172216252)或[模拟器](https://developer.harmonyos.com/cn/docs/documentation/doc-guides/run_simulator-0000001053303709)运行该工程。 + +完成上述操作后，请参考[使用JS语言开发](../quick-start/start-with-js.md)继续下一步的学习。 diff --git a/zh-cn/application-dev/quick-start/start-with-js.md b/zh-cn/application-dev/quick-start/start-with-js.md index e11af482e9896327cd6e6e0c5b06a4694747d7a8..4565f0f8789bedd85e24a0dc294c22c59c71f0cc 100644 --- a/zh-cn/application-dev/quick-start/start-with-js.md +++ b/zh-cn/application-dev/quick-start/start-with-js.md @@ -1,112 +1,106 @@ -# 使用JS语言开发 - -- [编写第一个页面](#section17436202895811) -- [创建另一个页面](#section944219415598) -- [实现页面跳转](#section126857614017) - -## 编写第一个页面 - -1. 第一个页面内有一个文本和一个按钮，通过text和button组件来实现。 - - 在“Project“窗口，选择“entry \> src \> main \> js \> default \> pages \> index“，打开“index.hml“文件，添加一个文本和一个按钮，示例代码如下： - - ``` - -
- - - Hello World - - - -
- ``` - -2. 打开“index.css“文件，设置文本和按钮的样式，示例代码如下： - - ``` - /* index.css */ - .container { - flex-direction: column; /* 设置容器内的项目纵向排列 */ - justify-content: center; /* 设置项目位于容器主轴的中心 */ - align-items: center; /* 项目在交叉轴居中 */ - } - /* 对class="text"的组件设置样式 */ - .text{ - font-size: 42px; - } - /* 对class="button"的组件设置样式 */ - .button { - width: 240px; - height: 60px; - background-color: #007dff; - font-size: 30px; - text-color: white; - margin-top: 20px; - } - ``` - -3. 使用[预览器](https://developer.harmonyos.com/cn/docs/documentation/doc-guides/previewer-0000001054328973#ZH-CN_TOPIC_0000001056725592__section16523172216252)或[模拟器](https://developer.harmonyos.com/cn/docs/documentation/doc-guides/run_simulator-0000001053303709)运行项目，效果如下图所示： - - ![](figures/1.png) - - -## 创建另一个页面 - -1. 在“Project“窗口，打开“entry \> src \> main \> js \> default“，右键点击“pages“文件夹，选择“New \> JS Page“，命名为“details“，单击回车键。 - - 创建完成后，可以看到“pages.index“文件夹下的文件目录结构如下： - - ![](figures/1-0.png) - -2. 打开“details.hml“文件，添加一个文本，示例代码如下： - - ``` - -
- - Hi there - -
- ``` - -3. 打开“details.css“文件，设置文本的样式，示例代码如下： - - ``` - /* details.css */ - .container { - flex-direction: column; - justify-content: center; - align-items: center; - } - .text { - font-size: 42px; - text-align: center; - } - ``` - - -## 实现页面跳转 - -1. 打开第一个页面的“index.js“文件，导入router模块，页面路由router根据页面的uri来找到目标页面，从而实现跳转。示例代码如下： - - ``` - // index.js - import router from '@system.router'; - - export default { - launch() { - router.push ({ - uri:'pages/index/details/details', // 指定要跳转的页面 - }) - } - } - ``` - -2. 再次使用[预览器](https://developer.harmonyos.com/cn/docs/documentation/doc-guides/previewer-0000001054328973#ZH-CN_TOPIC_0000001056725592__section16523172216252)或[模拟器](https://developer.harmonyos.com/cn/docs/documentation/doc-guides/run_simulator-0000001053303709)运行项目，效果如下图所示： - - ![](figures/2.png) - +# 使用JS语言开发 + +- [编写第一个页面](#编写第一个页面) +- [创建另一个页面](#创建另一个页面) +- [实现页面跳转](#实现页面跳转) + +## 编写第一个页面 + +1. 第一个页面内有一个文本和一个按钮，通过text和button组件来实现。 + 在 “Project“窗口，选择“entry > src > mainjsdefaultpages > index”，打开”index.hml“文件，添加一个文本和一个按钮，示例代码如下： + + ``` + +
+ + + Hello World + + + +
+ ``` + +2. 打开“index.css”文件，设置文本和按钮的样式，示例代码如下： + ``` + /* index.css */ + .container { + flex-direction: column; /* 设置容器内的项目纵向排列 */ + justify-content: center; /* 设置项目位于容器主轴的中心 */ + align-items: center; /* 项目在交叉轴居中 */ + width:100%; + height:100%; + } + /* 对class="text"的组件设置样式 */ + .text{ + font-size: 42px; + } + /* 对class="button"的组件设置样式 */ + .button { + width: 240px; + height: 60px; + background-color: #007dff; + font-size: 30px; + text-color: white; + margin-top: 20px; + } + ``` + +3. 使用[预览器](https://developer.harmonyos.com/cn/docs/documentation/doc-guides/previewer-0000001054328973#ZH-CN_TOPIC_0000001056725592__section16523172216252)或[模拟器](https://developer.harmonyos.com/cn/docs/documentation/doc-guides/run_simulator-0000001053303709)运行项目，效果如下图所示： + ![zh-cn_image_0000001212066021](figures/zh-cn_image_0000001212066021.png) + + +## 创建另一个页面 + +1. 在 “Project“窗口，打开“entry > src > mainjsdefault”，右键点击“pages”文件夹，选择“New > JS Page”，命名为“details”，单击回车键。 + 创建完成后，可以看到pages文件夹下的文件目录结构如下： + + ![zh-cn_image_0000001166744640](figures/zh-cn_image_0000001166744640.png) + +2. 打开“details.hml”文件，添加一个文本，示例代码如下： + ``` + +
+ + Hi there + +
+ ``` + +3. 打开“details.css”文件，设置文本的样式，示例代码如下： + ``` + /* details.css */ + .container { + flex-direction: column; + justify-content: center; + align-items: center; + width:100%; + height:100%; + } + .text { + font-size: 42px; + text-align: center; + } + ``` + + +## 实现页面跳转 + +1. 打开第一个页面的“index.js”文件，导入router模块，页面路由router根据页面的uri来找到目标页面，从而实现跳转。示例代码如下： + ``` + // index.js + import router from '@system.router'; + + export default { + launch() { + router.push ({ + uri:'pages/details/details', // 指定要跳转的页面 + }) + } + } + ``` + +2. 再次使用[预览器](https://developer.harmonyos.com/cn/docs/documentation/doc-guides/previewer-0000001054328973#ZH-CN_TOPIC_0000001056725592__section16523172216252)或[模拟器](https://developer.harmonyos.com/cn/docs/documentation/doc-guides/run_simulator-0000001053303709)运行项目，效果如下图所示： + ![zh-cn_image_0000001166904582](figures/zh-cn_image_0000001166904582.png) 恭喜你，至此已成功完成OpenHarmony快速入门-使用JS语言开发。 - diff --git a/zh-cn/application-dev/quick-start/start.md b/zh-cn/application-dev/quick-start/start.md index a667e2decf0e677089d2eaaf5f26fb986ba4be0a..f48551a3206f044d676d12b3777ec23d2e37bce7 100644 --- a/zh-cn/application-dev/quick-start/start.md +++ b/zh-cn/application-dev/quick-start/start.md @@ -1,7 +1,7 @@ -# 快速入门 +# 快速入门 -- **[开发准备](start-overview.md)** -- **[使用JS语言开发](start-with-js.md)** +- **[开发准备](start-overview.md)** +- **[使用JS语言开发](start-with-js.md)** diff --git a/zh-cn/application-dev/quick-start/use-wizard-to-create-project.md b/zh-cn/application-dev/quick-start/use-wizard-to-create-project.md index d3013d019cef8c60b064ea5b0aff80b26b9cca4e..e3c9fa6ee67a275257702654e530e76cc3b4340f 100644 --- a/zh-cn/application-dev/quick-start/use-wizard-to-create-project.md +++ b/zh-cn/application-dev/quick-start/use-wizard-to-create-project.md @@ -1,46 +1,45 @@ -# 使用工程向导创建新工程 +# 使用工程向导创建新工程 -- [前提条件](#section13642104391619) -- [操作步骤](#section132671712101714) +- [前提条件](#前提条件) +- [操作步骤](#操作步骤) -通过工程向导创建一个OpenHarmony工程，该功能只有DevEco Studio 2.2 Beta1及以上版本支持。如果是DevEco Studio 2.1 Release版本，请根据[通过导入Sample方式创建新工程](import-sample-to-create-project.md)进行操作。 +通过工程向导创建一个OpenHarmony工程，该功能只有DevEco Studio 2.2 Beta1及以上版本支持。如果是DevEco Studio 2.1 Release版本，请根据[通过导入Sample方式创建新工程](../quick-start/import-sample-to-create-project.md)进行操作。 -## 前提条件 -已安装OpenHarmony SDK，具体请参考[配置OpenHarmony SDK](configuring-openharmony-sdk.md)。 +## 前提条件 -## 操作步骤 +已安装OpenHarmony SDK，具体请参考[配置OpenHarmony SDK](../quick-start/configuring-openharmony-sdk.md)。 -1. 通过如下两种方式，打开工程创建向导界面。 - - 如果当前未打开任何工程，可以在DevEco Studio的欢迎页，选择**Create Project**开始创建一个新工程。 - - 如果已经打开了工程，可以在菜单栏选择**File \> New \> New Project**来创建一个新工程。 -2. 根据工程创建向导，选择**\[Standard\]Empty Ability**模板，点击**Next**。 +## 操作步骤 - ![](figures/zh-cn_image_0000001162463400.png) +1. 通过如下两种方式，打开工程创建向导界面。 + - 如果当前未打开任何工程，可以在DevEco Studio的欢迎页，选择 **Create Project**开始创建一个新工程。 + - 如果已经打开了工程，可以在菜单栏选择 **File > New > New Project**来创建一个新工程。 -3. 点击**Next**，进入到工程配置阶段，需要根据向导配置工程的基本信息。 - - **Project Name**：工程的名称，可以自定义。 - - **Project Type**：工程的类型，标识该工程是一个[原子化服务](https://developer.harmonyos.com/cn/docs/documentation/doc-guides/atomic-service-definition-0000001090840664)（Service）或传统方式的需要安装的应用（Application）。 +2. 根据工程创建向导，选择 **[Standard]Empty Ability**模板，点击 **Next**。 + ![zh-cn_image_0000001162463400](figures/zh-cn_image_0000001162463400.png) - >![](../public_sys-resources/icon-note.gif) **说明：** - >如果是创建的原子化服务，则： - >- 原子化服务调试、运行时，在设备桌面上没有应用图标，请使用DevEco Studio的调试和运行功能，来启动原子化服务。 - >- 原子化服务是免安装的，config.json中自动添加**installationFree**字段，取值为“true”。 - >- 如果entry模块的**installationFree**字段为true，则其相关的所有hap模块的**installationFree**字段都默认为true；如果entry模块的**installationFree**字段为false，则其相关的所有hap模块可以配置为true或false。 - >- 编译构建App时，每个hap包大小不能超过10MB。 - - - **Package Name**：软件包名称，默认情况下，应用ID也会使用该名称，应用发布时，应用ID需要唯一。 - - **Save Location**：工程文件本地存储路径。 - - **Compatible API Version**：兼容的SDK最低版本。 - - >![](../public_sys-resources/icon-note.gif) **说明：** - >OpenHarmony工程如果配置了compileSdkVersion 7以上，对应模块默认使用方舟编译器进行编译，如果要修改编译方式为非方舟编译，在模块级build.gradle的**ohos**闭包中添加**arkEnable false**字段。 - - - **Language：**支持的开发语言。 - - **Device Type**：该工程模板支持的设备类型。 - - ![](figures/zh-cn_image_0000001208210505.png) - -4. 点击**Finish**，工具会自动生成示例代码和相关资源，等待工程创建完成。 +3. 点击 **Next**，进入到工程配置阶段，需要根据向导配置工程的基本信息。 + - **Project Name**：工程的名称，可以自定义。 + - **Project Type**：工程的类型，标识该工程是一个[原子化服务](https://developer.harmonyos.com/cn/docs/documentation/doc-guides/atomic-service-definition-0000001090840664)（Service）或传统方式的需要安装的应用（Application）。 + > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
+ > 如果是创建的原子化服务，则： + > + > - 原子化服务调试、运行时，在设备桌面上没有应用图标，请使用DevEco Studio的调试和运行功能，来启动原子化服务。 + > + > - 原子化服务是免安装的，config.json中自动添加 **installationFree**字段，取值为“true”。 + > + > - 如果entry模块的 **installationFree**字段为true，则其相关的所有hap模块的 **installationFree**字段都默认为true；如果entry模块的 **installationFree**字段为false，则其相关的所有hap模块可以配置为true或false。 + > + > - 编译构建App时，每个hap包大小不能超过10MB。 + - **Package Name**：软件包名称，默认情况下，应用ID也会使用该名称，应用发布时，应用ID需要唯一。 + - **Save Location**：工程文件本地存储路径。 + - **Compatible API Version**：兼容的SDK最低版本。 + > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
+ > OpenHarmony工程如果配置了compileSdkVersion 7以上，对应模块默认使用方舟编译器进行编译，如果要修改编译方式为非方舟编译，在模块级build.gradle的 **ohos**闭包中添加 **arkEnable false**字段。 + - **Language**：支持的开发语言。 + - **Device Type**：该工程模板支持的设备类型。
+ ![zh-cn_image_0000001208210505](figures/zh-cn_image_0000001208210505.png) +4. 点击 **Finish**，工具会自动生成示例代码和相关资源，等待工程创建完成。 diff --git a/zh-cn/application-dev/ui/Readme-CN.md b/zh-cn/application-dev/ui/Readme-CN.md index fec0a247e1b29395920f531ee5b52bf584f3a220..17013f840646b2e9f7009457609d2570654002c6 100755 --- a/zh-cn/application-dev/ui/Readme-CN.md +++ b/zh-cn/application-dev/ui/Readme-CN.md @@ -1,19 +1,17 @@ # UI - - [JS UI框架](ui-js.md) - - [JS UI框架概述](ui-js-overview.md) - - [构建用户界面](ui-js-building-ui.md) - - [组件介绍](ui-js-building-ui-component.md) - - [构建布局](ui-js-building-ui-layout.md) - - [布局说明](ui-js-building-ui-layout-intro.md) - - [添加标题行和文本区域](ui-js-building-ui-layout-text.md) - - [添加图片区域](ui-js-building-ui-layout-image.md) - - [添加留言区域](ui-js-building-ui-layout-comment.md) - - [添加容器](ui-js-building-ui-layout-external-container.md) - - - [添加交互](ui-js-building-ui-interactions.md) - - [动画](ui-js-building-ui-animation.md) - - [事件](ui-js-building-ui-event.md) - - [页面路由](ui-js-building-ui-routes.md) - - - [自定义组件](ui-js-custom-components.md) +- JS UI框架 + - [JS UI框架概述](ui-js-overview.md) + - 构建用户界面 + - [组件介绍](ui-js-building-ui-component.md) + - 构建布局 + - [布局说明](ui-js-building-ui-layout-intro.md) + - [添加标题行和文本区域](ui-js-building-ui-layout-text.md) + - [添加图片区域](ui-js-building-ui-layout-image.md) + - [添加留言区域](ui-js-building-ui-layout-comment.md) + - [添加容器](ui-js-building-ui-layout-external-container.md) + - [添加交互](ui-js-building-ui-interactions.md) + - [动画](ui-js-building-ui-animation.md) + - [事件](ui-js-building-ui-event.md) + - [页面路由](ui-js-building-ui-routes.md) + - [自定义组件](ui-js-custom-components.md) diff --git a/zh-cn/application-dev/ui/figures/zh-cn_image_0000001077953992.png b/zh-cn/application-dev/ui/figures/zh-cn_image_0000001166426358.png similarity index 100% rename from zh-cn/application-dev/ui/figures/zh-cn_image_0000001077953992.png rename to zh-cn/application-dev/ui/figures/zh-cn_image_0000001166426358.png diff --git "a/zh-cn/application-dev/ui/figures/\351\241\265\351\235\242\345\270\203\345\261\200\345\210\206\350\247\243.png" b/zh-cn/application-dev/ui/figures/zh-cn_image_0000001166426374.png old mode 100755 new mode 100644 similarity index 100% rename from "zh-cn/application-dev/ui/figures/\351\241\265\351\235\242\345\270\203\345\261\200\345\210\206\350\247\243.png" rename to zh-cn/application-dev/ui/figures/zh-cn_image_0000001166426374.png diff --git "a/zh-cn/application-dev/ui/figures/\345\233\276\347\211\2073.png" b/zh-cn/application-dev/ui/figures/zh-cn_image_0000001166586348.png old mode 100755 new mode 100644 similarity index 100% rename from "zh-cn/application-dev/ui/figures/\345\233\276\347\211\2073.png" rename to zh-cn/application-dev/ui/figures/zh-cn_image_0000001166586348.png diff --git "a/zh-cn/application-dev/ui/figures/\350\277\236\347\273\255\345\212\250\347\224\273\346\225\210\346\236\234\345\233\276.gif" b/zh-cn/application-dev/ui/figures/zh-cn_image_0000001166744904.gif old mode 100755 new mode 100644 similarity index 100% rename from "zh-cn/application-dev/ui/figures/\350\277\236\347\273\255\345\212\250\347\224\273\346\225\210\346\236\234\345\233\276.gif" rename to zh-cn/application-dev/ui/figures/zh-cn_image_0000001166744904.gif diff --git "a/zh-cn/application-dev/ui/figures/\351\241\265\351\235\242\350\267\257\347\224\261\346\225\210\346\236\234.png" b/zh-cn/application-dev/ui/figures/zh-cn_image_0000001166904852.png old mode 100755 new mode 100644 similarity index 100% rename from "zh-cn/application-dev/ui/figures/\351\241\265\351\235\242\350\267\257\347\224\261\346\225\210\346\236\234.png" rename to zh-cn/application-dev/ui/figures/zh-cn_image_0000001166904852.png diff --git a/zh-cn/application-dev/ui/figures/zh-cn_image_0000001212066259.png b/zh-cn/application-dev/ui/figures/zh-cn_image_0000001212066259.png new file mode 100644 index 0000000000000000000000000000000000000000..bf7c20aab02bcf3a56d95c43913778c447066295 Binary files /dev/null and b/zh-cn/application-dev/ui/figures/zh-cn_image_0000001212066259.png differ diff --git "a/zh-cn/application-dev/ui/figures/\351\235\231\346\200\201\345\212\250\347\224\273\346\225\210\346\236\234\345\233\276.png" b/zh-cn/application-dev/ui/figures/zh-cn_image_0000001212066279.png old mode 100755 new mode 100644 similarity index 100% rename from "zh-cn/application-dev/ui/figures/\351\235\231\346\200\201\345\212\250\347\224\273\346\225\210\346\236\234\345\233\276.png" rename to zh-cn/application-dev/ui/figures/zh-cn_image_0000001212066279.png diff --git a/zh-cn/application-dev/ui/figures/zan.gif b/zh-cn/application-dev/ui/figures/zh-cn_image_0000001212146221.gif old mode 100755 new mode 100644 similarity index 100% rename from zh-cn/application-dev/ui/figures/zan.gif rename to zh-cn/application-dev/ui/figures/zh-cn_image_0000001212146221.gif diff --git "a/zh-cn/application-dev/ui/figures/\350\207\252\345\256\232\344\271\211\347\273\204\344\273\266\347\232\204\346\225\210\346\236\234.png" b/zh-cn/application-dev/ui/figures/zh-cn_image_0000001212146243.png old mode 100755 new mode 100644 similarity index 100% rename from "zh-cn/application-dev/ui/figures/\350\207\252\345\256\232\344\271\211\347\273\204\344\273\266\347\232\204\346\225\210\346\236\234.png" rename to zh-cn/application-dev/ui/figures/zh-cn_image_0000001212146243.png diff --git a/zh-cn/application-dev/ui/public_sys-resources/icon-caution.gif b/zh-cn/application-dev/ui/public_sys-resources/icon-caution.gif new file mode 100644 index 0000000000000000000000000000000000000000..6e90d7cfc2193e39e10bb58c38d01a23f045d571 Binary files /dev/null and b/zh-cn/application-dev/ui/public_sys-resources/icon-caution.gif differ diff --git a/zh-cn/application-dev/ui/public_sys-resources/icon-danger.gif b/zh-cn/application-dev/ui/public_sys-resources/icon-danger.gif new file mode 100644 index 0000000000000000000000000000000000000000..6e90d7cfc2193e39e10bb58c38d01a23f045d571 Binary files /dev/null and b/zh-cn/application-dev/ui/public_sys-resources/icon-danger.gif differ diff --git a/zh-cn/application-dev/ui/public_sys-resources/icon-note.gif b/zh-cn/application-dev/ui/public_sys-resources/icon-note.gif new file mode 100644 index 0000000000000000000000000000000000000000..6314297e45c1de184204098efd4814d6dc8b1cda Binary files /dev/null and b/zh-cn/application-dev/ui/public_sys-resources/icon-note.gif differ diff --git a/zh-cn/application-dev/ui/public_sys-resources/icon-notice.gif b/zh-cn/application-dev/ui/public_sys-resources/icon-notice.gif new file mode 100644 index 0000000000000000000000000000000000000000..86024f61b691400bea99e5b1f506d9d9aef36e27 Binary files /dev/null and b/zh-cn/application-dev/ui/public_sys-resources/icon-notice.gif differ diff --git a/zh-cn/application-dev/ui/public_sys-resources/icon-tip.gif b/zh-cn/application-dev/ui/public_sys-resources/icon-tip.gif new file mode 100644 index 0000000000000000000000000000000000000000..93aa72053b510e456b149f36a0972703ea9999b7 Binary files /dev/null and b/zh-cn/application-dev/ui/public_sys-resources/icon-tip.gif differ diff --git a/zh-cn/application-dev/ui/public_sys-resources/icon-warning.gif b/zh-cn/application-dev/ui/public_sys-resources/icon-warning.gif new file mode 100644 index 0000000000000000000000000000000000000000..6e90d7cfc2193e39e10bb58c38d01a23f045d571 Binary files /dev/null and b/zh-cn/application-dev/ui/public_sys-resources/icon-warning.gif differ diff --git a/zh-cn/application-dev/ui/ui-js-building-ui-animation.md b/zh-cn/application-dev/ui/ui-js-building-ui-animation.md index 6fa473789fa3b692f0beb2b35652a86d66717402..2a472cdc9b6779132a457f01bb94319db55d8912 100755 --- a/zh-cn/application-dev/ui/ui-js-building-ui-animation.md +++ b/zh-cn/application-dev/ui/ui-js-building-ui-animation.md @@ -1,17 +1,20 @@ -# 动画 +# 动画 -- [静态动画](#section456613911492) -- [连续动画](#section17836125204914) +- [静态动画](#静态动画) +- [连续动画](#连续动画) -动画分为[静态动画](#section456613911492)和[连续动画](#section17836125204914)。 +动画分为[静态动画](#静态动画)和[连续动画](#连续动画)。 -## 静态动画 + +## 静态动画 静态动画的核心是transform样式，主要可以实现以下三种变换类型，一次样式设置只能实现一种类型变换。 -- **translate**：沿水平或垂直方向将指定组件移动所需距离。 -- **scale**：横向或纵向将指定组件缩小或放大到所需比例。 -- **rotate**：将指定组件沿横轴或纵轴或中心点旋转指定的角度。 +- **translate**：沿水平或垂直方向将指定组件移动所需距离。 + +- **scale**：横向或纵向将指定组件缩小或放大到所需比例。 + +- **rotate**：将指定组件沿横轴或纵轴或中心点旋转指定的角度。 具体的使用示例如下。 @@ -54,20 +57,26 @@ } ``` -**图 1** 静态动画效果图 -![](figures/静态动画效果图.png "静态动画效果图") -## 连续动画 +**图1** 静态动画效果图
+![zh-cn_image_0000001212066279](figures/zh-cn_image_0000001212066279.png) + + +## 连续动画 静态动画只有开始状态和结束状态，没有中间状态，如果需要设置中间的过渡状态和转换效果，需要使用连续动画实现。 连续动画的核心是animation样式，它定义了动画的开始状态、结束状态以及时间和速度的变化曲线。通过animation样式可以实现的效果有： -- **animation-name**：设置动画执行后应用到组件上的背景颜色、透明度、宽高和变换类型。 -- **animation-delay**和**animation-duration**：分别设置动画执行后元素延迟和持续的时间。 -- **animation-timing-function**：描述动画执行的速度曲线，使动画更加平滑。 -- **animation-iteration-count**：定义动画播放的次数。 -- **animation-fill-mode**：指定动画执行结束后是否恢复初始状态。 +- **animation-name**：设置动画执行后应用到组件上的背景颜色、透明度、宽高和变换类型。 + +- **animation-delay**和 **animation-duration**：分别设置动画执行后元素延迟和持续的时间。 + +- **animation-timing-function**：描述动画执行的速度曲线，使动画更加平滑。 + +- **animation-iteration-count**：定义动画播放的次数。 + +- **animation-fill-mode**：指定动画执行结束后是否恢复初始状态。 animation样式需要在css文件中先定义keyframe，在keyframe中设置动画的过渡效果，并通过一个样式类型在hml文件中调用。animation-name的使用示例如下： @@ -150,6 +159,6 @@ export default { } ``` -**图 2** 连续动画效果图 -![](figures/连续动画效果图.gif "连续动画效果图") +**图2** 连续动画效果图
+![zh-cn_image_0000001166744904](figures/zh-cn_image_0000001166744904.gif) diff --git a/zh-cn/application-dev/ui/ui-js-building-ui-component.md b/zh-cn/application-dev/ui/ui-js-building-ui-component.md index d67645103dcc5552d637517559b35e75321e0cc3..49d2a1ef3f2024b1f8e41924c63fc3ba907085ea 100755 --- a/zh-cn/application-dev/ui/ui-js-building-ui-component.md +++ b/zh-cn/application-dev/ui/ui-js-building-ui-component.md @@ -1,35 +1,21 @@ -# 组件介绍 +# 组件介绍 -- [组件分类](#section154381954142018) +- [组件分类](#组件分类) -组件（Component）是构建页面的核心，每个组件通过对数据和方法的简单封装，实现独立的可视、可交互功能单元。组件之间相互独立，随取随用，也可以在需求相同的地方重复使用。 +组件（Component）是构建页面的核心，每个组件通过对数据和方法的简单封装，实现独立的可视、可交互功能单元。组件之间相互独立，随取随用，也可以在需求相同的地方重复使用。关于组件的详细参考文档请参见[组件](../js-reference/component/Readme-CN.md)。 -## 组件分类 +开发者还可以通过组件间合理的搭配定义满足业务需求的新组件，减少开发量，自定义组件的开发方法请参见[自定义组件](../js-reference/component/js-components-custom.md)。 + +## 组件分类 根据组件的功能，可以分为以下四大类： - - - - - - - - - - - - - - - -

组件类型

-

主要组件

-

基础组件

-

text、image、progress、rating、span、marquee、image-animator、divider、search、menu、chart

-

容器组件

-

div、list、list-item、stack、swiper、tabs、tab-bar、tab-content、list-item-group、refresh、dialog

-

画布组件

-

canvas

-
+| 组件类型 | 主要组件 | +| -------- | -------- | +| 基础组件 | button、chart、divider、image、image-animator、input、label、marquee、menu、option、picker、picker-view、piece、progress、qrcode、rating、richtext、search、select、slider、span、switch、text、textarea、toolbar、toolbar-item、toggle | +| 容器组件 | badge、dialog、div、form、list、list-item、list-item-group、panel、popup、refresh、stack、stepper、stepper-item、swiper、tabs、tab-bar、tab-content | +|媒体组件|video| +| 画布组件 | canvas | +|栅格组件|grid-container、grid-row、grid-col| +|svg组件|svg、rect、circle、ellipse、path、line、polyline、polygon、text、tspan、textPath、animate、animateMotion、animateTransform| diff --git a/zh-cn/application-dev/ui/ui-js-building-ui-event.md b/zh-cn/application-dev/ui/ui-js-building-ui-event.md index fad1987dfad53a12e9f0d748dab4af2781367191..2d6f82caacff7bdb61e57dfadfe7a2e20a9f5efe 100755 --- a/zh-cn/application-dev/ui/ui-js-building-ui-event.md +++ b/zh-cn/application-dev/ui/ui-js-building-ui-event.md @@ -1,19 +1,23 @@ -# 事件 +# 事件 -- [手势事件](#section21104561094) +- [手势事件](#手势事件) +- [按键事件](#按键事件) 事件主要为手势事件。手势事件主要用于具有触摸屏的设备。 -## 手势事件 + +## 手势事件 手势表示由单个或多个事件识别的语义动作（例如：点击、拖动和长按）。一个完整的手势也可能由多个事件组成，对应手势的生命周期。JS UI框架支持的手势事件有： -**触摸** + **触摸** +- touchstart：手指触摸动作开始。 + +- touchmove：手指触摸后移动。 + +- touchcancel：手指触摸动作被打断，如来电提醒、弹窗。 -- touchstart：手指触摸动作开始。 -- touchmove：手指触摸后移动。 -- touchcancel：手指触摸动作被打断，如来电提醒、弹窗。 -- touchend：手指触摸动作结束。 +- touchend：手指触摸动作结束。 **点击** diff --git a/zh-cn/application-dev/ui/ui-js-building-ui-interactions.md b/zh-cn/application-dev/ui/ui-js-building-ui-interactions.md index 1e365a8ed05ed0010f076724fb3ebcef3a10621d..d569f7970c9583886008c372a7a4531fa9fc4f6a 100755 --- a/zh-cn/application-dev/ui/ui-js-building-ui-interactions.md +++ b/zh-cn/application-dev/ui/ui-js-building-ui-interactions.md @@ -1,19 +1,22 @@ -# 添加交互 +# 添加交互 添加交互可以通过在组件上关联事件实现。本节将介绍如何用div、text、image组件关联click事件，构建一个如下图所示的点赞按钮。 +**图1** 点赞按钮效果 -**图 1** 点赞按钮效果 +![zh-cn_image_0000001212146221](figures/zh-cn_image_0000001212146221.gif) -![](figures/zan.gif) - 点赞按钮通过一个div组件关联click事件实现。div组件包含一个image组件和一个text组件： -- image组件用于显示未点赞和点赞的效果。click事件函数会交替更新点赞和未点赞图片的路径。 -- text组件用于显示点赞数，点赞数会在click事件的函数中同步更新。 + +- image组件用于显示未点赞和点赞的效果。click事件函数会交替更新点赞和未点赞图片的路径。 + +- text组件用于显示点赞数，点赞数会在click事件的函数中同步更新。 + click事件作为一个函数定义在js文件中，可以更改isPressed的状态，从而更新显示的image组件。如果isPressed为真，则点赞数加1。该函数在hml文件中对应的div组件上生效，点赞按钮各子组件的样式设置在css文件当中。具体的实现示例如下： + ``` @@ -25,6 +28,7 @@ click事件作为一个函数定义在js文件中，可以更改isPressed的状 ``` + ``` /* xxx.css */ .like { @@ -48,6 +52,7 @@ click事件作为一个函数定义在js文件中，可以更改isPressed的状 } ``` + ``` // xxx.js export default { @@ -71,5 +76,5 @@ export default { } ``` -JS UI框架还提供了很多表单组件，例如开关、标签、滑动选择器等，以便于开发者在页面布局时灵活使用和提高交互性。 +JS UI框架还提供了很多表单组件，例如开关、标签、滑动选择器等，以便于开发者在页面布局时灵活使用和提高交互性。 diff --git a/zh-cn/application-dev/ui/ui-js-building-ui-layout-comment.md b/zh-cn/application-dev/ui/ui-js-building-ui-layout-comment.md index 0ee00abda5a2e0f131dd8ae9f8bbdbdc9e99f08d..6de571962840a12cf879ca087d2275238b43042e 100755 --- a/zh-cn/application-dev/ui/ui-js-building-ui-layout-comment.md +++ b/zh-cn/application-dev/ui/ui-js-building-ui-layout-comment.md @@ -1,8 +1,10 @@ -# 添加留言区域 +# 添加留言区域 留言框的功能为：用户输入留言后点击完成，留言区域即显示留言内容；用户点击右侧的删除按钮可删除当前留言内容并重新输入。 -留言区域由div、text、input关联click事件实现。开发者可以使用input组件实现输入留言的部分，使用text组件实现留言完成部分，使用commentText的状态标记此时显示的组件（通过if属性控制）。在包含文本“完成“和“删除“的text组件中关联click事件，更新commentText状态和inputValue的内容。具体的实现示例如下： + +留言区域由div、text、input关联click事件实现。开发者可以使用input组件实现输入留言的部分，使用text组件实现留言完成部分，使用commentText的状态标记此时显示的组件（通过if属性控制）。在包含文本完成和删除的text组件中关联click事件，更新commentText状态和inputValue的内容。具体的实现示例如下： + ``` @@ -19,6 +21,7 @@ ``` + ``` /* xxx.css */ .container { @@ -30,7 +33,7 @@ color: #1a1a1a; font-weight: bold; margin-top: 40px; - margin-bottom: 10px; +margin-bottom: 10px; } .comment { width: 550px; @@ -60,6 +63,7 @@ } ``` + ``` // xxx.js export default { @@ -75,4 +79,3 @@ export default { }, } ``` - diff --git a/zh-cn/application-dev/ui/ui-js-building-ui-layout-external-container.md b/zh-cn/application-dev/ui/ui-js-building-ui-layout-external-container.md index 56ff8b0ed496b560f96e41f79e106926b20a46f6..65cdb858892ec484962eefd36a447336ce08c90f 100755 --- a/zh-cn/application-dev/ui/ui-js-building-ui-layout-external-container.md +++ b/zh-cn/application-dev/ui/ui-js-building-ui-layout-external-container.md @@ -1,11 +1,12 @@ -# 添加容器 +# 添加容器 -- [List组件](#section1875054932714) -- [Tabs组件](#section91861363535) +- [List组件](#list组件) +- [Tabs组件](#tabs组件) 要将页面的基本元素组装在一起，需要使用容器组件。在页面布局中常用到三种容器组件，分别是div、list和tabs。在页面结构相对简单时，可以直接用div作为容器，因为div作为单纯的布局容器，可以支持多种子组件，使用起来更为方便。 -## List组件 + +## List组件 当页面结构较为复杂时，如果使用div循环渲染，容易出现卡顿，因此推荐使用list组件代替div组件实现长列表布局，从而实现更加流畅的列表滚动体验。需要注意的是，list仅支持list-item作为子组件，具体的使用示例如下： @@ -37,7 +38,8 @@ export default { 为避免示例代码过长，以上示例的list中只包含一个list-item，list-item中只有一个text组件。在实际应用中可以在list中加入多个list-item，同时list-item下可以包含多个其他子组件。 -## Tabs组件 + +## Tabs组件 当页面经常需要动态加载时，推荐使用tabs组件。tabs组件支持change事件，在页签切换后触发。tabs组件仅支持一个tab-bar和一个tab-content。具体的使用示例如下： @@ -69,4 +71,3 @@ export default { ``` tab-content组件用来展示页签的内容区，高度默认充满tabs剩余空间。 - diff --git a/zh-cn/application-dev/ui/ui-js-building-ui-layout-image.md b/zh-cn/application-dev/ui/ui-js-building-ui-layout-image.md index 4c378cf73761954876bb7e3c12b1e0daa9a8d755..d0fbeb8983f1a7980f8e50aef4bdd3bfe1bd5f29 100755 --- a/zh-cn/application-dev/ui/ui-js-building-ui-layout-image.md +++ b/zh-cn/application-dev/ui/ui-js-building-ui-layout-image.md @@ -1,14 +1,17 @@ -# 添加图片区域 +# 添加图片区域 添加图片区域通常用image组件来实现，使用的方法和text组件类似。 -图片资源建议放在“js \> default \> common“目录下，common目录需自行创建。代码示例如下： + +图片资源建议放在jsdefaultcommon目录下，common目录需自行创建。代码示例如下： + ``` ``` + ``` /* xxx.css */ .img { @@ -18,6 +21,7 @@ } ``` + ``` // xxx.js export default { @@ -26,4 +30,3 @@ export default { }, } ``` - diff --git a/zh-cn/application-dev/ui/ui-js-building-ui-layout-intro.md b/zh-cn/application-dev/ui/ui-js-building-ui-layout-intro.md index 4e6400693ca5dd47e19255a87a8c994f88e77787..74ed1ef084efa7c5517b9a3f99b8ab9f4ef11dfe 100644 --- a/zh-cn/application-dev/ui/ui-js-building-ui-layout-intro.md +++ b/zh-cn/application-dev/ui/ui-js-building-ui-layout-intro.md @@ -1,26 +1,31 @@ -# 布局说明 +# 布局说明 JS UI框架中，设备的基准宽度为720px（px为逻辑像素，非物理像素），实际显示效果会根据实际屏幕宽度进行缩放。 + 其换算关系如下： + 组件的width设为100px时，在宽度为720物理像素的屏幕上，实际显示为100物理像素；在宽度为1440物理像素的屏幕上，实际显示为200物理像素。 一个页面的基本元素包含标题区域、文本区域、图片区域等，每个基本元素内还可以包含多个子元素，开发者根据需求还可以添加按钮、开关、进度条等组件。在构建页面布局时，需要对每个基本元素思考以下几个问题： -- 该元素的尺寸和排列位置 -- 是否有重叠的元素 -- 是否需要设置对齐、内间距或者边界 -- 是否包含子元素及其排列位置 -- 是否需要容器组件及其类型 -将页面中的元素分解之后再对每个基本元素按顺序实现，可以减少多层嵌套造成的视觉混乱和逻辑混乱，提高代码的可读性，方便对页面做后续的调整。以下图为例进行分解： +- 该元素的尺寸和排列位置 + +- 是否有重叠的元素 + +- 是否需要设置对齐、内间距或者边界 + +- 是否包含子元素及其排列位置 -**图 1** 页面布局分解 -![](figures/页面布局分解.png "页面布局分解") +- 是否需要容器组件及其类型 -**图 2** 留言区布局分解 +将页面中的元素分解之后再对每个基本元素按顺序实现，可以减少多层嵌套造成的视觉混乱和逻辑混乱，提高代码的可读性，方便对页面做后续的调整。以下图为例进行分解：
+**图1** 页面布局分解
+![zh-cn_image_0000001166426374](figures/zh-cn_image_0000001166426374.png) -![](figures/图片3.png) +**图2** 留言区布局分解
+![zh-cn_image_0000001166586348](figures/zh-cn_image_0000001166586348.png) diff --git a/zh-cn/application-dev/ui/ui-js-building-ui-layout-text.md b/zh-cn/application-dev/ui/ui-js-building-ui-layout-text.md index 2a1c927a22ff1b95b575026fee668d77a594d81b..4dd5e395201944005b15a5d93d52b3d8755d5179 100755 --- a/zh-cn/application-dev/ui/ui-js-building-ui-layout-text.md +++ b/zh-cn/application-dev/ui/ui-js-building-ui-layout-text.md @@ -1,7 +1,8 @@ -# 添加标题行和文本区域 +# 添加标题行和文本区域 实现标题和文本区域最常用的是基础组件text。text组件用于展示文本，可以设置不同的属性和样式，文本内容需要写在标签内容区。在页面中插入标题和文本区域的示例如下： + ```
@@ -11,6 +12,7 @@
``` + ``` /* xxx.css */ .container { @@ -31,6 +33,7 @@ } ``` + ``` // xxx.js export default { @@ -41,4 +44,3 @@ export default { }, } ``` - diff --git a/zh-cn/application-dev/ui/ui-js-building-ui-layout.md b/zh-cn/application-dev/ui/ui-js-building-ui-layout.md index 9cc3a1138d726a1d5aa4d73c7c039fcf749ea978..72d4a2292c420711c33c6a6e4ed1b07c6091efff 100644 --- a/zh-cn/application-dev/ui/ui-js-building-ui-layout.md +++ b/zh-cn/application-dev/ui/ui-js-building-ui-layout.md @@ -1,13 +1,12 @@ -# 构建布局 +# 构建布局 -- **[布局说明](ui-js-building-ui-layout-intro.md)** -- **[添加标题行和文本区域](ui-js-building-ui-layout-text.md)** +- **[布局说明](ui-js-building-ui-layout-intro.md)** -- **[添加图片区域](ui-js-building-ui-layout-image.md)** +- **[添加标题行和文本区域](ui-js-building-ui-layout-text.md)** -- **[添加留言区域](ui-js-building-ui-layout-comment.md)** - -- **[添加容器](ui-js-building-ui-layout-external-container.md)** +- **[添加图片区域](ui-js-building-ui-layout-image.md)** +- **[添加留言区域](ui-js-building-ui-layout-comment.md)** +- **[添加容器](ui-js-building-ui-layout-external-container.md)** \ No newline at end of file diff --git a/zh-cn/application-dev/ui/ui-js-building-ui-routes.md b/zh-cn/application-dev/ui/ui-js-building-ui-routes.md index dac9f8d307e17391db268147f403115efb3cdd60..5d1a79323a04243747b8e6f0106e0bf8f1b13ee1 100644 --- a/zh-cn/application-dev/ui/ui-js-building-ui-routes.md +++ b/zh-cn/application-dev/ui/ui-js-building-ui-routes.md @@ -1,18 +1,23 @@ -# 页面路由 +# 页面路由 -- [构建页面布局](#section135242911291) -- [构建页面样式](#section174441114183216) -- [实现跳转](#section1276711211359) +- [构建页面布局](#构建页面布局) +- [构建页面样式](#构建页面样式) +- [实现跳转](#实现跳转) 很多应用由多个页面组成，比如用户可以从音乐列表页面点击歌曲，跳转到该歌曲的播放界面。开发者需要通过页面路由将这些页面串联起来，按需实现跳转。 + 页面路由router根据页面的uri找到目标页面，从而实现跳转。以最基础的两个页面之间的跳转为例，具体实现步骤如下： -1. 在“Project“窗口，打开“entry \> src \> main \> js \> default“，右键点击“pages“文件夹，选择“New \> JS Page“，创建一个详情页。 -2. 调用router.push\(\)路由到详情页。 -3. 调用router.back\(\)回到首页。 -## 构建页面布局 +1. 在 “Project“窗口，打开“entry > src > main > js > default”，右键点击“pages”文件夹，选择“New > JS Page”，创建一个详情页。 + +2. 调用router.push()路由到详情页。 + +3. 调用router.back()回到首页。 + + +## 构建页面布局 index和detail这两个页面均包含一个text组件和button组件：text组件用来指明当前页面，button组件用来实现两个页面之间的相互跳转。hml文件代码示例如下： @@ -32,7 +37,8 @@ index和detail这两个页面均包含一个text组件和button组件：text组 ``` -## 构建页面样式 + +## 构建页面样式 构建index和detail页面的页面样式，text组件和button组件居中显示，两个组件之间间距为50px。css代码如下（两个页面样式代码一致）： @@ -51,9 +57,10 @@ index和detail这两个页面均包含一个text组件和button组件：text组 } ``` -## 实现跳转 -为了使button组件的launch方法生效，需要在页面的js文件中实现跳转逻辑。调用router.push\(\)接口将uri指定的页面添加到路由栈中，即跳转到uri指定的页面。在调用router方法之前，需要导入router模块。代码示例如下： +## 实现跳转 + +为了使button组件的launch方法生效，需要在页面的js文件中实现跳转逻辑。调用router.push()接口将uri指定的页面添加到路由栈中，即跳转到uri指定的页面。在调用router方法之前，需要导入router模块。代码示例如下： ``` // index.js @@ -79,6 +86,5 @@ export default { 运行效果如下图所示： -**图 1** 页面路由效果 -![](figures/页面路由效果.png "页面路由效果") - +**图1** 页面路由效果
+![zh-cn_image_0000001166904852](figures/zh-cn_image_0000001166904852.png) diff --git a/zh-cn/application-dev/ui/ui-js-building-ui.md b/zh-cn/application-dev/ui/ui-js-building-ui.md index 934f5970d8a9bffe4742f9ea22325d19a19bfdb6..ccb63dde2ef41ce0f39f66460b1caf7f0669faa6 100644 --- a/zh-cn/application-dev/ui/ui-js-building-ui.md +++ b/zh-cn/application-dev/ui/ui-js-building-ui.md @@ -1,15 +1,14 @@ -# 构建用户界面 +# 构建用户界面 -- **[组件介绍](ui-js-building-ui-component.md)** -- **[构建布局](ui-js-building-ui-layout.md)** +- **[组件介绍](ui-js-building-ui-component.md)** -- **[添加交互](ui-js-building-ui-interactions.md)** +- **[构建布局](ui-js-building-ui-layout.md)** -- **[动画](ui-js-building-ui-animation.md)** +- **[添加交互](ui-js-building-ui-interactions.md)** -- **[事件](ui-js-building-ui-event.md)** - -- **[页面路由](ui-js-building-ui-routes.md)** +- **[动画](ui-js-building-ui-animation.md)** +- **[事件](ui-js-building-ui-event.md)** +- **[页面路由](ui-js-building-ui-routes.md)** \ No newline at end of file diff --git a/zh-cn/application-dev/ui/ui-js-custom-components.md b/zh-cn/application-dev/ui/ui-js-custom-components.md index 806d4aaf48d327eef472b7f2d108983aff25809a..05f8bf0164f9424be192d9273f942a001d43d7f0 100755 --- a/zh-cn/application-dev/ui/ui-js-custom-components.md +++ b/zh-cn/application-dev/ui/ui-js-custom-components.md @@ -1,100 +1,99 @@ -# 自定义组件 +# 自定义组件 JS UI框架支持自定义组件，用户可根据业务需求将已有的组件进行扩展，增加自定义的私有属性和事件，封装成新的组件，方便在工程中多次调用，提高页面布局代码的可读性。具体的封装方法示例如下： -- **构建自定义组件** - ``` - -
- {{title}} - 点击这里查看隐藏文本 - hello world -
- ``` +- **构建自定义组件** + ``` + +
+ {{title}} + 点击这里查看隐藏文本 + hello world +
+ ``` - ``` - /* comp.css */ - .item { - width: 700px; - flex-direction: column; - height: 300px; - align-items: center; - margin-top: 100px; - } - .text-style { - width: 100%; - text-align: center; - font-weight: 500; - font-family: Courier; - font-size: 36px; - } - .title-style { - font-weight: 500; - font-family: Courier; - font-size: 50px; - color: #483d8b; - } - ``` + ``` + /* comp.css */ + .item { + width: 700px; + flex-direction: column; + height: 300px; + align-items: center; + margin-top: 100px; + } + .text-style { + width: 100%; + text-align: center; + font-weight: 500; + font-family: Courier; + font-size: 36px; + } + .title-style { + font-weight: 500; + font-family: Courier; + font-size: 50px; + color: #483d8b; + } + ``` - ``` - // comp.js - export default { - props: { - title: { - default: 'title', - }, - showObject: {}, + ``` + // comp.js + export default { + props: { + title: { + default: 'title', }, - data() { - return { - showObj: this.showObject, - }; - }, - childClicked () { - this.$emit('eventType1', {text: '收到子组件参数'}); - this.showObj = !this.showObj; - }, - } - ``` + showObject: {}, + }, + data() { + return { + showObj: this.showObject, + }; + }, + childClicked () { + this.$emit('eventType1', {text: '收到子组件参数'}); + this.showObj = !this.showObj; + }, + } + ``` -- **引入自定义组件** +- **引入自定义组件** + ``` + + +
+ 父组件：{{text}} + +
+ ``` - ``` - - -
- 父组件：{{text}} - -
- ``` + ``` + /* xxx.css */ + .container { + background-color: #f8f8ff; + flex: 1; + flex-direction: column; + align-content: center; + } + ``` - ``` - /* xxx.css */ - .container { - background-color: #f8f8ff; - flex: 1; - flex-direction: column; - align-content: center; - } - ``` - - ``` - // xxx.js - export default { - data: { - text: '开始', - isShow: false, - }, - textClicked (e) { - this.text = e.detail.text; - }, - } - ``` + ``` + // xxx.js + export default { + data: { + text: '开始', + isShow: false, + }, + textClicked (e) { + this.text = e.detail.text; + }, + } + ``` 本示例中父组件通过添加自定义属性向子组件传递了名称为title的参数，子组件在props中接收。同时子组件也通过事件绑定向上传递了参数text，接收时通过e.detail获取。要绑定子组件事件，父组件事件命名必须遵循事件绑定规则。自定义组件效果如下图所示： -**图 1** 自定义组件的效果 -![](figures/自定义组件的效果.png "自定义组件的效果") +**图1** 自定义组件的效果 +![zh-cn_image_0000001212146243](figures/zh-cn_image_0000001212146243.png) diff --git a/zh-cn/application-dev/ui/ui-js-overview.md b/zh-cn/application-dev/ui/ui-js-overview.md index 3fdabc8b7e42534c344179377e240602cb76d071..d373b1e91023fc3c59cdf9a13bbcd62dedfb0095 100755 --- a/zh-cn/application-dev/ui/ui-js-overview.md +++ b/zh-cn/application-dev/ui/ui-js-overview.md @@ -1,38 +1,31 @@ -# JS UI框架概述 +# JS UI框架概述 -- [基础能力](#section1393616301083) -- [整体架构](#section105231413161115) +- [基础能力](#基础能力) +- [整体架构](#整体架构) JS UI框架是OpenHarmony UI开发框架，提供基础类、容器类、画布类等UI组件和标准CSS动画能力，支持类Web范式编程。 -## 基础能力 +## 基础能力 +- **类Web范式编程**
+ JS UI框架采用类HTML和CSS Web编程语言作为页面布局和页面样式的开发语言，页面业务逻辑则支持ECMAScript规范的JavaScript语言。JS UI框架提供的类Web编程范式，可以让开发者避免编写UI状态切换的代码，视图配置信息更加直观。 -- **类Web范式编程** - - JS UI框架采用类HTML和CSS Web编程语言作为页面布局和页面样式的开发语言，页面业务逻辑则支持ECMAScript规范的JavaScript语言。JS UI框架提供的类Web编程范式，可以让开发者避免编写UI状态切换的代码，视图配置信息更加直观。 - - - -## 整体架构 +## 整体架构 JS UI框架包括应用层（Application）、前端框架层（Framework）、引擎层（Engine）和平台适配层（Porting Layer）。 -![](figures/zh-cn_image_0000001077953992.png) - -- **Application** - - 应用层表示开发者使用JS UI框架开发的FA应用，这里的FA应用特指JS FA应用。 - -- **Framework** - 前端框架层主要完成前端页面解析，以及提供MVVM（Model-View-ViewModel）开发模式、页面路由机制和自定义组件等能力。 -- **Engine** +![zh-cn_image_0000001166426358](figures/zh-cn_image_0000001166426358.png) - 引擎层主要提供动画解析、DOM（Document Object Model）树构建、布局计算、渲染命令构建与绘制、事件管理等能力。 +- **Application**
+ 应用层表示开发者使用JS UI框架开发的FA应用，这里的FA应用特指JS FA应用。 -- **Porting Layer** +- **Framework**
+ 前端框架层主要完成前端页面解析，以及提供MVVM（Model-View-ViewModel）开发模式、页面路由机制和自定义组件等能力。 - 适配层主要完成对平台层进行抽象，提供抽象接口，可以对接到系统平台。比如：事件对接、渲染管线对接和系统生命周期对接等。 +- **Engine**
+ 引擎层主要提供动画解析、DOM（Document Object Model）树构建、布局计算、渲染命令构建与绘制、事件管理等能力。 +- **Porting Layer**
+ 适配层主要完成对平台层进行抽象，提供抽象接口，可以对接到系统平台。比如：事件对接、渲染管线对接和系统生命周期对接等。 diff --git a/zh-cn/application-dev/ui/ui-js.md b/zh-cn/application-dev/ui/ui-js.md index 11cacfcb1d44323b2315d2121a8a45669584470a..88a6092003a039f8510205f4dac9d34821f63d83 100644 --- a/zh-cn/application-dev/ui/ui-js.md +++ b/zh-cn/application-dev/ui/ui-js.md @@ -1,9 +1,9 @@ -# JS UI框架 +# JS UI框架 -- **[JS UI框架概述](ui-js-overview.md)** -- **[构建用户界面](ui-js-building-ui.md)** +- **[JS UI框架概述](ui-js-overview.md)** -- **[自定义组件](ui-js-custom-components.md)** +- **[构建用户界面](ui-js-building-ui.md)** +- **[自定义组件](ui-js-custom-components.md)**