diff --git a/zh-cn/application-dev/reference/apis/Readme-CN.md b/zh-cn/application-dev/reference/apis/Readme-CN.md index bc7396b5a9221d742c9ebfb9286ba44bbcf08714..51b6a59dc99fe6fe8797e7e664176e914c7bb5e2 100644 --- a/zh-cn/application-dev/reference/apis/Readme-CN.md +++ b/zh-cn/application-dev/reference/apis/Readme-CN.md @@ -447,7 +447,6 @@ - [@ohos.enterprise.EnterpriseAdminExtensionAbility (企业设备管理扩展能力)](js-apis-EnterpriseAdminExtensionAbility.md) - [@ohos.enterprise.networkManager (网络管理)](js-apis-enterprise-networkManager.md) - [@ohos.enterprise.restrictions (限制类策略)](js-apis-enterprise-restrictions.md) - - [@ohos.enterprise.usbManager (USB管理)](js-apis-enterprise-usbManager.md) - [@ohos.enterprise.wifiManager (WiFi管理)](js-apis-enterprise-wifiManager.md) - 语言基础类库 diff --git a/zh-cn/application-dev/reference/apis/enterpriseDeviceManagement-overview.md b/zh-cn/application-dev/reference/apis/enterpriseDeviceManagement-overview.md index 07464320fcc0053c92be0b14bfe0222f7552aec1..23abe7a1a978980eca76d3bdc5c819a7afd40e44 100644 --- a/zh-cn/application-dev/reference/apis/enterpriseDeviceManagement-overview.md +++ b/zh-cn/application-dev/reference/apis/enterpriseDeviceManagement-overview.md @@ -42,5 +42,4 @@ OpenHarmony通过企业设备管理（Enterprise Device Management）API支持 - [@ohos.enterprise.EnterpriseAdminExtensionAbility (企业设备管理扩展能力)](js-apis-EnterpriseAdminExtensionAbility.md) - [@ohos.enterprise.networkManager (网络管理)](js-apis-enterprise-networkManager.md) - [@ohos.enterprise.restrictions (限制类策略)](js-apis-enterprise-restrictions.md) -- [@ohos.enterprise.usbManager (USB管理)](js-apis-enterprise-usbManager.md) - [@ohos.enterprise.wifiManager (WiFi管理)](js-apis-enterprise-wifiManager.md) \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-enterprise-deviceSettings.md b/zh-cn/application-dev/reference/apis/js-apis-enterprise-deviceSettings.md index 9467f9a32ae06c82a26eba8c55ffb958745fba0a..b7126e5d10d942fa8758d1ed4aaaa4a2acc8c4a5 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-enterprise-deviceSettings.md +++ b/zh-cn/application-dev/reference/apis/js-apis-enterprise-deviceSettings.md @@ -108,232 +108,3 @@ deviceSettings.getScreenOffTime(wantTemp).then((result) => { console.error(`Failed to get screen off time. Code: ${err.code}, message: ${err.message}`); }); ``` - -## deviceSettings.installUserCertificate - -installUserCertificate(admin: Want, certificate: CertBlob, callback: AsyncCallback<string>): void - -指定设备管理应用安装用户证书，使用callback异步回调。 - -**需要权限：** ohos.permission.ENTERPRISE_MANAGE_CERTIFICATE - -**系统能力：** SystemCapability.Customization.EnterpriseDeviceManager - -**系统API**: 此接口为系统接口。 - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ---------------------------------------- | ---- | ------------------------------- | -| admin | [Want](js-apis-app-ability-want.md) | 是 | 设备管理应用。 | -| certificate | [CertBlob](#certblob) | 是 | 证书信息。 | -| callback | AsyncCallback<string> | 是 | 回调函数，当接口调用成功，err为null，否则为错误对象。 | - -**错误码**： - -以下错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md) - -| 错误码ID | 错误信息 | -| ------- | ---------------------------------------------------------------------------- | -| 9200001 | the application is not an administrator of the device. | -| 9200002 | the administrator application does not have permission to manage the device. | -| 9201001 | manage certificate failed | - -**示例：** - -```js -let wantTemp = { - bundleName: 'com.example.myapplication', - abilityName: 'EntryAbility', -}; -var certFileArray: Uint8Array; -// The variable context needs to be initialized in MainAbility's onCreate callback function -// test.cer needs to be placed in the rawfile directory -await globalThis.context.resourceManager.getRawFileContent("test.cer") - .then(value => { - certFileArray = value - }) - .catch(error => { - console.error(`Failed to get row file content. message: ${error.message}`); - return - }); -new Promise((resolve, reject) => { - deviceSettings.installUserCertificate(wantTemp, {inData: certFileArray, alias: "cert_alias_xts"}, (err, result) => { - if (err) { - console.error(`Failed to install user certificate. Code: ${err.code}, message: ${err.message}`); - } else{ - console.info(`Succeeded in installing user certificate, result : ${JSON.stringify(result)}`); - } - }); -}); -``` - -## deviceSettings.installUserCertificate - -installUserCertificate(admin: Want, certificate: CertBlob): Promise<string> - -指定设备管理应用安装用户证书，使用Promise异步回调。 - -**需要权限：** ohos.permission.ENTERPRISE_MANAGE_CERTIFICATE - -**系统能力：** SystemCapability.Customization.EnterpriseDeviceManager - -**系统API**: 此接口为系统接口。 - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ----- | ----------------------------------- | ---- | ------- | -| admin | [Want](js-apis-app-ability-want.md) | 是 | 设备管理应用。 | -| certificate | [CertBlob](#certblob) | 是 | 证书信息。 | - -**返回值：** - -| 类型 | 说明 | -| --------------------- | ------------------------- | -| Promise<string> | Promise对象，返回当前证书安装后的uri，用于卸载证书。 | - -**错误码**： - -以下错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md) - -| 错误码ID | 错误信息 | -| ------- | ---------------------------------------------------------------------------- | -| 9200001 | the application is not an administrator of the device. | -| 9200002 | the administrator application does not have permission to manage the device. | -| 9201001 | manage certificate failed | - -**示例：** - -```js -let wantTemp = { - bundleName: 'com.example.myapplication', - abilityName: 'EntryAbility', -}; -var certFileArray: Uint8Array -// The variable context needs to be initialized in MainAbility's onCreate callback function -// test.cer needs to be placed in the rawfile directory -await globalThis.context.resourceManager.getRawFileContent("test.cer") - .then(data => { - certFileArray = data - }).catch(error => { - console.log('getRawFileContent error' + error) - return - }) -deviceSettings.installUserCertificate(wantTemp, { inData: certFileArray, alias: "cert_alias_xts" }) - .then((result) => { - console.info(`Succeeded in installing user certificate, result : ${JSON.stringify(result)}`); - }).catch(err => { - console.error(`Failed to install user certificate. Code: ${err.code}, message: ${err.message}`); - }) -``` - -## CertBlob - -证书信息。 - -**系统能力：** SystemCapability.Customization.EnterpriseDeviceManager - -**系统API**: 此接口为系统接口。 - -| 名称 | 类型 | 必填 | 说明 | -| ----------- | --------| ----- | ------------------------------- | -| inData | Uint8Array | 是 | 证书的二进制内容。 | -| alias | string | 是 | 证书别名。 | - -## deviceSettings.uninstallUserCertificate - -uninstallUserCertificate(admin: Want, certUri: string, callback: AsyncCallback<void>): void - -指定设备管理应用卸载用户证书，使用callback异步回调。 - -**需要权限：** ohos.permission.ENTERPRISE_MANAGE_CERTIFICATE - -**系统能力：** SystemCapability.Customization.EnterpriseDeviceManager - -**系统API**: 此接口为系统接口。 - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ---------------------------------------- | ---- | ------------------------------- | -| admin | [Want](js-apis-app-ability-want.md) | 是 | 设备管理应用。 | -| certUri | string | 是 | 证书uri，由安装用户证书接口返回。 | -| callback | AsyncCallback<void> | 是 | 回调函数，当接口调用成功，err为null，否则为错误对象。 | - -**错误码**： - -以下错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md) - -| 错误码ID | 错误信息 | -| ------- | ---------------------------------------------------------------------------- | -| 9200001 | the application is not an administrator of the device. | -| 9200002 | the administrator application does not have permission to manage the device. | -| 9201001 | manage certificate failed | - -**示例：** - -```js -let wantTemp = { - bundleName: 'com.example.myapplication', - abilityName: 'EntryAbility', -}; -let aliasStr = "certName" -deviceSettings.uninstallUserCertificate(wantTemp, aliasStr, (err) => { - if (err) { - console.error(`Failed to uninstall user certificate. Code: ${err.code}, message: ${err.message}`); - return; - } - console.info(`Succeeded in uninstalling user certificate`); -}); -``` - -## deviceSettings.uninstallUserCertificate - -uninstallUserCertificate(admin: Want, certUri: string): Promise<void> - -指定设备管理应用卸载用户证书，使用Promise异步回调。 - -**需要权限：** ohos.permission.ENTERPRISE_MANAGE_CERTIFICATE - -**系统能力：** SystemCapability.Customization.EnterpriseDeviceManager - -**系统API**: 此接口为系统接口。 - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ----- | ----------------------------------- | ---- | ------- | -| admin | [Want](js-apis-app-ability-want.md) | 是 | 设备管理应用。 | -| certUri | string | 是 | 证书uri，由安装用户证书接口返回。 | - -**返回值：** - -| 类型 | 说明 | -| --------------------- | ------------------------- | -| Promise<void> | 无返回结果的Promise对象。当指定设备管理应用卸载用户证书失败时会抛出错误对象。 | - -**错误码**： - -以下错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md) - -| 错误码ID | 错误信息 | -| ------- | ---------------------------------------------------------------------------- | -| 9200001 | the application is not an administrator of the device. | -| 9200002 | the administrator application does not have permission to manage the device. | -| 9201001 | manage certificate failed | - -**示例：** - -```js -let wantTemp = { - bundleName: 'com.example.myapplication', - abilityName: 'EntryAbility', -}; -let aliasStr = "certName" -deviceSettings.uninstallUserCertificate(wantTemp, aliasStr).then(() => { - console.info(`Succeeded in uninstalling user certificate`); -}).catch((err) => { - console.error(`Failed to uninstall user certificate. Code is ${err.code}, message is ${err.message}`); -}); -``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-enterprise-networkManager.md b/zh-cn/application-dev/reference/apis/js-apis-enterprise-networkManager.md index 260b9af76e52cc7ea4937025a6f58fbbf91fb1ae..8fecf17b0ffd2c1e0cd2ab5d77b3804bf9f66cf4 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-enterprise-networkManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-enterprise-networkManager.md @@ -491,209 +491,6 @@ networkManager.setNetworkInterfaceDisabled(wantTemp, 'eth0', true).then(() => { }); ``` -## networkManager.setGlobalProxy - -setGlobalProxy(admin: Want, httpProxy: connection.HttpProxy, callback: AsyncCallback\): void - -指定设备管理应用设置网络全局代理，使用callback异步回调。 - -**需要权限：** ohos.permission.ENTERPRISE_MANAGE_NETWORK - -**系统能力：** SystemCapability.Customization.EnterpriseDeviceManager - -**系统API**: 此接口为系统接口。 - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ---------------------------------------- | ---- | ------------------------------- | -| admin | [Want](js-apis-app-ability-want.md) | 是 | 设备管理应用。 | -| httpProxy | [connection.HttpProxy](js-apis-net-connection.md#httpproxy10) | 是 | 网络全局Http代理配置信息。 | -| callback | AsyncCallback<void> | 是 | 回调函数。当接口调用成功，err为null，否则err为错误对象。 | - -**错误码**： - -以下错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md) - -| 错误码ID | 错误信息 | -| ------- | ---------------------------------------------------------------------------- | -| 9200001 | the application is not an administrator of the device. | -| 9200002 | the administrator application does not have permission to manage the device. | - -**示例：** - -```js -let wantTemp = { - bundleName: 'com.example.myapplication', - abilityName: 'EntryAbility', -}; -let exclusionStr = "192.168,baidu.com" -let exclusionArray = exclusionStr.split(','); -let httpProxy = { - host: "192.168.xx.xxx", - port: 8080, - exclusionList: exclusionArray -}; - -networkManager.setGlobalProxy(wantTemp, httpProxy, (err) => { - if (err) { - console.error(`Failed to set network global proxy. Code: ${err.code}, message: ${err.message}`); - return; - } - console.info(`Succeeded in setting network global proxy`); -}); -``` - -## networkManager.setGlobalProxy - -setGlobalProxy(admin: Want, httpProxy: connection.HttpProxy): Promise\ - -指定设备管理应用设置网络全局代理，使用Promise异步回调。 - -**需要权限：** ohos.permission.ENTERPRISE_MANAGE_NETWORK - -**系统能力：** SystemCapability.Customization.EnterpriseDeviceManager - -**系统API**: 此接口为系统接口。 - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ----- | ----------------------------------- | ---- | ------- | -| admin | [Want](js-apis-app-ability-want.md) | 是 | 设备管理应用。 | -| httpProxy | [connection.HttpProxy](js-apis-net-connection.md#httpproxy10) | 是 | 网络全局Http代理配置信息。 | -| isDisabled | boolean | 是 | true表示禁用该网络接口，false表示开启该网络接口。 | - -**返回值：** - -| 类型 | 说明 | -| --------------------- | ------------------------- | -| Promise<void> | 无返回结果的Promise对象。当设置网络全局代理失败时抛出错误对象 | - -**错误码**： - -以下错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md) - -| 错误码ID | 错误信息 | -| ------- | ---------------------------------------------------------------------------- | -| 9200001 | the application is not an administrator of the device. | -| 9200002 | the administrator application does not have permission to manage the device. | - -**示例：** - -```js -let wantTemp = { - bundleName: 'com.example.myapplication', - abilityName: 'EntryAbility', -}; -let exclusionStr = "192.168,baidu.com" -let exclusionArray = exclusionStr.split(','); -let httpProxy = { - host: "192.168.xx.xxx", - port: 8080, - exclusionList: exclusionArray -}; - -networkManager.setGlobalProxy(wantTemp, httpProxy).then(() => { - console.info(`Succeeded in setting network global proxy`); -}).catch((err) => { - console.error(`Failed to set network global proxy. Code: ${err.code}, message: ${err.message}`); -}); -``` - -## networkManager.getGlobalProxy - -getGlobalProxy(admin: Want, callback: AsyncCallback\): void - -指定设备管理应用获取网络全局代理，使用callback异步回调。 - -**需要权限：** ohos.permission.ENTERPRISE_MANAGE_NETWORK - -**系统能力：** SystemCapability.Customization.EnterpriseDeviceManager - -**系统API**: 此接口为系统接口。 - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ---------------------------------------- | ---- | ------------------------------- | -| admin | [Want](js-apis-app-ability-want.md) | 是 | 设备管理应用。 | -| callback | AsyncCallback<[connection.HttpProxy](js-apis-net-connection.md#httpproxy10)> | 是 | 回调函数。当接口调用成功，err为null，否则err为错误对象。 | - -**错误码**： - -以下错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md) - -| 错误码ID | 错误信息 | -| ------- | ---------------------------------------------------------------------------- | -| 9200001 | the application is not an administrator of the device. | -| 9200002 | the administrator application does not have permission to manage the device. | - -**示例：** - -```js -let wantTemp = { - bundleName: 'com.example.myapplication', - abilityName: 'EntryAbility', -}; - -networkManager.getGlobalProxy(wantTemp, (err, result) => { - if (err) { - console.error(`Failed to get network global proxy. Code: ${err.code}, message: ${err.message}`); - return; - } - console.info(`Succeeded in getting network global proxy, result : ${JSON.stringify(result)}`); -}); -``` - -## networkManager.getGlobalProxy - -getGlobalProxy(admin: Want): Promise\ - -指定设备管理应用获取网络全局代理，使用Promise异步回调。 - -**需要权限：** ohos.permission.ENTERPRISE_MANAGE_NETWORK - -**系统能力：** SystemCapability.Customization.EnterpriseDeviceManager - -**系统API**: 此接口为系统接口。 - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ----- | ----------------------------------- | ---- | ------- | -| admin | [Want](js-apis-app-ability-want.md) | 是 | 设备管理应用。 | - -**返回值：** - -| 类型 | 说明 | -| --------------------- | ------------------------- | -| Promise<[connection.HttpProxy](js-apis-net-connection.md#httpproxy10)> | Promise对象，返回网络全局Http代理配置信息。 | - -**错误码**： - -以下错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md) - -| 错误码ID | 错误信息 | -| ------- | ---------------------------------------------------------------------------- | -| 9200001 | the application is not an administrator of the device. | -| 9200002 | the administrator application does not have permission to manage the device. | - -**示例：** - -```js -let wantTemp = { - bundleName: 'com.example.myapplication', - abilityName: 'EntryAbility', -}; - -networkManager.getGlobalProxy(wantTemp).then(() => { - console.info(`Succeeded in getting network global proxy`); -}).catch((err) => { - console.error(`Failed to get network global proxy. Code: ${err.code}, message: ${err.message}`); -}); -``` - ## networkManager.addIptablesFilterRule addIptablesFilterRule(admin: Want, filterRule: AddFilterRule, callback: AsyncCallback\): void diff --git a/zh-cn/application-dev/reference/apis/js-apis-enterprise-usbManager.md b/zh-cn/application-dev/reference/apis/js-apis-enterprise-usbManager.md deleted file mode 100644 index f2c96d2ba36d3758a5d54e9e51de6f7ecb18369d..0000000000000000000000000000000000000000 --- a/zh-cn/application-dev/reference/apis/js-apis-enterprise-usbManager.md +++ /dev/null @@ -1,127 +0,0 @@ -# @ohos.enterprise.usbManager (USB管理) - -本模块提供USB管理能力。 - -> **说明**： -> -> 本模块首批接口从API version 10开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -> -> 本模块接口仅可在Stage模型下使用。 -> -> 本模块接口仅对[设备管理应用](enterpriseDeviceManagement-overview.md#基本概念)开放，需将[设备管理应用激活](js-apis-enterprise-adminManager.md#adminmanagerenableadmin)后调用，实现相应功能。 - -## 导入模块 - -```js -import usbManager from '@ohos.enterprise.usbManager' -``` - -## usbManager.setUsbPolicy - -setUsbPolicy(admin: Want, usbPolicy: UsbPolicy, callback: AsyncCallback\): void - -指定设备管理应用设置USB的读写策略。使用callback异步回调。 - -**需要权限：** ohos.permission.ENTERPRISE_MANAGE_USB - -**系统能力：** SystemCapability.Customization.EnterpriseDeviceManager - -**系统API**: 此接口为系统接口。 - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ----- | ----------------------------------- | ---- | ------- | -| admin | [Want](js-apis-app-ability-want.md) | 是 | 设备管理应用。 | -| usbPolicy | [UsbPolicy](#usbpolicy) | 是 | USB读写策略。 | -| callback | AsyncCallback\ | 是 | 回调函数。当接口调用成功，err为null，否则为错误对象。 | - -**错误码**： - -以下错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md) - -| 错误码ID | 错误信息 | -| ------- | ---------------------------------------------------------------------------- | -| 9200001 | the application is not an administrator of the device. | -| 9200002 | the administrator application does not have permission to manage the device. | - -**示例：** - -```js -let wantTemp = { - bundleName: 'bundleName', - abilityName: 'abilityName', -}; -let policy = usbManager.UsbPolicy.READ_WRITE - -usbManager.setUsbPolicy(wantTemp, policy, (err) => { - if (err) { - console.error(`Failed to set usb policy. Code is ${err.code}, message is ${err.message}`); - return; - } - console.info('Succeeded in setting usb policy'); -}) -``` - -## usbManager.setUsbPolicy - -setUsbPolicy(admin: Want, usbPolicy: UsbPolicy): Promise\ - -指定设备管理应用设置USB的读写策略。使用Promise异步回调。 - -**需要权限：** ohos.permission.ENTERPRISE_MANAGE_USB - -**系统能力：** SystemCapability.Customization.EnterpriseDeviceManager - -**系统API**: 此接口为系统接口。 - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ----- | ----------------------------------- | ---- | ------- | -| admin | [Want](js-apis-app-ability-want.md) | 是 | 设备管理应用。 | -| usbPolicy | [UsbPolicy](#usbpolicy) | 是 | USB读写策略。 | - -**返回值：** - -| 类型 | 说明 | -| ----- | ----------------------------------- | -| Promise\ | 无返回结果的Promise对象。当指定设备管理应用设置USB策略失败时抛出错误对象。 | - -**错误码**： - -以下错误码的详细介绍请参见[企业设备管理错误码](../errorcodes/errorcode-enterpriseDeviceManager.md) - -| 错误码ID | 错误信息 | -| ------- | ---------------------------------------------------------------------------- | -| 9200001 | the application is not an administrator of the device. | -| 9200002 | the administrator application does not have permission to manage the device. | - -**示例：** - -```js -let wantTemp = { - bundleName: 'bundleName', - abilityName: 'abilityName', -}; -let policy = usbManager.UsbPolicy.READ_WRITE - -usbManager.setUsbPolicy(wantTemp, policy).then(() => { - console.info('Succeeded in setting usb policy'); -}).catch((err) => { - console.error(`Failed to set usb policy. Code is ${err.code}, message is ${err.message}`); -}) -``` - -## UsbPolicy - -USB读写策略的枚举。 - -**系统能力：** SystemCapability.Customization.EnterpriseDeviceManager - -**系统API**: 此接口为系统接口。 - -| 名称 | 值 | 说明 | -| -------- | -------- | -------- | -| READ_WRITE | 0 | 可读可写。 | -| READ_ONLY | 1 | 只读。 |