harmony 鸿蒙@ohos.enterprise.dateTimeManager (System Time Management)

2023-02-03
浏览 (580)

@ohos.enterprise.dateTimeManager (System Time Management)

The dateTimeManager module provides APIs for system time management.

NOTE

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.

The APIs of this module can be used only in the stage model.

The APIs provided by this module can be called only by a device administrator application that is enabled.

Modules to Import

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

dateTimeManager.setDateTime

setDateTime(admin: Want, time: number, callback: AsyncCallback<void>): void

Sets the system time through the specified device administrator application. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.ENTERPRISE_SET_DATETIME

System capability: SystemCapability.Customization.EnterpriseDeviceManager

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
admin	Want	Yes	Device administrator application.
time	number	Yes	Timestamp to set, in ms.
callback	AsyncCallback<void>	Yes	Callback invoked to return the result. If the operation is successful, err is null. Otherwise, err is an error object.

Error codes

For details about the error codes, see Enterprise Device Management Error Codes.

ID	Error Message
9200001	the application is not an administrator of the device.
9200002	the administrator application does not have permission to manage the device.

Example

import Want from '@ohos.app.ability.Want';
let wantTemp: Want = {
  bundleName: 'bundleName',
  abilityName: 'abilityName',
};

dateTimeManager.setDateTime(wantTemp, 1526003846000, (err) => {
  if (err) {
    console.error(`Failed to set date time. Code is ${err.code}, message is ${err.message}`);
    return;
  }
  console.info('Succeeded in setting date time');
})

dateTimeManager.setDateTime

setDateTime(admin: Want, time: number): Promise<void>

Sets the system time through the specified device administrator application. This API uses a promise to return the result.

Required permissions: ohos.permission.ENTERPRISE_SET_DATETIME

System capability: SystemCapability.Customization.EnterpriseDeviceManager

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
admin	Want	Yes	Device administrator application.
time	number	Yes	Timestamp to set, in ms.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Enterprise Device Management Error Codes.

ID	Error Message
9200001	the application is not an administrator of the device.
9200002	the administrator application does not have permission to manage the device.

Example

import Want from '@ohos.app.ability.Want';
import { BusinessError } from '@ohos.base';
let wantTemp: Want = {
  bundleName: 'bundleName',
  abilityName: 'abilityName',
};

dateTimeManager.setDateTime(wantTemp, 1526003846000).then(() => {
  console.info('Succeeded in setting date time');
}).catch((err: BusinessError) => {
  console.error(`Failed to set date time. Code is ${err.code}, message is ${err.message}`);
})

dateTimeManager.disallowModifyDateTime¹⁰⁺

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

Forbids the specified device administrator application to modify the system time. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.ENTERPRISE_SET_DATETIME

System capability: SystemCapability.Customization.EnterpriseDeviceManager

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
admin	Want	Yes	Device administrator application.
disallow	boolean	Yes	Whether to disallow modification of the system time. The value true means to disallow modification of the system time, and false means the opposite.
callback	AsyncCallback<void>	Yes	Callback invoked to return the result. If the operation is successful, err is null. Otherwise, err is an error object.

Error codes

For details about the error codes, see Enterprise Device Management Error Codes.

ID	Error Message
9200001	the application is not an administrator of the device.
9200002	the administrator application does not have permission to manage the device.

Example

import Want from '@ohos.app.ability.Want';
let wantTemp: Want = {
  bundleName: 'bundleName',
  abilityName: 'abilityName',
};

dateTimeManager.disallowModifyDateTime(wantTemp, true, (err) => {
  if (err) {
    console.error(`Failed to disallow modify date time. Code is ${err.code}, message is ${err.message}`);
    return;
  }
  console.info('Succeeded in disallowing modify date time');
})

dateTimeManager.disallowModifyDateTime¹⁰⁺

disallowModifyDateTime(admin: Want, disallow: boolean): Promise<void>

Forbids the specified device administrator application to modify the system time. This API uses a promise to return the result.

Required permissions: ohos.permission.ENTERPRISE_SET_DATETIME

System capability: SystemCapability.Customization.EnterpriseDeviceManager

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
admin	Want	Yes	Device administrator application.
disallow	boolean	Yes	Whether to disallow modification of the system time. The value true means to disallow modification of the system time, and false means the opposite.

Return value

Type	Description
Promise<void>	Promise that returns no value. If the operation fails, an error object will be thrown.

Error codes

For details about the error codes, see Enterprise Device Management Error Codes.

ID	Error Message
9200001	the application is not an administrator of the device.
9200002	the administrator application does not have permission to manage the device.

Example

import Want from '@ohos.app.ability.Want';
import { BusinessError } from '@ohos.base';
let wantTemp: Want = {
  bundleName: 'bundleName',
  abilityName: 'abilityName',
};

dateTimeManager.disallowModifyDateTime(wantTemp, true).then(() => {
  console.info('Succeeded in disallowing modify date time');
}).catch((err: BusinessError) => {
  console.error(`Failed to disallow modify date time. Code is ${err.code}, message is ${err.message}`);
})

dateTimeManager.isModifyDateTimeDisallowed¹⁰⁺

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

Checks whether the system time modification is disallowed through the specified device administrator application. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.ENTERPRISE_SET_DATETIME

System capability: SystemCapability.Customization.EnterpriseDeviceManager

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
admin	Want	Yes	Device administrator application.
callback	AsyncCallback<boolean>	Yes	Callback invoked to return the result. The value true means the system time modification is disallowed, and false means the opposite.

Error codes

For details about the error codes, see Enterprise Device Management Error Codes.

ID	Error Message
9200001	the application is not an administrator of the device.
9200002	the administrator application does not have permission to manage the device.

Example

import Want from '@ohos.app.ability.Want';
let wantTemp: Want = {
  bundleName: 'bundleName',
  abilityName: 'abilityName',
};

dateTimeManager.isModifyDateTimeDisallowed(wantTemp, (err, result) => {
  if (err) {
    console.error(`Failed to query modify date time is disallowed or not. Code is ${err.code}, message is ${err.message}`);
    return;
  }
  console.info(`Succeeded in querying modify date time is disallowed : ${result}`);
})

dateTimeManager.isModifyDateTimeDisallowed¹⁰⁺

isModifyDateTimeDisallowed(admin: Want): Promise<boolean>

Checks whether the system time modification is disallowed through the specified device administrator application. This API uses a promise to return the result.

Required permissions: ohos.permission.ENTERPRISE_SET_DATETIME

System capability: SystemCapability.Customization.EnterpriseDeviceManager

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
admin	Want	Yes	Device administrator application.

Return value

Type	Description
Promise<boolean>	Promise used to return the result. The value true means the system time modification is disallowed, and false means the opposite.

Error codes

For details about the error codes, see Enterprise Device Management Error Codes.

ID	Error Message
9200001	the application is not an administrator of the device.
9200002	the administrator application does not have permission to manage the device.

Example

import Want from '@ohos.app.ability.Want';
import { BusinessError } from '@ohos.base';
let wantTemp: Want = {
  bundleName: 'bundleName',
  abilityName: 'abilityName',
};

dateTimeManager.isModifyDateTimeDisallowed(wantTemp).then((result) => {
  console.info(`Succeeded in querying modify date time is disallowed : ${result}`);
}).catch((err: BusinessError) => {
  console.error(`Failed to query modify date time is disallowed or not. Code is ${err.code}, message is ${err.message}`);
})