From 70c2fe8f39c8becfa11a21234dffab46334afd2b Mon Sep 17 00:00:00 2001 From: zengyawen Date: Thu, 25 May 2023 16:57:32 +0800 Subject: [PATCH] update docs Signed-off-by: zengyawen --- .../common-event-remove-sticky.md | 2 +- .../connectivity/net-connection-manager.md | 4 +- .../reference/apis/js-apis-avsession.md | 85 +++++++++---------- .../apis/js-apis-bluetoothManager.md | 2 +- .../reference/apis/js-apis-commonEvent.md | 6 +- .../apis/js-apis-commonEventManager.md | 2 +- .../reference/apis/js-apis-image.md | 2 +- .../apis/js-apis-inputmethodengine.md | 4 +- .../security/huks-guidelines.md | 13 +-- .../telephony/telephony-sms.md | 8 +- zh-cn/application-dev/website.md | 2 +- 11 files changed, 62 insertions(+), 68 deletions(-) diff --git a/zh-cn/application-dev/application-models/common-event-remove-sticky.md b/zh-cn/application-dev/application-models/common-event-remove-sticky.md index 7205bf98b5..ac4cff8293 100644 --- a/zh-cn/application-dev/application-models/common-event-remove-sticky.md +++ b/zh-cn/application-dev/application-models/common-event-remove-sticky.md @@ -11,7 +11,7 @@ | 接口名 | 接口描述 | | -------- | -------- | -| removeStickyCommonEvent(event: string, callback: AsyncCallback): void | 移除粘性公共事件 | +| removeStickyCommonEvent(event: string, callback: AsyncCallback\): void | 移除粘性公共事件 | ## 开发步骤 diff --git a/zh-cn/application-dev/connectivity/net-connection-manager.md b/zh-cn/application-dev/connectivity/net-connection-manager.md index c5f714349d..fad4f47781 100644 --- a/zh-cn/application-dev/connectivity/net-connection-manager.md +++ b/zh-cn/application-dev/connectivity/net-connection-manager.md @@ -39,7 +39,7 @@ | ---- | ---- | ---- | | ohos.net.connection | function getDefaultNet(callback: AsyncCallback\): void; |获取一个含有默认网络的netId的NetHandle对象，使用callback回调 | | ohos.net.connection | function getGlobalHttpProxy10+(callback: AsyncCallback\): void;| 获取网络的全局代理设置，使用callback回调 | -| ohos.net.connection | function setGlobalHttpProxy10+(httpProxy: HttpProxy, callback: AsyncCallback): void;| 设置网络全局Http代理配置信息，使用callback回调 | +| ohos.net.connection | function setGlobalHttpProxy10+(httpProxy: HttpProxy, callback: AsyncCallback\): void;| 设置网络全局Http代理配置信息，使用callback回调 | | ohos.net.connection | function getAppNet9+(callback: AsyncCallback\): void;| 获取一个App绑定的包含了网络netId的NetHandle对象，使用callback回调 | | ohos.net.connection | function setAppNet9+(netHandle: NetHandle, callback: AsyncCallback\): void;| 绑定App到指定网络，绑定后的App只能通过指定网络访问外网。使用callback回调 | | ohos.net.connection | function getDefaultNetSync9+(): NetHandle; |使用同步方法获取默认激活的数据网络。可以使用getNetCapabilities去获取网络的类型、拥有的能力等信息。| @@ -47,7 +47,7 @@ | ohos.net.connection | function getAllNets(callback: AsyncCallback\>): void;| 获取所处于连接状态的网络的MetHandle对象列表，使用callback回调 | | ohos.net.connection | function getConnectionProperties(netHandle: NetHandle, callback: AsyncCallback\): void; |查询默认网络的链路信息，使用callback回调 | | ohos.net.connection | function getNetCapabilities(netHandle: NetHandle, callback: AsyncCallback\): void; |查询默认网络的能力集信息，使用callback回调 | -| ohos.net.connection | function isDefaultNetMetered9+(callback: AsyncCallback): void; |检查当前网络上的数据流量使用是否被计量，使用callback方式作为异步方法 | +| ohos.net.connection | function isDefaultNetMetered9+(callback: AsyncCallback\): void; |检查当前网络上的数据流量使用是否被计量，使用callback方式作为异步方法 | | ohos.net.connection | function reportNetConnected(netHandle: NetHandle, callback: AsyncCallback\): void;| 向网络管理报告网络处于可用状态，调用此接口说明应用程序认为网络的可用性（ohos.net.connection.NetCap.NET_CAPABILITY_VAILDATED）与网络管理不一致。使用callback回调 | | ohos.net.connection | function reportNetDisconnected(netHandle: NetHandle, callback: AsyncCallback\): void;| 向网络管理报告网络处于不可用状态，调用此接口说明应用程序认为网络的可用性（ohos.net.connection.NetCap.NET_CAPABILITY_VAILDATED）与网络管理不一致。使用callback回调 | | ohos.net.connection | function getAddressesByName(host: string, callback: AsyncCallback\>): void; |使用对应网络解析域名，获取所有IP，使用callback回调 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-avsession.md b/zh-cn/application-dev/reference/apis/js-apis-avsession.md index caf5ba6821..ae65d8ce84 100755 --- a/zh-cn/application-dev/reference/apis/js-apis-avsession.md +++ b/zh-cn/application-dev/reference/apis/js-apis-avsession.md @@ -3,6 +3,7 @@ 媒体会话管理提供媒体播控相关功能的接口，目的是让应用接入播控中心。 该模块提供以下媒体会话相关的常用功能： + - [AVSession](#avsession) : 会话，可用于设置元数据、播放状态信息等操作。 - [AVSessionController](#avsessioncontroller): 会话控制器，可用于查看会话ID，完成对会话发送命令及事件，获取会话元数据、播放状态信息等操作。 @@ -36,14 +37,12 @@ createAVSession(context: Context, tag: string, type: AVSessionType): Promise\ | Promise对象。回调返回会话实例对象，可用于获取会话ID，以及设置元数据、播放状态，发送按键事件等操作。| - **错误码：** 以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。 @@ -424,7 +423,7 @@ castAudio(session: SessionToken | 'all', audioDevices: Array | Promise对象。当投播成功，无返回结果，否则返回错误对象。 | +| Promise\ | Promise对象。当投播成功，无返回结果，否则返回错误对象。 | **错误码：** 以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。 @@ -477,7 +476,7 @@ castAudio(session: SessionToken | 'all', audioDevices: Array | 是 | 媒体设备列表。 | -| callback | AsyncCallback | 是 | 回调函数。当投播成功，err为undefined，否则返回错误对象。 | +| callback | AsyncCallback\ | 是 | 回调函数。当投播成功，err为undefined，否则返回错误对象。 | **错误码：** 以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。 @@ -678,7 +677,7 @@ sendSystemAVKeyEvent(event: KeyEvent): Promise\ | 类型 | 说明 | | -------------- | ----------------------------- | -| Promise | Promise对象。当事件发送成功，无返回结果，否则返回错误对象。 | +| Promise\ | Promise对象。当事件发送成功，无返回结果，否则返回错误对象。 | **错误码：** 以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。 @@ -720,7 +719,7 @@ sendSystemAVKeyEvent(event: KeyEvent, callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------------------------------------ | ---- | ------------------------------------- | | event | [KeyEvent](js-apis-keyevent.md) | 是 | 按键事件。 | -| callback | AsyncCallback | 是 | 回调函数。当事件发送成功，err为undefined，否则返回错误对象。 | +| callback | AsyncCallback\ | 是 | 回调函数。当事件发送成功，err为undefined，否则返回错误对象。 | **错误码：** 以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。 @@ -767,7 +766,7 @@ sendSystemControlCommand(command: AVControlCommand): Promise\ | 类型 | 说明 | | -------------- | ----------------------------- | -| Promise | Promise对象。当命令发送成功，无返回结果，否则返回错误对象。 | +| Promise\ | Promise对象。当命令发送成功，无返回结果，否则返回错误对象。 | **错误码：** 以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。 @@ -821,7 +820,7 @@ sendSystemControlCommand(command: AVControlCommand, callback: AsyncCallback\ | 是 | 回调函数。当命令发送成功，err为undefined，否则返回错误对象。 | +| callback | AsyncCallback\ | 是 | 回调函数。当命令发送成功，err为undefined，否则返回错误对象。 | **错误码：** 以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。 @@ -901,7 +900,7 @@ setAVMetadata(data: AVMetadata): Promise\ | 类型 | 说明 | | -------------- | ----------------------------- | -| Promise | Promise对象。当元数据设置成功，无返回结果，否则返回错误对象。 | +| Promise\ | Promise对象。当元数据设置成功，无返回结果，否则返回错误对象。 | **错误码：** 以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。 @@ -952,7 +951,7 @@ setAVMetadata(data: AVMetadata, callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------- | ---- | ------------------------------------- | | data | [AVMetadata](#avmetadata) | 是 | 会话元数据。 | -| callback | AsyncCallback | 是 | 回调函数。当元数据设置成功，err为undefined，否则返回错误对象。 | +| callback | AsyncCallback\ | 是 | 回调函数。当元数据设置成功，err为undefined，否则返回错误对象。 | **错误码：** 以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。 @@ -1010,7 +1009,7 @@ setAVPlaybackState(state: AVPlaybackState): Promise\ | 类型 | 说明 | | -------------- | ----------------------------- | -| Promise | Promise对象。当播放状态设置成功，无返回结果，否则返回错误对象。 | +| Promise\ | Promise对象。当播放状态设置成功，无返回结果，否则返回错误对象。 | **错误码：** 以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。 @@ -1053,7 +1052,7 @@ setAVPlaybackState(state: AVPlaybackState, callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------------------- | ---- | ---------------------------------------------- | | data | [AVPlaybackState](#avplaybackstate) | 是 | 会话播放状态，包括状态、倍数、循环模式等信息。 | -| callback | AsyncCallback | 是 | 回调函数。当播放状态设置成功，err为undefined，否则返回错误对象。 | +| callback | AsyncCallback\ | 是 | 回调函数。当播放状态设置成功，err为undefined，否则返回错误对象。 | **错误码：** 以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。 @@ -1085,7 +1084,7 @@ session.setAVPlaybackState(PlaybackState, function (err) { ### setAVQueueItems10+ -setAVQueueItems(items: Array\): Promise +setAVQueueItems(items: Array\): Promise\ 设置媒体播放列表。结果通过Promise异步回调方式返回。 @@ -1103,7 +1102,7 @@ setAVQueueItems(items: Array\): Promise | 类型 | 说明 | | -------------- | ----------------------------- | -| Promise | Promise对象。当播放列表设置成功，无返回结果，否则返回错误对象。 | +| Promise\ | Promise对象。当播放列表设置成功，无返回结果，否则返回错误对象。 | **错误码：** 以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。 @@ -1154,7 +1153,7 @@ session.setAVQueueItems(queueItemsArray).then(() => { ### setAVQueueItems10+ -setAVQueueItems(items: Array\, callback: AsyncCallback): void +setAVQueueItems(items: Array\, callback: AsyncCallback\): void 设置媒体播放列表。结果通过callback异步回调方式返回。 @@ -1167,7 +1166,7 @@ setAVQueueItems(items: Array\, callback: AsyncCallback): voi | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------------ | ---- | ----------------------------------------------------------- | | items | Array<[AVQueueItem](#avqueueitem10)\> | 是 | 播放列表单项的队列，用以表示播放列表。 | -| callback | AsyncCallback | 是 | 回调函数。当播放状态设置成功，err为undefined，否则返回错误对象。 | +| callback | AsyncCallback\ | 是 | 回调函数。当播放状态设置成功，err为undefined，否则返回错误对象。 | **错误码：** 以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。 @@ -1238,7 +1237,7 @@ setAVQueueTitle(title: string): Promise\ | 类型 | 说明 | | -------------- | ----------------------------- | -| Promise | Promise对象。当播放列表设置成功，无返回结果，否则返回错误对象。 | +| Promise\ | Promise对象。当播放列表设置成功，无返回结果，否则返回错误对象。 | **错误码：** 以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。 @@ -1261,7 +1260,7 @@ session.setAVQueueTitle(queueTitle).then(() => { ### setAVQueueTitle10+ -setAVQueueTitle(title: string, callback: AsyncCallback\): void +setAVQueueTitle(title: string, callback: AsyncCallback\): void 设置媒体播放列表名称。结果通过callback异步回调方式返回。 @@ -1274,7 +1273,7 @@ setAVQueueTitle(title: string, callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------- | ---- | ----------------------------------------------------------- | | title | string | 是 | 播放列表名称字段。 | -| callback | AsyncCallback | 是 | 回调函数。当播放状态设置成功，err为undefined，否则返回错误对象。 | +| callback | AsyncCallback\ | 是 | 回调函数。当播放状态设置成功，err为undefined，否则返回错误对象。 | **错误码：** 以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。 @@ -1317,7 +1316,7 @@ setLaunchAbility(ability: WantAgent): Promise\ | 类型 | 说明 | | -------------- | ----------------------------- | -| Promise | Promise对象。当Ability设置成功，无返回结果，否则返回错误对象。 | +| Promise\ | Promise对象。当Ability设置成功，无返回结果，否则返回错误对象。 | **错误码：** 以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。 @@ -1384,7 +1383,7 @@ setLaunchAbility(ability: WantAgent, callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------------------------------- | ---- | ------------------------------------------------------------ | | ability | [WantAgent](js-apis-app-ability-wantAgent.md) | 是 | 应用的相关属性信息，如bundleName，abilityName，deviceId等。 | -| callback | AsyncCallback | 是 | 回调函数。当Ability设置成功，err为undefined，否则返回错误对象。 | +| callback | AsyncCallback\ | 是 | 回调函数。当Ability设置成功，err为undefined，否则返回错误对象。 | **错误码：** 以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。 @@ -1462,7 +1461,7 @@ dispatchSessionEvent(event: string, args: {[key: string]: Object}): Promise\ | Promise对象。当事件设置成功，无返回结果，否则返回错误对象。 | +| Promise\ | Promise对象。当事件设置成功，无返回结果，否则返回错误对象。 | **错误码：** 以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。 @@ -1486,7 +1485,7 @@ await session.dispatchSessionEvent(eventName, args).catch((err) => { ### dispatchSessionEvent10+ -dispatchSessionEvent(event: string, args: {[key: string]: Object}, callback: AsyncCallback): void +dispatchSessionEvent(event: string, args: {[key: string]: Object}, callback: AsyncCallback\): void 媒体提供方设置一个会话内自定义事件，包括事件名和键值对形式的事件内容, 结果通过callback异步回调方式返回。 @@ -1500,7 +1499,7 @@ dispatchSessionEvent(event: string, args: {[key: string]: Object}, callback: Asy | ------- | --------------------------------------------- | ---- | ----------------------------------------------------------- | | event | string | 是 | 需要设置的会话事件的名称 | | args | {[key: string]: any} | 是 | 需要传递的会话事件键值对 | -| callback | AsyncCallback | 是 | 回调函数。当会话事件设置成功，err为undefined，否则返回错误对象。 | +| callback | AsyncCallback\ | 是 | 回调函数。当会话事件设置成功，err为undefined，否则返回错误对象。 | > **说明：** > 参数args支持的数据类型有：字符串、数字、布尔、对象、数组和文件描述符等，详细介绍请参见[@ohos.app.ability.Want(Want)](./js-apis-app-ability-want.md)。 @@ -1550,7 +1549,7 @@ setExtras(extras: {[key: string]: Object}): Promise\ | 类型 | 说明 | | -------------- | ----------------------------- | -| Promise | Promise对象。当自定义媒体数据包设置成功，无返回结果，否则返回错误对象。 | +| Promise\ | Promise对象。当自定义媒体数据包设置成功，无返回结果，否则返回错误对象。 | **错误码：** 以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。 @@ -1573,7 +1572,7 @@ await session.setExtras(extras).catch((err) => { ### setExtras10+ -setExtras(extras: {[key: string]: Object}, callback: AsyncCallback): void +setExtras(extras: {[key: string]: Object}, callback: AsyncCallback\): void 媒体提供方设置键值对形式的自定义媒体数据包, 结果通过callback异步回调方式返回。 @@ -1584,7 +1583,7 @@ setExtras(extras: {[key: string]: Object}, callback: AsyncCallback): void | 参数名 | 类型 | 必填 | 说明 | | ------- | --------------------------------------------- | ---- | ----------------------------------------------------------- | | extras | {[key: string]: any} | 是 | 需要传递的自定义媒体数据包键值对 | -| callback | AsyncCallback | 是 | 回调函数。当自定义媒体数据包设置成功，err为undefined，否则返回错误对象。 | +| callback | AsyncCallback\ | 是 | 回调函数。当自定义媒体数据包设置成功，err为undefined，否则返回错误对象。 | > **说明：** > 参数extras支持的数据类型有：字符串、数字、布尔、对象、数组和文件描述符等，详细介绍请参见[@ohos.app.ability.Want(Want)](./js-apis-app-ability-want.md)。 @@ -1768,7 +1767,7 @@ activate(): Promise\ | 类型 | 说明 | | -------------- | ----------------------------- | -| Promise | Promise对象。当会话激活成功，无返回结果，否则返回错误对象。 | +| Promise\ | Promise对象。当会话激活成功，无返回结果，否则返回错误对象。 | **错误码：** 以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。 @@ -1802,7 +1801,7 @@ activate(callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ---------- | -| callback | AsyncCallback | 是 | 回调函数。当会话激活成功，err为undefined，否则返回错误对象。 | +| callback | AsyncCallback\ | 是 | 回调函数。当会话激活成功，err为undefined，否则返回错误对象。 | **错误码：** 以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。 @@ -1838,7 +1837,7 @@ deactivate(): Promise\ | 类型 | 说明 | | -------------- | ----------------------------- | -| Promise | Promise对象。当禁用会话成功，无返回结果，否则返回错误对象。| +| Promise\ | Promise对象。当禁用会话成功，无返回结果，否则返回错误对象。| **错误码：** 以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。 @@ -1874,7 +1873,7 @@ deactivate(callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ---------- | -| callback | AsyncCallback | 是 | 回调函数。当禁用会话成功，err为undefined，否则返回错误对象。| +| callback | AsyncCallback\ | 是 | 回调函数。当禁用会话成功，err为undefined，否则返回错误对象。| **错误码：** 以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。 @@ -1910,7 +1909,7 @@ destroy(): Promise\ | 类型 | 说明 | | -------------- | ----------------------------- | -| Promise | Promise对象。当会话销毁成功，无返回结果，否则返回错误对象。 | +| Promise\ | Promise对象。当会话销毁成功，无返回结果，否则返回错误对象。 | **错误码：** 以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。 @@ -1944,7 +1943,7 @@ destroy(callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ---------- | -| callback | AsyncCallback | 是 | 回调函数。当会话销毁成功，err为undefined，否则返回错误对象。 | +| callback | AsyncCallback\ | 是 | 回调函数。当会话销毁成功，err为undefined，否则返回错误对象。 | **错误码：** 以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。 @@ -2824,7 +2823,7 @@ skipToQueueItem(itemId: number): Promise\ | 类型 | 说明 | | -------------- | --------------------------------------------------------------- | -| Promise | Promise对象。当播放列表单项ID设置成功，无返回结果，否则返回错误对象。 | +| Promise\ | Promise对象。当播放列表单项ID设置成功，无返回结果，否则返回错误对象。 | **错误码：** 以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。 @@ -2860,7 +2859,7 @@ skipToQueueItem(itemId: number, callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------- | ---- | ----------------------------------------------------------- | | itemId | number | 是 | 播放列表单项的ID值，用以表示选中的播放列表单项。 | -| callback | AsyncCallback | 是 | 回调函数。当播放状态设置成功，err为undefined，否则返回错误对象。 | +| callback | AsyncCallback\ | 是 | 回调函数。当播放状态设置成功，err为undefined，否则返回错误对象。 | **错误码：** 以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。 @@ -3137,7 +3136,7 @@ sendAVKeyEvent(event: KeyEvent): Promise\ | 类型 | 说明 | | -------------- | ----------------------------- | -| Promise | Promise对象。当事件发送成功，无返回结果，否则返回错误对象。 | +| Promise\ | Promise对象。当事件发送成功，无返回结果，否则返回错误对象。 | **示例：** @@ -3167,7 +3166,7 @@ sendAVKeyEvent(event: KeyEvent, callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------------------------------------ | ---- | ---------- | | event | [KeyEvent](js-apis-keyevent.md) | 是 | 按键事件。 | -| callback | AsyncCallback | 是 | 回调函数。当事件发送成功，err为undefined，否则返回错误对象。 | +| callback | AsyncCallback\ | 是 | 回调函数。当事件发送成功，err为undefined，否则返回错误对象。 | **错误码：** 以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。 @@ -3387,7 +3386,7 @@ destroy(): Promise\ | 类型 | 说明 | | -------------- | ----------------------------- | -| Promise | Promise对象。当控制器销毁成功，无返回结果，否则返回错误对象。 | +| Promise\ | Promise对象。当控制器销毁成功，无返回结果，否则返回错误对象。 | **错误码：** 以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。 @@ -3421,7 +3420,7 @@ destroy(callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ---------- | -| callback | AsyncCallback | 是 | 回调函数。当控制器销毁成功，err为undefined，否则返回错误对象。 | +| callback | AsyncCallback\ | 是 | 回调函数。当控制器销毁成功，err为undefined，否则返回错误对象。 | **错误码：** 以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。 @@ -3539,7 +3538,7 @@ sendControlCommand(command: AVControlCommand): Promise\ | 类型 | 说明 | | -------------- | ----------------------------- | -| Promise | Promise对象。当命令发送成功，无返回结果，否则返回错误对象。 | +| Promise\ | Promise对象。当命令发送成功，无返回结果，否则返回错误对象。 | **错误码：** 以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。 @@ -3593,7 +3592,7 @@ sendControlCommand(command: AVControlCommand, callback: AsyncCallback\): v | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------------- | ---- | ------------------------------ | | command | [AVControlCommand](#avcontrolcommand) | 是 | 会话的相关命令和命令相关参数。 | -| callback | AsyncCallback | 是 | 回调函数。当命令发送成功，err为undefined，否则返回错误对象。 | +| callback | AsyncCallback\ | 是 | 回调函数。当命令发送成功，err为undefined，否则返回错误对象。 | **错误码：** 以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。 @@ -3654,7 +3653,7 @@ sendCommonCommand(command: string, args: {[key: string]: Object}): Promise\ | Promise对象。当命令发送成功，无返回结果，否则返回错误对象。 | +| Promise\ | Promise对象。当命令发送成功，无返回结果，否则返回错误对象。 | **错误码：** 以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。 @@ -3696,7 +3695,7 @@ sendCommonCommand(command: string, args: {[key: string]: Object}, callback: Asyn | ------- | ------------------------------------- | ---- | ------------------------------ | | command | string | 是 | 需要设置的自定义控制命令的名称 | | args | {[key: string]: any} | 是 | 需要传递的控制命令键值对 | -| callback | AsyncCallback | 是 | 回调函数。当命令发送成功，err为undefined，否则返回错误对象。 | +| callback | AsyncCallback\ | 是 | 回调函数。当命令发送成功，err为undefined，否则返回错误对象。 | > **说明：** > 参数args支持的数据类型有：字符串、数字、布尔、对象、数组和文件描述符等，详细介绍请参见[@ohos.app.ability.Want(Want)](./js-apis-app-ability-want.md)。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-bluetoothManager.md b/zh-cn/application-dev/reference/apis/js-apis-bluetoothManager.md index a181e526ef..72b9a7371c 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-bluetoothManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-bluetoothManager.md @@ -694,7 +694,7 @@ try { ``` -## bluetoothManager.setDevicePinCode10+ +## bluetoothManager.setDevicePinCode10+ setDevicePinCode(device: string, code: string): Promise<void> diff --git a/zh-cn/application-dev/reference/apis/js-apis-commonEvent.md b/zh-cn/application-dev/reference/apis/js-apis-commonEvent.md index b9cf951cc3..cf45a3b3f4 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-commonEvent.md +++ b/zh-cn/application-dev/reference/apis/js-apis-commonEvent.md @@ -186,7 +186,7 @@ CommonEvent.publishAsUser("event", userId, options, publishCB); ## CommonEvent.createSubscriber(deprecated) -createSubscriber(subscribeInfo: CommonEventSubscribeInfo, callback: AsyncCallback): void +createSubscriber(subscribeInfo: CommonEventSubscribeInfo, callback: AsyncCallback\): void 以回调形式创建订阅者。 @@ -229,7 +229,7 @@ CommonEvent.createSubscriber(subscribeInfo, createCB); ## CommonEvent.createSubscriber(deprecated) -createSubscriber(subscribeInfo: CommonEventSubscribeInfo): Promise +createSubscriber(subscribeInfo: CommonEventSubscribeInfo): Promise\ 以Promise形式创建订阅者。 @@ -270,7 +270,7 @@ CommonEvent.createSubscriber(subscribeInfo).then((commonEventSubscriber) => { ## CommonEvent.subscribe(deprecated) -subscribe(subscriber: CommonEventSubscriber, callback: AsyncCallback): void +subscribe(subscriber: CommonEventSubscriber, callback: AsyncCallback\): void 以回调形式订阅公共事件。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-commonEventManager.md b/zh-cn/application-dev/reference/apis/js-apis-commonEventManager.md index 789173a32a..53ef04cd6f 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-commonEventManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-commonEventManager.md @@ -562,7 +562,7 @@ setStaticSubscriberState(enable: boolean, callback: AsyncCallback\): void; | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | -------------------------- | | enable | boolean | 是 | 表示静态订阅事件使能状态。 true:使能 false：去使能。 | -| callback | AsyncCallback | 是 | 表示设置静态订阅事件使能状态的回调方法。 | +| callback | AsyncCallback\ | 是 | 表示设置静态订阅事件使能状态的回调方法。 | **错误码：** diff --git a/zh-cn/application-dev/reference/apis/js-apis-image.md b/zh-cn/application-dev/reference/apis/js-apis-image.md index 5f3087afd4..be0428b759 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-image.md +++ b/zh-cn/application-dev/reference/apis/js-apis-image.md @@ -1702,7 +1702,7 @@ let delayTimes = imageSourceApi.getDelayTime(); ### getFrameCount10+ -getFrameCount(callback: AsyncCallback): void; +getFrameCount(callback: AsyncCallback\): void; 获取图像帧数，使用callback形式返回结果。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-inputmethodengine.md b/zh-cn/application-dev/reference/apis/js-apis-inputmethodengine.md index c052d526d5..4a4221f926 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inputmethodengine.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inputmethodengine.md @@ -1067,7 +1067,7 @@ resize(width: number, height: number): Promise\; | 类型 | 说明 | | ------- | ------------------------------ | -| Promise | 无返回结果的Promise对象。 | +| Promise\ | 无返回结果的Promise对象。 | **示例：** @@ -1139,7 +1139,7 @@ moveTo(x: number, y: number): Promise\ | 类型 | 说明 | | ------- | ------------------------------ | -| Promise | 无返回结果的Promise对象。 | +| Promise\ | 无返回结果的Promise对象。 | **示例：** diff --git a/zh-cn/application-dev/security/huks-guidelines.md b/zh-cn/application-dev/security/huks-guidelines.md index 6468aeb707..855b5adcd2 100644 --- a/zh-cn/application-dev/security/huks-guidelines.md +++ b/zh-cn/application-dev/security/huks-guidelines.md @@ -5,19 +5,14 @@ HUKS提供为业务安全随机生成密钥的能力。通过HUKS生成的密钥，密钥的全生命周期明文不会出安全环境，能保证任何人都无法接触获取到密钥的明文。即使生成密钥的业务自身，后续也只能通过HUKS提供的接口请求执行密钥操作，获取操作结果，但无法接触到密钥自身。 - -**开发步骤** +**开发步骤** 生成密钥时使用[huks.generateKeyItem(keyAlias,options,callback)](../reference/apis/js-apis-huks.md#huksgeneratekeyitem9)方法，传入keyAlias作为密钥别名，传入options包含该密钥的属性集，传入callback用于回调异步结果。关于接口的具体信息，可在[API参考文档](../reference/apis/js-apis-huks.md)中查看。 - - 1. 确定密钥别名； 2. 初始化密钥属性集：通过[HuksParam](../reference/apis/js-apis-huks.md#huksparam)封装密钥属性，搭配Array组成密钥属性集，并赋值给[HuksOptions](../reference/apis/js-apis-huks.md#huksoptions)（properties字段），其中必须包含[HuksKeyAlg](../reference/apis/js-apis-huks.md#hukskeyalg),[HuksKeySize](../reference/apis/js-apis-huks.md#hukskeysize),[HuksKeyPurpose](../reference/apis/js-apis-huks.md#hukskeypurpose)属性； 3. 将密钥别名与密钥参数集作为参数传入，生成密钥。 - - > **说明** > > 存储的 keyAlias 密钥别名最大为64字节 @@ -227,9 +222,9 @@ try { | 接口名 | 描述 | | -------------------------------------- | ----------------------------| |generateKeyItem(keyAlias: string, options: HuksOptions, callback: AsyncCallback\) : void| 生成新密钥| -|exportKeyItem(keyAlias: string, options: HuksOptions, callback: AsyncCallback) : void| 导出密钥对的公钥| -|importWrappedKeyItem(keyAlias: string, wrappingKeyAlias: string, options: HuksOptions, callback: AsyncCallback) : void|导入加密密钥| -|deleteKeyItem(keyAlias: string, options: HuksOptions, callback: AsyncCallback) : void|删除密钥| +|exportKeyItem(keyAlias: string, options: HuksOptions, callback: AsyncCallback\) : void| 导出密钥对的公钥| +|importWrappedKeyItem(keyAlias: string, wrappingKeyAlias: string, options: HuksOptions, callback: AsyncCallback\) : void|导入加密密钥| +|deleteKeyItem(keyAlias: string, options: HuksOptions, callback: AsyncCallback\) : void|删除密钥| 需要注意的是，导出密钥接口返回的公钥明文材料是按照**X.509**格式封装，导入加密密钥接口中的密钥材料需满足**LengthData-Data** 的格式封装。具体，应用需要申请一个Uint8Array按照以下表格中的顺序依次封装。 diff --git a/zh-cn/application-dev/telephony/telephony-sms.md b/zh-cn/application-dev/telephony/telephony-sms.md index ca4f78bceb..a6ee614501 100644 --- a/zh-cn/application-dev/telephony/telephony-sms.md +++ b/zh-cn/application-dev/telephony/telephony-sms.md @@ -31,11 +31,11 @@ | 接口名 | 描述 | | ------------------------------------------------------------ | ------------------------------------------------------- | -| createMessage(pdu: Array, specification: string, callback: AsyncCallback): void | 基于协议数据单元（PDU）和指定的SMS协议创建SMS消息实例。 | +| createMessage(pdu: Array\, specification: string, callback: AsyncCallback\): void | 基于协议数据单元（PDU）和指定的SMS协议创建SMS消息实例。 | | sendMessage(options: SendMessageOptions): void | 发送文本或数据SMS消息。 | -| getDefaultSmsSlotId(callback: AsyncCallback): void | 获取用于发送短信的默认SIM卡。 | -| setSmscAddr(slotId: number, smscAddr: string, callback: AsyncCallback): void | 根据指定的插槽ID设置短信服务中心的地址。 | -| getSmscAddr(slotId: number, callback: AsyncCallback): void | 根据指定的插槽ID获取短信服务中心地址。 | +| getDefaultSmsSlotId(callback: AsyncCallback\): void | 获取用于发送短信的默认SIM卡。 | +| setSmscAddr(slotId: number, smscAddr: string, callback: AsyncCallback\): void | 根据指定的插槽ID设置短信服务中心的地址。 | +| getSmscAddr(slotId: number, callback: AsyncCallback\): void | 根据指定的插槽ID获取短信服务中心地址。 | ## 开发步骤 diff --git a/zh-cn/application-dev/website.md b/zh-cn/application-dev/website.md index 53f148e7c6..632415c056 100644 --- a/zh-cn/application-dev/website.md +++ b/zh-cn/application-dev/website.md @@ -1289,7 +1289,7 @@ - [@ohos.file.storageStatistics (应用空间统计)](reference/apis/js-apis-file-storage-statistics.md) - [@ohos.file.volumeManager (卷管理)](reference/apis/js-apis-file-volumemanager.md) - [@ohos.filemanagement.userFileManager (用户数据管理)](reference/apis/js-apis-userFileManager.md) - - [@ohos.fileShare (文件分享)](reference/apis/js-apis-fileShare.md) + - [@ohos.fileshare (文件分享)](reference/apis/js-apis-fileShare.md) - 电话服务 - [@ohos.contact (联系人)](reference/apis/js-apis-contact.md) - [@ohos.telephony.call (拨打电话)](reference/apis/js-apis-call.md) -- GitLab