From c997b04deb8567a6ce7a8ea99186b3bbd13e116c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=AD=99=E6=82=A6?= Date: Thu, 12 May 2022 09:55:56 +0000 Subject: [PATCH] update zh-cn/application-dev/reference/apis/js-apis-system-time.md. Signed-off-by: sunyue --- .../reference/apis/js-apis-system-time.md | 199 ++++++++++-------- 1 file changed, 111 insertions(+), 88 deletions(-) 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 0e0321b654..fbc8a59dc5 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,5 +1,6 @@ # 设置系统时间 +本模块用来设置、获取当前系统时间，设置、获取当前系统日期和设置、获取当前系统时区。 > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 @@ -18,17 +19,18 @@ setTime(time : number, callback : AsyncCallback<void>) : void 设置系统时间。 -**需要权限：**ohos.permission.SET_TIME +**需要权限：** ohos.permission.SET_TIME -**系统能力**: SystemCapability.Miscservices.Time +**系统能力：** SystemCapability.Miscservices.Time -- 参数： - | 参数名 | 类型 | 必填 | 说明 | +**参数：** + + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | time | number | 是 | 目标时间戳（毫秒）。 | + | time | number | 是 | 目标时间戳（ms）。 | | callback | AsyncCallback<void> | 是 | 回调函数，可以在回调函数中处理接口返回值。 | -- 示例： +**示例：** ```js // time对应的时间为2021-01-20 02:36:25 @@ -49,21 +51,23 @@ setTime(time : number) : Promise<void> 设置系统时间。 -**需要权限：**ohos.permission.SET_TIME +**需要权限：** ohos.permission.SET_TIME + +**系统能力：** SystemCapability.MiscServices.Time -**系统能力**: SystemCapability.MiscServices.Time +**参数：** -- 参数： - | 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | time | number | 是 | 目标时间戳（毫秒）。 | + | time | number | 是 | 目标时间戳（ms）。 | + +**返回值：** -- 返回值： - | 类型 | 说明 | + | 类型 | 说明 | | -------- | -------- | | Promise<void> | 返回的异步回调函数。 | -- 示例： +**示例：** ```js // time对应的时间为2021-01-20 02:36:25 @@ -82,15 +86,16 @@ getCurrentTime(isNano?: boolean, callback: AsyncCallback<number>): void 获取自 Unix 纪元以来经过的时间，使用callback形式返回结果。 -**系统能力**: SystemCapability.MiscServices.Time +**系统能力：** SystemCapability.MiscServices.Time -- 参数： - | 参数名 | 类型 | 必填 | 说明 | +**参数：** + + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | isNano | boolean | 否 | 如果是true，返回纳秒数；否则返回毫秒数。 | | callback | AsyncCallback<number> | 是 | 回调函数，返回自 Unix 纪元以来经过的时间。 | -- 示例： +**示例：** ```js systemTime.getCurrentTime(true, (error, data) => { @@ -109,19 +114,21 @@ getCurrentTime(isNano?: boolean): Promise<number> 获取自 Unix 纪元以来经过的时间，使用Promise形式返回结果。 -**系统能力**: SystemCapability.MiscServices.Time +**系统能力：** SystemCapability.MiscServices.Time + +**参数：** -- 参数： - | 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | isNano | boolean | 否 | 如果是true，返回纳秒数；否则返回毫秒数。 | -- 返回值： - | 类型 | 说明 | +**返回值：** + + | 类型 | 说明 | | -------- | -------- | | Promise<number> | 以Promise形式返回结果，返回自 Unix 纪元以来经过的时间。 | -- 示例： +**示例：** ```js systemTime.getCurrentTime().then((data) => { @@ -138,15 +145,16 @@ getRealActiveTime(isNano?: boolean, callback: AsyncCallback<number>): void 获取自系统启动以来经过的时间，不包括深度睡眠时间，使用callback形式返回结果。 -**系统能力**: SystemCapability.MiscServices.Time +**系统能力：** SystemCapability.MiscServices.Time -- 参数： - | 参数名 | 类型 | 必填 | 说明 | +**参数：** + + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | isNano | boolean | 否 | 如果是true，返回纳秒数；否则返回毫秒数。 | - | callback | AsyncCallback<number> | 是 | 回调函数，返回自系统启动以来但不包括度睡眠时间经过的时间。 | + | callback | AsyncCallback<number> | 是 | 回调函数，返回自系统启动以来经过的时间，但不包括深度睡眠时间。 | -- 示例： +**示例：** ```js systemTime.getRealActiveTime(true, (error, data) => { @@ -165,19 +173,21 @@ getRealActiveTime(isNano?: boolean): Promise<number> 获取自系统启动以来经过的时间，不包括深度睡眠时间，使用Promise形式返回结果。 -**系统能力**: SystemCapability.MiscServices.Time +**系统能力：** SystemCapability.MiscServices.Time + +**参数：** -- 参数： - | 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | isNano | boolean | 否 | 如果是true，返回纳秒数；否则返回毫秒数。 | -- 返回值： - | 类型 | 说明 | +**返回值：** + + | 类型 | 说明 | | -------- | -------- | - | Promise<number> | 以Promise形式返回结果，返回自系统启动以来但不包括度睡眠时间经过的时间。 | + | Promise<number> | 以Promise形式返回结果，返回自系统启动以来经过的时间，但不包括深度睡眠时间。 | -- 示例： +**示例：** ```js systemTime.getCurrentTime().then((data) => { @@ -194,15 +204,16 @@ getRealTime(callback: AsyncCallback<number>): void 获取自系统启动以来经过的时间，包括深度睡眠时间，使用callback形式返回结果。 -**系统能力**: SystemCapability.MiscServices.Time +**系统能力：** SystemCapability.MiscServices.Time -- 参数： - | 参数名 | 类型 | 必填 | 说明 | +**参数：** + + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | isNano | boolean | 否 | 如果是true，返回纳秒数；否则返回毫秒数。 | - | callback | AsyncCallback<number> | 是 | 回调函数，返回自系统启动以来包括深度睡眠时间经过的毫秒数。 | + | callback | AsyncCallback<number> | 是 | 回调函数，返回自系统启动以来经过的时间，包括深度睡眠时间。 | -- 示例： +**示例：** ```js systemTime.getRealTime(true, (error, data) => { @@ -221,19 +232,21 @@ getRealTime(): Promise<number> 获取自系统启动以来经过的时间，包括深度睡眠时间，使用Promise形式返回结果。 -**系统能力**: SystemCapability.MiscServices.Time +**系统能力：** SystemCapability.MiscServices.Time + +**参数：** -- 参数： - | 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | isNano | boolean | 否 | 如果是true，返回纳秒数；否则返回毫秒数。 | -- 返回值： - | 类型 | 说明 | +**返回值：** + + | 类型 | 说明 | | -------- | -------- | - | Promise<number> | 以Promise形式返回结果，返回自系统启动以来包括深度睡眠时间经过的时间。 | + | Promise<number> | 以Promise形式返回结果，返回自系统启动以来经过的时间，包括深度睡眠时间。 | -- 示例： +**示例：** ```js systemTime.getRealTime().then((data) => { @@ -250,17 +263,18 @@ setDate(date: Date, callback: AsyncCallback<void>): void 设置系统日期，使用callback形式返回结果。 -**需要权限：**ohos.permission.SET_TIME +**需要权限：** ohos.permission.SET_TIME + +**系统能力：** SystemCapability.MiscServices.Time -**系统能力**: SystemCapability.MiscServices.Time +**参数：** -- 参数： - | 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | date | Date | 是 | 目标日期。 | | callback | AsyncCallback<void> | 是 | 回调函数，可以在回调函数中处理接口返回值。 | -- 示例： +**示例：** ```js var data = new Date("October 13, 2020 11:13:00"); @@ -280,21 +294,23 @@ setDate(date: Date): Promise<void> 设置系统日期，使用Promise形式返回结果。 -**需要权限：**ohos.permission.SET_TIME +**需要权限：** ohos.permission.SET_TIME + +**系统能力：** SystemCapability.MiscServices.Time -**系统能力**: SystemCapability.MiscServices.Time +**参数：** -- 参数： - | 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | date | Date | 是 | 目标日期。 | -- 返回值： - | 类型 | 说明 | +**返回值：** + + | 类型 | 说明 | | -------- | -------- | | Promise<void> | 返回的异步回调函数。 | -- 示例： +**示例：** ```js var data = new Date("October 13, 2020 11:13:00"); @@ -312,14 +328,15 @@ getDate(callback: AsyncCallback<Date>): void 获取当前系统日期，使用callback形式返回结果。 -**系统能力**: SystemCapability.MiscServices.Time +**系统能力：** SystemCapability.MiscServices.Time + +**参数：** -- 参数： - | 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | callback | AsyncCallback<Date> | 是 | 回调函数，返回当前系统日期。 | -- 示例： +**示例：** ```js systemTime.getDate((error, data) => { @@ -338,14 +355,15 @@ getDate(): Promise<Date> 获取当前系统日期，使用Promise形式返回结果。 -**系统能力**: SystemCapability.MiscServices.Time +**系统能力：** SystemCapability.MiscServices.Time + +**返回值：** -- 返回值： - | 类型 | 说明 | + | 类型 | 说明 | | -------- | -------- | | Promise<Date> | 以Promise形式返回结果，返回当前系统日期。 | -- 示例： +**示例：** ```js systemTime.getDate().then((data) => { @@ -362,17 +380,18 @@ setTimezone(timezone: string, callback: AsyncCallback<void>): void 设置系统时区。 -**需要权限：**ohos.permission.SET_TIME_ZONE +**需要权限：** ohos.permission.SET_TIME_ZONE -**系统能力**: SystemCapability.MiscServices.Time +**系统能力：** SystemCapability.MiscServices.Time -- 参数： - | 参数名 | 类型 | 必填 | 说明 | +**参数：** + + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | timezone | string | 是 | 系统时区。 | | callback | AsyncCallback<void> | 是 | 回调函数，可以在回调函数中处理接口返回值。 | -- 示例： +**示例：** ```js systemTime.setTimezone('Asia/Shanghai', (error, data) => { @@ -391,21 +410,23 @@ setTimezone(timezone: string): Promise<void> 设置系统时区。 -**需要权限：**ohos.permission.SET_TIME_ZONE +**需要权限：** ohos.permission.SET_TIME_ZONE + +**系统能力：** SystemCapability.MiscServices.Time -**系统能力**: SystemCapability.MiscServices.Time +**参数：** -- 参数： - | 参数名 | 类型 | 必填 | 说明 | + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | timezone | string | 是 | 系统时区。 | -- 返回值： - | 类型 | 说明 | +**返回值：** + + | 类型 | 说明 | | -------- | -------- | | Promise<void> | 返回的异步回调函数。 | -- 示例： +**示例：** ```js systemTime.setTimezone('Asia/Shanghai').then((data) => { @@ -422,14 +443,15 @@ getTimezone(callback: AsyncCallback<string>): void 获取系统时区，使用callback形式返回结果。 -**系统能力**: SystemCapability.MiscServices.Time +**系统能力：** SystemCapability.MiscServices.Time -- 参数： - | 参数名 | 类型 | 必填 | 说明 | +**参数：** + + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | callback | AsyncCallback<string> | 是 | 回调函数，返回系统时区。 | -- 示例： +**示例：** ```js systemTime.getTimezone((error, data) => { @@ -448,14 +470,15 @@ getTimezone(): Promise<string> 获取系统时区，使用Promise形式返回结果。 -**系统能力**: SystemCapability.MiscServices.Time +**系统能力：** SystemCapability.MiscServices.Time + +**返回值：** -- 返回值： - | 类型 | 说明 | + | 类型 | 说明 | | -------- | -------- | | Promise<string> | 以Promise形式返回结果，返回系统时区。 | -- 示例： +**示例：** ```js systemTime.getTimezone().then((data) => { -- GitLab