From 4b5e9b56905cb43c595a95070fabe86defe9b98d Mon Sep 17 00:00:00 2001 From: xujie Date: Sat, 5 Aug 2023 15:06:14 +0800 Subject: [PATCH 1/5] fix Signed-off-by: xujie --- .../reference/apis/js-apis-net-mdns.md | 132 +++++++++++++++++- 1 file changed, 128 insertions(+), 4 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-net-mdns.md b/zh-cn/application-dev/reference/apis/js-apis-net-mdns.md index fab925b78e13..813704e4bffa 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-net-mdns.md +++ b/zh-cn/application-dev/reference/apis/js-apis-net-mdns.md @@ -718,6 +718,37 @@ discoveryService.on('discoveryStart', (data) => { discoveryService.stopSearchingMDNS(); ``` +### off('discoveryStart')10+ + +off(type: 'discoveryStart', callback?: Callback<{serviceInfo: LocalServiceInfo, errorCode?: MdnsError}>): void + +关闭开启监听mDNS服务的通知。 + +**系统能力**：SystemCapability.Communication.NetManager.MDNS + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | +| type | string | 是 | 订阅事件，固定为'discoveryStart'。
discoveryStart：开始搜索局域网内的mDNS服务事件。 | +| callback | Callback<{serviceInfo: [LocalServiceInfo](#localserviceinfo), errorCode?: [MdnsError](#mdnserror)}> | 否 | mDNS服务的信息和事件错误信息。 | + +**示例：** + +```js +// 参考mdns.createDiscoveryService +let context = globalThis.context; +let serviceType = "_print._tcp"; +let discoveryService = mdns.createDiscoveryService(context, serviceType); +discoveryService.startSearchingMDNS(); + +discoveryService.off('discoveryStart', (data) => { + console.log(JSON.stringify(data)); +}); + +discoveryService.stopSearchingMDNS(); +``` + ### on('discoveryStop')10+ on(type: 'discoveryStop', callback: Callback<{serviceInfo: LocalServiceInfo, errorCode?: MdnsError}>): void @@ -749,6 +780,37 @@ discoveryService.on('discoveryStop', (data) => { discoveryService.stopSearchingMDNS(); ``` +### off('discoveryStop')10+ + +off(type: 'discoveryStop', callback?: Callback<{serviceInfo: LocalServiceInfo, errorCode?: MdnsError}>): void + +取消停止监听mDNS服务的通知。 + +**系统能力**：SystemCapability.Communication.NetManager.MDNS + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | +| type | string | 是 | 订阅事件，固定为'discoveryStop'。
discoveryStop：停止搜索局域网内的mDNS服务事件。 | +| callback | Callback<{serviceInfo: [LocalServiceInfo](#localserviceinfo), errorCode?: [MdnsError](#mdnserror)}> | 否 | mDNS服务的信息和事件错误信息。 | + +**示例：** + +```js +// 参考mdns.createDiscoveryService +let context = globalThis.context; +let serviceType = "_print._tcp"; +let discoveryService = mdns.createDiscoveryService(context, serviceType); +discoveryService.startSearchingMDNS(); + +discoveryService.off('discoveryStop', (data) => { + console.log(JSON.stringify(data)); +}); + +discoveryService.stopSearchingMDNS(); +``` + ### on('serviceFound')10+ on(type: 'serviceFound', callback: Callback\): void @@ -759,10 +821,10 @@ on(type: 'serviceFound', callback: Callback\): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -|-------------|--------------|-----------|-----------------------------------------------------| -| type | string | 是 |订阅事件，固定为'serviceFound'。
serviceFound：发现mDNS服务事件。 | -| callback | Callback<[LocalServiceInfo](#localserviceinfo)> | 是 | mDNS服务的信息。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------------------------------- | ---- | ------------------------------------------------------------ | +| type | string | 是 | 订阅事件，固定为'serviceFound'。
serviceFound：发现mDNS服务事件。 | +| callback | Callback<[LocalServiceInfo](#localserviceinfo)> | 是 | mDNS服务的信息。 | **示例：** @@ -780,6 +842,37 @@ discoveryService.on('serviceFound', (data) => { discoveryService.stopSearchingMDNS(); ``` +### off('serviceFound')10+ + +off(type: 'serviceFound', callback?: Callback\): void + +取消发现mDNS服务的通知。 + +**系统能力**：SystemCapability.Communication.NetManager.MDNS + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------------------------------- | ---- | ------------------------------------------------------------ | +| type | string | 是 | 订阅事件，固定为'serviceFound'。
serviceFound：发现mDNS服务事件。 | +| callback | Callback<[LocalServiceInfo](#localserviceinfo)> | 否 | mDNS服务的信息。 | + +**示例：** + +```js +// 参考mdns.createDiscoveryService +let context = globalThis.context; +let serviceType = "_print._tcp"; +let discoveryService = mdns.createDiscoveryService(context, serviceType); +discoveryService.startSearchingMDNS(); + +discoveryService.off('serviceFound', (data) => { + console.log(JSON.stringify(data)); +}); + +discoveryService.stopSearchingMDNS(); +``` + ### on('serviceLost')10+ on(type: 'serviceLost', callback: Callback\): void @@ -811,6 +904,37 @@ discoveryService.on('serviceLost', (data) => { discoveryService.stopSearchingMDNS(); ``` +### off('serviceLost')10+ + +off(type: 'serviceLost', callback?: Callback\): void + +取消移除mDNS服务的通知。 + +**系统能力**：SystemCapability.Communication.NetManager.MDNS + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------------------------------- | ---- | ------------------------------------------------------------ | +| type | string | 是 | 订阅事件，固定为'serviceLost'。
serviceLost：移除mDNS服务事件。 | +| callback | Callback<[LocalServiceInfo](#localserviceinfo)> | 否 | mDNS服务的信息。 | + +**示例：** + +```js +// 参考mdns.createDiscoveryService +let context = globalThis.context; +let serviceType = "_print._tcp"; +let discoveryService = mdns.createDiscoveryService(context, serviceType); +discoveryService.startSearchingMDNS(); + +discoveryService.off('serviceLost', (data) => { + console.log(JSON.stringify(data)); +}); + +discoveryService.stopSearchingMDNS(); +``` + ## LocalServiceInfo10+ mDNS服务信息 -- Gitee From a1f3f578ac3b10add6091436358b936d16f3768f Mon Sep 17 00:00:00 2001 From: xujie Date: Sat, 5 Aug 2023 15:17:11 +0800 Subject: [PATCH 2/5] fix Signed-off-by: xujie --- zh-cn/application-dev/reference/apis/js-apis-net-mdns.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-net-mdns.md b/zh-cn/application-dev/reference/apis/js-apis-net-mdns.md index 813704e4bffa..94fd84bfd03e 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-net-mdns.md +++ b/zh-cn/application-dev/reference/apis/js-apis-net-mdns.md @@ -821,10 +821,10 @@ on(type: 'serviceFound', callback: Callback\): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ----------------------------------------------- | ---- | ------------------------------------------------------------ | -| type | string | 是 | 订阅事件，固定为'serviceFound'。
serviceFound：发现mDNS服务事件。 | -| callback | Callback<[LocalServiceInfo](#localserviceinfo)> | 是 | mDNS服务的信息。 | +| 参数名 | 类型 | 必填 | 说明 | +|-------------|--------------|-----------|-----------------------------------------------------| +| type | string | 是 |订阅事件，固定为'serviceFound'。
serviceFound：发现mDNS服务事件。 | +| callback | Callback<[LocalServiceInfo](#localserviceinfo)> | 是 | mDNS服务的信息。 | **示例：** -- Gitee From 1591d3370f1a72a43d008a90d0f5781af47f5dfb Mon Sep 17 00:00:00 2001 From: xujie Date: Tue, 8 Aug 2023 13:59:40 +0800 Subject: [PATCH 3/5] fix Signed-off-by: xujie --- zh-cn/application-dev/reference/apis/js-apis-net-mdns.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-net-mdns.md b/zh-cn/application-dev/reference/apis/js-apis-net-mdns.md index 94fd84bfd03e..b5665f5f0bcd 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-net-mdns.md +++ b/zh-cn/application-dev/reference/apis/js-apis-net-mdns.md @@ -722,7 +722,7 @@ discoveryService.stopSearchingMDNS(); off(type: 'discoveryStart', callback?: Callback<{serviceInfo: LocalServiceInfo, errorCode?: MdnsError}>): void -关闭开启监听mDNS服务的通知。 +停止监听mDNS服务的发现通知。 **系统能力**：SystemCapability.Communication.NetManager.MDNS @@ -784,7 +784,7 @@ discoveryService.stopSearchingMDNS(); off(type: 'discoveryStop', callback?: Callback<{serviceInfo: LocalServiceInfo, errorCode?: MdnsError}>): void -取消停止监听mDNS服务的通知。 +停止监听mDNS服务的关闭通知。 **系统能力**：SystemCapability.Communication.NetManager.MDNS -- Gitee From 46ff04ae8e0bcbd381c08d049284bb20f99ad947 Mon Sep 17 00:00:00 2001 From: xujie Date: Thu, 10 Aug 2023 14:07:51 +0800 Subject: [PATCH 4/5] fix Signed-off-by: xujie --- .../reference/apis/js-apis-net-mdns.md | 44 ++++++++++--------- 1 file changed, 24 insertions(+), 20 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-net-mdns.md b/zh-cn/application-dev/reference/apis/js-apis-net-mdns.md index b5665f5f0bcd..ac21007151fd 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-net-mdns.md +++ b/zh-cn/application-dev/reference/apis/js-apis-net-mdns.md @@ -24,8 +24,8 @@ addLocalService(context: Context, serviceInfo: LocalServiceInfo, callback: Async | 参数名 | 类型 | 必填 | 说明 | |-------------|----------------------------------|-----------|-------------------------------------------------| | context | Context | 是 | 应用的上下文。
FA模型的应用Context定义见[Context](js-apis-inner-app-context.md)。
Stage模型的应用Context定义见[Context](js-apis-app-ability-uiAbility.md)。 | -| serviceInfo | [LocalServiceInfo](#localserviceinfo) | 是 | mDNS服务的信息。 | -| callback | AsyncCallback\<[LocalServiceInfo](#localserviceinfo)> | 是 | 回调函数。成功添加error为undefined，data为添加到本地的mdns服务信息。 | +| serviceInfo | [LocalServiceInfo](#localserviceinfo10) | 是 | mDNS服务的信息。 | +| callback | AsyncCallback\<[LocalServiceInfo](#localserviceinfo10)> | 是 | 回调函数。成功添加error为undefined，data为添加到本地的mdns服务信息。 | **错误码：** @@ -113,13 +113,13 @@ addLocalService(context: Context, serviceInfo: LocalServiceInfo): Promise\FA模型的应用Context定义见[Context](js-apis-inner-app-context.md)。
Stage模型的应用Context定义见[Context](js-apis-app-ability-uiAbility.md)。 | -| serviceInfo | [LocalServiceInfo](#localserviceinfo) | 是 | mDNS服务的信息。 | +| serviceInfo | [LocalServiceInfo](#localserviceinfo10) | 是 | mDNS服务的信息。 | **返回值：** | 类型 | 说明 | | --------------------------------- | ------------------------------------- | -| Promise\<[LocalServiceInfo](#localserviceinfo)> | 以Promise形式返回添加的mdns服务信息。 | +| Promise\<[LocalServiceInfo](#localserviceinfo10)> | 以Promise形式返回添加的mdns服务信息。 | **错误码：** @@ -205,8 +205,8 @@ removeLocalService(context: Context, serviceInfo: LocalServiceInfo, callback: As | 参数名 | 类型 | 必填 | 说明 | |-------------|----------------------------------|-----------|-------------------------------------------------| | context | Context | 是 | 应用的上下文。
FA模型的应用Context定义见[Context](js-apis-inner-app-context.md)。
Stage模型的应用Context定义见[Context](js-apis-app-ability-uiAbility.md)。 | -| serviceInfo | [LocalServiceInfo](#localserviceinfo) | 是 | mDNS服务的信息。 | -| callback | AsyncCallback\<[LocalServiceInfo](#localserviceinfo)> | 是 | 回调函数。成功移除error为undefined，data为移除本地的mdns服务信息。 | +| serviceInfo | [LocalServiceInfo](#localserviceinfo10) | 是 | mDNS服务的信息。 | +| callback | AsyncCallback\<[LocalServiceInfo](#localserviceinfo10)> | 是 | 回调函数。成功移除error为undefined，data为移除本地的mdns服务信息。 | **错误码：** @@ -294,13 +294,13 @@ removeLocalService(context: Context, serviceInfo: LocalServiceInfo): Promise\FA模型的应用Context定义见[Context](js-apis-inner-app-context.md)。
Stage模型的应用Context定义见[Context](js-apis-app-ability-uiAbility.md)。 | -| serviceInfo | [LocalServiceInfo](#localserviceinfo) | 是 | mDNS服务的信息。 | +| serviceInfo | [LocalServiceInfo](#localserviceinfo10) | 是 | mDNS服务的信息。 | **返回值：** | 类型 | 说明 | | --------------------------------- | ------------------------------------- | -| Promise\<[LocalServiceInfo](#localserviceinfo)> | 以Promise形式返回移除的mdns服务信息。 | +| Promise\<[LocalServiceInfo](#localserviceinfo10)> | 以Promise形式返回移除的mdns服务信息。 | **错误码：** @@ -442,8 +442,8 @@ resolveLocalService(context: Context, serviceInfo: LocalServiceInfo, callback: A | 参数名 | 类型 | 必填 | 说明 | |-------------|----------------------------------|-----------|-------------------------------------------------------------| | context | Context | 是 | 应用的上下文。
FA模型的应用Context定义见[Context](js-apis-inner-app-context.md)。
Stage模型的应用Context定义见[Context](js-apis-app-ability-uiAbility.md)。 | -| serviceInfo | [LocalServiceInfo](#localserviceinfo) | 是 | mDNS服务的信息。 | -| callback | AsyncCallback\<[LocalServiceInfo](#localserviceinfo)> | 是 | 回调函数。成功移除error为undefined，data为解析的mdns服务信息。 | +| serviceInfo | [LocalServiceInfo](#localserviceinfo10) | 是 | mDNS服务的信息。 | +| callback | AsyncCallback\<[LocalServiceInfo](#localserviceinfo10)> | 是 | 回调函数。成功移除error为undefined，data为解析的mdns服务信息。 | **错误码：** @@ -531,13 +531,13 @@ resolveLocalService(context: Context, serviceInfo: LocalServiceInfo): Promise\FA模型的应用Context定义见[Context](js-apis-inner-app-context.md)。
Stage模型的应用Context定义见[Context](js-apis-app-ability-uiAbility.md)。 | -| serviceInfo | [LocalServiceInfo](#localserviceinfo) | 是 | mDNS服务的信息。 | +| serviceInfo | [LocalServiceInfo](#localserviceinfo10) | 是 | mDNS服务的信息。 | **返回值：** | 类型 | 说明 | |----------------------------| ------------------------------------- | -| Promise\<[LocalServiceInfo](#localserviceinfo)> | 以Promise形式返回解析的mDNS服务信息。| +| Promise\<[LocalServiceInfo](#localserviceinfo10)> | 以Promise形式返回解析的mDNS服务信息。| **错误码：** @@ -700,7 +700,7 @@ on(type: 'discoveryStart', callback: Callback<{serviceInfo: LocalServiceInfo, er | 参数名 | 类型 | 必填 | 说明 | |-------------|--------------|-----------|-----------------------------------------------------| | type | string | 是 |订阅事件，固定为'discoveryStart'。
discoveryStart：开始搜索局域网内的mDNS服务事件。 | -| callback | Callback<{serviceInfo: [LocalServiceInfo](#localserviceinfo), errorCode?: [MdnsError](#mdnserror)}> | 是 | mDNS服务的信息和事件错误信息。 | +| callback | Callback<{serviceInfo: [LocalServiceInfo](#localserviceinfo10), errorCode?: [MdnsError](#mdnserror)}> | 是 | mDNS服务的信息和事件错误信息。 | **示例：** @@ -731,7 +731,7 @@ off(type: 'discoveryStart', callback?: Callback<{serviceInfo: LocalServiceInfo, | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | type | string | 是 | 订阅事件，固定为'discoveryStart'。
discoveryStart：开始搜索局域网内的mDNS服务事件。 | -| callback | Callback<{serviceInfo: [LocalServiceInfo](#localserviceinfo), errorCode?: [MdnsError](#mdnserror)}> | 否 | mDNS服务的信息和事件错误信息。 | +| callback | Callback<{serviceInfo: [LocalServiceInfo](#localserviceinfo10), errorCode?: [MdnsError](#mdnserror)}> | 否 | mDNS服务的信息和事件错误信息。 | **示例：** @@ -742,6 +742,10 @@ let serviceType = "_print._tcp"; let discoveryService = mdns.createDiscoveryService(context, serviceType); discoveryService.startSearchingMDNS(); +discoveryService.on('discoveryStart', (data) => { + console.log(JSON.stringify(data)); +}); + discoveryService.off('discoveryStart', (data) => { console.log(JSON.stringify(data)); }); @@ -762,7 +766,7 @@ on(type: 'discoveryStop', callback: Callback<{serviceInfo: LocalServiceInfo, err | 参数名 | 类型 | 必填 | 说明 | |-------------|--------------|-----------|-----------------------------------------------------| | type | string | 是 |订阅事件，固定为'discoveryStop'。
discoveryStop：停止搜索局域网内的mDNS服务事件。 | -| callback | Callback<{serviceInfo: [LocalServiceInfo](#localserviceinfo), errorCode?: [MdnsError](#mdnserror)}> | 是 | mDNS服务的信息和事件错误信息。 | +| callback | Callback<{serviceInfo: [LocalServiceInfo](#localserviceinfo10), errorCode?: [MdnsError](#mdnserror)}> | 是 | mDNS服务的信息和事件错误信息。 | **示例：** @@ -793,7 +797,7 @@ off(type: 'discoveryStop', callback?: Callback<{serviceInfo: LocalServiceInfo, e | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | type | string | 是 | 订阅事件，固定为'discoveryStop'。
discoveryStop：停止搜索局域网内的mDNS服务事件。 | -| callback | Callback<{serviceInfo: [LocalServiceInfo](#localserviceinfo), errorCode?: [MdnsError](#mdnserror)}> | 否 | mDNS服务的信息和事件错误信息。 | +| callback | Callback<{serviceInfo: [LocalServiceInfo](#localserviceinfo10), errorCode?: [MdnsError](#mdnserror)}> | 否 | mDNS服务的信息和事件错误信息。 | **示例：** @@ -824,7 +828,7 @@ on(type: 'serviceFound', callback: Callback\): void | 参数名 | 类型 | 必填 | 说明 | |-------------|--------------|-----------|-----------------------------------------------------| | type | string | 是 |订阅事件，固定为'serviceFound'。
serviceFound：发现mDNS服务事件。 | -| callback | Callback<[LocalServiceInfo](#localserviceinfo)> | 是 | mDNS服务的信息。 | +| callback | Callback<[LocalServiceInfo](#localserviceinfo10)> | 是 | mDNS服务的信息。 | **示例：** @@ -855,7 +859,7 @@ off(type: 'serviceFound', callback?: Callback\): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------------------------------- | ---- | ------------------------------------------------------------ | | type | string | 是 | 订阅事件，固定为'serviceFound'。
serviceFound：发现mDNS服务事件。 | -| callback | Callback<[LocalServiceInfo](#localserviceinfo)> | 否 | mDNS服务的信息。 | +| callback | Callback<[LocalServiceInfo](#localserviceinfo10)> | 否 | mDNS服务的信息。 | **示例：** @@ -886,7 +890,7 @@ on(type: 'serviceLost', callback: Callback\): void | 参数名 | 类型 | 必填 | 说明 | |-------------|--------------|-----------|-----------------------------------------------------| | type | string | 是 |订阅事件，固定为'serviceLost'。
serviceLost：移除mDNS服务事件。 | -| callback | Callback<[LocalServiceInfo](#localserviceinfo)> | 是 | mDNS服务的信息。 | +| callback | Callback<[LocalServiceInfo](#localserviceinfo10)> | 是 | mDNS服务的信息。 | **示例：** @@ -917,7 +921,7 @@ off(type: 'serviceLost', callback?: Callback\): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------------------------------- | ---- | ------------------------------------------------------------ | | type | string | 是 | 订阅事件，固定为'serviceLost'。
serviceLost：移除mDNS服务事件。 | -| callback | Callback<[LocalServiceInfo](#localserviceinfo)> | 否 | mDNS服务的信息。 | +| callback | Callback<[LocalServiceInfo](#localserviceinfo10)> | 否 | mDNS服务的信息。 | **示例：** -- Gitee From e2e3e2db70871ef8cb6d872a75a6ac8352c6e497 Mon Sep 17 00:00:00 2001 From: xujie Date: Thu, 10 Aug 2023 14:11:28 +0800 Subject: [PATCH 5/5] fix Signed-off-by: xujie --- zh-cn/application-dev/reference/apis/js-apis-net-mdns.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-net-mdns.md b/zh-cn/application-dev/reference/apis/js-apis-net-mdns.md index ac21007151fd..f135978a149a 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-net-mdns.md +++ b/zh-cn/application-dev/reference/apis/js-apis-net-mdns.md @@ -951,7 +951,7 @@ mDNS服务信息 | serviceName | string | 是 | mDNS服务的名字。 | | port | number | 否 | mDNS服务的端口号。 | | host | [NetAddress](js-apis-net-connection.md#netaddress) | 否 | mDNS服务设备的IP地址。采用设备的IP，添加服务和移除服务时候不生效。 | -| serviceAttribute | serviceAttribute\<[ServiceAttribute](#serviceattribute)> | 否 | mDNS服务属性信息。 | +| serviceAttribute | serviceAttribute\<[ServiceAttribute](#serviceattribute10)> | 否 | mDNS服务属性信息。 | ## ServiceAttribute10+ -- Gitee