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 123327344dd2e66f3d330d386f7ecbe038ef35f9..fbb1fb0d0aa027762f4a6a9adad0336c33babd69 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 @@ -1,6 +1,6 @@ # 设置系统时间 -本模块用来设置、获取当前系统时间，设置、获取当前系统日期和设置、获取当前系统时区。 +本模块主要由时间、时区和定时三大功能组成。其中，定时服务用来管理和使用时间、时区。开发者可以通过对系统进行设置、获取等操作管理系统时间、时区，也可以通过定时功能实现定时服务如闹钟服务等。 > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 @@ -26,13 +26,13 @@ setTime(time : number, callback : AsyncCallback<void>) : void **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | time | number | 是 | 目标时间戳（ms）。 | - | callback | AsyncCallback<void> | 是 | 回调函数，可以在回调函数中处理接口返回值。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ------------------------------------------ | +| time | number | 是 | 目标时间戳（ms）。 | +| callback | AsyncCallback<void> | 是 | 回调函数，可以在回调函数中处理接口返回值。 | **示例：** - + ```js // time对应的时间为2021-01-20 02:36:25 var time = 1611081385000; @@ -58,18 +58,18 @@ setTime(time : number) : Promise<void> **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | time | number | 是 | 目标时间戳（ms）。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ------------------ | +| time | number | 是 | 目标时间戳（ms）。 | **返回值：** - | 类型 | 说明 | - | -------- | -------- | - | Promise<void> | 返回的异步回调函数。 | +| 类型 | 说明 | +| ------------------- | -------------------- | +| Promise<void> | 返回的异步回调函数。 | **示例：** - + ```js // time对应的时间为2021-01-20 02:36:25 var time = 1611081385000; @@ -91,13 +91,13 @@ getCurrentTime(isNano?: boolean, callback: AsyncCallback<number>): void **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | isNano | boolean | 否 | 如果是true，返回纳秒数；否则返回毫秒数。 | - | callback | AsyncCallback<number> | 是 | 回调函数，返回自 Unix 纪元以来经过的时间。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------- | ---- | ------------------------------------------------------------ | +| isNano | boolean | 否 | 返回结果是否为纳秒数。 - true：纳秒数。
- false：毫秒数。
| +| callback | AsyncCallback<number> | 是 | 回调函数，返回自 Unix 纪元以来经过的时间。 | **示例：** - + ```js systemTime.getCurrentTime(true, (error, data) => { if (error) { @@ -119,18 +119,18 @@ getCurrentTime(isNano?: boolean): Promise<number> **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | isNano | boolean | 否 | 如果是true，返回纳秒数；否则返回毫秒数。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------- | ---- | ------------------------------------------------------------ | +| isNano | boolean | 否 | 返回结果是否为纳秒数。 - true：纳秒数。
- false：毫秒数。
| **返回值：** - | 类型 | 说明 | - | -------- | -------- | - | Promise<number> | 以Promise形式返回结果，返回自 Unix 纪元以来经过的时间。 | +| 类型 | 说明 | +| --------------------- | ------------------------------------------------------------ | +| Promise<number> | 以Promise形式返回结果，返回自 Unix 纪元以来经过的时间。 | **示例：** - + ```js systemTime.getCurrentTime().then((data) => { console.log(`systemTime.getCurrentTime success data : ` + JSON.stringify(data)); @@ -150,13 +150,13 @@ getRealActiveTime(isNano?: boolean, callback: AsyncCallback<number>): void **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | isNano | boolean | 否 | 如果是true，返回纳秒数；否则返回毫秒数。 | - | callback | AsyncCallback<number> | 是 | 回调函数，返回自系统启动以来但不包括度睡眠时间经过的时间。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------- | ---- | ------------------------------------------------------------ | +| isNano | boolean | 否 | 返回结果是否为纳秒数。 - true：纳秒数。
- false：毫秒数。
| +| callback | AsyncCallback<number> | 是 | 回调函数，返回自系统启动以来经过的时间，但不包括度睡眠时间。 | **示例：** - + ```js systemTime.getRealActiveTime(true, (error, data) => { if (error) { @@ -178,18 +178,18 @@ getRealActiveTime(isNano?: boolean): Promise<number> **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | isNano | boolean | 否 | 如果是true，返回纳秒数；否则返回毫秒数。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------- | ---- | ------------------------------------------------------------ | +| isNano | boolean | 否 | 返回结果是否为纳秒数。 - true：纳秒数。
- false：毫秒数。
| **返回值：** - | 类型 | 说明 | - | -------- | -------- | - | Promise<number> | 以Promise形式返回结果，返回自系统启动以来经过的时间，但不包括深度睡眠时间。 | +| 类型 | 说明 | +| --------------------- | ------------------------------------------------------------ | +| Promise<number> | 以Promise形式返回结果，返回自系统启动以来经过的时间，但不包括深度睡眠时间。 | **示例：** - + ```js systemTime.getCurrentTime().then((data) => { console.log(`systemTime.getRealActiveTime success data : ` + JSON.stringify(data)); @@ -201,7 +201,7 @@ getRealActiveTime(isNano?: boolean): Promise<number> ## systemTime.getRealTime8+ -getRealTime(isNano?: boolean, callback: AsyncCallback<number>): void +getRealTime(callback: AsyncCallback<number>): void 获取自系统启动以来经过的时间，包括深度睡眠时间，使用callback形式返回结果。 @@ -209,13 +209,13 @@ getRealTime(isNano?: boolean, callback: AsyncCallback<number>): void **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | isNano | boolean | 否 | 如果是true，返回纳秒数；否则返回毫秒数。 | - | callback | AsyncCallback<number> | 是 | 回调函数，返回自系统启动以来经过的时间，包括深度睡眠时间。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------- | ---- | ------------------------------------------------------------ | +| isNano | boolean | 否 | 返回结果是否为纳秒数。 - true：纳秒数。
- false：毫秒数。
| +| callback | AsyncCallback<number> | 是 | 回调函数，返回自系统启动以来经过的时间，包括深度睡眠时间。 | **示例：** - + ```js systemTime.getRealTime(true, (error, data) => { if (error) { @@ -229,7 +229,7 @@ getRealTime(isNano?: boolean, callback: AsyncCallback<number>): void ## systemTime.getRealTime8+ -getRealTime(isNano?: boolean): Promise<number> +getRealTime(): Promise<number> 获取自系统启动以来经过的时间，包括深度睡眠时间，使用Promise形式返回结果。 @@ -237,18 +237,18 @@ getRealTime(isNano?: boolean): Promise<number> **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | isNano | boolean | 否 | 如果是true，返回纳秒数；否则返回毫秒数。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------- | ---- | ------------------------------------------------------------ | +| isNano | boolean | 否 | 返回结果是否为纳秒数。 - true：纳秒数。
- false：毫秒数。
| **返回值：** - | 类型 | 说明 | - | -------- | -------- | - | Promise<number> | 以Promise形式返回结果，返回自系统启动以来经过的时间，包括深度睡眠时间。 | +| 类型 | 说明 | +| --------------------- | ------------------------------------------------------------ | +| Promise<number> | 以Promise形式返回结果，返回自系统启动以来经过的时间，包括深度睡眠时间。 | **示例：** - + ```js systemTime.getRealTime().then((data) => { console.log(`systemTime.getRealTime success data: ` + JSON.stringify(data)); @@ -270,13 +270,13 @@ setDate(date: Date, callback: AsyncCallback<void>): void **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | date | Date | 是 | 目标日期。 | - | callback | AsyncCallback<void> | 是 | 回调函数，可以在回调函数中处理接口返回值。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ------------------------------------------ | +| date | Date | 是 | 目标日期。 | +| callback | AsyncCallback<void> | 是 | 回调函数，可以在回调函数中处理接口返回值。 | **示例：** - + ```js var data = new Date("October 13, 2020 11:13:00"); systemTime.setDate(data,(error, data) => { @@ -301,18 +301,18 @@ setDate(date: Date): Promise<void> **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | date | Date | 是 | 目标日期。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ---- | ---- | ---------- | +| date | Date | 是 | 目标日期。 | **返回值：** - | 类型 | 说明 | - | -------- | -------- | - | Promise<void> | 返回的异步回调函数。 | +| 类型 | 说明 | +| ------------------- | -------------------- | +| Promise<void> | 返回的异步回调函数。 | **示例：** - + ```js var data = new Date("October 13, 2020 11:13:00"); systemTime.setDate(data).then((value) => { @@ -333,12 +333,12 @@ getDate(callback: AsyncCallback<Date>): void **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<Date> | 是 | 回调函数，返回当前系统日期。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ---------------------------- | +| callback | AsyncCallback<Date> | 是 | 回调函数，返回当前系统日期。 | **示例：** - + ```js systemTime.getDate((error, data) => { if (error) { @@ -360,12 +360,12 @@ getDate(): Promise<Date> **返回值：** - | 类型 | 说明 | - | -------- | -------- | - | Promise<Date> | 以Promise形式返回结果，返回当前系统日期。 | +| 类型 | 说明 | +| ------------------- | ----------------------------------------- | +| Promise<Date> | 以Promise形式返回结果，返回当前系统日期。 | **示例：** - + ```js systemTime.getDate().then((data) => { console.log(`systemTime.getDate success data : ` + JSON.stringify(data)); @@ -387,13 +387,13 @@ setTimezone(timezone: string, callback: AsyncCallback<void>): void **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | timezone | string | 是 | 系统时区。 | - | callback | AsyncCallback<void> | 是 | 回调函数，可以在回调函数中处理接口返回值。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ------------------------------------------ | +| timezone | string | 是 | 系统时区。 | +| callback | AsyncCallback<void> | 是 | 回调函数，可以在回调函数中处理接口返回值。 | **示例：** - + ```js systemTime.setTimezone('Asia/Shanghai', (error, data) => { if (error) { @@ -417,18 +417,18 @@ setTimezone(timezone: string): Promise<void> **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | timezone | string | 是 | 系统时区。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------ | ---- | ---------- | +| timezone | string | 是 | 系统时区。 | **返回值：** - | 类型 | 说明 | - | -------- | -------- | - | Promise<void> | 返回的异步回调函数。 | +| 类型 | 说明 | +| ------------------- | -------------------- | +| Promise<void> | 返回的异步回调函数。 | **示例：** - + ```js systemTime.setTimezone('Asia/Shanghai').then((data) => { console.log(`systemTime.setTimezone success data : ` + JSON.stringify(data)); @@ -448,12 +448,12 @@ getTimezone(callback: AsyncCallback<string>): void **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<string> | 是 | 回调函数，返回系统时区。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------- | ---- | ------------------------ | +| callback | AsyncCallback<string> | 是 | 回调函数，返回系统时区。 | **示例：** - + ```js systemTime.getTimezone((error, data) => { if (error) { @@ -475,16 +475,16 @@ getTimezone(): Promise<string> **返回值：** - | 类型 | 说明 | - | -------- | -------- | - | Promise<string> | 以Promise形式返回结果，返回系统时区。 | +| 类型 | 说明 | +| --------------------- | ------------------------------------- | +| Promise<string> | 以Promise形式返回结果，返回系统时区。 | **示例：** - + ```js systemTime.getTimezone().then((data) => { console.log(`systemTime.getTimezone success data : ` + JSON.stringify(data)); }).catch((error) => { console.error(`failed to systemTime.getTimezone because ` + JSON.stringify(error)); }); - ``` + ``` \ No newline at end of file