@ohos.systemTime (System Time and Time Zone)
The systemTime module provides system time and time zone features. You can use the APIs of this module to set and obtain the system time and time zone.
NOTE
- The APIs of this module are deprecated since API version 9. You are advised to use the APIs of the @ohos.systemDateTime (System Time and Time Zone) module.
- The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version.
Modules to Import
import systemTime from '@ohos.systemTime';
systemTime.setTime
setTime(time : number, callback : AsyncCallback<void>) : void
Sets the system time. This API uses an asynchronous callback to return the result.
Required permissions: ohos.permission.SET_TIME
System capability: SystemCapability.MiscServices.Time
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
time | number | Yes | Timestamp to set, in milliseconds. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Error codes
For details about the error codes, see Time and Time Zone Service Error Codes.
ID | Error Message |
---|---|
-1 | The parameter check failed or permission denied or system error. |
Example
import { BusinessError } from '@ohos.base';
// Set the system time to 2021-01-20 02:36:25.
let time = 1611081385000;
try {
systemTime.setTime(time, (error: BusinessError) => {
if (error) {
console.info(`Failed to setting time. message: ${error.message}, code: ${error.code}`);
return;
}
console.info(`Succeeded in setting time`);
});
} catch(e) {
let error = e as BusinessError;
console.info(`Failed to set time. message: ${error.message}, code: ${error.code}`);
}
systemTime.setTime
setTime(time : number) : Promise<void>
Sets the system time. This API uses a promise to return the result.
Required permissions: ohos.permission.SET_TIME
System capability: SystemCapability.MiscServices.Time
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
time | number | Yes | Timestamp to set, in milliseconds. |
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Error codes
For details about the error codes, see Time and Time Zone Service Error Codes.
ID | Error Message |
---|---|
-1 | The parameter check failed or permission denied or system error. |
Example
import { BusinessError } from '@ohos.base';
// Set the system time to 2021-01-20 02:36:25.
let time = 1611081385000;
try {
systemTime.setTime(time).then(() => {
console.info(`Succeeded in setting time.`);
}).catch((error: BusinessError) => {
console.info(`Failed to setting time. message: ${error.message}, code: ${error.code}`);
});
} catch(e) {
let error = e as BusinessError;
console.info(`Failed to set time. message: ${error.message}, code: ${error.code}`);
}
systemTime.setDate
setDate(date: Date, callback: AsyncCallback<void>): void
Sets the system date. This API uses an asynchronous callback to return the result.
Required permissions: ohos.permission.SET_TIME
System capability: SystemCapability.MiscServices.Time
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
date | Date | Yes | Target date to set. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Error codes
For details about the error codes, see Time and Time Zone Service Error Codes.
ID | Error Message |
---|---|
-1 | The parameter check failed or permission denied or system error. |
Example
import { BusinessError } from '@ohos.base';
let date = new Date();
try {
systemTime.setDate(date, (error: BusinessError) => {
if (error) {
console.info(`Failed to setting date. message: ${error.message}, code: ${error.code}`);
return;
}
console.info(`Succeeded in setting date.`);
});
} catch(e) {
let error = e as BusinessError;
console.info(`Failed to set date. message: ${error.message}, code: ${error.code}`);
}
systemTime.setDate
setDate(date: Date): Promise<void>
Sets the system date. This API uses a promise to return the result.
Required permissions: ohos.permission.SET_TIME
System capability: SystemCapability.MiscServices.Time
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
date | Date | Yes | Target date to set. |
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Error codes
For details about the error codes, see Time and Time Zone Service Error Codes.
ID | Error Message |
---|---|
-1 | The parameter check failed or permission denied or system error. |
Example
import { BusinessError } from '@ohos.base';
let date = new Date();
try {
systemTime.setDate(date).then(() => {
console.info(`Succeeded in setting date.`);
}).catch((error: BusinessError) => {
console.info(`Failed to setting date. message: ${error.message}, code: ${error.code}`);
});
} catch(e) {
let error = e as BusinessError;
console.info(`Failed to set date. message: ${error.message}, code: ${error.code}`);
}
systemTime.setTimezone
setTimezone(timezone: string, callback: AsyncCallback<void>): void
Sets the system time zone. This API uses an asynchronous callback to return the result.
Required permissions: ohos.permission.SET_TIME_ZONE
System capability: SystemCapability.MiscServices.Time
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
timezone | string | Yes | System time zone to set. For details, see Supported System Time Zones. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Error codes
For details about the error codes, see Time and Time Zone Service Error Codes.
ID | Error Message |
---|---|
-1 | The parameter check failed or permission denied or system error. |
Example
import { BusinessError } from '@ohos.base';
try {
systemTime.setTimezone('Asia/Shanghai', (error: BusinessError) => {
if (error) {
console.info(`Failed to setting timezone. message: ${error.message}, code: ${error.code}`);
return;
}
console.info(`Succeeded in setting timezone.`);
});
} catch(e) {
let error = e as BusinessError;
console.info(`Failed to set timezone. message: ${error.message}, code: ${error.code}`);
}
systemTime.setTimezon
setTimezone(timezone: string): Promise<void>
Sets the system time zone. This API uses a promise to return the result.
Required permissions: ohos.permission.SET_TIME_ZONE
System capability: SystemCapability.MiscServices.Time
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
timezone | string | Yes | System time zone to set. For details, see Supported System Time Zones. |
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Error codes
For details about the error codes, see Time and Time Zone Service Error Codes.
ID | Error Message |
---|---|
-1 | The parameter check failed or permission denied or system error. |
Example
import { BusinessError } from '@ohos.base';
try {
systemTime.setTimezone('Asia/Shanghai').then(() => {
console.info(`Succeeded in setting timezone.`);
}).catch((error: BusinessError) => {
console.info(`Failed to setting timezone. message: ${error.message}, code: ${error.code}`);
});
} catch(e) {
let error = e as BusinessError;
console.info(`Failed to set timezone. message: ${error.message}, code: ${error.code}`);
}
Supported System Time Zones
The following table lists the supported system time zones and the respective offset (unit: h) between each time zone and time zone 0.
Time Zone | Offset |
---|---|
Antarctica/McMurdo | 12 |
America/Argentina/Buenos_Aires | -3 |
Australia/Sydney | 10 |
America/Noronha | -2 |
America/St_Johns | -3 |
Africa/Kinshasa | 1 |
America/Santiago | -3 |
Asia/Shanghai | 8 |
Asia/Nicosia | 3 |
Europe/Berlin | 2 |
America/Guayaquil | -5 |
Europe/Madrid | 2 |
Pacific/Pohnpei | 11 |
America/Godthab | -2 |
Asia/Jakarta | 7 |
Pacific/Tarawa | 12 |
Asia/Almaty | 6 |
Pacific/Majuro | 12 |
Asia/Ulaanbaatar | 8 |
America/Mexico_City | -5 |
Asia/Kuala_Lumpur | 8 |
Pacific/Auckland | 12 |
Pacific/Tahiti | -10 |
Pacific/Port_Moresby | 10 |
Asia/Gaza | 3 |
Europe/Lisbon | 1 |
Europe/Moscow | 3 |
Europe/Kiev | 3 |
Pacific/Wake | 12 |
America/New_York | -4 |
Asia/Tashkent | 5 |