Skip to content

D
Docs

OpenHarmony / Docs
大约 1 年 前同步成功

通知 159
Star 292
Fork 28
D
Docs

体验新版 GitCode，发现更多精彩内容 >>

未验证 提交 8ff6ec1b 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!13555 资料需求回合 

Merge pull request !13555 from wTong888/cherry-pick-1673572732
上级 75468e2c 424e39c5
显示空白变更内容
内联 并排
Showing with 1252 addition and 300 deletion
zh-cn/application-dev/reference/apis/js-apis-system-date-time.md 0 → 100644
浏览文件 @ 8ff6ec1b
# @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 | 是 | 返回结果是否为纳秒数。<br>- true：表示返回结果为纳秒数（ns）。 <br>- false：表示返回结果为毫秒数（ms）。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调函数，返回自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&lt;number&gt;): void
获取自Unix纪元以来经过的时间，使用callback异步回调。
**系统能力：** SystemCapability.MiscServices.Time
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------- | ---- | ---------------------------------- |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调函数，返回自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&lt;number&gt;
获取自Unix纪元以来经过的时间，使用Promise异步回调。
**系统能力：** SystemCapability.MiscServices.Time
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------- | ---- | ------------------------- |
| isNano | boolean | 否 | 返回结果是否为纳秒数。<br/>- true：表示返回结果为纳秒数（ns）。 <br/>- false：表示返回结果为毫秒数（ms）。 |
**返回值：**
| 类型 | 说明 |
| --------------------- | --------------------------- |
| Promise&lt;number&gt; | 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&lt;number&gt;): void
获取自系统启动以来经过的时间，不包括深度睡眠时间，使用callback异步回调。
**系统能力：** SystemCapability.MiscServices.Time
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------- | ---- | -------------------------- |
| isNano | boolean | 是 | 返回结果是否为纳秒数。<br/>- true：表示返回结果为纳秒数（ns）。 <br/>- false：表示返回结果为毫秒数（ms）。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调函数，返回自系统启动以来经过的时间，但不包括度睡眠时间。 |
**示例：**
```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&lt;number&gt;): void
获取自系统启动以来经过的时间，不包括深度睡眠时间，使用callback异步回调。
**系统能力：** SystemCapability.MiscServices.Time
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------- | ---- | --------------------- |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调函数，返回自系统启动以来经过的时间，但不包括度睡眠时间。 |
**示例：**
```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&lt;number&gt;
获取自系统启动以来经过的时间，不包括深度睡眠时间，使用Promise异步回调。
**系统能力：** SystemCapability.MiscServices.Time
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------- | ---- | ----------------------------------- |
| isNano | boolean | 否 | 返回结果是否为纳秒数。<br/>- true：表示返回结果为纳秒数（ns）。 <br/>- false：表示返回结果为毫秒数（ms）。 |
**返回值：**
| 类型 | 说明 |
| -------------- | -------------------------------- |
| Promise&lt;number&gt; | 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&lt;number&gt;): void
获取自系统启动以来经过的时间，包括深度睡眠时间，使用callback异步回调。
**系统能力：** SystemCapability.MiscServices.Time
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------- | ---- | ------------------------------- |
| isNano | boolean | 是 | 返回结果是否为纳秒数。<br/>- true：表示返回结果为纳秒数（ns）。 <br/>- false：表示返回结果为毫秒数（ms）。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调函数，返回自系统启动以来经过的时间，包括深度睡眠时间。 |
**示例：**
```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&lt;number&gt;): void
获取自系统启动以来经过的时间，包括深度睡眠时间，使用callback异步回调。
**系统能力：** SystemCapability.MiscServices.Time
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------- | ---- | --------------------------- |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调函数，返回自系统启动以来经过的时间，包括深度睡眠时间。 |
**示例：**
```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&lt;number&gt;
获取自系统启动以来经过的时间，包括深度睡眠时间，使用Promise异步回调。
**系统能力：** SystemCapability.MiscServices.Time
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------- | ---- | ------------------------------- |
| isNano | boolean | 否 | 返回结果是否为纳秒数。<br/>- true：表示返回结果为纳秒数（ns）。 <br/>- false：表示返回结果为毫秒数（ms）。 |
**返回值：**
| 类型 | 说明 |
| --------------------- | ------------------------------- |
| Promise&lt;number&gt; | 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&lt;void&gt;): void
设置系统日期，使用callback异步回调。
**系统接口：** 此接口为系统接口
**系统能力：** SystemCapability.MiscServices.Time
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------- | ---- | --------------------- |
| date | Date | 是 | 目标日期。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
**示例：**
```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&lt;void&gt;
设置系统日期，使用Promise异步回调。
**系统接口：** 此接口为系统接口
**系统能力：** SystemCapability.MiscServices.Time
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ---- | ---- | ---------- |
| date | Date | 是 | 目标日期。 |
**返回值：**
| 类型 | 说明 |
| ------------------- | -------------------- |
| Promise&lt;void&gt; | 无返回结果的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&lt;Date&gt;): void
获取当前系统日期，使用callback异步回调。
**系统能力：** SystemCapability.MiscServices.Time
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------- | ---- | --------------------- |
| callback | AsyncCallback&lt;Date&gt; | 是 | 回调函数，返回当前系统日期。 |
**示例：**
```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&lt;Date&gt;
获取当前系统日期，使用Promise异步回调。
**系统能力：** SystemCapability.MiscServices.Time
**返回值：**
| 类型 | 说明 |
| ------------------- | ----------------------------------------- |
| Promise&lt;Date&gt; | 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&lt;void&gt;): void
设置系统时区，使用callback异步回调。
**系统接口：** 此接口为系统接口
**系统能力：** SystemCapability.MiscServices.Time
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------- | ---- | -------------------------- |
| timezone | string | 是 | 系统时区。 具体可见[支持的系统时区](#支持的系统时区) 。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
**示例：**
```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&lt;void&gt;
设置系统时区，使用Promise异步回调。
**系统接口：** 此接口为系统接口
**系统能力：** SystemCapability.MiscServices.Time
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ---------- |
| timezone | string | 是 | 系统时区。具体可见[支持的系统时区](#支持的系统时区) 。 |
**返回值：**
| 类型 | 说明 |
| ------------------- | -------------------- |
| Promise&lt;void&gt; | 无返回结果的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&lt;string&gt;): void
获取系统时区，使用callback异步回调。
**系统能力：** SystemCapability.MiscServices.Time
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------- | ---- | ------------------------ |
| callback | AsyncCallback&lt;string&gt; | 是 | 回调函数，返回系统时区。具体可见[支持的系统时区](#支持的系统时区) 。 |
**示例：**
```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&lt;string&gt;
获取系统时区，使用Promise异步回调。
**系统能力：** SystemCapability.MiscServices.Time
**返回值：**
| 类型 | 说明 |
| --------------------- | ------------------------------------- |
| Promise&lt;string&gt; | 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
zh-cn/application-dev/reference/apis/js-apis-system-time.md
浏览文件 @ 8ff6ec1b
...@@ -25,22 +25,34 @@ setTime(time : number, callback : AsyncCallback&lt;void&gt;) : void ...@@ -25,22 +25,34 @@ setTime(time : number, callback : AsyncCallback&lt;void&gt;) : void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------- | ---- | ---------------- | | -------- | ------------------------- | ---- | ------------------ |
| time | number | 是 | 目标时间戳（ms）。 | | time | number | 是 | 目标时间戳（ms）。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
**错误码：**
以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ |
| -1 | The parameter check failed or permission denied or system error. |
**示例：** **示例：**
```js ```js
// time对应的时间为2021-01-20 02:36:25 // time对应的时间为2021-01-20 02:36:25
let time = 1611081385000; let time = 1611081385000;
systemTime.setTime(time, (error, data) => { try {
systemTime.setTime(time, (error) => {
if (error) { if (error) {
console.error(`Failed to set systemTime. Cause:` + JSON.stringify(error)); console.info(`Failed to setting time. message: ${error.message}, code: ${error.code}`);
return; 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 ## systemTime.setTime
...@@ -65,16 +77,28 @@ setTime(time : number) : Promise&lt;void&gt; ...@@ -65,16 +77,28 @@ setTime(time : number) : Promise&lt;void&gt;
| ------------------- | ------------------------- | | ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 | | Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**错误码：**
以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ |
| -1 | The parameter check failed or permission denied or system error. |
**示例：** **示例：**
```js ```js
// time对应的时间为2021-01-20 02:36:25 // time对应的时间为2021-01-20 02:36:25
let time = 1611081385000; let time = 1611081385000;
systemTime.setTime(time).then((data) => { try {
console.log(`Succeeded in setting systemTime. Data:` + JSON.stringify(data)); systemTime.setTime(time).then(() => {
}).catch((error) => { console.info(`Succeeded in setting time.`);
console.error(`Failed to set systemTime. Cause:` + JSON.stringify(error)); }).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.getCurrentTime<sup>8+</sup> ## systemTime.getCurrentTime<sup>8+</sup>
...@@ -88,20 +112,32 @@ getCurrentTime(isNano: boolean, callback: AsyncCallback&lt;number&gt;): void ...@@ -88,20 +112,32 @@ getCurrentTime(isNano: boolean, callback: AsyncCallback&lt;number&gt;): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------- | ---- | ------------------ | | -------- | --------------------------- | ---- | ------------------------------------------------------------ |
| isNano | boolean | 是 | 返回结果是否为纳秒数。<br>- true：表示返回结果为纳秒数（ns）。 <br>- false：表示返回结果为毫秒数（ms）。 | | isNano | boolean | 是 | 返回结果是否为纳秒数。<br>- true：表示返回结果为纳秒数（ns）。 <br>- false：表示返回结果为毫秒数（ms）。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调函数，返回自Unix纪元以来经过的时间。 | | callback | AsyncCallback&lt;number&gt; | 是 | 回调函数，返回自Unix纪元以来经过的时间。 |
**错误码：**
以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------------------------------- |
| -1 | The parameter check failed or system error. |
**示例：** **示例：**
```js ```js
systemTime.getCurrentTime(true, (error, data) => { try {
systemTime.getCurrentTime(true, (error, time) => {
if (error) { if (error) {
console.error(`Failed to get systemTime. Cause:` + JSON.stringify(error)); console.info(`Failed to getting currentTime. message: ${error.message}, code: ${error.code}`);
return; 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.getCurrentTime<sup>8+</sup> ## systemTime.getCurrentTime<sup>8+</sup>
...@@ -115,19 +151,31 @@ getCurrentTime(callback: AsyncCallback&lt;number&gt;): void ...@@ -115,19 +151,31 @@ getCurrentTime(callback: AsyncCallback&lt;number&gt;): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------- | ---- | ---------------------------------- | | -------- | --------------------------- | ---- | ---------------------------------------- |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调函数，返回自Unix纪元以来经过的时间。 | | callback | AsyncCallback&lt;number&gt; | 是 | 回调函数，返回自Unix纪元以来经过的时间。 |
**错误码：**
以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------------------------------- |
| -1 | The parameter check failed or system error. |
**示例：** **示例：**
```js ```js
systemTime.getCurrentTime((error, data) => { try {
systemTime.getCurrentTime((error, time) => {
if (error) { if (error) {
console.error(`Succeeded in getting systemTime. Data:` + JSON.stringify(error)); console.info(`Failed to getting currentTime. message: ${error.message}, code: ${error.code}`);
return; 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.getCurrentTime<sup>8+</sup> ## systemTime.getCurrentTime<sup>8+</sup>
...@@ -141,23 +189,35 @@ getCurrentTime(isNano?: boolean): Promise&lt;number&gt; ...@@ -141,23 +189,35 @@ getCurrentTime(isNano?: boolean): Promise&lt;number&gt;
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------- | ---- | ------------------------- | | ------ | ------- | ---- | ------------------------------------------------------------ |
| isNano | boolean | 否 | 返回结果是否为纳秒数。<br/>- true：表示返回结果为纳秒数（ns）。 <br/>- false：表示返回结果为毫秒数（ms）。 | | isNano | boolean | 否 | 返回结果是否为纳秒数。<br/>- true：表示返回结果为纳秒数（ns）。 <br/>- false：表示返回结果为毫秒数（ms）。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | --------------------------- | | --------------------- | ------------------------------------------- |
| Promise&lt;number&gt; | Promise对象，返回自Unix纪元以来经过的时间。 | | Promise&lt;number&gt; | Promise对象，返回自Unix纪元以来经过的时间。 |
**错误码：**
以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------------------------------- |
| -1 | The parameter check failed or system error. |
**示例：** **示例：**
```js ```js
systemTime.getCurrentTime().then((data) => { try {
console.log(`Succeeded in getting systemTime. Data:` + JSON.stringify(data)); systemTime.getCurrentTime().then((time) => {
}).catch((error) => { console.info(`Succeeded in getting currentTime : ${time}`);
console.error(`Failed to get systemTime. Cause:` + JSON.stringify(error)); }).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.getRealActiveTime<sup>8+</sup> ## systemTime.getRealActiveTime<sup>8+</sup>
...@@ -171,20 +231,32 @@ getRealActiveTime(isNano: boolean, callback: AsyncCallback&lt;number&gt;): void ...@@ -171,20 +231,32 @@ getRealActiveTime(isNano: boolean, callback: AsyncCallback&lt;number&gt;): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------- | ---- | -------------------------- | | -------- | --------------------------- | ---- | ------------------------------------------------------------ |
| isNano | boolean | 是 | 返回结果是否为纳秒数。<br/>- true：表示返回结果为纳秒数（ns）。 <br/>- false：表示返回结果为毫秒数（ms）。 | | isNano | boolean | 是 | 返回结果是否为纳秒数。<br/>- true：表示返回结果为纳秒数（ns）。 <br/>- false：表示返回结果为毫秒数（ms）。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调函数，返回自系统启动以来经过的时间，但不包括度睡眠时间。 | | callback | AsyncCallback&lt;number&gt; | 是 | 回调函数，返回自系统启动以来经过的时间，但不包括度睡眠时间。 |
**错误码：**
以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------------------------------- |
| -1 | The parameter check failed or system error. |
**示例：** **示例：**
```js ```js
systemTime.getRealActiveTime(true, (error, data) => { try {
systemTime.getRealActiveTime(true, (error, time) => {
if (error) { if (error) {
console.error(`Failed to get real active time. Cause:` + JSON.stringify(error)); console.info(`Failed to getting real active time. message: ${error.message}, code: ${error.code}`);
return; 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.getRealActiveTime<sup>8+</sup> ## systemTime.getRealActiveTime<sup>8+</sup>
...@@ -198,19 +270,31 @@ getRealActiveTime(callback: AsyncCallback&lt;number&gt;): void ...@@ -198,19 +270,31 @@ getRealActiveTime(callback: AsyncCallback&lt;number&gt;): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------- | ---- | --------------------- | | -------- | --------------------------- | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调函数，返回自系统启动以来经过的时间，但不包括度睡眠时间。 | | callback | AsyncCallback&lt;number&gt; | 是 | 回调函数，返回自系统启动以来经过的时间，但不包括度睡眠时间。 |
**错误码：**
以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------------------------------- |
| -1 | The parameter check failed or system error. |
**示例：** **示例：**
```js ```js
systemTime.getRealActiveTime((error, data) => { try {
systemTime.getRealActiveTime((error, time) => {
if (error) { if (error) {
console.error(`Failed to get real active time. Cause:` + JSON.stringify(error)); console.info(`Failed to getting real active time. message: ${error.message}, code: ${error.code}`);
return; 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.getRealActiveTime<sup>8+</sup> ## systemTime.getRealActiveTime<sup>8+</sup>
...@@ -224,23 +308,35 @@ getRealActiveTime(isNano?: boolean): Promise&lt;number&gt; ...@@ -224,23 +308,35 @@ getRealActiveTime(isNano?: boolean): Promise&lt;number&gt;
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------- | ---- | ----------------------------------- | | ------ | ------- | ---- | ------------------------------------------------------------ |
| isNano | boolean | 否 | 返回结果是否为纳秒数。<br/>- true：表示返回结果为纳秒数（ns）。 <br/>- false：表示返回结果为毫秒数（ms）。 | | isNano | boolean | 否 | 返回结果是否为纳秒数。<br/>- true：表示返回结果为纳秒数（ns）。 <br/>- false：表示返回结果为毫秒数（ms）。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------------- | -------------------------------- | | --------------------- | ------------------------------------------------------------ |
| Promise&lt;number&gt; | Promise对象，返回自系统启动以来经过的时间，但不包括深度睡眠时间。 | | Promise&lt;number&gt; | Promise对象，返回自系统启动以来经过的时间，但不包括深度睡眠时间。 |
**错误码：**
以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------------------------------- |
| -1 | The parameter check failed or system error. |
**示例：** **示例：**
```js ```js
systemTime.getRealActiveTime().then((data) => { try {
console.log(`Succeeded in getting real active time. Data:` + JSON.stringify(data)); systemTime.getRealActiveTime().then((time) => {
}).catch((error) => { console.info(`Succeeded in getting real active time : ${time}`);
console.error(`Failed to get real active time. Cause:` + JSON.stringify(error)); }).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.getRealTime<sup>8+</sup> ## systemTime.getRealTime<sup>8+</sup>
...@@ -254,20 +350,32 @@ getRealTime(isNano: boolean, callback: AsyncCallback&lt;number&gt;): void ...@@ -254,20 +350,32 @@ getRealTime(isNano: boolean, callback: AsyncCallback&lt;number&gt;): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------- | ---- | ------------------------------- | | -------- | --------------------------- | ---- | ------------------------------------------------------------ |
| isNano | boolean | 是 | 返回结果是否为纳秒数。<br/>- true：表示返回结果为纳秒数（ns）。 <br/>- false：表示返回结果为毫秒数（ms）。 | | isNano | boolean | 是 | 返回结果是否为纳秒数。<br/>- true：表示返回结果为纳秒数（ns）。 <br/>- false：表示返回结果为毫秒数（ms）。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调函数，返回自系统启动以来经过的时间，包括深度睡眠时间。 | | callback | AsyncCallback&lt;number&gt; | 是 | 回调函数，返回自系统启动以来经过的时间，包括深度睡眠时间。 |
**错误码：**
以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------------------------------- |
| -1 | The parameter check failed or system error. |
**示例：** **示例：**
```js ```js
systemTime.getRealTime(true, (error, data) => { try {
systemTime.getRealTime(true, (error, time) => {
if (error) { if (error) {
console.error(`Failed to get real time. Cause:` + JSON.stringify(error)); console.info(`Failed to getting real time. message: ${error.message}, code: ${error.code}`);
return; 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.getRealTime<sup>8+</sup> ## systemTime.getRealTime<sup>8+</sup>
...@@ -281,19 +389,31 @@ getRealTime(callback: AsyncCallback&lt;number&gt;): void ...@@ -281,19 +389,31 @@ getRealTime(callback: AsyncCallback&lt;number&gt;): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------- | ---- | --------------------------- | | -------- | --------------------------- | ---- | ---------------------------------------------------------- |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调函数，返回自系统启动以来经过的时间，包括深度睡眠时间。 | | callback | AsyncCallback&lt;number&gt; | 是 | 回调函数，返回自系统启动以来经过的时间，包括深度睡眠时间。 |
**错误码：**
以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------------------------------- |
| -1 | The parameter check failed or system error. |
**示例：** **示例：**
```js ```js
systemTime.getRealTime((error, data) => { try {
systemTime.getRealTime((error, time) => {
if (error) { if (error) {
console.error(`Failed to get real time. Cause:` + JSON.stringify(error)); console.info(`Failed to getting real time. message: ${error.message}, code: ${error.code}`);
return; 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.getRealTime<sup>8+</sup> ## systemTime.getRealTime<sup>8+</sup>
...@@ -307,23 +427,35 @@ getRealTime(isNano?: boolean): Promise&lt;number&gt; ...@@ -307,23 +427,35 @@ getRealTime(isNano?: boolean): Promise&lt;number&gt;
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------- | ---- | ------------------------------- | | ------ | ------- | ---- | ------------------------------------------------------------ |
| isNano | boolean | 否 | 返回结果是否为纳秒数。<<br/>- true：表示返回结果为纳秒数（ns）。 <br/>- false：表示返回结果为毫秒数（ms）。 | | isNano | boolean | 否 | 返回结果是否为纳秒数。<br/>- true：表示返回结果为纳秒数（ns）。 <br/>- false：表示返回结果为毫秒数（ms）。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | ------------------------------- | | --------------------- | ------------------------------------------------------------ |
| Promise&lt;number&gt; | Promise对象，返回自系统启动以来经过的时间，包括深度睡眠时间。 | | Promise&lt;number&gt; | Promise对象，返回自系统启动以来经过的时间，包括深度睡眠时间。 |
**错误码：**
以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------------------------------- |
| -1 | The parameter check failed or system error. |
**示例：** **示例：**
```js ```js
systemTime.getRealTime().then((data) => { try {
console.log(`Succeeded in getting real time. Data:` + JSON.stringify(data)); systemTime.getRealTime().then((time) => {
}).catch((error) => { console.info(`Succeeded in getting real time : ${time}`);
console.error(`Failed to get real time. Cause:` + JSON.stringify(error)); }).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 ## systemTime.setDate
...@@ -339,21 +471,33 @@ setDate(date: Date, callback: AsyncCallback&lt;void&gt;): void ...@@ -339,21 +471,33 @@ setDate(date: Date, callback: AsyncCallback&lt;void&gt;): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------- | ---- | --------------------- | | -------- | ------------------------- | ---- | ---------- |
| date | Date | 是 | 目标日期。 | | date | Date | 是 | 目标日期。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
**错误码：**
以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ |
| -1 | The parameter check failed or permission denied or system error. |
**示例：** **示例：**
```js ```js
let data = new Date(); let date = new Date();
systemTime.setDate(data,(error, data) => { try {
systemTime.setDate(date, (error) => {
if (error) { if (error) {
console.error('Failed to set system date. Cause:' + JSON.stringify(error)); console.info(`Failed to setting date. message: ${error.message}, code: ${error.code}`);
return; return;
}
console.info(`Succeeded in setting date.`);
});
} catch(e) {
console.info(`Failed to set date. message: ${e.message}, code: ${e.code}`);
} }
console.info('Succeeded in setting system date. Data:' + JSON.stringify(data));
});
``` ```
## systemTime.setDate ## systemTime.setDate
...@@ -375,18 +519,30 @@ setDate(date: Date): Promise&lt;void&gt; ...@@ -375,18 +519,30 @@ setDate(date: Date): Promise&lt;void&gt;
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | -------------------- | | ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 | | Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**错误码：**
以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ |
| -1 | The parameter check failed or permission denied or system error. |
**示例：** **示例：**
```js ```js
let data = new Date(); let date = new Date();
systemTime.setDate(data).then((value) => { try {
console.log(`Succeeded in setting system date. Data:` + JSON.stringify(value)); systemTime.setDate(date).then(() => {
}).catch((error) => { console.info(`Succeeded in setting date.`);
console.error(`Failed to set system date. Cause:` + JSON.stringify(error)); }).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.getDate<sup>8+</sup> ## systemTime.getDate<sup>8+</sup>
...@@ -400,19 +556,31 @@ getDate(callback: AsyncCallback&lt;Date&gt;): void ...@@ -400,19 +556,31 @@ getDate(callback: AsyncCallback&lt;Date&gt;): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------- | ---- | --------------------- | | -------- | ------------------------- | ---- | ---------------------------- |
| callback | AsyncCallback&lt;Date&gt; | 是 | 回调函数，返回当前系统日期。 | | callback | AsyncCallback&lt;Date&gt; | 是 | 回调函数，返回当前系统日期。 |
**错误码：**
以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------------------------------- |
| -1 | The parameter check failed or system error. |
**示例：** **示例：**
```js ```js
systemTime.getDate((error, data) => { try {
systemTime.getDate((error, date) => {
if (error) { if (error) {
console.error(`Failed to get system date. Cause:` + JSON.stringify(error)); console.info(`Failed to get date. message: ${error.message}, code: ${error.code}`);
return; 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.getDate<sup>8+</sup> ## systemTime.getDate<sup>8+</sup>
...@@ -426,17 +594,29 @@ getDate(): Promise&lt;Date&gt; ...@@ -426,17 +594,29 @@ getDate(): Promise&lt;Date&gt;
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | ----------------------------------------- | | ------------------- | ------------------------------- |
| Promise&lt;Date&gt; | Promise对象，返回当前系统日期。 | | Promise&lt;Date&gt; | Promise对象，返回当前系统日期。 |
**错误码：**
以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------------------------------- |
| -1 | The parameter check failed or system error. |
**示例：** **示例：**
```js ```js
systemTime.getDate().then((data) => { try {
console.log(`Succeeded in getting system date. Data:` + JSON.stringify(data)); systemTime.getDate().then((date) => {
}).catch((error) => { console.info(`Succeeded in getting date : ${date}`);
console.error(`Failed to get system date. Cause:` + JSON.stringify(error)); }).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 ## systemTime.setTimezone
...@@ -452,20 +632,32 @@ setTimezone(timezone: string, callback: AsyncCallback&lt;void&gt;): void ...@@ -452,20 +632,32 @@ setTimezone(timezone: string, callback: AsyncCallback&lt;void&gt;): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------- | ---- | -------------------------- | | -------- | ------------------------- | ---- | ------------------------------------------------------- |
| timezone | string | 是 | 系统时区。 具体可见[支持的系统时区](#支持的系统时区) 。 | | timezone | string | 是 | 系统时区。 具体可见[支持的系统时区](#支持的系统时区) 。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
**错误码：**
以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ |
| -1 | The parameter check failed or permission denied or system error. |
**示例：** **示例：**
```js ```js
systemTime.setTimezone('Asia/Shanghai', (error, data) => { try {
systemTime.setTimezone('Asia/Shanghai', (error) => {
if (error) { if (error) {
console.error('Failed to set system time zone. Cause:' + JSON.stringify(error)); console.info(`Failed to setting timezone. message: ${error.message}, code: ${error.code}`);
return; return;
} }
console.info('Succeeded in setting system time zone. Data:' + JSON.stringify(data)); console.info(`Succeeded in setting timezone.`);
}); });
} catch(e) {
console.info(`Failed to set timezone. message: ${e.message}, code: ${e.code}`);
}
``` ```
## systemTime.setTimezone ## systemTime.setTimezone
...@@ -481,23 +673,35 @@ setTimezone(timezone: string): Promise&lt;void&gt; ...@@ -481,23 +673,35 @@ setTimezone(timezone: string): Promise&lt;void&gt;
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ---------- | | -------- | ------ | ---- | ------------------------------------------------------ |
| timezone | string | 是 | 系统时区。具体可见[支持的系统时区](#支持的系统时区) 。 | | timezone | string | 是 | 系统时区。具体可见[支持的系统时区](#支持的系统时区) 。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | -------------------- | | ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 | | Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**错误码：**
以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ |
| -1 | The parameter check failed or permission denied or system error. |
**示例：** **示例：**
```js ```js
systemTime.setTimezone('Asia/Shanghai').then((data) => { try {
console.log(`Succeeded in setting system time zone. Data:` + JSON.stringify(data)); systemTime.setTimezone('Asia/Shanghai').then(() => {
}).catch((error) => { console.info(`Succeeded in setting timezone.`);
console.error(`Failed to set system time zone. Cause:` + JSON.stringify(error)); }).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.getTimezone<sup>8+</sup> ## systemTime.getTimezone<sup>8+</sup>
...@@ -511,19 +715,31 @@ getTimezone(callback: AsyncCallback&lt;string&gt;): void ...@@ -511,19 +715,31 @@ getTimezone(callback: AsyncCallback&lt;string&gt;): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------- | ---- | ------------------------ | | -------- | --------------------------- | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback&lt;string&gt; | 是 | 回调函数，返回系统时区。具体可见[支持的系统时区](#支持的系统时区) 。 | | callback | AsyncCallback&lt;string&gt; | 是 | 回调函数，返回系统时区。具体可见[支持的系统时区](#支持的系统时区) 。 |
**错误码：**
以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------------------------------- |
| -1 | The parameter check failed or system error. |
**示例：** **示例：**
```js ```js
systemTime.getTimezone((error, data) => { try {
systemTime.getTimezone((error, data) => {
if (error) { if (error) {
console.error(`Failed to get system time zone. Cause:` + JSON.stringify(error)); console.info(`Failed to get timezone. message: ${error.message}, code: ${error.code}`);
return; 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.getTimezone<sup>8+</sup> ## systemTime.getTimezone<sup>8+</sup>
...@@ -537,17 +753,29 @@ getTimezone(): Promise&lt;string&gt; ...@@ -537,17 +753,29 @@ getTimezone(): Promise&lt;string&gt;
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | ------------------------------------- | | --------------------- | ------------------------------------------------------------ |
| Promise&lt;string&gt; | Promise对象，返回系统时区。具体可见[支持的系统时区](#支持的系统时区) 。 | | Promise&lt;string&gt; | Promise对象，返回系统时区。具体可见[支持的系统时区](#支持的系统时区) 。 |
**错误码：**
以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)。
| 错误码ID | 错误信息 |
| -------- | ------------------------------------------- |
| -1 | The parameter check failed or system error. |
**示例：** **示例：**
```js ```js
systemTime.getTimezone().then((data) => { try {
console.log(`Succeeded in getting system time zone. Data:` + JSON.stringify(data)); systemTime.getTimezone().then((data) => {
}).catch((error) => { console.info(`Succeeded in getting timezone: ${data}`);
console.error(`Failed to get system time zone. Cause:` + JSON.stringify(error)); }).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}`);
}
``` ```
## 支持的系统时区 ## 支持的系统时区
...@@ -555,7 +783,7 @@ systemTime.getTimezone().then((data) => { ...@@ -555,7 +783,7 @@ systemTime.getTimezone().then((data) => {
支持的系统时区及各时区与0时区相比的偏移量（单位：h）可见下表。 支持的系统时区及各时区与0时区相比的偏移量（单位：h）可见下表。
| 时区 | 偏移量 | | 时区 | 偏移量 |
| ------------------------------ | --------------------- | | ------------------------------ | ------ |
| Antarctica/McMurdo | 12 | | Antarctica/McMurdo | 12 |
| America/Argentina/Buenos_Aires | -3 | | America/Argentina/Buenos_Aires | -3 |
| Australia/Sydney | 10 | | Australia/Sydney | 10 |
......
zh-cn/application-dev/reference/apis/js-apis-system-timer.md
浏览文件 @ 8ff6ec1b
...@@ -21,7 +21,7 @@ import systemTimer from '@ohos.systemTimer'; ...@@ -21,7 +21,7 @@ import systemTimer from '@ohos.systemTimer';
**系统能力：** SystemCapability.MiscServices.Time **系统能力：** SystemCapability.MiscServices.Time
| 名称 | 类型 | 值 | 说明 | | 名称 | 类型 | 值 | 说明 |
| ------------------- | ------ | ---- | ---------------------------- | | ------------------- | ------ | ---- | ------------------------------------------------------------ |
| TIMER_TYPE_REALTIME | number | 1 | 系统启动时间定时器。（定时器启动时间不能晚于当前设置的系统时间） | | TIMER_TYPE_REALTIME | number | 1 | 系统启动时间定时器。（定时器启动时间不能晚于当前设置的系统时间） |
| TIMER_TYPE_WAKEUP | number | 2 | 唤醒定时器。 | | TIMER_TYPE_WAKEUP | number | 2 | 唤醒定时器。 |
| TIMER_TYPE_EXACT | number | 4 | 精准定时器。 | | TIMER_TYPE_EXACT | number | 4 | 精准定时器。 |
...@@ -34,11 +34,11 @@ import systemTimer from '@ohos.systemTimer'; ...@@ -34,11 +34,11 @@ import systemTimer from '@ohos.systemTimer';
**系统能力：** SystemCapability.MiscServices.Time **系统能力：** SystemCapability.MiscServices.Time
| 名称 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| --------- | --------------------------------- | ---- | ------------------------------------------------------------ | | --------- | --------------------------------------------- | ---- | ------------------------------------------------------------ |
| type | number | 是 | 定时器类型。<br>取值为1时，表示为系统启动时间定时器（定时器启动时间不能晚于当前设置的系统时间） ；<br>取值为2时，表示为唤醒定时器；<br>取值为4时，表示为精准定时器；<br>取值为5时，表示为IDLE模式定时器（暂不支持）。 | | type | number | 是 | 定时器类型。<br>取值为1，表示为系统启动时间定时器（定时器启动时间不能晚于当前设置的系统时间） ；<br>取值为2，表示为唤醒定时器；<br>取值为4，表示为精准定时器；<br>取值为8，表示为IDLE模式定时器（暂不支持）。 |
| repeat | boolean | 是 | true为循环定时器，false为单次定时器。 | | repeat | boolean | 是 | true为循环定时器，false为单次定时器。 |
| interval | number | 否 | 如果是循环定时器，repeat值应大于5000毫秒，非重复定时器置为0。 | | interval | number | 否 | 如果是循环定时器，repeat值应大于5000毫秒，非重复定时器置为0。 |
| wantAgent | [WantAgent](js-apis-wantAgent.md) | 否 | 设置通知的WantAgent，定时器到期后通知。（支持拉起应用MainAbility，暂不支持拉起ServiceAbility。） | | wantAgent | [WantAgent](js-apis-app-ability-wantAgent.md) | 否 | 设置通知的WantAgent，定时器到期后通知。（支持拉起应用MainAbility，暂不支持拉起ServiceAbility。） |
| callback | number | 是 | 以回调函数的形式返回定时器的ID。 | | callback | number | 是 | 以回调函数的形式返回定时器的ID。 |
...@@ -66,13 +66,17 @@ export default { ...@@ -66,13 +66,17 @@ export default {
type: systemTimer.TIMER_TYPE_REALTIME, type: systemTimer.TIMER_TYPE_REALTIME,
repeat: false repeat: false
}; };
systemTimer.createTimer(options, (error, data) => { try {
systemTimer.createTimer(options, (error, timerId) => {
if (error) { if (error) {
console.error(`Failed to create timer. Cause:` + JSON.stringify(error)); console.info(`Failed to create timer. message: ${error.message}, code: ${error.code}`);
return; return;
} }
console.log(`Succeeded in creating timer. Data:` + JSON.stringify(data)); console.info(`Succeeded in creating timer. timerId: ${timerId}`);
}); });
} catch(e) {
console.info(`Failed to create timer. message: ${e.message}, code: ${e.code}`);
}
} }
} }
``` ```
...@@ -106,11 +110,15 @@ export default { ...@@ -106,11 +110,15 @@ export default {
type: systemTimer.TIMER_TYPE_REALTIME, type: systemTimer.TIMER_TYPE_REALTIME,
repeat:false repeat:false
}; };
systemTimer.createTimer(options).then((data) => { try {
console.log(`Succeeded in creating timer. Data:` + JSON.stringify(data)); systemTimer.createTimer(options).then((timerId) => {
console.info(`Succeeded in creating timer. timerId: ${timerId}`);
}).catch((error) => { }).catch((error) => {
console.error(`Failed to create timer. Cause:` + JSON.stringify(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}`);
}
} }
} }
``` ```
...@@ -140,15 +148,20 @@ export default { ...@@ -140,15 +148,20 @@ export default {
type: systemTimer.TIMER_TYPE_REALTIME, type: systemTimer.TIMER_TYPE_REALTIME,
repeat:false repeat:false
} }
let timerId = await systemTimer.createTimer(options) let timerId = await systemTimer.createTimer(options);
let triggerTime = new Date().getTime() let triggerTime = new Date().getTime();
triggerTime += 3000 triggerTime += 3000;
try {
systemTimer.startTimer(timerId, triggerTime, (error) => { systemTimer.startTimer(timerId, triggerTime, (error) => {
if (error) { if (error) {
console.error(`Failed to start timer. Cause:` + JSON.stringify(error)); console.info(`Failed to start timer. message: ${error.message}, code: ${error.code}`);
return; return;
} }
console.info(`Succeeded in starting timer.`);
}); });
} catch(e) {
console.info(`Failed to start timer. message: ${e.message}, code: ${e.code}`);
}
} }
} }
``` ```
...@@ -183,14 +196,18 @@ export default { ...@@ -183,14 +196,18 @@ export default {
type: systemTimer.TIMER_TYPE_REALTIME, type: systemTimer.TIMER_TYPE_REALTIME,
repeat:false repeat:false
} }
let timerId = await systemTimer.createTimer(options) let timerId = await systemTimer.createTimer(options);
let triggerTime = new Date().getTime() let triggerTime = new Date().getTime();
triggerTime += 3000 triggerTime += 3000;
systemTimer.startTimer(timerId, triggerTime).then((data) => { try {
console.log(`Succeeded in startting timer. Data:` + JSON.stringify(data)); systemTimer.startTimer(timerId, triggerTime).then(() => {
console.info(`Succeeded in starting timer.`);
}).catch((error) => { }).catch((error) => {
console.error(`Failed to start timer. Cause:` + JSON.stringify(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}`);
}
} }
} }
``` ```
...@@ -219,16 +236,21 @@ export default { ...@@ -219,16 +236,21 @@ export default {
type: systemTimer.TIMER_TYPE_REALTIME, type: systemTimer.TIMER_TYPE_REALTIME,
repeat:false repeat:false
} }
let timerId = await systemTimer.createTimer(options) let timerId = await systemTimer.createTimer(options);
let triggerTime = new Date().getTime() let triggerTime = new Date().getTime();
triggerTime += 3000 triggerTime += 3000;
systemTimer.startTimer(timerId, triggerTime) systemTimer.startTimer(timerId, triggerTime);
try {
systemTimer.stopTimer(timerId, (error) => { systemTimer.stopTimer(timerId, (error) => {
if (error) { if (error) {
console.error(`Failed to stop timer. Cause:` + JSON.stringify(error)); console.info(`Failed to stop timer. message: ${error.message}, code: ${error.code}`);
return; return;
} }
console.info(`Succeeded in stopping timer.`);
}); });
} catch(e) {
console.info(`Failed to stop timer. message: ${e.message}, code: ${e.code}`);
}
} }
} }
``` ```
...@@ -262,15 +284,19 @@ export default { ...@@ -262,15 +284,19 @@ export default {
type: systemTimer.TIMER_TYPE_REALTIME, type: systemTimer.TIMER_TYPE_REALTIME,
repeat:false repeat:false
} }
let timerId = await systemTimer.createTimer(options) let timerId = await systemTimer.createTimer(options);
let triggerTime = new Date().getTime() let triggerTime = new Date().getTime();
triggerTime += 3000 triggerTime += 3000;
systemTimer.startTimer(timerId, triggerTime) systemTimer.startTimer(timerId, triggerTime);
systemTimer.stopTimer(timerId).then((data) => { try {
console.log(`Succeeded in stopping timer. Data:` + JSON.stringify(data)); systemTimer.stopTimer(timerId).then(() => {
console.info(`Succeeded in stopping timer.`);
}).catch((error) => { }).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}`);
}
} }
} }
``` ```
...@@ -299,17 +325,22 @@ export default { ...@@ -299,17 +325,22 @@ export default {
type: systemTimer.TIMER_TYPE_REALTIME, type: systemTimer.TIMER_TYPE_REALTIME,
repeat:false repeat:false
} }
let timerId = await systemTimer.createTimer(options) let timerId = await systemTimer.createTimer(options);
let triggerTime = new Date().getTime() let triggerTime = new Date().getTime();
triggerTime += 3000 triggerTime += 3000;
systemTimer.startTimer(timerId, triggerTime) systemTimer.startTimer(timerId, triggerTime);
systemTimer.stopTimer(timerId) systemTimer.stopTimer(timerId);
try {
systemTimer.destroyTimer(timerId, (error) => { systemTimer.destroyTimer(timerId, (error) => {
if (error) { if (error) {
console.error(`Failed to destroy timer. Cause:` + JSON.stringify(error)); console.info(`Failed to destroy timer. message: ${error.message}, code: ${error.code}`);
return; return;
} }
console.info(`Succeeded in destroying timer.`);
}); });
} catch(e) {
console.info(`Failed to destroying timer. message: ${e.message}, code: ${e.code}`);
}
} }
} }
``` ```
...@@ -343,16 +374,20 @@ export default { ...@@ -343,16 +374,20 @@ export default {
type: systemTimer.TIMER_TYPE_REALTIME, type: systemTimer.TIMER_TYPE_REALTIME,
repeat:false repeat:false
} }
let timerId = await systemTimer.createTimer(options) let timerId = await systemTimer.createTimer(options);
let triggerTime = new Date().getTime() let triggerTime = new Date().getTime();
triggerTime += 3000 triggerTime += 3000;
systemTimer.startTimer(timerId, triggerTime) systemTimer.startTimer(timerId, triggerTime);
systemTimer.stopTimer(timerId) systemTimer.stopTimer(timerId);
systemTimer.destroyTimer(timerId).then((data) => { try {
console.log(`Succeeded in destroying timer. Data:` + JSON.stringify(data)); systemTimer.destroyTimer(timerId).then(() => {
console.info(`Succeeded in destroying timer.`);
}).catch((error) => { }).catch((error) => {
console.error(`Failed to destroy timer. Cause:` + JSON.stringify(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
zh-cn/application-dev/reference/errorcodes/errorcode-time.md 0 → 100644
浏览文件 @ 8ff6ec1b
# 时间时区服务错误码
## -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. 系统运行异常。确认内存是否足够。
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或