设置系统时间、时区

本模块用来设置、获取当前系统时间、系统日期和系统时区。

说明：

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

导入模块

import systemTime from '@ohos.systemTime';

systemTime.setTime

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

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

需要权限： ohos.permission.SET_TIME

系统能力： SystemCapability.Miscservices.Time

参数：

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

示例：

// time对应的时间为2021-01-20 02:36:25
let time = 1611081385000;
systemTime.setTime(time, (error) => {
    if (error) {
        console.error(`Failed to set systemTime. Cause:` + JSON.stringify(error));
        return;
    }
    console.log('Succeeded in setting systemTime.');
});

systemTime.setTime

setTime(time : number) : Promise<void>

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

需要权限： ohos.permission.SET_TIME

系统能力： SystemCapability.MiscServices.Time

参数：

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

返回值：

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

示例：

// time对应的时间为2021-01-20 02:36:25
let time = 1611081385000;
systemTime.setTime(time).then(() => {
    console.log('Succeeded in setting systemTime.');
}).catch((error) => {
    console.error(`Failed to set systemTime. Cause:` + JSON.stringify(error));
});

systemTime.getCurrentTime⁸⁺

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 get systemTime. Cause:` + JSON.stringify(error));
        return;
    }
    console.log(`Succeeded in getting systemTime.Data: ` + JSON.stringify(data));
});

systemTime.getCurrentTime⁸⁺

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

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

系统能力： SystemCapability.MiscServices.Time

参数：

参数名	类型	必填	说明
isNano	boolean	否	如果是true，返回纳秒数；否则返回毫秒数。

返回值：

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

示例：

systemTime.getCurrentTime().then((data) => {
    console.log(`Succeeded in getting systemTime.Data: ` + JSON.stringify(data));
}).catch((error) => {
    console.error(`Failed to get systemTime. Cause:` + JSON.stringify(error));
});

systemTime.getRealActiveTime⁸⁺

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 get real active systemTime. Cause:` + JSON.stringify(error));
        return;
    }
    console.log(`Succeeded in getting real active systemTime. Data: ` + JSON.stringify(data));
});

systemTime.getRealActiveTime⁸⁺

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

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

系统能力： SystemCapability.MiscServices.Time

参数：

参数名	类型	必填	说明
isNano	boolean	否	如果是true，返回纳秒数；否则返回毫秒数。

返回值：

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

示例：

systemTime.getRealActiveTime().then((data) => {
    console.log(`Succeeded in getting real active systemTime. Data: ` + JSON.stringify(data));
}).catch((error) => {
    console.error(`Failed to get real active systemTime. Cause:` + JSON.stringify(error));
});

systemTime.getRealTime⁸⁺

