@ohos.enterprise.adminManager (企业设备管理)


@ohos.enterprise.adminManager (企业设备管理)

本模块提供企业设备管理能力,使设备具备企业场景下所需的定制能力。

说明:

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

导入模块

import adminManager from '@ohos.enterprise.adminManager';
1

adminManager.enableAdmin

enableAdmin(admin: Want, enterpriseInfo: EnterpriseInfo, type: AdminType, callback: AsyncCallback<void>): void

以异步方法根据给定的包名和类名激活设备管理员应用,使用Callback形式返回是否激活成功。

需要权限: ohos.permission.MANAGE_ENTERPRISE_DEVICE_ADMIN

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

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

参数

参数名 类型 必填 说明
admin Want 设备管理员应用
enterpriseInfo EnterpriseInfo 设备管理员应用的企业信息
type AdminType 激活的设备管理员类型
callback AsyncCallback<void> callback方式返回是否激活成功

错误码

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

错误码ID 错误信息
9200003 the administrator ability component is invalid.
9200004 failed to enable the administrator application of the device.
9200007 the system ability work abnormally.

示例

let wantTemp = {
    bundleName: "com.example.myapplication",
    abilityName: "com.example.myapplication.MainAbility",
};
let enterpriseInfo = {
    name: "enterprise name",
    description: "enterprise description"
}
adminManager.enableAdmin(wantTemp, enterpriseInfo, adminManager.AdminType.ADMIN_TYPE_NORMAL, error => {
    if (error != null) {
        console.log("error occurs" + error);
        return;
    }
    console.log("enableAdmin success");
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

adminManager.enableAdmin

enableAdmin(admin: Want, enterpriseInfo: EnterpriseInfo, type: AdminType, userId: number, callback: AsyncCallback<void>): void

以异步方法根据给定的包名和类名激活设备管理员应用,使用Callback形式返回是否激活成功。

需要权限: ohos.permission.MANAGE_ENTERPRISE_DEVICE_ADMIN

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

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

参数

参数名 类型 必填 说明
admin Want 设备管理员应用
enterpriseInfo EnterpriseInfo 设备管理员应用的企业信息
type AdminType 激活的设备管理员类型
userId number 用户ID。默认值:调用方所在用户,取值范围:大于等于0。
callback AsyncCallback<void> callback方式返回是否激活成功

错误码:

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

错误码ID 错误信息
9200003 the administrator ability component is invalid.
9200004 failed to enable the administrator application of the device.
9200007 the system ability work abnormally.

示例

let wantTemp = {
    bundleName: "com.example.myapplication",
    abilityName: "com.example.myapplication.MainAbility",
};
let enterpriseInfo = {
    name: "enterprise name",
    description: "enterprise description"
}
adminManager.enableAdmin(wantTemp, enterpriseInfo, adminManager.AdminType.ADMIN_TYPE_NORMAL, 100, error => {
    if (error != null) {
        console.log("error occurs" + error);
        return;
    }
    console.log("enableAdmin success");
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

adminManager.enableAdmin

enableAdmin(admin: Want, enterpriseInfo: EnterpriseInfo, type: AdminType, userId?: number): Promise<void>

以异步方法根据给定的包名和类名激活设备管理员应用,使用Promise形式返回是否激活成功。

需要权限: ohos.permission.MANAGE_ENTERPRISE_DEVICE_ADMIN

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

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

参数

参数名 类型 必填 说明
admin Want 设备管理员应用
enterpriseInfo EnterpriseInfo 设备管理员应用的企业信息
type AdminType 激活的设备管理员类型
userId number 用户ID。默认值:调用方所在用户,取值范围:大于等于0。

返回值:

类型 说明
Promise<void> Promise形式返回是否激活成功

错误码

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

错误码ID 错误信息
9200003 the administrator ability component is invalid.
9200004 failed to enable the administrator application of the device.
9200007 the system ability work abnormally.

示例

let wantTemp = {
    bundleName: "com.example.myapplication",
    abilityName: "com.example.myapplication.MainAbility",
};
let enterpriseInfo = {
    name: "enterprise name",
    description: "enterprise description"
}
adminManager.enableAdmin(wantTemp, enterpriseInfo, adminManager.AdminType.ADMIN_TYPE_NORMAL, 100)
.catch(error => {
    console.log("error occurs" + error);
});
1
2
3
4
5
6
7
8
9
10
11
12

adminManager.disableAdmin

disableAdmin(admin: Want, callback: AsyncCallback<void>): void

以异步方法根据给定的包名和类名将设备普通管理员应用去激活,使用Callback形式返回是否去激活成功。

需要权限: ohos.permission.MANAGE_ENTERPRISE_DEVICE_ADMIN

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

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

参数

参数名 类型 必填 说明
admin Want 普通设备管理员应用
callback AsyncCallback<void> callback方式返回是否去激活成功

错误码:

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

错误码ID 错误信息
9200005 failed to disable the administrator application of the device.

示例

let wantTemp = {
    bundleName: "bundleName",
    abilityName: "abilityName",
};
adminManager.disableAdmin(wantTemp, error => {
    if (error != null) {
        console.log("error occurs" + error);
        return;
    }
    console.log("disableAdmin success ");
});
1
2
3
4
5
6
7
8
9
10
11

adminManager.disableAdmin

disableAdmin(admin: Want, userId: number, callback: AsyncCallback<void>): void

以异步方法根据给定的包名和类名将设备普通管理员应用去激活,使用Callback形式返回是否去激活成功。

需要权限: ohos.permission.MANAGE_ENTERPRISE_DEVICE_ADMIN

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

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

参数

参数名 类型 必填 说明
admin Want 普通设备管理员应用
userId number 用户ID。默认值:调用方所在用户,取值范围:大于等于0。
callback AsyncCallback<void> callback方式返回是否去激活成功

错误码:

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

错误码ID 错误信息
9200005 failed to disable the administrator application of the device.

示例

let wantTemp = {
    bundleName: "bundleName",
    abilityName: "abilityName",
};
adminManager.disableAdmin(wantTemp, 100, error => {
    if (error != null) {
        console.log("error occurs" + error);
        return;
    }
    console.log("disableAdmin success ");
});
1
2
3
4
5
6
7
8
9
10
11

adminManager.disableAdmin

disableAdmin(admin: Want, userId?: number): Promise<void>

以异步方法根据给定的包名和类名将设备普通管理员应用去激活,使用Promise形式返回是否去激活成功。

需要权限: ohos.permission.MANAGE_ENTERPRISE_DEVICE_ADMIN

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

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

参数

参数名 类型 必填 说明
admin Want 普通设备管理员应用
userId number 用户ID。默认值:调用方所在用户,取值范围:大于等于0。

返回值:

类型 说明
Promise<void> Promise形式返回是否激活成功

错误码:

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

错误码ID 错误信息
9200005 failed to disable the administrator application of the device.

示例

let wantTemp = {
    bundleName: "bundleName",
    abilityName: "abilityName",
};
adminManager.disableAdmin(wantTemp, 100).catch(error => {
    console.log("error occurs" + error);
});
1
2
3
4
5
6
7

adminManager.disableSuperAdmin

disableSuperAdmin(bundleName: String, callback: AsyncCallback<void>): void

以异步方法根据给定的包名将设备超级管理员应用去激活,使用Callback形式返回是否去激活成功。

需要权限: ohos.permission.MANAGE_ENTERPRISE_DEVICE_ADMIN

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

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

参数

参数名 类型 必填 说明
bundleName String 超级设备管理员应用的包名
callback AsyncCallback<void> callback方式返回是否去激活成功

错误码:

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

错误码ID 错误信息
9200005 failed to disable the administrator application of the device.

示例

let bundleName = "com.example.myapplication";
adminManager.disableSuperAdmin(bundleName, error => {
    if (error != null) {
        console.log("error occurs" + error);
        return;
    }
    console.log("disableSuperAdmin success");
});
1
2
3
4
5
6
7
8

adminManager.disableSuperAdmin

disableSuperAdmin(bundleName: String): Promise<void>

以异步方法根据给定的包名将设备超级管理员应用去激活,使用Promise形式返回是否去激活成功。

需要权限: ohos.permission.MANAGE_ENTERPRISE_DEVICE_ADMIN

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

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

参数

参数名 类型 必填 说明
bundleName String 超级设备管理员应用的包名

返回值:

类型 说明
Promise<void> Promise形式返回是否激活成功

错误码:

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

错误码ID 错误信息
9200005 failed to disable the administrator application of the device.

示例

let bundleName = "com.example.myapplication";
adminManager.disableSuperAdmin(bundleName).catch(error => {
    console.log("error occurs" + error);
});
1
2
3
4

adminManager.isAdminEnabled

isAdminEnabled(admin: Want, callback: AsyncCallback<boolean>): void

以异步方法根据给定的包名和类名判断设备管理员应用是否被激活,使用Callback形式返回是否处于激活状态。

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

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

参数

参数名 类型 必填 说明
admin Want 设备管理员应用
callback AsyncCallback<boolean> callback方式返回是否处于激活状态

示例

let wantTemp = {
    bundleName: "bundleName",
    abilityName: "abilityName",
};
adminManager.isAdminEnabled(wantTemp, (error, result) => {
    if (error != null) {
        console.log("error occurs" + error);
        return;
    }
    console.log("result is " + result);
});
1
2
3
4
5
6
7
8
9
10
11

adminManager.isAdminEnabled

isAdminEnabled(admin: Want, userId: number, callback: AsyncCallback<boolean>): void

以异步方法根据给定的包名和类名判断设备管理员应用是否被激活,使用Callback形式返回是否处于激活状态。

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

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

参数

参数名 类型 必填 说明
admin Want 设备管理员应用
userId number 用户ID。默认值:调用方所在用户,取值范围:大于等于0。
callback AsyncCallback<boolean> callback方式返回是否处于激活状态

示例

let wantTemp = {
    bundleName: "bundleName",
    abilityName: "abilityName",
};
adminManager.isAdminEnabled(wantTemp, 100, (error, result) => {
    if (error != null) {
        console.log("error occurs" + error);
        return;
    }
    console.log("result is " + result);
});
1
2
3
4
5
6
7
8
9
10
11

adminManager.isAdminEnabled

isAdminEnabled(admin: Want, userId?: number): Promise<boolean>

以异步方法根据给定的包名和类名判断设备管理员应用是否被激活,使用Promise形式返回是否处于激活状态。

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

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

参数

参数名 类型 必填 说明
admin Want 设备管理员应用
userId number 用户ID。默认值:调用方所在用户,取值范围:大于等于0。

返回值:

类型 说明
Promise<boolean> Promise形式返回是否处于激活状态

示例

let wantTemp = {
    bundleName: "bundleName",
    abilityName: "abilityName",
};
adminManager.isAdminEnabled(wantTemp, 100).then((result) => {
    console.log("result is " + result);
}).catch(error => {
    console.log("error occurs" + error);
});
1
2
3
4
5
6
7
8
9

adminManager.isSuperAdmin

isSuperAdmin(bundleName: String, callback: AsyncCallback<boolean>): void

以异步方法根据给定的包名判断设备超级管理员应用是否被激活,使用Callback形式返回是否处于激活状态。

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

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

参数

参数名 类型 必填 说明
bundleName String 设备管理员应用
callback AsyncCallback<boolean> callback方式返回是否处于激活状态

示例

let bundleName = "com.example.myapplication";
adminManager.isSuperAdmin(bundleName, (error, result) => {
    if (error != null) {
        console.log("error occurs" + error);
        return;
    }
    console.log("result is " + result);
});
1
2
3
4
5
6
7
8

adminManager.isSuperAdmin

isSuperAdmin(bundleName: String): Promise<boolean>

以异步方法根据给定的包名判断设备超级管理员应用是否被激活,使用Promise形式返回是否处于激活状态。

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

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

参数

参数名 类型 必填 说明
bundleName String 超级设备管理员应用

返回值:

错误码ID 错误信息
Promise<boolean> Promise形式返回是否处于激活状态

示例

let bundleName = "com.example.myapplication";
adminManager.isSuperAdmin(bundleName).then((result) => {
    console.log("result is " + result);
}).catch(error => {
    console.log("error occurs" + error);
});
1
2
3
4
5
6

adminManager.setEnterpriseInfo

setEnterpriseInfo(admin: Want, enterpriseInfo: EnterpriseInfo, callback: AsyncCallback<void>;): void

设置设备管理员应用的企业信息,使用callback形式返回是否设置成功。

需要权限: ohos.permission.SET_ENTERPRISE_INFO

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

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

参数:

参数名 类型 必填 说明
admin Want 设备管理员应用
enterpriseInfo EnterpriseInfo 设备管理员应用的企业信息
callback AsyncCallback<void>; callback方式返回是否设置企业信息成功

错误码

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

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

示例:

let wantTemp = {
    bundleName: "com.example.myapplication",
    abilityName: "com.example.myapplication.MainAbility",
};
let enterpriseInfo = {
    name: "enterprise name",
    description: "enterprise description"
}
adminManager.setEnterpriseInfo(wantTemp, enterpriseInfo, error => {
    if (error != null) {
        console.log("error occurs" + error);
        return;
    }
    console.log("setEnterpriseInfo success");
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

adminManager.setEnterpriseInfo

setEnterpriseInfo(admin: Want, enterpriseInfo: EnterpriseInfo): Promise<void>;

设置设备管理员应用的企业信息,使用Promise形式返回是否设置成功。

需要权限: ohos.permission.SET_ENTERPRISE_INFO

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

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

参数:

参数名 类型 必填 说明
admin Want 设备管理员应用
enterpriseInfo EnterpriseInfo 设备管理员应用的企业信息

返回值:

类型 说明
Promise<void> Promise方式返回是否设置企业信息成功

错误码

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

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

示例:

let wantTemp = {
    bundleName: "com.example.myapplication",
    abilityName: "com.example.myapplication.MainAbility",
};
let enterpriseInfo = {
    name: "enterprise name",
    description: "enterprise description"
}
adminManager.setEnterpriseInfo(wantTemp, enterpriseInfo).catch(error => {
    console.log("error occurs" + error);
});
1
2
3
4
5
6
7
8
9
10
11

adminManager.getEnterpriseInfo

getEnterpriseInfo(admin: Want, callback: AsyncCallback<EnterpriseInfo>): void

获取设备管理员应用的企业信息,使用callback形式返回设备管理员应用的企业信息。

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

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

参数:

参数名 类型 必填 说明
admin Want 设备管理员应用
callback AsyncCallback<EnterpriseInfo> callback方式返回设备管理员应用的企业信息

错误码

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

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

示例:

let wantTemp = {
    bundleName: "com.example.myapplication",
    abilityName: "com.example.myapplication.MainAbility",
};
adminManager.getEnterpriseInfo(wantTemp, (error, result) => {
    if (error != null) {
        console.log("error occurs" + error);
        return;
    }
    console.log(result.name);
    console.log(result.description);
});
1
2
3
4
5
6
7
8
9
10
11
12

adminManager.getEnterpriseInfo

getEnterpriseInfo(admin: Want): Promise<EnterpriseInfo>

获取设备管理员应用的企业信息,使用Promise形式返回设备管理员应用的企业信息。

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

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

参数:

参数名 类型 必填 说明
admin Want 设备管理员应用

返回值:

类型 说明
Promise<EnterpriseInfo> Promise方式返回设备管理员应用的企业信息对象

错误码

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

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

示例:

let wantTemp = {
    bundleName: "com.example.myapplication",
    abilityName: "com.example.myapplication.MainAbility",
};
adminManager.getEnterpriseInfo(wantTemp).then((result) => {
    console.log(result.name);
    console.log(result.description);
}).catch(error => {
    console.log("error occurs" + error);
});
1
2
3
4
5
6
7
8
9
10

adminManager.subscribeManagedEvent

subscribeManagedEvent(admin: Want, managedEvents: Array<ManagedEvent>, callback: AsyncCallback<void>): void

订阅系统管理事件。使用callback异步回调。

需要权限: ohos.permission.ENTERPRISE_SUBSCRIBE_MANAGED_EVENT

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

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

参数:

参数名 类型 必填 说明
admin Want 设备管理员应用。
managedEvents Array<ManagedEvent> 订阅事件数组。
callback AsyncCallback<void> 回调函数。当系统管理事件订阅成功err为null,否则为错误对象。

错误码

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

错误码ID 错误信息
9200001 the application is not an administrator of the device.
9200008 the specified system events enum is invalid.

示例:

let wantTemp = {
    bundleName: "bundleName",
    abilityName: "abilityName",
};
let events = [0, 1];
adminManager.subscribeManagedEvent(wantTemp, events, (error) => {
    if (error) {
        console.log("error code:" + error.code + " error message:" + error.message);
    }
});
1
2
3
4
5
6
7
8
9
10

adminManager.subscribeManagedEvent

subscribeManagedEvent(admin: Want, managedEvents: Array<ManagedEvent>): Promise<void>

订阅系统管理事件。使用Promise异步回调。

需要权限: ohos.permission.ENTERPRISE_SUBSCRIBE_MANAGED_EVENT

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

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

参数:

参数名 类型 必填 说明
admin Want 设备管理员应用。
managedEvents Array<ManagedEvent> 订阅事件数组。

返回值:

类型 说明
Promise<void> Promise对象。无返回结果的Promise对象。

错误码

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

错误码ID 错误信息
9200001 the application is not an administrator of the device.
9200008 the specified system events enum is invalid.

示例:

let wantTemp = {
    bundleName: "bundleName",
    abilityName: "abilityName",
};
let events = [0, 1];
adminManager.subscribeManagedEvent(wantTemp, events).then(() => {
}).catch((error) => {
    console.log("error code:" + error.code + " error message:" + error.message);
})
1
2
3
4
5
6
7
8
9

adminManager.unsubscribeManagedEvent

unsubscribeManagedEvent(admin: Want, managedEvents: Array<ManagedEvent>, callback: AsyncCallback<void>): void

取消订阅系统管理事件。使用callback异步回调。

需要权限: ohos.permission.ENTERPRISE_SUBSCRIBE_MANAGED_EVENT

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

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

参数:

参数名 类型 必填 说明
admin Want 设备管理员应用。
managedEvents Array<ManagedEvent> 取消订阅事件数组。
callback AsyncCallback<void> 回调函数。当系统管理事件取消订阅成功err为null,否则为错误对象。

错误码

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

错误码ID 错误信息
9200001 the application is not an administrator of the device.
9200008 the specified system events enum is invalid.

示例:

let wantTemp = {
    bundleName: "bundleName",
    abilityName: "abilityName",
};
let events = [0, 1];
adminManager.unsubscribeManagedEvent(wantTemp, events, (error) => {
    if (error) {
        console.log("error code:" + error.code + " error message:" + error.message);
    }
});
1
2
3
4
5
6
7
8
9
10

adminManager.unsubscribeManagedEvent

unsubscribeManagedEvent(admin: Want, managedEvents: Array<ManagedEvent>): Promise<void>

取消订阅系统管理事件。使用callback异步回调。

需要权限: ohos.permission.ENTERPRISE_SUBSCRIBE_MANAGED_EVENT

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

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

参数:

参数名 类型 必填 说明
admin Want 设备管理员应用。
managedEvents Array<ManagedEvent> 取消订阅事件数组。

返回值:

类型 说明
Promise<void> Promise对象。无返回结果的Promise对象。

错误码

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

错误码ID 错误信息
9200001 the application is not an administrator of the device.
9200008 the specified system events enum is invalid.

示例:

let wantTemp = {
    bundleName: "bundleName",
    abilityName: "abilityName",
};
let events = [0, 1];
adminManager.unsubscribeManagedEvent(wantTemp, events).then(() => {
}).catch((error) => {
    console.log("error code:" + error.code + " error message:" + error.message);
})
1
2
3
4
5
6
7
8
9

EnterpriseInfo

设备管理员应用的企业信息

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

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

名称 类型 可读 可写 说明
name string 表示设备管理员应用所属企业的名称。
description string 表示设备管理员应用所属企业的描述。

AdminType

设备管理员应用的管理员类型。

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

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

名称 说明
ADMIN_TYPE_NORMAL 0x00 普通管理员
ADMIN_TYPE_SUPER 0x01 超级管理员

ManagedEvent

可订阅系统管理事件。

系统能力: SystemCapability.Customization.EnterpriseDeviceManager

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

名称 说明
MANAGED_EVENT_BUNDLE_ADDED 0 应用安装事件。
MANAGED_EVENT_BUNDLE_REMOVED 1 应用卸载事件。