@ohos.systemDateTime (系统时间、时区)

本模块主要由系统时间和系统时区功能组成。开发者可以设置、获取系统时间及系统时区。

说明：

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

导入模块

import systemDateTime from '@ohos.systemDateTime';

TimeType¹⁰⁺

定义获取时间的枚举类型。

系统能力: SystemCapability.MiscServices.Time

名称	值	说明
STARTUP	0	自系统启动以来经过的毫秒数，包括深度睡眠时间。
ACTIVE	1	自系统启动以来经过的毫秒数，不包括深度睡眠时间。

systemDateTime.setTime

setTime(time : number, callback : AsyncCallback<void>) : void

设置系统时间，使用callback异步回调。

系统接口： 此接口为系统接口

系统能力： SystemCapability.MiscServices.Time

需要权限： ohos.permission.SET_TIME

参数：

参数名	类型	必填	说明
time	number	是	目标时间戳（ms）。
callback	AsyncCallback<void>	是	回调函数。

示例：

import { BusinessError } from '@ohos.base';

// time对应的时间为2021-01-20 02:36:25
let time = 1611081385000;
try {
  systemDateTime.setTime(time, (error: BusinessError) => {
    if (error) {
      console.info(`Failed to set 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}`);
}

systemDateTime.setTime

setTime(time : number) : Promise<void>

设置系统时间，使用Promise异步回调。

系统接口： 此接口为系统接口

系统能力： SystemCapability.MiscServices.Time

需要权限： ohos.permission.SET_TIME

参数：

参数名	类型	必填	说明
time	number	是	目标时间戳（ms）。

返回值：

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

示例：

import { BusinessError } from '@ohos.base';

// time对应的时间为2021-01-20 02:36:25
let time = 1611081385000;
try {
  systemDateTime.setTime(time).then(() => {
    console.info(`Succeeded in setting time.`);
  }).catch((error: BusinessError) => {
    console.info(`Failed to set 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}`);
}

systemDateTime.getCurrentTime

getCurrentTime(isNano: boolean, callback: AsyncCallback<number>): void

获取自Unix纪元以来经过的时间，使用callback异步回调。

系统能力： SystemCapability.MiscServices.Time

参数：

参数名	类型	必填	说明
isNano	boolean	是	返回结果是否为纳秒数。 - true：表示返回结果为纳秒数（ns）。 - false：表示返回结果为毫秒数（ms）。
callback	AsyncCallback<number>	是	回调函数，返回自Unix纪元以来经过的时间戳。

示例：

import { BusinessError } from '@ohos.base';

try {
  systemDateTime.getCurrentTime(true, (error: BusinessError, time: number) => {
    if (error) {
      console.info(`Failed to get currentTime. message: ${error.message}, code: ${error.code}`);
      return;
    }
    console.info(`Succeeded in getting currentTime : ${time}`);
  });
} catch(e) {
  let error = e as BusinessError;
  console.info(`Failed to get currentTime. message: ${error.message}, code: ${error.code}`);
}

systemDateTime.getCurrentTime

getCurrentTime(callback: AsyncCallback<number>): void

获取自Unix纪元以来经过的时间，使用callback异步回调。

系统能力： SystemCapability.MiscServices.Time

参数：

参数名	类型	必填	说明
callback	AsyncCallback<number>	是	回调函数，返回自Unix纪元以来经过的时间戳（ms）。

示例：

import { BusinessError } from '@ohos.base';

try {
  systemDateTime.getCurrentTime((error: BusinessError, time: number) => {
    if (error) {
      console.info(`Failed to get currentTime. message: ${error.message}, code: ${error.code}`);
      return;
    }
    console.info(`Succeeded in getting currentTime : ${time}`);
  });
} catch(e) {
  let error = e as BusinessError;
  console.info(`Failed to get currentTime. message: ${error.message}, code: ${error.code}`);
}

systemDateTime.getCurrentTime

getCurrentTime(isNano?: boolean): Promise<number>

获取自Unix纪元以来经过的时间，使用Promise异步回调。

系统能力： SystemCapability.MiscServices.Time

参数：

参数名	类型	必填	说明
isNano	boolean	否	返回结果是否为纳秒数,默认值为false。 - true：表示返回结果为纳秒数（ns）。 - false：表示返回结果为毫秒数（ms）。

返回值：

类型	说明
Promise<number>	Promise对象，返回自Unix纪元以来经过的时间戳。

示例：

import { BusinessError } from '@ohos.base';

try {
  systemDateTime.getCurrentTime().then((time: number) => {
    console.info(`Succeeded in getting currentTime : ${time}`);
  }).catch((error: BusinessError) => {
    console.info(`Failed to get currentTime. message: ${error.message}, code: ${error.code}`);
  });
} catch(e) {
  let error = e as BusinessError;
  console.info(`Failed to get currentTime. message: ${error.message}, code: ${error.code}`);
}

systemDateTime.getRealActiveTime

getRealActiveTime(isNano: boolean, callback: AsyncCallback<number>): void

获取自系统启动以来经过的时间，不包括深度睡眠时间，使用callback异步回调。

系统能力： SystemCapability.MiscServices.Time

参数：

参数名	类型	必填	说明
isNano	boolean	是	返回结果是否为纳秒数。 - true：表示返回结果为纳秒数（ns）。 - false：表示返回结果为毫秒数（ms）。
callback	AsyncCallback<number>	是	回调函数，返回自系统启动以来经过的时间，但不包括深度睡眠时间。

示例：

import { BusinessError } from '@ohos.base';

try {
  systemDateTime.getRealActiveTime(true, (error: BusinessError, time: number) => {
    if (error) {
      console.info(`Failed to get real active time. message: ${error.message}, code: ${error.code}`);
      return;
    }
    console.info(`Succeeded in getting real active time : ${time}`);
  });
} catch(e) {
  let error = e as BusinessError;
  console.info(`Failed to get real active time. message: ${error.message}, code: ${error.code}`);
}

systemDateTime.getRealActiveTime

getRealActiveTime(callback: AsyncCallback<number>): void

获取自系统启动以来经过的时间，不包括深度睡眠时间，使用callback异步回调。

系统能力： SystemCapability.MiscServices.Time

参数：

参数名	类型	必填	说明
callback	AsyncCallback<number>	是	回调函数，返回自系统启动以来经过的时间，但不包括度睡眠时间。

示例：

import { BusinessError } from '@ohos.base';

try {
  systemDateTime.getRealActiveTime((error: BusinessError, time: number) => {
    if (error) {
      console.info(`Failed to get real active time. message: ${error.message}, code: ${error.code}`);
      return;
    }
    console.info(`Succeeded in getting real active time : ${time}`);
  });
} catch(e) {
  let error = e as BusinessError;
  console.info(`Failed to get real active time. message: ${error.message}, code: ${error.code}`);
}

systemDateTime.getRealActiveTime

getRealActiveTime(isNano?: boolean): Promise<number>

获取自系统启动以来经过的时间，不包括深度睡眠时间，使用Promise异步回调。

系统能力： SystemCapability.MiscServices.Time

参数：

参数名	类型	必填	说明
isNano	boolean	否	返回结果是否为纳秒数,默认值为false。 - true：表示返回结果为纳秒数（ns）。 - false：表示返回结果为毫秒数（ms）。

返回值：

类型	说明
Promise<number>	Promise对象，返回自系统启动以来经过的时间，但不包括深度睡眠时间。

示例：

import { BusinessError } from '@ohos.base';

try {
  systemDateTime.getRealActiveTime().then((time: number) => {
    console.info(`Succeeded in getting real active time : ${time}`);
  }).catch((error: BusinessError) => {
    console.info(`Failed to get real active time. message: ${error.message}, code: ${error.code}`);
  });
} catch(e) {
  let error = e as BusinessError;
  console.info(`Failed to get real active time. message: ${error.message}, code: ${error.code}`);
}

systemDateTime.getRealTime

getRealTime(isNano: boolean, callback: AsyncCallback<number>): void

获取自系统启动以来经过的时间，包括深度睡眠时间，使用callback异步回调。

系统能力： SystemCapability.MiscServices.Time

参数：

参数名	类型	必填	说明
isNano	boolean	是	返回结果是否为纳秒数。 - true：表示返回结果为纳秒数（ns）。 - false：表示返回结果为毫秒数（ms）。
callback	AsyncCallback<number>	是	回调函数，返回自系统启动以来经过的时间，包括深度睡眠时间。

示例：

import { BusinessError } from '@ohos.base';

try {
  systemDateTime.getRealTime(true, (error: BusinessError, time: number) => {
    if (error) {
      console.info(`Failed to get real time. message: ${error.message}, code: ${error.code}`);
      return;
    }
    console.info(`Succeeded in getting real time : ${time}`);
  });
} catch(e) {
  let error = e as BusinessError;
  console.info(`Failed to get real time. message: ${error.message}, code: ${error.code}`);
}

systemDateTime.getRealTime

getRealTime(callback: AsyncCallback<number>): void

获取自系统启动以来经过的时间，包括深度睡眠时间，使用callback异步回调。

系统能力： SystemCapability.MiscServices.Time

参数：

参数名	类型	必填	说明
callback	AsyncCallback<number>	是	回调函数，返回自系统启动以来经过的时间，包括深度睡眠时间。

示例：

import { BusinessError } from '@ohos.base';

try {
  systemDateTime.getRealTime((error: BusinessError, time: number) => {
    if (error) {
      console.info(`Failed to get real time. message: ${error.message}, code: ${error.code}`);
      return;
    }
    console.info(`Succeeded in getting real time : ${time}`);
  });
} catch(e) {
  let error = e as BusinessError;
  console.info(`Failed to get real time. message: ${error.message}, code: ${error.code}`);
}

systemDateTime.getRealTime

getRealTime(isNano?: boolean): Promise<number>

获取自系统启动以来经过的时间，包括深度睡眠时间，使用Promise异步回调。

系统能力： SystemCapability.MiscServices.Time

参数：

参数名	类型	必填	说明
isNano	boolean	否	返回结果是否为纳秒数,默认值为false。 - true：表示返回结果为纳秒数（ns）。 - false：表示返回结果为毫秒数（ms）。

返回值：

类型	说明
Promise<number>	Promise对象，返回自系统启动以来经过的时间，包括深度睡眠时间。

示例：

import { BusinessError } from '@ohos.base';

try {
  systemDateTime.getRealTime().then((time: number) => {
    console.info(`Succeeded in getting real time : ${time}`);
  }).catch((error: BusinessError) => {
    console.info(`Failed to get real time. message: ${error.message}, code: ${error.code}`);
  });
} catch(e) {
  let error = e as BusinessError;
  console.info(`Failed to get real time. message: ${error.message}, code: ${error.code}`);
}

systemDateTime.getTime¹⁰⁺

getTime(isNanoseconds?: boolean): number

使用同步方式获取自Unix纪元以来经过的时间。

系统能力： SystemCapability.MiscServices.Time

参数：

参数名	类型	必填	说明
isNanoseconds	boolean	否	返回结果是否为纳秒数。 - true：表示返回结果为纳秒数（ns）。 - false：表示返回结果为毫秒数（ms）。默认值为false。

返回值：

类型	说明
number	自Unix纪元以来经过的时间。

示例：

import { BusinessError } from '@ohos.base';

try {
  let time = systemDateTime.getTime(true)
} catch(e) {
  let error = e as BusinessError;
  console.info(`Failed to get time. message: ${error.message}, code: ${error.code}`);
}

systemDateTime.getUptime¹⁰⁺

getUptime(timeType: TimeType, isNanoseconds?: boolean): number

使用同步方式获取自系统启动以来经过的时间。

系统能力： SystemCapability.MiscServices.Time

参数：

参数名	类型	必填	说明
timeType	TimeType	是	获取时间的类型。
isNanoseconds	boolean	否	返回结果是否为纳秒数。 - true：表示返回结果为纳秒数（ns）。 - false：表示返回结果为毫秒数（ms）。默认值为false。

返回值：

类型	说明
number	自系统启动以来经过的时间。

示例：

import { BusinessError } from '@ohos.base';

try {
  let time = systemDateTime.getUptime(systemDateTime.TimeType.ACTIVE, false);
} catch(e) {
  let error = e as BusinessError;
  console.info(`Failed to get uptime. message: ${error.message}, code: ${error.code}`);
}

systemDateTime.setDate^(deprecated)

setDate(date: Date, callback: AsyncCallback<void>): void

设置系统日期，使用callback异步回调。

说明：

从API version 9开始支持，从API 10开始废弃。建议使用systemDateTime.setTime替代。

系统接口： 此接口为系统接口

系统能力： SystemCapability.MiscServices.Time

需要权限： ohos.permission.SET_TIME

参数：

参数名	类型	必填	说明
date	Date	是	目标日期。
callback	AsyncCallback<void>	是	回调函数。

示例：

import { BusinessError } from '@ohos.base';

let date = new Date();
try {
  systemDateTime.setDate(date, (error: BusinessError) => {
    if (error) {
      console.info(`Failed to set 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}`);
}

systemDateTime.setDate^(deprecated)

setDate(date: Date): Promise<void>

设置系统日期，使用Promise异步回调。

说明：

从API version 9开始支持，从API 10开始废弃。建议使用systemDateTime.setTime替代。

系统接口： 此接口为系统接口

系统能力： SystemCapability.MiscServices.Time

需要权限： ohos.permission.SET_TIME

参数：

参数名	类型	必填	说明
date	Date	是	目标日期。

返回值：

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

示例：

import { BusinessError } from '@ohos.base';

let date = new Date(); 
try {
  systemDateTime.setDate(date).then(() => {
    console.info(`Succeeded in setting date.`);
  }).catch((error: BusinessError) => {
    console.info(`Failed to set 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}`);
}

systemDateTime.getDate^(deprecated)

getDate(callback: AsyncCallback<Date>): void

获取当前系统日期，使用callback异步回调。

说明：

从API version 9开始支持，从API 10开始废弃。建议使用new Date()替代，new Date()返回Date实例对象。

系统能力： SystemCapability.MiscServices.Time

参数：

参数名	类型	必填	说明
callback	AsyncCallback<Date>	是	回调函数，返回当前系统日期。

示例：

import { BusinessError } from '@ohos.base';

try {
  systemDateTime.getDate((error: BusinessError, date: Date) => {
    if (error) {
      console.info(`Failed to get date. message: ${error.message}, code: ${error.code}`);
      return;
    }
    console.info(`Succeeded in getting date : ${date}`);;
  });
} catch(e) {
  let error = e as BusinessError;
  console.info(`Failed to get date. message: ${error.message}, code: ${error.code}`);
}

systemDateTime.getDate^(deprecated)

getDate(): Promise<Date>

获取当前系统日期，使用Promise异步回调。

说明：

从API version 9开始支持，从API 10开始废弃。建议使用new Date()替代，new Date()返回Date实例对象。

系统能力： SystemCapability.MiscServices.Time

返回值：

类型	说明
Promise<Date>	Promise对象，返回当前系统日期。

示例：

import { BusinessError } from '@ohos.base';

try {
  systemDateTime.getDate().then((date: Date) => {
    console.info(`Succeeded in getting date : ${date}`);
  }).catch((error: BusinessError) => {
    console.info(`Failed to get date. message: ${error.message}, code: ${error.code}`);
  });
} catch(e) {
  let error = e as BusinessError;
  console.info(`Failed to get date. message: ${error.message}, code: ${error.code}`);
}

systemDateTime.setTimezone

setTimezone(timezone: string, callback: AsyncCallback<void>): void

设置系统时区，使用callback异步回调。

系统接口： 此接口为系统接口

系统能力： SystemCapability.MiscServices.Time

需要权限： ohos.permission.SET_TIME_ZONE

参数：

参数名	类型	必填	说明
timezone	string	是	系统时区。具体可见支持的系统时区。
callback	AsyncCallback<void>	是	回调函数。

示例：

import { BusinessError } from '@ohos.base';

try {
  systemDateTime.setTimezone('Asia/Shanghai', (error: BusinessError) => {
    if (error) {
      console.info(`Failed to set 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}`);
}

systemDateTime.setTimezone

setTimezone(timezone: string): Promise<void>

设置系统时区，使用Promise异步回调。

系统接口： 此接口为系统接口

系统能力： SystemCapability.MiscServices.Time

需要权限： ohos.permission.SET_TIME_ZONE

参数：

参数名	类型	必填	说明
timezone	string	是	系统时区。具体可见支持的系统时区。

返回值：

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

示例：

import { BusinessError } from '@ohos.base';

try {
  systemDateTime.setTimezone('Asia/Shanghai').then(() => {
    console.info(`Succeeded in setting timezone.`);
  }).catch((error: BusinessError) => {
    console.info(`Failed to set 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}`);
}

systemDateTime.getTimezone

getTimezone(callback: AsyncCallback<string>): void

获取系统时区，使用callback异步回调。

系统能力： SystemCapability.MiscServices.Time

参数：

参数名	类型	必填	说明
callback	AsyncCallback<string>	是	回调函数，返回系统时区。具体可见支持的系统时区。

示例：

import { BusinessError } from '@ohos.base';

try {
  systemDateTime.getTimezone((error: BusinessError, data: string) => {
    if (error) {
      console.info(`Failed to get timezone. message: ${error.message}, code: ${error.code}`);
      return;
    }
    console.info(`Succeeded in get timezone : ${data}`);;
  });
} catch(e) {
  let error = e as BusinessError;
  console.info(`Failed to get timezone. message: ${error.message}, code: ${error.code}`);
}

systemDateTime.getTimezone

getTimezone(): Promise<string>

获取系统时区，使用Promise异步回调。

系统能力： SystemCapability.MiscServices.Time

返回值：

类型	说明
Promise<string>	Promise对象，返回系统时区。具体可见支持的系统时区。

示例：

import { BusinessError } from '@ohos.base';

try {
  systemDateTime.getTimezone().then((data: string) => {
    console.info(`Succeeded in getting timezone: ${data}`);
  }).catch((error: BusinessError) => {
    console.info(`Failed to get timezone. message: ${error.message}, code: ${error.code}`);
  });
} catch(e) {
  let error = e as BusinessError;
  console.info(`Failed to get timezone. message: ${error.message}, code: ${error.code}`);
}

systemDateTime.getTimezoneSync¹⁰⁺

getTimezoneSync(): string

获取系统时区，使用同步方式。

系统能力： SystemCapability.MiscServices.Time

返回值：

类型	说明
string	返回系统时区。具体可见支持的系统时区。

示例：

import { BusinessError } from '@ohos.base';

try {
  let timezone = systemDateTime.getTimezoneSync();
} catch(e) {
  let error = e as BusinessError;
  console.info(`Failed to get timezone. message: ${error.message}, code: ${error.code}`);
}

支持的系统时区

支持的系统时区及各时区与0时区相比的偏移量（单位：h）可见下表。

时区	偏移量
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

@ohos.systemDateTime (系统时间、时区)

导入模块

TimeType10+

systemDateTime.setTime

systemDateTime.setTime

systemDateTime.getCurrentTime

systemDateTime.getCurrentTime

systemDateTime.getCurrentTime

systemDateTime.getRealActiveTime

systemDateTime.getRealActiveTime

systemDateTime.getRealActiveTime

systemDateTime.getRealTime

systemDateTime.getRealTime

systemDateTime.getRealTime

systemDateTime.getTime10+

systemDateTime.getUptime10+

systemDateTime.setDate(deprecated)

systemDateTime.setDate(deprecated)

systemDateTime.getDate(deprecated)

systemDateTime.getDate(deprecated)

systemDateTime.setTimezone

systemDateTime.setTimezone

systemDateTime.getTimezone

systemDateTime.getTimezone

systemDateTime.getTimezoneSync10+

支持的系统时区

TimeType¹⁰⁺

systemDateTime.getTime¹⁰⁺

systemDateTime.getUptime¹⁰⁺

systemDateTime.setDate^(deprecated)

systemDateTime.setDate^(deprecated)

systemDateTime.getDate^(deprecated)

systemDateTime.getDate^(deprecated)

systemDateTime.getTimezoneSync¹⁰⁺