getRealTime(isNano?: boolean, 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 get real systemTime. Cause:` + JSON.stringify(error));
        return;
    }
    console.log(`Succeeded in getting real active systemTime. Data: ` + JSON.stringify(data));
});

systemTime.getRealTime⁸⁺

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

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

系统能力： SystemCapability.MiscServices.Time

参数：

参数名	类型	必填	说明
isNano	boolean	否	如果是true，返回纳秒数；否则返回毫秒数。

返回值：

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

示例：

systemTime.getRealTime().then((data) => {
    console.log(`Succeeded in getting real active systemTime. Data: ` + JSON.stringify(data));
}).catch((error) => {
    console.error(`Failed to get real systemTime. Cause:` + 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>	是	回调函数。

示例：

let data = new Date("October 13, 2020 11:13:00");
systemTime.setDate(data,(error) => {       
    if (error) {            
    console.error('Failed to set systemDate. Cause: ' + JSON.stringify(error));           
    return;       
}        
    console.info('Succeeded in setting systemDate.');    
});

systemTime.setDate

setDate(date: Date): Promise<void>

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

需要权限： ohos.permission.SET_TIME

系统能力： SystemCapability.MiscServices.Time

参数：

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

返回值：

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

示例：

let data = new Date("October 13, 2020 11:13:00"); 
systemTime.setDate(data).then(() => {        
    console.log('Succeeded in setting systemDate.');    
}).catch((error) => {        
    console.error(`Failed to set systemDate. Cause: ` + JSON.stringify(error));
});

systemTime.getDate⁸⁺

getDate(callback: AsyncCallback<Date>): void

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

系统能力： SystemCapability.MiscServices.Time

参数：

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

示例：

systemTime.getDate((error, data) => {
    if (error) {
        console.error(`Failed to get systemDate. Cause: ` + JSON.stringify(error));
        return;
    }
    console.log(`Succeeded in getting systemDate. Data: ` + JSON.stringify(data));
});

systemTime.getDate⁸⁺

getDate(): Promise<Date>

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

系统能力： SystemCapability.MiscServices.Time

返回值：

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

示例：

systemTime.getDate().then((data) => {
    console.log(`Succeeded in getting systemDate. Data: ` + JSON.stringify(data));
}).catch((error) => {
    console.error(`Failed to get systemDate. Cause: ` + JSON.stringify(error));
});

systemTime.setTimezone

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

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

需要权限： ohos.permission.SET_TIME_ZONE

系统能力： SystemCapability.MiscServices.Time

参数：

参数名	类型	必填	说明
timezone	string	是	系统时区。
callback	AsyncCallback<void>	是	回调函数。

示例：

systemTime.setTimezone('Asia/Shanghai', (error) => {       
    if (error) {          
        console.error('Failed to set systemTimeZone. Cause: ' + JSON.stringify(error));         
        return;       
    }       
    console.info('Succeeded in setting systemTimeZone.'); 
});

systemTime.setTimezone

setTimezone(timezone: string): Promise<void>

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

需要权限： ohos.permission.SET_TIME_ZONE

系统能力： SystemCapability.MiscServices.Time

参数：

参数名	类型	必填	说明
timezone	string	是	系统时区。

返回值：

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

示例：

systemTime.setTimezone('Asia/Shanghai').then(() => {        
    console.log('Succeeded in setting systemTimeZone.');     
}).catch((error) => {        
    console.error(`Failed to set systemTimeZone. Cause: ` + JSON.stringify(error));    
});

systemTime.getTimezone⁸⁺

getTimezone(callback: AsyncCallback<string>): void

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

系统能力： SystemCapability.MiscServices.Time

参数：

参数名	类型	必填	说明
callback	AsyncCallback<string>	是	回调函数，返回系统时区。

示例：

systemTime.getTimezone((error, data) => {
    if (error) {
        console.error(`Failed to get systemTimeZone. Cause: ` + JSON.stringify(error));
        return;
    }
    console.log(`Succeeded in getting systemTimeZone. Data: ` + JSON.stringify(data));
});

systemTime.getTimezone⁸⁺

getTimezone(): Promise<string>

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

系统能力： SystemCapability.MiscServices.Time

返回值：

类型	说明
Promise<string>	Promise对象，返回系统时区。

示例：

systemTime.getTimezone().then((data) => {
    console.log(`Succeeded in getting systemTimeZone. Data: ` + JSON.stringify(data));
}).catch((error) => {
    console.error(`Failed to get systemTimeZone. Cause: ` + JSON.stringify(error));
});

设置系统时间、时区

导入模块

systemTime.setTime

systemTime.setTime

systemTime.getCurrentTime8+

systemTime.getCurrentTime8+

systemTime.getRealActiveTime8+

systemTime.getRealActiveTime8+

systemTime.getRealTime8+

systemTime.getRealTime8+

systemTime.setDate

systemTime.setDate

systemTime.getDate8+

systemTime.getDate8+

systemTime.setTimezone

systemTime.setTimezone

systemTime.getTimezone8+

systemTime.getTimezone8+

systemTime.getCurrentTime⁸⁺

systemTime.getCurrentTime⁸⁺

systemTime.getRealActiveTime⁸⁺

systemTime.getRealActiveTime⁸⁺

systemTime.getRealTime⁸⁺

systemTime.getRealTime⁸⁺

systemTime.getDate⁸⁺

systemTime.getDate⁸⁺

systemTime.getTimezone⁸⁺

systemTime.getTimezone⁸⁺