# 设置系统时间
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
```
import systemTime from '@ohos.systemTime';
```
## systemTime.setTime
setTime(time : number, callback : AsyncCallback<void>) : void
设置系统时间。
**需要权限:**ohos.permission.SET_TIME
**系统能力**: SystemCapability.Miscservices.Time
- 参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| time | number | 是 | 目标时间戳(毫秒)。 |
| callback | AsyncCallback<void> | 是 | 回调函数,可以在回调函数中处理接口返回值。 |
- 示例:
```
// time对应的时间为2021-01-20 02:36:25
var time = 1611081385000;
systemTime.setTime(time, (error, data) => {
if (error) {
console.error(`failed to systemTime.setTime because ` + JSON.stringify(error));
return;
}
console.log(`systemTime.setTime success data : ` + JSON.stringify(data));
});
```
## systemTime.setTime
setTime(time : number) : Promise<void>
设置系统时间。
**需要权限:**ohos.permission.SET_TIME
**系统能力**: SystemCapability.Miscservices.Time
- 参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| time | number | 是 | 目标时间戳(毫秒)。 |
- 返回值:
| 类型 | 说明 |
| -------- | -------- |
| Promise<void> | 返回的异步回调函数。 |
- 示例:
```
// time对应的时间为2021-01-20 02:36:25
var time = 1611081385000;
systemTime.setTime(time).then((data) => {
console.log(`systemTime.setTime success data : ` + JSON.stringify(data));
}).catch((error) => {
console.error(`failed to systemTime.setTime because ` + JSON.stringify(error));
});
```
## systemTime.getCurrentTime8+
getCurrentTime(isNano?: boolean, callback: AsyncCallback<number>): void
获取自 Unix 纪元以来经过的时间,使用callback形式返回结果。
**系统能力**: SystemCapability.Miscservices.Time
- 参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| isNano | boolean | 否 | 如果是true,返回纳秒数;否则返回毫秒数。 |
| callback | AsyncCallback<number> | 是 | 回调函数,返回自 Unix 纪元以来经过的时间。 |
- 示例:
```
systemTime.getCurrentTime(true, (error, data) => {
if (error) {
console.error(`failed to systemTime.getCurrentTime because ` + JSON.stringify(error));
return;
}
console.log(`systemTime.getCurrentTime success data : ` + JSON.stringify(data));
});
```
## systemTime.getCurrentTime8+
getCurrentTime(isNano?: boolean): Promise<number>
获取自 Unix 纪元以来经过的时间,使用Promise形式返回结果。
**系统能力**: SystemCapability.Miscservices.Time
- 参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| isNano | boolean | 否 | 如果是true,返回纳秒数;否则返回毫秒数。 |
- 返回值:
| 类型 | 说明 |
| -------- | -------- |
| Promise<number> | 以Promise形式返回结果,返回自 Unix 纪元以来经过的时间。 |
- 示例:
```
systemTime.getCurrentTime().then((data) => {
console.log(`systemTime.getCurrentTime success data : ` + JSON.stringify(data));
}).catch((error) => {
console.error(`failed to systemTime.getCurrentTime because ` + JSON.stringify(error));
});
```
## systemTime.getRealActiveTime8+
getRealActiveTime(isNano?: boolean, callback: AsyncCallback<number>): void
获取自系统启动以来经过的时间,不包括深度睡眠时间,使用callback形式返回结果。
**系统能力**: SystemCapability.Miscservices.Time
- 参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| isNano | boolean | 否 | 如果是true,返回纳秒数;否则返回毫秒数。 |
| callback | AsyncCallback<number> | 是 | 回调函数,返回自系统启动以来但不包括度睡眠时间经过的时间。 |
- 示例:
```
systemTime.getRealActiveTime(true, (error, data) => {
if (error) {
console.error(`failed to systemTime.getRealActiveTimebecause ` + JSON.stringify(error));
return;
}
console.log(`systemTime.getRealActiveTime success data : ` + JSON.stringify(data));
});
```
## systemTime.getRealActiveTime8+
getRealActiveTime(isNano?: boolean): Promise<number>
获取自系统启动以来经过的时间,不包括深度睡眠时间,使用Promise形式返回结果。
**系统能力**: SystemCapability.Miscservices.Time
- 参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| isNano | boolean | 否 | 如果是true,返回纳秒数;否则返回毫秒数。 |
- 返回值:
| 类型 | 说明 |
| -------- | -------- |
| Promise<number> | 以Promise形式返回结果,返回自系统启动以来但不包括度睡眠时间经过的时间。 |
- 示例:
```
systemTime.getCurrentTime().then((data) => {
console.log(`systemTime.getRealActiveTime success data : ` + JSON.stringify(data));
}).catch((error) => {
console.error(`failed to systemTime.getRealActiveTime because ` + JSON.stringify(error));
});
```
## systemTime.getRealTime8+
getRealTime(callback: AsyncCallback<number>): void
获取自系统启动以来经过的时间,包括深度睡眠时间,使用callback形式返回结果。
**系统能力**: SystemCapability.Miscservices.Time
- 参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| isNano | boolean | 否 | 如果是true,返回纳秒数;否则返回毫秒数。 |
| callback | AsyncCallback<number> | 是 | 回调函数,返回自系统启动以来包括深度睡眠时间经过的毫秒数。 |
- 示例:
```
systemTime.getRealTime(true, (error, data) => {
if (error) {
console.error(`failed to systemTime.getRealTime because ` + JSON.stringify(error));
return;
}
console.log(`systemTime.getRealTime success data: ` + JSON.stringify(data));
});
```
## systemTime.getRealTime8+
getRealTime(): Promise<number>
获取自系统启动以来经过的时间,包括深度睡眠时间,使用Promise形式返回结果。
**系统能力**: SystemCapability.Miscservices.Time
- 参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| isNano | boolean | 否 | 如果是true,返回纳秒数;否则返回毫秒数。 |
- 返回值:
| 类型 | 说明 |
| -------- | -------- |
| Promise<number> | 以Promise形式返回结果,返回自系统启动以来包括深度睡眠时间经过的时间。 |
- 示例:
```
systemTime.getRealTime().then((data) => {
console.log(`systemTime.getRealTime success data: ` + JSON.stringify(data));
}).catch((error) => {
console.error(`failed to systemTime.getRealTime because ` + JSON.stringify(error));
});
```
## systemTime.setDate
setDate(date: Date, callback: AsyncCallback<void>): void
设置系统日期,使用callback形式返回结果。
**需要权限:**ohos.permission.SET_TIME
**系统能力**: SystemCapability.Miscservices.Time
- 参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| date | Date | 是 | 目标日期。 |
| callback | AsyncCallback<void> | 是 | 回调函数,可以在回调函数中处理接口返回值。 |
- 示例:
```
var data = new Date("October 13, 2020 11:13:00");
systemTime.setDate(data,(error, data) => {
if (error) {
console.error('failed to systemTime.setDate because ' + JSON.stringify(error));
return;
}
console.info('systemTime.setDate success data : ' + JSON.stringify(data));
});
```
## systemTime.setDate
setDate(date: Date): Promise<void>
设置系统日期,使用Promise形式返回结果。
**需要权限:**ohos.permission.SET_TIME
**系统能力**: SystemCapability.Miscservices.Time
- 参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| date | Date | 是 | 目标日期。 |
- 返回值:
| 类型 | 说明 |
| -------- | -------- |
| Promise<void> | 返回的异步回调函数。 |
- 示例:
```
var data = new Date("October 13, 2020 11:13:00");
systemTime.setDate(data).then((value) => {
console.log(`systemTime.setDate success data : ` + JSON.stringify(value));
}).catch((error) => {
console.error(`failed to systemTime.setDate because: ` + JSON.stringify(error));
});
```
## systemTime.getDate8+
getDate(callback: AsyncCallback<Date>): void
获取当前系统日期,使用callback形式返回结果。
**系统能力**: SystemCapability.Miscservices.Time
- 参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback<Date> | 是 | 回调函数,返回当前系统日期。 |
- 示例:
```
systemTime.getDate((error, data) => {
if (error) {
console.error(`failed to systemTime.getDate because ` + JSON.stringify(error));
return;
}
console.log(`systemTime.getDate success data : ` + JSON.stringify(data));
});
```
## systemTime.getDate8+
getDate(): Promise<Date>
获取当前系统日期,使用Promise形式返回结果。
**系统能力**: SystemCapability.Miscservices.Time
- 返回值:
| 类型 | 说明 |
| -------- | -------- |
| Promise<Date> | 以Promise形式返回结果,返回当前系统日期。 |
- 示例:
```
systemTime.getDate().then((data) => {
console.log(`systemTime.getDate success data : ` + JSON.stringify(data));
}).catch((error) => {
console.error(`failed to systemTime.getDate because ` + JSON.stringify(error));
});
```
## systemTime.setTimezone
setTimezone(timezone: string, callback: AsyncCallback<void>): void
设置系统时区。
**需要权限:**ohos.permission.SET_TIME_ZONE
**系统能力**: SystemCapability.Miscservices.Time
- 参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| timezone | string | 是 | 系统时区。 |
| callback | AsyncCallback<void> | 是 | 回调函数,可以在回调函数中处理接口返回值。 |
- 示例:
```
systemTime.setTimezone('Asia/Shanghai', (error, data) => {
if (error) {
console.error('failed to systemTime.setTimezone because ' + JSON.stringify(error));
return;
}
console.info('SystemTimePlugin systemTime.setTimezone success data : ' + JSON.stringify(data));
});
```
## systemTime.setTimezone
setTimezone(timezone: string): Promise<void>
设置系统时区。
**需要权限:**ohos.permission.SET_TIME_ZONE
**系统能力**: SystemCapability.Miscservices.Time
- 参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| timezone | string | 是 | 系统时区。 |
- 返回值:
| 类型 | 说明 |
| -------- | -------- |
| Promise<void> | 返回的异步回调函数。 |
- 示例:
```
systemTime.setTimezone('Asia/Shanghai').then((data) => {
console.log(`systemTime.setTimezone success data : ` + JSON.stringify(data));
}).catch((error) => {
console.error(`failed to systemTime.setTimezone because: ` + JSON.stringify(error));
});
```
## systemTime.getTimeZone8+
getTimeZone(callback: AsyncCallback<string>): void
获取系统时区,使用callback形式返回结果。
**系统能力**: SystemCapability.Miscservices.Time
- 参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback<string> | 是 | 回调函数,返回系统时区。 |
- 示例:
```
systemTime.getTimeZone((error, data) => {
if (error) {
console.error(`failed to systemTime.getTimeZone because ` + JSON.stringify(error));
return;
}
console.log(`systemTime.getTimeZone success data : ` + JSON.stringify(data));
});
```
## systemTime.getTimeZone8+
getTimeZone(): Promise<string>
获取系统时区,使用Promise形式返回结果。
**系统能力**: SystemCapability.Miscservices.Time
- 返回值:
| 类型 | 说明 |
| -------- | -------- |
| Promise<string> | 以Promise形式返回结果,返回系统时区。 |
- 示例:
```
systemTime.getDate().then((data) => {
console.log(`systemTime.getTimeZone success data : ` + JSON.stringify(data));
}).catch((error) => {
console.error(`failed to systemTime.getTimeZone because ` + JSON.stringify(error));
});
```