diff --git a/zh-cn/application-dev/reference/apis/js-apis-system-date-time.md b/zh-cn/application-dev/reference/apis/js-apis-system-date-time.md new file mode 100644 index 0000000000000000000000000000000000000000..c3e97f5085d47faf62857bfc92c120d86a9927c2 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-system-date-time.md @@ -0,0 +1,665 @@ +# @ohos.systemDateTime (系统时间、时区) + +本模块主要由系统时间和系统时区功能组成。开发者可以设置、获取系统时间及系统时区。 + +> **说明:** +> +> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 + +## 导入模块 + +```js +import systemDateTime from '@ohos.systemDateTime'; +``` + +## systemDateTime.setTime + +setTime(time : number, callback : AsyncCallback<void>) : void + +设置系统时间,使用callback异步回调。 + +**系统接口:** 此接口为系统接口 + +**系统能力:** SystemCapability.MiscServices.Time + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------- | ---- | ---------------- | +| time | number | 是 | 目标时间戳(ms)。 | +| callback | AsyncCallback<void> | 是 | 回调函数。 | + +**示例:** + +```js +// time对应的时间为2021-01-20 02:36:25 +let time = 1611081385000; +try { + systemDateTime.setTime(time, (error) => { + if (error) { + console.info(`Failed to set time. message:${error.message}, code:${error.code}`); + return; + } + console.info(`Succeeded in setting time`); + }); +} catch(e) { + console.info(`Failed to set time. message:${e.message}, code:${e.code}`); +} +``` + +## systemDateTime.setTime + +setTime(time : number) : Promise<void> + +设置系统时间,使用Promise异步回调。 + +**系统接口:** 此接口为系统接口 + +**系统能力:** SystemCapability.MiscServices.Time + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ------------------ | +| time | number | 是 | 目标时间戳(ms)。 | + +**返回值:** + +| 类型 | 说明 | +| ------------------- | ------------------------- | +| Promise<void> | 无返回结果的Promise对象。 | + +**示例:** + +```js +// time对应的时间为2021-01-20 02:36:25 +let time = 1611081385000; +try { + systemDateTime.setTime(time).then(() => { + console.info(`Succeeded in setting time.`); + }).catch((error) => { + console.info(`Failed to set time. message:${error.message}, code:${error.code}`); + }); +} catch(e) { + console.info(`Failed to set time. message:${e.message}, code:${e.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纪元以来经过的时间。 | + +**示例:** + +```js +try { + systemDateTime.getCurrentTime(true, (error, time) => { + if (error) { + console.info(`Failed to get currentTime. message:${error.message}, code:${error.code}`); + return; + } + console.info(`Succeeded in getting currentTime : ${time}`); + }); +} catch(e) { + console.info(`Failed to get currentTime. message:${e.message}, code:${e.code}`); +} +``` + +## systemDateTime.getCurrentTime + +getCurrentTime(callback: AsyncCallback<number>): void + +获取自Unix纪元以来经过的时间,使用callback异步回调。 + +**系统能力:** SystemCapability.MiscServices.Time + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------- | ---- | ---------------------------------- | +| callback | AsyncCallback<number> | 是 | 回调函数,返回自Unix纪元以来经过的时间。 | + +**示例:** + +```js +try { + systemDateTime.getCurrentTime((error, time) => { + if (error) { + console.info(`Failed to get currentTime. message:${error.message}, code:${error.code}`); + return; + } + console.info(`Succeeded in getting currentTime : ${time}`); + }); +} catch(e) { + console.info(`Failed to get currentTime. message:${e.message}, code:${e.code}`); +} +``` + +## systemDateTime.getCurrentTime + +getCurrentTime(isNano?: boolean): Promise<number> + +获取自Unix纪元以来经过的时间,使用Promise异步回调。 + +**系统能力:** SystemCapability.MiscServices.Time + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------- | ---- | ------------------------- | +| isNano | boolean | 否 | 返回结果是否为纳秒数。
- true:表示返回结果为纳秒数(ns)。
- false:表示返回结果为毫秒数(ms)。 | + +**返回值:** + +| 类型 | 说明 | +| --------------------- | --------------------------- | +| Promise<number> | Promise对象,返回自Unix纪元以来经过的时间。 | + +**示例:** + +```js +try { + systemDateTime.getCurrentTime().then((time) => { + console.info(`Succeeded in getting currentTime : ${time}`); + }).catch((error) => { + console.info(`Failed to get currentTime. message:${error.message}, code:${error.code}`); + }); +} catch(e) { + console.info(`Failed to get currentTime. message:${e.message}, code:${e.code}`); +} +``` + +## systemDateTime.getRealActiveTime + +getRealActiveTime(isNano: boolean, callback: AsyncCallback<number>): void + +获取自系统启动以来经过的时间,不包括深度睡眠时间,使用callback异步回调。 + +**系统能力:** SystemCapability.MiscServices.Time + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------- | ---- | -------------------------- | +| isNano | boolean | 是 | 返回结果是否为纳秒数。
- true:表示返回结果为纳秒数(ns)。
- false:表示返回结果为毫秒数(ms)。 | +| callback | AsyncCallback<number> | 是 | 回调函数,返回自系统启动以来经过的时间,但不包括度睡眠时间。 | + +**示例:** + +```js +try { + systemDateTime.getRealActiveTime(true, (error, time) => { + 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) { + console.info(`Failed to get real active time. message:${e.message}, code:${e.code}`); +} +``` + +## systemDateTime.getRealActiveTime + +getRealActiveTime(callback: AsyncCallback<number>): void + +获取自系统启动以来经过的时间,不包括深度睡眠时间,使用callback异步回调。 + +**系统能力:** SystemCapability.MiscServices.Time + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------- | ---- | --------------------- | +| callback | AsyncCallback<number> | 是 | 回调函数,返回自系统启动以来经过的时间,但不包括度睡眠时间。 | + +**示例:** + +```js +try { + systemDateTime.getRealActiveTime((error, time) => { + 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) { + console.info(`Failed to get real active time. message:${e.message}, code:${e.code}`); +} +``` + +## systemDateTime.getRealActiveTime + +getRealActiveTime(isNano?: boolean): Promise<number> + +获取自系统启动以来经过的时间,不包括深度睡眠时间,使用Promise异步回调。 + +**系统能力:** SystemCapability.MiscServices.Time + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------- | ---- | ----------------------------------- | +| isNano | boolean | 否 | 返回结果是否为纳秒数。
- true:表示返回结果为纳秒数(ns)。
- false:表示返回结果为毫秒数(ms)。 | + +**返回值:** + +| 类型 | 说明 | +| -------------- | -------------------------------- | +| Promise<number> | Promise对象,返回自系统启动以来经过的时间,但不包括深度睡眠时间。 | + +**示例:** + +```js +try { + systemDateTime.getRealActiveTime().then((time) => { + console.info(`Succeeded in getting real active time : ${time}`); + }).catch((error) => { + console.info(`Failed to get real active time. message:${error.message}, code:${error.code}`); + }); +} catch(e) { + console.info(`Failed to get real active time. message:${e.message}, code:${e.code}`); +} +``` + +## systemDateTime.getRealTime + +getRealTime(isNano: boolean, callback: AsyncCallback<number>): void + +获取自系统启动以来经过的时间,包括深度睡眠时间,使用callback异步回调。 + +**系统能力:** SystemCapability.MiscServices.Time + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------- | ---- | ------------------------------- | +| isNano | boolean | 是 | 返回结果是否为纳秒数。
- true:表示返回结果为纳秒数(ns)。
- false:表示返回结果为毫秒数(ms)。 | +| callback | AsyncCallback<number> | 是 | 回调函数,返回自系统启动以来经过的时间,包括深度睡眠时间。 | + +**示例:** + +```js +try { + systemDateTime.getRealTime(true, (error, time) => { + 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) { + console.info(`Failed to get real time. message:${e.message}, code:${e.code}`); +} +``` + +## systemDateTime.getRealTime + +getRealTime(callback: AsyncCallback<number>): void + +获取自系统启动以来经过的时间,包括深度睡眠时间,使用callback异步回调。 + +**系统能力:** SystemCapability.MiscServices.Time + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------- | ---- | --------------------------- | +| callback | AsyncCallback<number> | 是 | 回调函数,返回自系统启动以来经过的时间,包括深度睡眠时间。 | + +**示例:** + +```js +try { + systemDateTime.getRealTime((error, time) => { + 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) { + console.info(`Failed to get real time. message:${e.message}, code:${e.code}`); +} +``` + +## systemDateTime.getRealTime + +getRealTime(isNano?: boolean): Promise<number> + +获取自系统启动以来经过的时间,包括深度睡眠时间,使用Promise异步回调。 + +**系统能力:** SystemCapability.MiscServices.Time + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------- | ---- | ------------------------------- | +| isNano | boolean | 否 | 返回结果是否为纳秒数。
- true:表示返回结果为纳秒数(ns)。
- false:表示返回结果为毫秒数(ms)。 | + +**返回值:** + +| 类型 | 说明 | +| --------------------- | ------------------------------- | +| Promise<number> | Promise对象,返回自系统启动以来经过的时间,包括深度睡眠时间。 | + +**示例:** + +```js +try { + systemDateTime.getRealTime().then((time) => { + console.info(`Succeeded in getting real time : ${time}`); + }).catch((error) => { + console.info(`Failed to get real time. message:${error.message}, code:${error.code}`); + }); +} catch(e) { + console.info(`Failed to get real time. message:${e.message}, code:${e.code}`); +} +``` + +## systemDateTime.setDate + +setDate(date: Date, callback: AsyncCallback<void>): void + +设置系统日期,使用callback异步回调。 + +**系统接口:** 此接口为系统接口 + +**系统能力:** SystemCapability.MiscServices.Time + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------- | ---- | --------------------- | +| date | Date | 是 | 目标日期。 | +| callback | AsyncCallback<void> | 是 | 回调函数。 | + +**示例:** + +```js +let date = new Date(); +try { + systemDateTime.setDate(date, (error) => { + if (error) { + console.info(`Failed to set date. message:${error.message}, code:${error.code}`); + return; + } + console.info(`Succeeded in setting date.`); + }); +} catch(e) { + console.info(`Failed to set date. message:${e.message}, code:${e.code}`); +} +``` + +## systemDateTime.setDate + +setDate(date: Date): Promise<void> + +设置系统日期,使用Promise异步回调。 + +**系统接口:** 此接口为系统接口 + +**系统能力:** SystemCapability.MiscServices.Time + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ---- | ---- | ---------- | +| date | Date | 是 | 目标日期。 | + +**返回值:** + +| 类型 | 说明 | +| ------------------- | -------------------- | +| Promise<void> | 无返回结果的Promise对象。 | + +**示例:** + +```js +let date = new Date(); +try { + systemDateTime.setDate(date).then(() => { + console.info(`Succeeded in setting date.`); + }).catch((error) => { + console.info(`Failed to set date. message:${error.message}, code:${error.code}`); + }); +} catch(e) { + console.info(`Failed to set date. message:${e.message}, code:${e.code}`); +} +``` + +## systemDateTime.getDate + +getDate(callback: AsyncCallback<Date>): void + +获取当前系统日期,使用callback异步回调。 + +**系统能力:** SystemCapability.MiscServices.Time + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------- | ---- | --------------------- | +| callback | AsyncCallback<Date> | 是 | 回调函数,返回当前系统日期。 | + +**示例:** + +```js +try { + systemDateTime.getDate((error, 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) { + console.info(`Failed to get date. message:${e.message}, code:${e.code}`); +} +``` + +## systemDateTime.getDate + +getDate(): Promise<Date> + +获取当前系统日期,使用Promise异步回调。 + +**系统能力:** SystemCapability.MiscServices.Time + +**返回值:** + +| 类型 | 说明 | +| ------------------- | ----------------------------------------- | +| Promise<Date> | Promise对象,返回当前系统日期。 | + +**示例:** + +```js +try { + systemDateTime.getDate().then((date) => { + console.info(`Succeeded in getting date : ${date}`); + }).catch((error) => { + console.info(`Failed to get date. message:${error.message}, code:${error.code}`); + }); +} catch(e) { + console.info(`Failed to get date. message:${e.message}, code:${e.code}`); +} +``` + +## systemDateTime.setTimezone + +setTimezone(timezone: string, callback: AsyncCallback<void>): void + +设置系统时区,使用callback异步回调。 + +**系统接口:** 此接口为系统接口 + +**系统能力:** SystemCapability.MiscServices.Time + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------- | ---- | -------------------------- | +| timezone | string | 是 | 系统时区。 具体可见[支持的系统时区](#支持的系统时区) 。 | +| callback | AsyncCallback<void> | 是 | 回调函数。 | + +**示例:** + +```js +try { + systemDateTime.setTimezone('Asia/Shanghai', (error) => { + if (error) { + console.info(`Failed to set timezone. message:${error.message}, code:${error.code}`); + return; + } + console.info(`Succeeded in setting timezone.`); + }); +} catch(e) { + console.info(`Failed to set timezone. message:${e.message}, code:${e.code}`); +} +``` + +## systemDateTime.setTimezone + +setTimezone(timezone: string): Promise<void> + +设置系统时区,使用Promise异步回调。 + +**系统接口:** 此接口为系统接口 + +**系统能力:** SystemCapability.MiscServices.Time + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------ | ---- | ---------- | +| timezone | string | 是 | 系统时区。具体可见[支持的系统时区](#支持的系统时区) 。 | + +**返回值:** + +| 类型 | 说明 | +| ------------------- | -------------------- | +| Promise<void> | 无返回结果的Promise对象。 | + +**示例:** + +```js +try { + systemDateTime.setTimezone('Asia/Shanghai').then(() => { + console.info(`Succeeded in setting timezone.`); + }).catch((error) => { + console.info(`Failed to set timezone. message:${error.message}, code:${error.code}`); + }); +} catch(e) { + console.info(`Failed to set timezone. message:${e.message}, code:${e.code}`); +} +``` + +## systemDateTime.getTimezone + +getTimezone(callback: AsyncCallback<string>): void + +获取系统时区,使用callback异步回调。 + +**系统能力:** SystemCapability.MiscServices.Time + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------- | ---- | ------------------------ | +| callback | AsyncCallback<string> | 是 | 回调函数,返回系统时区。具体可见[支持的系统时区](#支持的系统时区) 。 | + +**示例:** + +```js +try { + systemDateTime.getTimezone((error, data) => { + if (error) { + console.info(`Failed to get timezone. message:${error.message}, code:${error.code}`); + return; + } + console.info(`Succeeded in get timezone : ${data}`);; + }); +} catch(e) { + console.info(`Failed to get timezone. message:${e.message}, code:${e.code}`); +} +``` + +## systemDateTime.getTimezone + +getTimezone(): Promise<string> + +获取系统时区,使用Promise异步回调。 + +**系统能力:** SystemCapability.MiscServices.Time + +**返回值:** + +| 类型 | 说明 | +| --------------------- | ------------------------------------- | +| Promise<string> | Promise对象,返回系统时区。具体可见[支持的系统时区](#支持的系统时区) 。 | + +**示例:** + +```js +try { + systemDateTime.getTimezone().then((data) => { + console.info(`Succeeded in getting timezone: ${data}`); + }).catch((error) => { + console.info(`Failed to get timezone. message:${error.message}, code:${error.code}`); + }); +} catch(e) { + console.info(`Failed to get timezone. message:${e.message}, code:${e.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 | \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-system-time.md b/zh-cn/application-dev/reference/apis/js-apis-system-time.md index 5e38c7c300ab379fa5cee8a07e11679b1900ac3d..1d0d7b90816f6d9a6b00e088609f037b0ecca8d5 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-system-time.md +++ b/zh-cn/application-dev/reference/apis/js-apis-system-time.md @@ -24,23 +24,35 @@ setTime(time : number, callback : AsyncCallback<void>) : void **参数:** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ----------- | ---- | ---------------- | -| time | number | 是 | 目标时间戳(ms)。 | -| callback | AsyncCallback<void> | 是 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ------------------ | +| time | number | 是 | 目标时间戳(ms)。 | +| callback | AsyncCallback<void> | 是 | 回调函数。 | + +**错误码:** + +以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)。 + +| 错误码ID | 错误信息 | +| -------- | ------------------------------------------------------------ | +| -1 | The parameter check failed or permission denied or system error. | **示例:** ```js // time对应的时间为2021-01-20 02:36:25 let time = 1611081385000; -systemTime.setTime(time, (error, data) => { +try { + systemTime.setTime(time, (error) => { if (error) { - console.error(`Failed to set systemTime. Cause:` + JSON.stringify(error)); - return; + console.info(`Failed to setting time. message: ${error.message}, code: ${error.code}`); + return; } - console.log(`Succeeded in setting systemTime. Data:` + JSON.stringify(data)); -}); + }console.info(`Succeeded in setting time`); + }); +} catch(e) { + console.info(`Failed to set time. message: ${e.message}, code: ${e.code}`); +} ``` ## systemTime.setTime @@ -65,16 +77,28 @@ setTime(time : number) : Promise<void> | ------------------- | ------------------------- | | Promise<void> | 无返回结果的Promise对象。 | +**错误码:** + +以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)。 + +| 错误码ID | 错误信息 | +| -------- | ------------------------------------------------------------ | +| -1 | The parameter check failed or permission denied or system error. | + **示例:** ```js // time对应的时间为2021-01-20 02:36:25 let time = 1611081385000; -systemTime.setTime(time).then((data) => { - console.log(`Succeeded in setting systemTime. Data:` + JSON.stringify(data)); -}).catch((error) => { - console.error(`Failed to set systemTime. Cause:` + JSON.stringify(error)); -}); +try { + systemTime.setTime(time).then(() => { + console.info(`Succeeded in setting time.`); + }).catch((error) => { + console.info(`Failed to setting time. message: ${error.message}, code: ${error.code}`); + }); +} catch(e) { + console.info(`Failed to set time. message: ${e.message}, code: ${e.code}`); +} ``` ## systemTime.getCurrentTime8+ @@ -87,21 +111,33 @@ getCurrentTime(isNano: boolean, callback: AsyncCallback<number>): void **参数:** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------------- | ---- | ------------------ | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------- | ---- | ------------------------------------------------------------ | | isNano | boolean | 是 | 返回结果是否为纳秒数。
- true:表示返回结果为纳秒数(ns)。
- false:表示返回结果为毫秒数(ms)。 | -| callback | AsyncCallback<number> | 是 | 回调函数,返回自Unix纪元以来经过的时间。 | +| callback | AsyncCallback<number> | 是 | 回调函数,返回自Unix纪元以来经过的时间。 | + +**错误码:** + +以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)。 + +| 错误码ID | 错误信息 | +| -------- | ------------------------------------------- | +| -1 | The parameter check failed or system error. | **示例:** ```js -systemTime.getCurrentTime(true, (error, data) => { +try { + systemTime.getCurrentTime(true, (error, time) => { if (error) { - console.error(`Failed to get systemTime. Cause:` + JSON.stringify(error)); - return; + console.info(`Failed to getting currentTime. message: ${error.message}, code: ${error.code}`); + return; } - console.log(`Succeeded in getting systemTime. Data:` + JSON.stringify(data)); -}); + console.info(`Succeeded in getting currentTime: ${time}`); + }); +} catch(e) { + console.info(`Failed to get currentTime. message: ${e.message}, code: ${e.code}`); +} ``` ## systemTime.getCurrentTime8+ @@ -114,20 +150,32 @@ getCurrentTime(callback: AsyncCallback<number>): void **参数:** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ----------- | ---- | ---------------------------------- | -| callback | AsyncCallback<number> | 是 | 回调函数,返回自Unix纪元以来经过的时间。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------- | ---- | ---------------------------------------- | +| callback | AsyncCallback<number> | 是 | 回调函数,返回自Unix纪元以来经过的时间。 | + +**错误码:** + +以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)。 + +| 错误码ID | 错误信息 | +| -------- | ------------------------------------------- | +| -1 | The parameter check failed or system error. | **示例:** ```js -systemTime.getCurrentTime((error, data) => { +try { + systemTime.getCurrentTime((error, time) => { if (error) { - console.error(`Succeeded in getting systemTime. Data:` + JSON.stringify(error)); - return; + console.info(`Failed to getting currentTime. message: ${error.message}, code: ${error.code}`); + return; } - console.log(`Failed to get systemTime. Cause:` + JSON.stringify(data)); -}); + console.info(`Succeeded in getting currentTime : ${time}`); + }); +} catch(e) { + console.info(`Failed to get currentTime. message: ${e.message}, code: ${e.code}`); +} ``` ## systemTime.getCurrentTime8+ @@ -140,24 +188,36 @@ getCurrentTime(isNano?: boolean): Promise<number> **参数:** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------- | ---- | ------------------------- | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------- | ---- | ------------------------------------------------------------ | | isNano | boolean | 否 | 返回结果是否为纳秒数。
- true:表示返回结果为纳秒数(ns)。
- false:表示返回结果为毫秒数(ms)。 | **返回值:** -| 类型 | 说明 | -| --------------------- | --------------------------- | +| 类型 | 说明 | +| --------------------- | ------------------------------------------- | | Promise<number> | Promise对象,返回自Unix纪元以来经过的时间。 | +**错误码:** + +以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)。 + +| 错误码ID | 错误信息 | +| -------- | ------------------------------------------- | +| -1 | The parameter check failed or system error. | + **示例:** ```js -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)); -}); +try { + systemTime.getCurrentTime().then((time) => { + console.info(`Succeeded in getting currentTime : ${time}`); + }).catch((error) => { + console.info(`Failed to getting currentTime. message: ${error.message}, code: ${error.code}`); + }); +} catch(e) { + console.info(`Failed to get currentTime. message: ${e.message}, code: ${e.code}`); +} ``` ## systemTime.getRealActiveTime8+ @@ -170,21 +230,33 @@ getRealActiveTime(isNano: boolean, callback: AsyncCallback<number>): void **参数:** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ---------- | ---- | -------------------------- | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------- | ---- | ------------------------------------------------------------ | | isNano | boolean | 是 | 返回结果是否为纳秒数。
- true:表示返回结果为纳秒数(ns)。
- false:表示返回结果为毫秒数(ms)。 | | callback | AsyncCallback<number> | 是 | 回调函数,返回自系统启动以来经过的时间,但不包括度睡眠时间。 | +**错误码:** + +以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)。 + +| 错误码ID | 错误信息 | +| -------- | ------------------------------------------- | +| -1 | The parameter check failed or system error. | + **示例:** ```js -systemTime.getRealActiveTime(true, (error, data) => { +try { + systemTime.getRealActiveTime(true, (error, time) => { if (error) { - console.error(`Failed to get real active time. Cause:` + JSON.stringify(error)); - return; + console.info(`Failed to getting real active time. message: ${error.message}, code: ${error.code}`); + return; } - console.log(`Succeeded in getting real active time. Data:` + JSON.stringify(data)); -}); + console.info(`Succeeded in getting real active time : ${time}`); + }); +} catch(e) { + console.info(`Failed to get real active time. message: ${e.message}, code: ${e.code}`); +} ``` ## systemTime.getRealActiveTime8+ @@ -197,20 +269,32 @@ getRealActiveTime(callback: AsyncCallback<number>): void **参数:** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------------- | ---- | --------------------- | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------- | ---- | ------------------------------------------------------------ | | callback | AsyncCallback<number> | 是 | 回调函数,返回自系统启动以来经过的时间,但不包括度睡眠时间。 | +**错误码:** + +以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)。 + +| 错误码ID | 错误信息 | +| -------- | ------------------------------------------- | +| -1 | The parameter check failed or system error. | + **示例:** ```js -systemTime.getRealActiveTime((error, data) => { +try { + systemTime.getRealActiveTime((error, time) => { if (error) { - console.error(`Failed to get real active time. Cause:` + JSON.stringify(error)); - return; + console.info(`Failed to getting real active time. message: ${error.message}, code: ${error.code}`); + return; } - console.log(`Succeeded in getting real active time. Data:` + JSON.stringify(data)); -}); + console.info(`Succeeded in getting real active time : ${time}`); + }); +} catch(e) { + console.info(`Failed to get real active time. message: ${e.message}, code: ${e.code}`); +} ``` ## systemTime.getRealActiveTime8+ @@ -223,24 +307,36 @@ getRealActiveTime(isNano?: boolean): Promise<number> **参数:** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------- | ---- | ----------------------------------- | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------- | ---- | ------------------------------------------------------------ | | isNano | boolean | 否 | 返回结果是否为纳秒数。
- true:表示返回结果为纳秒数(ns)。
- false:表示返回结果为毫秒数(ms)。 | **返回值:** -| 类型 | 说明 | -| -------------- | -------------------------------- | +| 类型 | 说明 | +| --------------------- | ------------------------------------------------------------ | | Promise<number> | Promise对象,返回自系统启动以来经过的时间,但不包括深度睡眠时间。 | +**错误码:** + +以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)。 + +| 错误码ID | 错误信息 | +| -------- | ------------------------------------------- | +| -1 | The parameter check failed or system error. | + **示例:** ```js -systemTime.getRealActiveTime().then((data) => { - console.log(`Succeeded in getting real active time. Data:` + JSON.stringify(data)); -}).catch((error) => { - console.error(`Failed to get real active time. Cause:` + JSON.stringify(error)); -}); +try { + systemTime.getRealActiveTime().then((time) => { + console.info(`Succeeded in getting real active time : ${time}`); + }).catch((error) => { + console.info(`Failed to getting real active time. message: ${error.message}, code: ${error.code}`); + }); +} catch(e) { + console.info(`Failed to get real active time. message: ${e.message}, code: ${e.code}`); +} ``` ## systemTime.getRealTime8+ @@ -253,21 +349,33 @@ getRealTime(isNano: boolean, callback: AsyncCallback<number>): void **参数:** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------- | ---- | ------------------------------- | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------- | ---- | ------------------------------------------------------------ | | isNano | boolean | 是 | 返回结果是否为纳秒数。
- true:表示返回结果为纳秒数(ns)。
- false:表示返回结果为毫秒数(ms)。 | | callback | AsyncCallback<number> | 是 | 回调函数,返回自系统启动以来经过的时间,包括深度睡眠时间。 | +**错误码:** + +以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)。 + +| 错误码ID | 错误信息 | +| -------- | ------------------------------------------- | +| -1 | The parameter check failed or system error. | + **示例:** ```js -systemTime.getRealTime(true, (error, data) => { +try { + systemTime.getRealTime(true, (error, time) => { if (error) { - console.error(`Failed to get real time. Cause:` + JSON.stringify(error)); - return; + console.info(`Failed to getting real time. message: ${error.message}, code: ${error.code}`); + return; } - console.log(`Succeeded in getting real time. Data:` + JSON.stringify(data)); -}); + console.info(`Succeeded in getting real time : ${time}`); + }); +} catch(e) { + console.info(`Failed to get real time. message: ${e.message}, code: ${e.code}`); +} ``` ## systemTime.getRealTime8+ @@ -280,20 +388,32 @@ getRealTime(callback: AsyncCallback<number>): void **参数:** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------- | ---- | --------------------------- | -| callback | AsyncCallback<number> | 是 | 回调函数,返回自系统启动以来经过的时间,包括深度睡眠时间。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------- | ---- | ---------------------------------------------------------- | +| callback | AsyncCallback<number> | 是 | 回调函数,返回自系统启动以来经过的时间,包括深度睡眠时间。 | + +**错误码:** + +以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)。 + +| 错误码ID | 错误信息 | +| -------- | ------------------------------------------- | +| -1 | The parameter check failed or system error. | **示例:** ```js -systemTime.getRealTime((error, data) => { +try { + systemTime.getRealTime((error, time) => { if (error) { - console.error(`Failed to get real time. Cause:` + JSON.stringify(error)); - return; + console.info(`Failed to getting real time. message: ${error.message}, code: ${error.code}`); + return; } - console.log(`Succeeded in getting real time. Data:` + JSON.stringify(data)); -}); + console.info(`Succeeded in getting real time : ${time}`); + }); +} catch(e) { + console.info(`Failed to get real time. message: ${e.message}, code: ${e.code}`); +} ``` ## systemTime.getRealTime8+ @@ -306,24 +426,36 @@ getRealTime(isNano?: boolean): Promise<number> **参数:** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------- | ---- | ------------------------------- | -| isNano | boolean | 否 | 返回结果是否为纳秒数。<
- true:表示返回结果为纳秒数(ns)。
- false:表示返回结果为毫秒数(ms)。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------- | ---- | ------------------------------------------------------------ | +| isNano | boolean | 否 | 返回结果是否为纳秒数。
- true:表示返回结果为纳秒数(ns)。
- false:表示返回结果为毫秒数(ms)。 | **返回值:** -| 类型 | 说明 | -| --------------------- | ------------------------------- | +| 类型 | 说明 | +| --------------------- | ------------------------------------------------------------ | | Promise<number> | Promise对象,返回自系统启动以来经过的时间,包括深度睡眠时间。 | +**错误码:** + +以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)。 + +| 错误码ID | 错误信息 | +| -------- | ------------------------------------------- | +| -1 | The parameter check failed or system error. | + **示例:** ```js -systemTime.getRealTime().then((data) => { - console.log(`Succeeded in getting real time. Data:` + JSON.stringify(data)); -}).catch((error) => { - console.error(`Failed to get real time. Cause:` + JSON.stringify(error)); -}); +try { + systemTime.getRealTime().then((time) => { + console.info(`Succeeded in getting real time : ${time}`); + }).catch((error) => { + console.info(`Failed to getting real time. message: ${error.message}, code: ${error.code}`); + }); +} catch(e) { + console.info(`Failed to get real time. message: ${e.message}, code: ${e.code}`); +} ``` ## systemTime.setDate @@ -338,22 +470,34 @@ setDate(date: Date, callback: AsyncCallback<void>): void **参数:** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------- | ---- | --------------------- | -| date | Date | 是 | 目标日期。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ---------- | +| date | Date | 是 | 目标日期。 | | callback | AsyncCallback<void> | 是 | 回调函数。 | +**错误码:** + +以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)。 + +| 错误码ID | 错误信息 | +| -------- | ------------------------------------------------------------ | +| -1 | The parameter check failed or permission denied or system error. | + **示例:** ```js -let data = new Date(); -systemTime.setDate(data,(error, data) => { - if (error) { - console.error('Failed to set system date. Cause:' + JSON.stringify(error)); - return; -} - console.info('Succeeded in setting system date. Data:' + JSON.stringify(data)); -}); +let date = new Date(); +try { + systemTime.setDate(date, (error) => { + if (error) { + console.info(`Failed to setting date. message: ${error.message}, code: ${error.code}`); + return; + } + console.info(`Succeeded in setting date.`); + }); +} catch(e) { + console.info(`Failed to set date. message: ${e.message}, code: ${e.code}`); +} ``` ## systemTime.setDate @@ -374,19 +518,31 @@ setDate(date: Date): Promise<void> **返回值:** -| 类型 | 说明 | -| ------------------- | -------------------- | +| 类型 | 说明 | +| ------------------- | ------------------------- | | Promise<void> | 无返回结果的Promise对象。 | +**错误码:** + +以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)。 + +| 错误码ID | 错误信息 | +| -------- | ------------------------------------------------------------ | +| -1 | The parameter check failed or permission denied or system error. | + **示例:** ```js -let data = new Date(); -systemTime.setDate(data).then((value) => { - console.log(`Succeeded in setting system date. Data:` + JSON.stringify(value)); -}).catch((error) => { - console.error(`Failed to set system date. Cause:` + JSON.stringify(error)); -}); +let date = new Date(); +try { + systemTime.setDate(date).then(() => { + console.info(`Succeeded in setting date.`); + }).catch((error) => { + console.info(`Failed to setting date. message: ${error.message}, code: ${error.code}`); + }); +} catch(e) { + console.info(`Failed to set date. message: ${e.message}, code: ${e.code}`); +} ``` ## systemTime.getDate8+ @@ -399,20 +555,32 @@ getDate(callback: AsyncCallback<Date>): void **参数:** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------------- | ---- | --------------------- | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ---------------------------- | | callback | AsyncCallback<Date> | 是 | 回调函数,返回当前系统日期。 | +**错误码:** + +以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)。 + +| 错误码ID | 错误信息 | +| -------- | ------------------------------------------- | +| -1 | The parameter check failed or system error. | + **示例:** ```js -systemTime.getDate((error, data) => { +try { + systemTime.getDate((error, date) => { if (error) { - console.error(`Failed to get system date. Cause:` + JSON.stringify(error)); - return; + console.info(`Failed to get date. message: ${error.message}, code: ${error.code}`); + return; } - console.log(`Succeeded in getting system date. Data:` + JSON.stringify(data)); -}); + console.info(`Succeeded in get date : ${date}`);; + }); +} catch(e) { + console.info(`Failed to get date. message: ${e.message}, code: ${e.code}`); +} ``` ## systemTime.getDate8+ @@ -425,18 +593,30 @@ getDate(): Promise<Date> **返回值:** -| 类型 | 说明 | -| ------------------- | ----------------------------------------- | +| 类型 | 说明 | +| ------------------- | ------------------------------- | | Promise<Date> | Promise对象,返回当前系统日期。 | +**错误码:** + +以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)。 + +| 错误码ID | 错误信息 | +| -------- | ------------------------------------------- | +| -1 | The parameter check failed or system error. | + **示例:** ```js -systemTime.getDate().then((data) => { - console.log(`Succeeded in getting system date. Data:` + JSON.stringify(data)); -}).catch((error) => { - console.error(`Failed to get system date. Cause:` + JSON.stringify(error)); -}); +try { + systemTime.getDate().then((date) => { + console.info(`Succeeded in getting date : ${date}`); + }).catch((error) => { + console.info(`Failed to getting date. message: ${error.message}, code: ${error.code}`); + }); +} catch(e) { + console.info(`Failed to get date. message: ${e.message}, code: ${e.code}`); +} ``` ## systemTime.setTimezone @@ -451,21 +631,33 @@ setTimezone(timezone: string, callback: AsyncCallback<void>): void **参数:** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------- | ---- | -------------------------- | -| timezone | string | 是 | 系统时区。 具体可见[支持的系统时区](#支持的系统时区) 。 | -| callback | AsyncCallback<void> | 是 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ------------------------------------------------------- | +| timezone | string | 是 | 系统时区。 具体可见[支持的系统时区](#支持的系统时区) 。 | +| callback | AsyncCallback<void> | 是 | 回调函数。 | + +**错误码:** + +以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)。 + +| 错误码ID | 错误信息 | +| -------- | ------------------------------------------------------------ | +| -1 | The parameter check failed or permission denied or system error. | **示例:** ```js -systemTime.setTimezone('Asia/Shanghai', (error, data) => { - if (error) { - console.error('Failed to set system time zone. Cause:' + JSON.stringify(error)); - return; - } - console.info('Succeeded in setting system time zone. Data:' + JSON.stringify(data)); -}); +try { + systemTime.setTimezone('Asia/Shanghai', (error) => { + if (error) { + console.info(`Failed to setting timezone. message: ${error.message}, code: ${error.code}`); + return; + } + console.info(`Succeeded in setting timezone.`); + }); +} catch(e) { + console.info(`Failed to set timezone. message: ${e.message}, code: ${e.code}`); +} ``` ## systemTime.setTimezone @@ -480,24 +672,36 @@ setTimezone(timezone: string): Promise<void> **参数:** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------ | ---- | ---------- | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------ | ---- | ------------------------------------------------------ | | timezone | string | 是 | 系统时区。具体可见[支持的系统时区](#支持的系统时区) 。 | **返回值:** -| 类型 | 说明 | -| ------------------- | -------------------- | +| 类型 | 说明 | +| ------------------- | ------------------------- | | Promise<void> | 无返回结果的Promise对象。 | +**错误码:** + +以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)。 + +| 错误码ID | 错误信息 | +| -------- | ------------------------------------------------------------ | +| -1 | The parameter check failed or permission denied or system error. | + **示例:** ```js -systemTime.setTimezone('Asia/Shanghai').then((data) => { - console.log(`Succeeded in setting system time zone. Data:` + JSON.stringify(data)); -}).catch((error) => { - console.error(`Failed to set system time zone. Cause:` + JSON.stringify(error)); -}); +try { + systemTime.setTimezone('Asia/Shanghai').then(() => { + console.info(`Succeeded in setting timezone.`); + }).catch((error) => { + console.info(`Failed to setting timezone. message: ${error.message}, code: ${error.code}`); + }); +} catch(e) { + console.info(`Failed to set timezone. message: ${e.message}, code: ${e.code}`); +} ``` ## systemTime.getTimezone8+ @@ -510,20 +714,32 @@ getTimezone(callback: AsyncCallback<string>): void **参数:** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------- | ---- | ------------------------ | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------- | ---- | ------------------------------------------------------------ | | callback | AsyncCallback<string> | 是 | 回调函数,返回系统时区。具体可见[支持的系统时区](#支持的系统时区) 。 | +**错误码:** + +以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)。 + +| 错误码ID | 错误信息 | +| -------- | ------------------------------------------- | +| -1 | The parameter check failed or system error. | + **示例:** ```js -systemTime.getTimezone((error, data) => { +try { + systemTime.getTimezone((error, data) => { if (error) { - console.error(`Failed to get system time zone. Cause:` + JSON.stringify(error)); - return; + console.info(`Failed to get timezone. message: ${error.message}, code: ${error.code}`); + return; } - console.log(`Succeeded in getting system time zone. Data:` + JSON.stringify(data)); -}); + console.info(`Succeeded in get timezone : ${data}`);; + }); +} catch(e) { + console.info(`Failed to get timezone. message: ${e.message}, code: ${e.code}`); +} ``` ## systemTime.getTimezone8+ @@ -536,54 +752,66 @@ getTimezone(): Promise<string> **返回值:** -| 类型 | 说明 | -| --------------------- | ------------------------------------- | +| 类型 | 说明 | +| --------------------- | ------------------------------------------------------------ | | Promise<string> | Promise对象,返回系统时区。具体可见[支持的系统时区](#支持的系统时区) 。 | +**错误码:** + +以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)。 + +| 错误码ID | 错误信息 | +| -------- | ------------------------------------------- | +| -1 | The parameter check failed or system error. | + **示例:** ```js -systemTime.getTimezone().then((data) => { - console.log(`Succeeded in getting system time zone. Data:` + JSON.stringify(data)); -}).catch((error) => { - console.error(`Failed to get system time zone. Cause:` + JSON.stringify(error)); -}); +try { + systemTime.getTimezone().then((data) => { + console.info(`Succeeded in getting timezone: ${data}`); + }).catch((error) => { + console.info(`Failed to getting timezone. message: ${error.message}, code: ${error.code}`); + }); +} catch(e) { + console.info(`Failed to get timezone. message: ${e.message}, code: ${e.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 | \ No newline at end of file +| 时区 | 偏移量 | +| ------------------------------ | ------ | +| 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 | \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-system-timer.md b/zh-cn/application-dev/reference/apis/js-apis-system-timer.md index f1cec2767a38bc5aaac708ff18a877054b09764a..b2f04a41760f7d0c00ed14b4345be4152c4caddd 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-system-timer.md +++ b/zh-cn/application-dev/reference/apis/js-apis-system-timer.md @@ -20,12 +20,12 @@ import systemTimer from '@ohos.systemTimer'; **系统能力:** SystemCapability.MiscServices.Time -| 名称 | 类型 | 值 | 说明 | -| ------------------- | ------ | ---- | ---------------------------- | -| TIMER_TYPE_REALTIME | number | 1 | 系统启动时间定时器。(定时器启动时间不能晚于当前设置的系统时间) | -| TIMER_TYPE_WAKEUP | number | 2 | 唤醒定时器。 | -| TIMER_TYPE_EXACT | number | 4 | 精准定时器。 | -| TIMER_TYPE_IDLE | number | 8 | IDLE模式定时器(暂不支持)。 | +| 名称 | 类型 | 值 | 说明 | +| ------------------- | ------ | ---- | ------------------------------------------------------------ | +| TIMER_TYPE_REALTIME | number | 1 | 系统启动时间定时器。(定时器启动时间不能晚于当前设置的系统时间) | +| TIMER_TYPE_WAKEUP | number | 2 | 唤醒定时器。 | +| TIMER_TYPE_EXACT | number | 4 | 精准定时器。 | +| TIMER_TYPE_IDLE | number | 8 | IDLE模式定时器(暂不支持)。 | ## TimerOptions @@ -33,13 +33,13 @@ import systemTimer from '@ohos.systemTimer'; **系统能力:** SystemCapability.MiscServices.Time -| 名称 | 类型 | 必填 | 说明 | -| --------- | --------------------------------- | ---- | ------------------------------------------------------------ | -| type | number | 是 | 定时器类型。
取值为1时,表示为系统启动时间定时器(定时器启动时间不能晚于当前设置的系统时间) ;
取值为2时,表示为唤醒定时器;
取值为4时,表示为精准定时器;
取值为5时,表示为IDLE模式定时器(暂不支持)。 | -| repeat | boolean | 是 | true为循环定时器,false为单次定时器。 | -| interval | number | 否 | 如果是循环定时器,repeat值应大于5000毫秒,非重复定时器置为0。 | -| wantAgent | [WantAgent](js-apis-wantAgent.md) | 否 | 设置通知的WantAgent,定时器到期后通知。(支持拉起应用MainAbility,暂不支持拉起ServiceAbility。) | -| callback | number | 是 | 以回调函数的形式返回定时器的ID。 | +| 名称 | 类型 | 必填 | 说明 | +| --------- | --------------------------------------------- | ---- | ------------------------------------------------------------ | +| type | number | 是 | 定时器类型。
取值为1,表示为系统启动时间定时器(定时器启动时间不能晚于当前设置的系统时间) ;
取值为2,表示为唤醒定时器;
取值为4,表示为精准定时器;
取值为8,表示为IDLE模式定时器(暂不支持)。 | +| repeat | boolean | 是 | true为循环定时器,false为单次定时器。 | +| interval | number | 否 | 如果是循环定时器,repeat值应大于5000毫秒,非重复定时器置为0。 | +| wantAgent | [WantAgent](js-apis-app-ability-wantAgent.md) | 否 | 设置通知的WantAgent,定时器到期后通知。(支持拉起应用MainAbility,暂不支持拉起ServiceAbility。) | +| callback | number | 是 | 以回调函数的形式返回定时器的ID。 | ## systemTimer.createTimer @@ -61,19 +61,23 @@ createTimer(options: TimerOptions, callback: AsyncCallback<number>): void ```js export default { - systemTimer () { - let options = { - type: systemTimer.TIMER_TYPE_REALTIME, - repeat: false - }; - systemTimer.createTimer(options, (error, data) => { - if (error) { - console.error(`Failed to create timer. Cause:` + JSON.stringify(error)); - return; - } - console.log(`Succeeded in creating timer. Data:` + JSON.stringify(data)); - }); + systemTimer () { + let options = { + type: systemTimer.TIMER_TYPE_REALTIME, + repeat: false + }; + try { + systemTimer.createTimer(options, (error, timerId) => { + if (error) { + console.info(`Failed to create timer. message: ${error.message}, code: ${error.code}`); + return; + } + console.info(`Succeeded in creating timer. timerId: ${timerId}`); + }); + } catch(e) { + console.info(`Failed to create timer. message: ${e.message}, code: ${e.code}`); } + } } ``` @@ -101,17 +105,21 @@ createTimer(options: TimerOptions): Promise<number> ```js export default { - systemTimer () { - let options = { - type: systemTimer.TIMER_TYPE_REALTIME, - repeat:false - }; - systemTimer.createTimer(options).then((data) => { - console.log(`Succeeded in creating timer. Data:` + JSON.stringify(data)); - }).catch((error) => { - console.error(`Failed to create timer. Cause:` + JSON.stringify(error)); - }); + systemTimer () { + let options = { + type: systemTimer.TIMER_TYPE_REALTIME, + repeat:false + }; + try { + systemTimer.createTimer(options).then((timerId) => { + console.info(`Succeeded in creating timer. timerId: ${timerId}`); + }).catch((error) => { + console.info(`Failed to create timer. message: ${error.message}, code: ${error.code}`); + }); + } catch(e) { + console.info(`Failed to create timer. message: ${e.message}, code: ${e.code}`); } + } } ``` @@ -135,21 +143,26 @@ startTimer(timer: number, triggerTime: number, callback: AsyncCallback<void&g ```js export default { - async systemTimer () { - let options = { - type: systemTimer.TIMER_TYPE_REALTIME, - repeat:false - } - let timerId = await systemTimer.createTimer(options) - let triggerTime = new Date().getTime() - triggerTime += 3000 + async systemTimer () { + let options = { + type: systemTimer.TIMER_TYPE_REALTIME, + repeat:false + } + let timerId = await systemTimer.createTimer(options); + let triggerTime = new Date().getTime(); + triggerTime += 3000; + try { systemTimer.startTimer(timerId, triggerTime, (error) => { - if (error) { - console.error(`Failed to start timer. Cause:` + JSON.stringify(error)); - return; - } + if (error) { + console.info(`Failed to start timer. message: ${error.message}, code: ${error.code}`); + return; + } + console.info(`Succeeded in starting timer.`); }); + } catch(e) { + console.info(`Failed to start timer. message: ${e.message}, code: ${e.code}`); } + } } ``` @@ -178,20 +191,24 @@ startTimer(timer: number, triggerTime: number): Promise<void> ```js export default { - async systemTimer (){ - let options = { - type: systemTimer.TIMER_TYPE_REALTIME, - repeat:false - } - let timerId = await systemTimer.createTimer(options) - let triggerTime = new Date().getTime() - triggerTime += 3000 - systemTimer.startTimer(timerId, triggerTime).then((data) => { - console.log(`Succeeded in startting timer. Data:` + JSON.stringify(data)); - }).catch((error) => { - console.error(`Failed to start timer. Cause:` + JSON.stringify(error)); - }); + async systemTimer (){ + let options = { + type: systemTimer.TIMER_TYPE_REALTIME, + repeat:false } + let timerId = await systemTimer.createTimer(options); + let triggerTime = new Date().getTime(); + triggerTime += 3000; + try { + systemTimer.startTimer(timerId, triggerTime).then(() => { + console.info(`Succeeded in starting timer.`); + }).catch((error) => { + console.info(`Failed to start timer. message: ${error.message}, code: ${error.code}`); + }); + } catch(e) { + console.info(`Failed to start timer. message: ${e.message}, code: ${e.code}`); + } + } } ``` @@ -215,20 +232,25 @@ stopTimer(timer: number, callback: AsyncCallback<void>): void ```js export default { async systemTimer () { - let options = { - type: systemTimer.TIMER_TYPE_REALTIME, - repeat:false - } - let timerId = await systemTimer.createTimer(options) - let triggerTime = new Date().getTime() - triggerTime += 3000 - systemTimer.startTimer(timerId, triggerTime) + let options = { + type: systemTimer.TIMER_TYPE_REALTIME, + repeat:false + } + let timerId = await systemTimer.createTimer(options); + let triggerTime = new Date().getTime(); + triggerTime += 3000; + systemTimer.startTimer(timerId, triggerTime); + try { systemTimer.stopTimer(timerId, (error) => { - if (error) { - console.error(`Failed to stop timer. Cause:` + JSON.stringify(error)); - return; - } + if (error) { + console.info(`Failed to stop timer. message: ${error.message}, code: ${error.code}`); + return; + } + console.info(`Succeeded in stopping timer.`); }); + } catch(e) { + console.info(`Failed to stop timer. message: ${e.message}, code: ${e.code}`); + } } } ``` @@ -258,19 +280,23 @@ stopTimer(timer: number): Promise<void> ```js export default { async systemTimer (){ - let options = { - type: systemTimer.TIMER_TYPE_REALTIME, - repeat:false - } - let timerId = await systemTimer.createTimer(options) - let triggerTime = new Date().getTime() - triggerTime += 3000 - systemTimer.startTimer(timerId, triggerTime) - systemTimer.stopTimer(timerId).then((data) => { - console.log(`Succeeded in stopping timer. Data:` + JSON.stringify(data)); + let options = { + type: systemTimer.TIMER_TYPE_REALTIME, + repeat:false + } + let timerId = await systemTimer.createTimer(options); + let triggerTime = new Date().getTime(); + triggerTime += 3000; + systemTimer.startTimer(timerId, triggerTime); + try { + systemTimer.stopTimer(timerId).then(() => { + console.info(`Succeeded in stopping timer.`); }).catch((error) => { - console.error(`Failed to stop timer. Cause:` + JSON.stringify(error)); + console.info(`Failed to stop timer. message: ${error.message}, code: ${error.code}`); }); + } catch(e) { + console.info(`Failed to stop timer. message: ${e.message}, code: ${e.code}`); + } } } ``` @@ -294,23 +320,28 @@ destroyTimer(timer: number, callback: AsyncCallback<void>): void ```js export default { - async systemTimer () { - let options = { - type: systemTimer.TIMER_TYPE_REALTIME, - repeat:false + async systemTimer () { + let options = { + type: systemTimer.TIMER_TYPE_REALTIME, + repeat:false + } + let timerId = await systemTimer.createTimer(options); + let triggerTime = new Date().getTime(); + triggerTime += 3000; + systemTimer.startTimer(timerId, triggerTime); + systemTimer.stopTimer(timerId); + try { + systemTimer.destroyTimer(timerId, (error) => { + if (error) { + console.info(`Failed to destroy timer. message: ${error.message}, code: ${error.code}`); + return; } - let timerId = await systemTimer.createTimer(options) - let triggerTime = new Date().getTime() - triggerTime += 3000 - systemTimer.startTimer(timerId, triggerTime) - systemTimer.stopTimer(timerId) - systemTimer.destroyTimer(timerId, (error) => { - if (error) { - console.error(`Failed to destroy timer. Cause:` + JSON.stringify(error)); - return; - } - }); + console.info(`Succeeded in destroying timer.`); + }); + } catch(e) { + console.info(`Failed to destroying timer. message: ${e.message}, code: ${e.code}`); } + } } ``` @@ -338,21 +369,25 @@ destroyTimer(timer: number): Promise<void> ```js export default { - async systemTimer (){ - let options = { - type: systemTimer.TIMER_TYPE_REALTIME, - repeat:false - } - let timerId = await systemTimer.createTimer(options) - let triggerTime = new Date().getTime() - triggerTime += 3000 - systemTimer.startTimer(timerId, triggerTime) - systemTimer.stopTimer(timerId) - systemTimer.destroyTimer(timerId).then((data) => { - console.log(`Succeeded in destroying timer. Data:` + JSON.stringify(data)); - }).catch((error) => { - console.error(`Failed to destroy timer. Cause:` + JSON.stringify(error)); - }); + async systemTimer (){ + let options = { + type: systemTimer.TIMER_TYPE_REALTIME, + repeat:false } + let timerId = await systemTimer.createTimer(options); + let triggerTime = new Date().getTime(); + triggerTime += 3000; + systemTimer.startTimer(timerId, triggerTime); + systemTimer.stopTimer(timerId); + try { + systemTimer.destroyTimer(timerId).then(() => { + console.info(`Succeeded in destroying timer.`); + }).catch((error) => { + console.info(`Failed to destroy timer. message: ${error.message}, code: ${error.code}`); + }); + } catch(e) { + console.info(`Failed to destroying timer. message: ${e.message}, code: ${e.code}`); + } + } } ``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/errorcodes/errorcode-time.md b/zh-cn/application-dev/reference/errorcodes/errorcode-time.md new file mode 100644 index 0000000000000000000000000000000000000000..1ceca485130c9cb34734cd37c23f04b3c6249054 --- /dev/null +++ b/zh-cn/application-dev/reference/errorcodes/errorcode-time.md @@ -0,0 +1,24 @@ +# 时间时区服务错误码 + +## -1 锁屏服务异常 + +**错误信息** + + The parameter check failed or permission denied or system error. + +**错误描述** + +参数校验失败、权限校验失败或者时间时区服务异常。 + +**可能原因** + +该错误码代表一种通用错误码,可根据错误信息判断具体异常,可能原因如下: +1. 参数校验失败,传入参数无效。 +2. 权限校验失败,权限未配置。应用设置时间未配置ohos.permission.SET_TIME或者设置时区未配置ohos.permission.SET_TIME_ZONE。 +3. 系统运行异常。内存申请、多线程处理等内核通用错误。 + +**处理步骤** + +1. 参数校验失败,传入参数无效。检查参数是否按照要求传入。 +2. 权限校验失败,应用设置时间配置ohos.permission.SET_TIME或者设置时区配置ohos.permission.SET_TIME_ZONE。 +3. 系统运行异常。确认内存是否足够。