js-apis-enterprise-device-manager.md

# Enterprise Device Management

> **NOTE**<br>
> The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version.


## Modules to Import

```
import enterpriseDeviceManager from '@ohos.enterpriseDeviceManager';
```


## enterpriseDeviceManager.activateAdmin

activateAdmin(admin: Want, enterpriseInfo: EnterpriseInfo, type: AdminType, callback: AsyncCallback\<boolean>): void

Activates a device administrator application based on the specified bundle name and class name. This API uses an asynchronous callback to return the result.

**Required permissions**

ohos.permission.MANAGE_ADMIN

**System capability**

SystemCapability.Customation.EnterpriseDeviceManager

**Parameters**

 | Name | Type | Mandatory | Description |
 | -------- | -------- | -------- | -------- |
 | admin | [Want](js-apis-application-Want.md) | Yes | Device administrator application. |
 | enterpriseInfo | [EnterpriseInfo](#EnterpriseInfo) | Yes | Enterprise information of the device administrator application. |
 | type | [AdminType](#AdminType) | Yes | Type of the device administrator to activate. |
 | callback | AsyncCallback\<boolean> | Yes | Callback used to return the result. |

**Example**

```
let wantTemp = {
	bundleName: "com.example.myapplication",
	abilityName: "com.example.myapplication.MainAbility",
};
let enterpriseInfo = {
	name: "enterprise name",
	description: "enterprise description"
}
enterpriseDeviceManager.activateAdmin(wantTemp, enterpriseInfo, enterpriseDeviceManager.AdminType.ADMIN_TYPE_NORMAL, (error, result) => {
    if (error != null) {
        console.log("error occurs" + error);
        return; 
    }
    console.log(result);
});
```

## enterpriseDeviceManager.activateAdmin

activateAdmin(admin: Want, enterpriseInfo: EnterpriseInfo, type: AdminType): Promise\<boolean>

Activates a device administrator application based on the specified bundle name and class name. This API uses a promise to return the result.

**Required permissions**

ohos.permission.MANAGE_ADMIN

**System capability**

SystemCapability.Customation.EnterpriseDeviceManager

**Parameters**

 | Name | Type | Mandatory | Description |
 | -------------- | ---------------------------------------------- | ---- | ------------------------ |
 | admin | [Want](js-apis-application-Want.md) | Yes | Device administrator application. |
 | enterpriseInfo | [EnterpriseInfo](#EnterpriseInfo) | Yes | Enterprise information of the device administrator application. |
 | type | [AdminType](#AdminType) | Yes | Type of the device administrator to activate. |

**Return value**

 | Type | Description |
 | ----------------- | --------------------------- |
 | Promise\<boolean> | Promise used to return the result. |

**Example**

```
let wantTemp = {
	bundleName: "com.example.myapplication",
	abilityName: "com.example.myapplication.MainAbility",
};
let enterpriseInfo = {
	name: "enterprise name",
	description: "enterprise description"
}
enterpriseDeviceManager.activateAdmin(wantTemp, enterpriseInfo, enterpriseDeviceManager.AdminType.ADMIN_TYPE_NORMAL)
.then((result) => {
	console.log(result);
}).catch(error => {
	console.log("error occurs" + error);
});
```

## enterpriseDeviceManager.deactivateAdmin

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

Deactivates a device common administrator application based on the specified bundle name and class name. This API uses an asynchronous callback to return the result.

**Required permissions**

ohos.permission.MANAGE_ADMIN

**System capability**

SystemCapability.Customation.EnterpriseDeviceManager

**Parameters**

 | Name | Type | Mandatory | Description |
 | -------- | ---------------------------------------------- | ---- | ------------------------------ |
 | admin | [Want](js-apis-application-Want.md) | Yes | Device common administrator application. |
 | callback | AsyncCallback\<boolean> | Yes | Callback used to return the result. |

**Example**

```
let wantTemp = {
	bundleName: elementName.bundleName,
	abilityName: elementName.abilityName,
};
enterpriseDeviceManager.deactivateAdmin(wantTemp, (error, result) => {
    if (error != null) {
        console.log("error occurs" + error);
        return; 
    }
    console.log(result);
});
```



## enterpriseDeviceManager.deactivateAdmin

deactivateAdmin(admin: Want): Promise\<boolean>

Deactivates a device common administrator application based on the specified bundle name and class name. This API uses a promise to return the result.

**Required permissions**

ohos.permission.MANAGE_ADMIN

**System capability**

SystemCapability.Customation.EnterpriseDeviceManager

**Parameters**

 | Name | Type | Mandatory | Description |
 | ------ | ---------------------------------------------- | ---- | ------------------ |
 | admin | [Want](js-apis-application-Want.md) | Yes | Device common administrator application. |

**Return value**

 | Type | Description |
 | ----------------- | --------------------------- |
 | Promise\<boolean> | Promise used to return the result. |

**Example**

```
let wantTemp = {
	bundleName: "bundleName",
	abilityName: "abilityName",
};
enterpriseDeviceManager.deactivateAdmin(wantTemp).then((result) => {
	console.log(result);
}).catch(error => {
	console.log("error occurs" + error);
});
```

## enterpriseDeviceManager.deactivateSuperAdmin

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

Deactivates a device super administrator application based on the specified bundle name. This API uses an asynchronous callback to return the result.

**System capability**

SystemCapability.Customation.EnterpriseDeviceManager

**Parameters**

 | Name | Type | Mandatory | Description |
 | ---------- | ----------------------- | ---- | ------------------------------ |
 | bundleName | String | Yes | Bundle name of a device super administrator application. |
 | callback | AsyncCallback\<boolean> | Yes | Callback used to return the result. |

**Example**

```
let bundleName = "com.example.myapplication";
enterpriseDeviceManager.deactivateSuperAdmin(bundleName, (error, result) => {
    if (error != null) {
        console.log("error occurs" + error);
        return; 
    }
    console.log(result);
});
```

## enterpriseDeviceManager.deactivateSuperAdmin

deactivateSuperAdmin(bundleName: String): Promise\<boolean>

Deactivates a device super administrator application based on the specified bundle name. This API uses a promise to return the result.

**System capability**

SystemCapability.Customation.EnterpriseDeviceManager

**Parameters**

 | Name | Type | Mandatory | Description |
 | ---------- | ------ | ---- | ------------------------ |
 | bundleName | String | Yes | Bundle name of a device super administrator application. |

**Return value**

 | Type | Description |
 | ----------------- | --------------------------- |
 | Promise\<boolean> | Promise used to return the result. |

**Example**

```
let bundleName = "com.example.myapplication";
enterpriseDeviceManager.deactivateSuperAdmin(bundleName).then((result) => {
	console.log(result);
}).catch(error => {
	console.log("error occurs" + error);
});
```

## enterpriseDeviceManager.isAdminAppActive

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

Checks whether a device administrator application is activated based on the specified bundle name and class name. This API uses an asynchronous callback to return the result.

**System capability**

SystemCapability.Customation.EnterpriseDeviceManager

**Parameters**

 | Name | Type | Mandatory | Description |
 | -------- | ---------------------------------------------- | ---- | -------------------------------- |
 | admin | [Want](js-apis-application-Want.md) | Yes | Device administrator application. |
 | callback | AsyncCallback\<boolean> | Yes | Callback used to return the result. |

**Example**

```
let wantTemp = {
	bundleName: elementName.bundleName,
	abilityName: elementName.abilityName,
};
enterpriseDeviceManager.isAdminAppActive(wantTemp, (error, result) => {
    if (error != null) {
        console.log("error occurs" + error);
        return; 
    }
    console.log(result);
});
```



## enterpriseDeviceManager.isAdminAppActive

isAdminAppActive(admin: Want): Promise\<boolean>

Checks whether a device administrator application is activated based on the specified bundle name and class name. This API uses a promise to return the result.

**System capability**

SystemCapability.Customation.EnterpriseDeviceManager

**Parameters**

 | Name | Type | Mandatory | Description |
 | ------ | ---------------------------------------------- | ---- | -------------- |
 | admin | [Want](js-apis-application-Want.md) | Yes | Device administrator application. |

**Return value**

 | Type | Description |
 | ----------------- | ------------------------------- |
 | Promise\<boolean> | Promise used to return the result. |

**Example**

```
let wantTemp = {
	bundleName: "bundleName",
	abilityName: "abilityName",
};
enterpriseDeviceManager.isAdminAppActive(wantTemp).then((result) => {
	console.log(result);
}).catch(error => {
	console.log("error occurs" + error);
});
```

## enterpriseDeviceManager.isSuperAdmin

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

Checks whether a device super administrator application is activated based on the specified bundle name. This API uses an asynchronous callback to return the result.

**System capability**

SystemCapability.Customation.EnterpriseDeviceManager

**Parameters**

 | Name | Type | Mandatory | Description |
 | ---------- | ----------------------- | ---- | -------------------------------- |
 | bundleName | String | Yes | Bundle name of a device super administrator application. |
 | callback | AsyncCallback\<boolean> | Yes | Callback used to return the result. |

**Example**

```
let bundleName = "com.example.myapplication";
enterpriseDeviceManager.isSuperAdmin(bundleName, (error, result) => {
    if (error != null) {
        console.log("error occurs" + error);
        return; 
    }
    console.log(result);
});
```



## enterpriseDeviceManager.isSuperAdmin

isSuperAdmin(bundleName: String): Promise\<boolean>

Checks whether a device super administrator application is activated based on the specified bundle name. This API uses a promise to return the result.

**System capability**

SystemCapability.Customation.EnterpriseDeviceManager

**Parameters**

 | Name | Type | Mandatory | Description |
 | ---------- | ------ | ---- | ------------------ |
 | bundleName | String | Yes | Bundle name of a device super administrator application. |

**Return value**

 | Type | Description |
 | ----------------- | ------------------------------- |
 | Promise\<boolean> | Promise used to return the result. |

**Example**

```
let bundleName = "com.example.myapplication";
enterpriseDeviceManager.isSuperAdmin(bundleName).then((result) => {
	console.log(result);
}).catch(error => {
	console.log("error occurs" + error);
});
```

## enterpriseDeviceManager.getDeviceSettingsManager

getDeviceSettingsManager(callback: AsyncCallback&lt;DeviceSettingsManager&gt;): void

Obtains a **DeviceSettingsManager** object. This API uses an asynchronous callback to return the result.

**System capability**

SystemCapability.Customation.EnterpriseDeviceManager

**Parameters**

 | Name | Type | Mandatory | Description |
 | -------- | -------- | -------- | -------- |
 | callback | AsyncCallback<DeviceSettingsManager&gt; | Yes | Callback used to return the **DeviceSettingsManager** object obtained. |

**Example**

```
let wantTemp = {
	bundleName: "bundleName",
	abilityName: "abilityName",
};
enterpriseDeviceManager.getDeviceSettingsManager((error, mgr) => {
    if (error != null) {
        console.log("error occurs" + error);
        return; 
    }
    mgr.setDateTime(wantTemp, 1526003846000, (error, value) => { 
        if (error != null) {
            console.log(error);
        } else {
            console.log(value);
        }
    });
});
```


## enterpriseDeviceManager.getDeviceSettingsManager

getDeviceSettingsManager(): Promise&lt;DeviceSettingsManager&gt;

Obtains a **DeviceSettingsManager** object. This API uses a promise to return the result.

**System capability**

SystemCapability.Customation.EnterpriseDeviceManager

**Return value**

 | Type | Description |
 | -------- | -------- |
 | Promise&lt;DeviceSettingsManager&gt; | Promise used to return the **DeviceSettingsManager** object obtained. |

**Example**

```
let wantTemp = {
	bundleName: "bundleName",
	abilityName: "abilityName",
};
mgr.getDeviceSettingsManager().then((mgr) => {
    mgr.setDateTime(wantTemp, 1526003846000).then((value) => {
        console.log(value);
    }).catch((error) => {
        console.log(error);
    })
}).catch((error) => {
    console.log(error);
})
```

## enterpriseDeviceManager.setEnterpriseInfo

setEnterpriseInfo(admin: Want, enterpriseInfo: EnterpriseInfo, callback: AsyncCallback&lt;boolean&gt;): void

Sets the enterprise information of a device administrator application. This API uses an asynchronous callback to return the result.

**System capability**

SystemCapability.Customation.EnterpriseDeviceManager

**Parameters**

 | Name | Type | Mandatory | Description |
 | -------------- | ---------------------------------------------- | ---- | ------------------------------------ |
 | admin | [Want](js-apis-application-Want.md) | Yes | Device administrator application. |
 | enterpriseInfo | [EnterpriseInfo](#EnterpriseInfo) | Yes | Enterprise information of the device administrator application. |
 | callback | AsyncCallback\<boolean&gt; | Yes | Callback used to return the result. |

**Example**

```
let wantTemp = {
	bundleName: "com.example.myapplication",
	abilityName: "com.example.myapplication.MainAbility",
};
let enterpriseInfo = {
	name: "enterprise name",
	description: "enterprise description"
}
enterpriseDeviceManager.setEnterpriseInfo(wantTemp, enterpriseInfo)
.then((result) => {
	console.log(result);
}).catch(error => {
	console.log("error occurs" + error);
});
```


## enterpriseDeviceManager.setEnterpriseInfo

setEnterpriseInfo(admin: Want, enterpriseInfo: EnterpriseInfo): Promise&lt;boolean&gt;

Sets the enterprise information of a device administrator application. This API uses a promise to return the result.

**System capability**

SystemCapability.Customation.EnterpriseDeviceManager

**Parameters**

 | Name | Type | Mandatory | Description |
 | -------------- | ---------------------------------------------- | ---- | ------------------------ |
 | admin | [Want](js-apis-application-Want.md) | Yes | Device administrator application. |
 | enterpriseInfo | [EnterpriseInfo](#EnterpriseInfo) | Yes | Enterprise information of the device administrator application. |

**Return value**

 | Type | Description |
 | ------------------ | ----------------------------------- |
 | Promise\<boolean>; | Callback used to return the result. |

**Example**

```
let wantTemp = {
	bundleName: "com.example.myapplication",
	abilityName: "com.example.myapplication.MainAbility",
};
let enterpriseInfo = {
	name: "enterprise name",
	description: "enterprise description"
}
enterpriseDeviceManager.setEnterpriseInfo(wantTemp, enterpriseInfo)
.then((result) => {
	console.log(result);
}).catch(error => {
	console.log("error occurs" + error);
});
```

## enterpriseDeviceManager.getEnterpriseInfo

getEnterpriseInfo(admin: Want, callback: AsyncCallback&lt;EnterpriseInfo&gt;): void

Obtains the enterprise information of a device administrator application. This API uses an asynchronous callback to return the result.

**System capability**

SystemCapability.Customation.EnterpriseDeviceManager

**Parameters**

 | Name | Type  | Mandatory | Description |
 | -------- | ------------------------------------------------------ | ---- | ---------------------------------------- |
 | admin | [Want](js-apis-application-Want.md) | Yes | Device administrator application. |
 | callback | AsyncCallback&lt;[EnterpriseInfo](#EnterpriseInfo)&gt; | Yes | Callback used to return the enterprise information of the device administrator application. |

**Example**

```
let wantTemp = {
	bundleName: "com.example.myapplication",
	abilityName: "com.example.myapplication.MainAbility",
};
enterpriseDeviceManager.getEnterpriseInfo(wantTemp, (error, result) => {
    if (error != null) {
        console.log("error occurs" + error);
        return; 
    }
    console.log(result.name);
	console.log(result.description);
});
```


## enterpriseDeviceManager.getEnterpriseInfo

getDeviceSettingsManager(admin: Want): Promise&lt;EnterpriseInfo&gt;

Obtains the enterprise information of a device administrator application. This API uses a promise to return the result.

**System capability**

SystemCapability.Customation.EnterpriseDeviceManager

**Parameters**

 | Name | Type | Mandatory | Description |
 | ------ | ---------------------------------------------- | ---- | -------------- |
 | admin | [Want](js-apis-application-Want.md) | Yes | Device administrator application. |

**Return value**

 | Type | Description |
 | ------------------------------------------------ | ------------------------------------------- |
 | Promise&lt;[EnterpriseInfo](#EnterpriseInfo)&gt; | Promise used to return the enterprise information of the device administrator application. |

**Example**

```
let wantTemp = {
	bundleName: "com.example.myapplication",
	abilityName: "com.example.myapplication.MainAbility",
};
enterpriseDeviceManager.getEnterpriseInfo(wantTemp).then((result) => {
	console.log(result.name);
	console.log(result.description);
}).catch(error => {
	console.log("error occurs" + error);
});
```

## EnterpriseInfo

Describes the enterprise information of a device administrator application.

**System capability**

SystemCapability.Customation.EnterpriseDeviceManager

 | Name | Readable/Writable | Type | Mandatory | Description |
 | ----------- | -------- | ------ | ---- | ---------------------------------- |
 | name | Read only | string | Yes | Name of the enterprise to which the device administrator application belongs. |
 | description | Read only | string | Yes | Description of the enterprise to which the device administrator application belongs. |


## AdminType

Enumerates the administrator types of the device administrator application.

**System capability**

SystemCapability.Customation.EnterpriseDeviceManager

 | Name | Default Value | Description |
 | -------- | -------- | -------- |
 | ADMIN_TYPE_NORMAL | 0x00 | Common administrator. |
 | ADMIN_TYPE_SUPER | 0x01 | Super administrator. |