From e7412f13880b7e0d4959bd344d2d6b9f19940ed2 Mon Sep 17 00:00:00 2001 From: zengyawen Date: Fri, 27 May 2022 15:48:58 +0800 Subject: [PATCH] update Signed-off-by: zengyawen --- .../reference/apis/js-apis-audio.md | 22 +++--------- .../reference/apis/js-apis-contact.md | 5 --- .../reference/apis/js-apis-medialibrary.md | 36 +++++++++---------- .../reference/apis/js-apis-system-cipher.md | 3 +- .../reference/apis/js-apis-webSocket.md | 1 - 5 files changed, 24 insertions(+), 43 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-audio.md b/zh-cn/application-dev/reference/apis/js-apis-audio.md index 2b9a99ea20..19f54ee611 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-audio.md +++ b/zh-cn/application-dev/reference/apis/js-apis-audio.md @@ -465,8 +465,6 @@ audio.createAudioRenderer(audioCapturerOptions).then((data) => { 枚举,中断事件返回类型。 -本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 - **系统能力:** 以下各项对应的系统能力均为SystemCapability.Multimedia.Audio.Renderer | 名称 | 默认值 | 描述 | @@ -526,8 +524,6 @@ audio.createAudioRenderer(audioCapturerOptions).then((data) => { 音频监听事件传入的参数。 -本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 - **系统能力:** 以下各项对应的系统能力均为SystemCapability.Multimedia.Audio.Renderer | 名称 | 类型 | 必填 | 说明 | @@ -540,8 +536,6 @@ audio.createAudioRenderer(audioCapturerOptions).then((data) => { 音频打断/获取焦点事件的回调方法。 -本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 - **系统能力:** 以下各项对应的系统能力均为SystemCapability.Multimedia.Audio.Renderer | 名称 | 类型 | 必填 | 说明 | @@ -615,11 +609,11 @@ audio.createAudioRenderer(audioCapturerOptions).then((data) => { **系统能力:** 以下各项对应的系统能力均为SystemCapability.Multimedia.Audio.Core -| 名称 | 默认值 | 描述 | -| :------------------------------ | :----- | :----------------------------------------------------------- | -| SOURCE_TYPE_INVALID | -1 | 无效的音频源。 | -| SOURCE_TYPE_MIC | 0 | Mic音频源。 | -| SOURCE_TYPE_VOICE_COMMUNICATION | 7 | 语音通话场景的音频源。
本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 | +| 名称 | 默认值 | 描述 | +| :------------------------------ | :----- | :--------------------- | +| SOURCE_TYPE_INVALID | -1 | 无效的音频源。 | +| SOURCE_TYPE_MIC | 0 | Mic音频源。 | +| SOURCE_TYPE_VOICE_COMMUNICATION | 7 | 语音通话场景的音频源。 | ## AudioScene8+ @@ -1603,8 +1597,6 @@ off(type: 'deviceChange', callback?: Callback): void 取消订阅音频设备连接变化事件。 -本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 - **系统能力:** SystemCapability.Multimedia.Audio.Device **参数:** @@ -1628,8 +1620,6 @@ on(type: 'interrupt', interrupt: AudioInterrupt, callback: Callback\(deprecated) storeMediaAsset(option: MediaAssetOption, callback: AsyncCallback<string>): void 保存媒体资源,以异步方法获取保存成功的URI,使用callback形式返回结果。 -本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 +> **说明**: 从API Version 9开始废弃。 **系统能力**:SystemCapability.Multimedia.MediaLibrary.Core @@ -479,13 +479,13 @@ mediaLibrary.getMediaLibrary().storeMediaAsset(option, (err, value) => { ``` -### storeMediaAsset +### storeMediaAsset(deprecated) storeMediaAsset(option: MediaAssetOption): Promise<string> 保存媒体资源,以异步方法获取保存成功的URI,使用Promise形式返回结果。 -本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 +> **说明**: 从API Version 9开始废弃。 **系统能力**:SystemCapability.Multimedia.MediaLibrary.Core @@ -518,13 +518,13 @@ mediaLibrary.getMediaLibrary().storeMediaAsset(option).then((value) => { ``` -### startImagePreview +### startImagePreview(deprecated) startImagePreview(images: Array<string>, index: number, callback: AsyncCallback<void>): void 启动图片预览界面并限定预览开始显示的图片。可以预览指定序号的单张本地图片(dataability://),也可以预览列表中的所有网络图片(https://)。使用callback方式进行异步回调。 -本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 +> **说明**: 从API Version 9开始废弃。 **系统能力**:SystemCapability.Multimedia.MediaLibrary.Core @@ -560,13 +560,13 @@ mediaLibrary.getMediaLibrary().startImagePreview(images, index, (err) => { ``` -### startImagePreview +### startImagePreview(deprecated) startImagePreview(images: Array<string>, callback: AsyncCallback<void>): void 启动图片预览界面,可以预览列表中首张本地图片(dataability://),也可以预览列表中的所有网络图片(https://)。使用callback方式进行异步回调。 -本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 +> **说明**: 从API Version 9开始废弃。 **系统能力**:SystemCapability.Multimedia.MediaLibrary.Core @@ -600,13 +600,13 @@ mediaLibrary.getMediaLibrary().startImagePreview(images, (err) => { ``` -### startImagePreview +### startImagePreview(deprecated) startImagePreview(images: Array<string>, index?: number): Promise<void> 启动图片预览界面并限定预览开始显示的图片。可以预览指定序号的单张本地图片(dataability://),也可以预览列表中的所有网络图片(https://)。使用Promise方式进行异步回调。 -本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 +> **说明**: 从API Version 9开始废弃。 **系统能力**:SystemCapability.Multimedia.MediaLibrary.Core @@ -645,13 +645,13 @@ mediaLibrary.getMediaLibrary().startImagePreview(images, index).then(() => { ``` -### startMediaSelect +### startMediaSelect(deprecated) startMediaSelect(option: MediaSelectOption, callback: AsyncCallback<Array<string>>): void 启动媒体选择界面,以异步方法获取选择的媒体URI列表,使用callback形式返回结果。 -本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 +> **说明**: 从API Version 9开始废弃。 **系统能力**:SystemCapability.Multimedia.MediaLibrary.Core @@ -680,13 +680,13 @@ mediaLibrary.getMediaLibrary().startMediaSelect(option, (err, value) => { ``` -### startMediaSelect +### startMediaSelect(deprecated) startMediaSelect(option: MediaSelectOption): Promise<Array<string>> 启动媒体选择界面,以异步方法获取选择的媒体URI列表,使用Promise形式返回结果。 -本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 +> **说明**: 从API Version 9开始废弃。 **系统能力**:SystemCapability.Multimedia.MediaLibrary.Core @@ -2228,11 +2228,11 @@ async function example() { | width | number | 是 | 是 | 宽(单位:像素) | | height | number | 是 | 是 | 高(单位:像素) | -## MediaAssetOption +## MediaAssetOption(deprecated) 媒体资源选项。 -本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 +> **说明**: 从API Version 9开始废弃。 **系统能力:** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core @@ -2243,11 +2243,11 @@ async function example() { | mimeType | string | 是 | 媒体MIME(Multipurpose Internet Mail Extensions)类型。
包括:'image/\*'、'video/\*'、'audio/\*'、 'file\*'。 | | relativePath | string | 否 | 自定义媒体资源保存位置,例:Pictures/ 不填则保存到默认路径。
image类型默认路径Pictures/
video类型默认路径Videos/
audio类型默认路径Audios/
file类型默认路径Documents/ 。 | -## MediaSelectOption +## MediaSelectOption(deprecated) 媒体资源类型选项。 -本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 +> **说明**: 从API Version 9开始废弃。 **系统能力:** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core diff --git a/zh-cn/application-dev/reference/apis/js-apis-system-cipher.md b/zh-cn/application-dev/reference/apis/js-apis-system-cipher.md index 3cabf0c468..2ca1fc3ccd 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-system-cipher.md +++ b/zh-cn/application-dev/reference/apis/js-apis-system-cipher.md @@ -2,8 +2,7 @@ > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > -> - 本模块首批接口从API version 3开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 -> - 本接口在OpenHarmony 3.1 Release版本仅为接口定义。接口将在OpenHarmony 3.1 MR版本提供使用支持。 +> 本模块首批接口从API version 3开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 ## 导入模块 diff --git a/zh-cn/application-dev/reference/apis/js-apis-webSocket.md b/zh-cn/application-dev/reference/apis/js-apis-webSocket.md index 9d1d0455e7..e3ca0ee129 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-webSocket.md +++ b/zh-cn/application-dev/reference/apis/js-apis-webSocket.md @@ -3,7 +3,6 @@ >![](public_sys-resources/icon-note.gif) **说明:** >本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > ->本接口在Openharmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 使用WebSocket建立服务器与客户端的双向连接,需要先通过[createWebSocket](#websocketcreatewebsocket)方法创建[WebSocket](#websocket)对象,然后通过[connect](#connect)方法连接到服务器。当连接成功后,客户端会收到[open](#onopen)事件的回调,之后客户端就可以通过[send](#send)方法与服务器进行通信。当服务器发信息给客户端时,客户端会收到[message](#onmessage)事件的回调。当客户端不要此连接时,可以通过调用[close](#close)方法主动断开连接,之后客户端会收到[close](#onclose)事件的回调。 -- GitLab