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

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

说明：

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

导入模块

import { systemDateTime } from '@kit.BasicServicesKit';

TimeType¹⁰⁺

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

系统能力: SystemCapability.MiscServices.Time

systemDateTime.setTime

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

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

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

系统能力： SystemCapability.MiscServices.Time

需要权限： ohos.permission.SET_TIME

参数：

错误码：

以下错误码的详细介绍请参见通用错误码说明文档。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

// 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

参数：

返回值：

错误码：

以下错误码的详细介绍请参见通用错误码说明文档。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

// 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.setDate^(deprecated)

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

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

说明：

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

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

系统能力： SystemCapability.MiscServices.Time

需要权限： ohos.permission.SET_TIME

参数：

错误码：

以下错误码的详细介绍请参见通用错误码说明文档。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

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

参数：

返回值：

错误码：

以下错误码的详细介绍请参见通用错误码说明文档。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

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.setTimezone

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

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

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

系统能力： SystemCapability.MiscServices.Time

需要权限： ohos.permission.SET_TIME_ZONE

参数：

错误码：

以下错误码的详细介绍请参见通用错误码说明文档。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

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

参数：

返回值：

错误码：

以下错误码的详细介绍请参见通用错误码说明文档。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

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.updateNtpTime¹⁴⁺

updateNtpTime(): Promise<void>

使用异步方式从NTP服务器更新NTP时间。该方法一小时内只会从NTP服务器更新一次NTP时间。

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

系统能力： SystemCapability.MiscServices.Time

返回值：

错误码：

以下错误码的详细介绍请参见时间时区错误码和通用错误码说明文档。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

try {
  systemDateTime.updateNtpTime().then(() => {
    console.info(`Succeeded in update ntp time.`);
  }).catch((error: BusinessError) => {
    console.error(`Failed to update ntp time. message: ${error.message}, code: ${error.code}`);
  });
} catch(e) {
  let error = e as BusinessError;
  console.error(`Failed to update ntp time. message: ${error.message}, code: ${error.code}`);
}

systemDateTime.getNtpTime¹⁴⁺

getNtpTime(): number

使用同步方式获取基于上次更新的NTP时间所计算出的真实时间。

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

系统能力： SystemCapability.MiscServices.Time

返回值：

错误码：

以下错误码的详细介绍请参见时间时区错误码和通用错误码说明文档。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

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

支持的系统时区

支持的系统时区参考接口I18n.SystemLocaleManager.getTimeZoneCityItemArray()。

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Basic Services Kit（基础服务）

harmony 鸿蒙DeviceInfo

harmony 鸿蒙OH_Print

harmony 鸿蒙Print_Margin

harmony 鸿蒙Print_PageSize

harmony 鸿蒙Print_PrintAttributes

harmony 鸿蒙Print_PrintDocCallback

harmony 鸿蒙Print_Range

harmony 鸿蒙TimeService

harmony 鸿蒙ohscan.h