harmony 鸿蒙@ohos.enterprise.browser（浏览器管理）

2023-10-30
浏览 (392)

@ohos.enterprise.browser（浏览器管理）

本模块提供浏览器管理能力，包括设置/取消浏览器策略、获取浏览器策略等。

说明：

本模块首批接口从API version 10开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

本模块接口仅可在Stage模型下使用。

本模块接口仅对设备管理应用开放，需将设备管理应用激活后调用，实现相应功能。

导入模块

import browser from '@ohos.enterprise.browser';

browser.setPolicies

setPolicies(admin: Want, appId: string, policies: string, callback: AsyncCallback<void>): void;

指定设备管理应用为指定的浏览器设置浏览策略，使用callback异步回调。

需要权限： ohos.permission.ENTERPRISE_SET_BROWSER_POLICY

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

系统API: 此接口为系统接口。

参数：

参数名	类型	必填	说明
admin	Want	是	设备管理应用。
appId	string	是	应用ID，用于指定浏览器。
policies	string	是	浏览器策略，当参数policies为空字符串时，表示取消指定浏览器的策略。
callback	AsyncCallback<void>	是	回调函数。当接口调用成功，err为null，否则为错误对象。

错误码：

以下错误码的详细介绍请参见企业设备管理错误码

|错误码ID|错误信息 |
|——-|—————————————————————————-| |9200001|the application is not an administrator of the device. | |9200002|the administrator application does not have permission to manage the device. |

示例：

import Want from '@ohos.app.ability.Want';
let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};
let appId: string = 'com.example.myapplication';
let policies: string = '{"InsecurePrivateNetworkRequestsAllowed":{"level":"mandatory","scope":"machine","source":"platform","value":true},"LegacySameSiteCookieBehaviorEnabledForDomainList":{"level":"mandatory","scope":"machine","source":"platform","value":["[*.]"]}}'
browser.setPolicies(wantTemp, appId, policies, (err) => {
  if (err) {
    console.error(`Failed to set browser policies. Code is ${err.code}, message is ${err.message}`);
    return;
  }
  console.info('Succeeded in setting browser policies');
});

browser.setPolicies

setPolicies(admin: Want, appId: string, policies: string): Promise<void>;

指定设备管理应用为指定的浏览器设置浏览策略，使用promise异步回调。

需要权限： ohos.permission.ENTERPRISE_SET_BROWSER_POLICY

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

系统API: 此接口为系统接口。

参数：

参数名	类型	必填	说明
admin	Want	是	设备管理应用。
appId	string	是	应用ID，用于指定浏览器。
policies	string	是	浏览器策略，当参数policies为空字符串时，表示取消指定浏览器的策略。

返回值：

类型	说明
Promise<void>	无返回结果的Promise对象。当指定设备管理应用设置浏览器策略失败时，会抛出错误对象。

错误码：

以下错误码的详细介绍请参见企业设备管理错误码

示例：

import Want from '@ohos.app.ability.Want';
import { BusinessError } from '@ohos.base';
let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};
let appId: string = 'com.example.myapplication';
let policies: string = '{"InsecurePrivateNetworkRequestsAllowed":{"level":"mandatory","scope":"machine","source":"platform","value":true},"LegacySameSiteCookieBehaviorEnabledForDomainList":{"level":"mandatory","scope":"machine","source":"platform","value":["[*.]"]}}'
browser.setPolicies(wantTemp, appId, policies).then(() => {
  console.info('Succeeded in setting browser policies');
}).catch((err: BusinessError) => {
  console.error(`Failed to set browser policies. Code is ${err.code}, message is ${err.message}`);
});

browser.getPolicies

getPolicies(admin: Want, appId: string, callback: AsyncCallback<string>): void;

指定管理员应用获取指定浏览器的策略，使用callback异步回调。

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

系统API: 此接口为系统接口。

参数：

参数名	类型	必填	说明
admin	Want	是	设备管理应用。
appId	string	是	应用ID，用于指定浏览器。
callback	AsyncCallback<string>	是	回调函数，当接口调用成功，err为null，否则为错误对象。

错误码：

以下错误码的详细介绍请参见企业设备管理错误码

|错误码ID|错误信息 |
|——-|—————————————————————————-| |9200001|the application is not an administrator of the device. |

示例：

import Want from '@ohos.app.ability.Want';
let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};
let appId: string = 'com.example.myapplication';
browser.getPolicies(wantTemp, appId, (err, result) => {
  if (err) {
    console.error(`Failed to get browser policies. Code is ${err.code}, message is ${err.message}`);
    return;
  }
  console.info(`Succeeded in getting  browser policies, result : ${JSON.stringify(result)}`);
});

browser.getPolicies

getPolicies(admin: Want, appId: string): Promise<string>;

指定管理员应用获取指定浏览器的策略，使用promise异步回调。

系统能力： SystemCapability.Customization.EnterpriseDeviceManager

系统API: 此接口为系统接口。

参数：

参数名	类型	必填	说明
admin	Want	是	设备管理应用。
appId	string	是	应用ID，用于指定浏览器。

返回值：

类型	说明
Promise<string>	Promise对象，返回浏览器策略。

错误码：

以下错误码的详细介绍请参见企业设备管理错误码

|错误码ID|错误信息 |
|——-|—————————————————————————-| |9200001|the application is not an administrator of the device. |

示例：

import Want from '@ohos.app.ability.Want';
import { BusinessError } from '@ohos.base';
let wantTemp: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility',
};
let appId: string = 'com.example.myapplication';
browser.getPolicies(wantTemp, appId).then((result) => {
  console.info(`Succeeded in getting browser policies, result : ${JSON.stringify(result)}`);
}).catch((err: BusinessError) => {
  console.error(`Failed to get browser policies. Code is ${err.code}, message is ${err.message}`);
});