Skip to content

D
Docs

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

通知 161
Star 293
Fork 28
D
Docs
提交 424e39c5 编写于 作者: W wangtong
浏览文件
操作

回合monthly 

Signed-off-by: Nwangtong <wangtong94@huawei.com>
上级 e5d7149a
隐藏空白更改
内联 并排
Showing with 1084 addition and 300 deletion
zh-cn/application-dev/reference/apis/js-apis-system-date-time.md 0 → 100644
浏览文件 @ 424e39c5
# @ohos.systemDateTime (系统时间、时区)
本模块主要由系统时间和系统时区功能组成。开发者可以设置、获取系统时间及系统时区。
> **说明：**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块
```js
import systemDateTime from '@ohos.systemDateTime';
```
## systemDateTime.setTime
setTime(time : number, callback : AsyncCallback&lt;void&gt;) : void
设置系统时间，使用callback异步回调。
**系统接口：** 此接口为系统接口
**系统能力：** SystemCapability.MiscServices.Time
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------- | ---- | ---------------- |
| time | number | 是 | 目标时间戳（ms）。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
**示例：**
```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&lt;void&gt;
设置系统时间，使用Promise异步回调。
**系统接口：** 此接口为系统接口
**系统能力：** SystemCapability.MiscServices.Time
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------ |
| time | number | 是 | 目标时间戳（ms）。 |
**返回值：**
| 类型 | 说明 |
| ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的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&lt;number&gt;): 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
浏览文件 @ 424e39c5
...@@ -24,10 +24,10 @@ setTime(time : number, callback : AsyncCallback&lt;void&gt;) : void ...@@ -24,10 +24,10 @@ 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; | 是 | 回调函数。 |
**错误码：** **错误码：**
...@@ -42,13 +42,17 @@ setTime(time : number, callback : AsyncCallback&lt;void&gt;) : void ...@@ -42,13 +42,17 @@ setTime(time : number, callback : AsyncCallback&lt;void&gt;) : void
```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
...@@ -86,11 +90,15 @@ setTime(time : number) : Promise&lt;void&gt; ...@@ -86,11 +90,15 @@ setTime(time : number) : Promise&lt;void&gt;
```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>
...@@ -103,10 +111,10 @@ getCurrentTime(isNano: boolean, callback: AsyncCallback&lt;number&gt;): void ...@@ -103,10 +111,10 @@ 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纪元以来经过的时间。 |
**错误码：** **错误码：**
...@@ -119,13 +127,17 @@ getCurrentTime(isNano: boolean, callback: AsyncCallback&lt;number&gt;): void ...@@ -119,13 +127,17 @@ getCurrentTime(isNano: boolean, callback: AsyncCallback&lt;number&gt;): void
**示例：** **示例：**
```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>
...@@ -138,9 +150,9 @@ getCurrentTime(callback: AsyncCallback&lt;number&gt;): void ...@@ -138,9 +150,9 @@ getCurrentTime(callback: AsyncCallback&lt;number&gt;): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------- | ---- | ---------------------------------- | | -------- | --------------------------- | ---- | ---------------------------------------- |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调函数，返回自Unix纪元以来经过的时间。 | | callback | AsyncCallback&lt;number&gt; | 是 | 回调函数，返回自Unix纪元以来经过的时间。 |
**错误码：** **错误码：**
...@@ -153,13 +165,17 @@ getCurrentTime(callback: AsyncCallback&lt;number&gt;): void ...@@ -153,13 +165,17 @@ getCurrentTime(callback: AsyncCallback&lt;number&gt;): void
**示例：** **示例：**
```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>
...@@ -172,14 +188,14 @@ getCurrentTime(isNano?: boolean): Promise&lt;number&gt; ...@@ -172,14 +188,14 @@ 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纪元以来经过的时间。 |
**错误码：** **错误码：**
...@@ -193,11 +209,15 @@ getCurrentTime(isNano?: boolean): Promise&lt;number&gt; ...@@ -193,11 +209,15 @@ getCurrentTime(isNano?: boolean): Promise&lt;number&gt;
**示例：** **示例：**
```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>
...@@ -210,8 +230,8 @@ getRealActiveTime(isNano: boolean, callback: AsyncCallback&lt;number&gt;): void ...@@ -210,8 +230,8 @@ 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; | 是 | 回调函数，返回自系统启动以来经过的时间，但不包括度睡眠时间。 |
...@@ -226,13 +246,17 @@ getRealActiveTime(isNano: boolean, callback: AsyncCallback&lt;number&gt;): void ...@@ -226,13 +246,17 @@ getRealActiveTime(isNano: boolean, callback: AsyncCallback&lt;number&gt;): void
**示例：** **示例：**
```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>
...@@ -245,8 +269,8 @@ getRealActiveTime(callback: AsyncCallback&lt;number&gt;): void ...@@ -245,8 +269,8 @@ getRealActiveTime(callback: AsyncCallback&lt;number&gt;): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------- | ---- | --------------------- | | -------- | --------------------------- | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调函数，返回自系统启动以来经过的时间，但不包括度睡眠时间。 | | callback | AsyncCallback&lt;number&gt; | 是 | 回调函数，返回自系统启动以来经过的时间，但不包括度睡眠时间。 |
**错误码：** **错误码：**
...@@ -260,13 +284,17 @@ getRealActiveTime(callback: AsyncCallback&lt;number&gt;): void ...@@ -260,13 +284,17 @@ getRealActiveTime(callback: AsyncCallback&lt;number&gt;): void
**示例：** **示例：**
```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>
...@@ -279,14 +307,14 @@ getRealActiveTime(isNano?: boolean): Promise&lt;number&gt; ...@@ -279,14 +307,14 @@ 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对象，返回自系统启动以来经过的时间，但不包括深度睡眠时间。 |
**错误码：** **错误码：**
...@@ -300,11 +328,15 @@ getRealActiveTime(isNano?: boolean): Promise&lt;number&gt; ...@@ -300,11 +328,15 @@ getRealActiveTime(isNano?: boolean): Promise&lt;number&gt;
**示例：** **示例：**
```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>
...@@ -317,8 +349,8 @@ getRealTime(isNano: boolean, callback: AsyncCallback&lt;number&gt;): void ...@@ -317,8 +349,8 @@ 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; | 是 | 回调函数，返回自系统启动以来经过的时间，包括深度睡眠时间。 |
...@@ -333,13 +365,17 @@ getRealTime(isNano: boolean, callback: AsyncCallback&lt;number&gt;): void ...@@ -333,13 +365,17 @@ getRealTime(isNano: boolean, callback: AsyncCallback&lt;number&gt;): void
**示例：** **示例：**
```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>
...@@ -352,9 +388,9 @@ getRealTime(callback: AsyncCallback&lt;number&gt;): void ...@@ -352,9 +388,9 @@ getRealTime(callback: AsyncCallback&lt;number&gt;): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------- | ---- | --------------------------- | | -------- | --------------------------- | ---- | ---------------------------------------------------------- |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调函数，返回自系统启动以来经过的时间，包括深度睡眠时间。 | | callback | AsyncCallback&lt;number&gt; | 是 | 回调函数，返回自系统启动以来经过的时间，包括深度睡眠时间。 |
**错误码：** **错误码：**
...@@ -367,13 +403,17 @@ getRealTime(callback: AsyncCallback&lt;number&gt;): void ...@@ -367,13 +403,17 @@ getRealTime(callback: AsyncCallback&lt;number&gt;): void
**示例：** **示例：**
```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>
...@@ -386,14 +426,14 @@ getRealTime(isNano?: boolean): Promise&lt;number&gt; ...@@ -386,14 +426,14 @@ 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对象，返回自系统启动以来经过的时间，包括深度睡眠时间。 |
**错误码：** **错误码：**
...@@ -407,11 +447,15 @@ getRealTime(isNano?: boolean): Promise&lt;number&gt; ...@@ -407,11 +447,15 @@ getRealTime(isNano?: boolean): Promise&lt;number&gt;
**示例：** **示例：**
```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
...@@ -426,9 +470,9 @@ setDate(date: Date, callback: AsyncCallback&lt;void&gt;): void ...@@ -426,9 +470,9 @@ setDate(date: Date, callback: AsyncCallback&lt;void&gt;): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------- | ---- | --------------------- | | -------- | ------------------------- | ---- | ---------- |
| date | Date | 是 | 目标日期。 | | date | Date | 是 | 目标日期。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
**错误码：** **错误码：**
...@@ -442,14 +486,18 @@ setDate(date: Date, callback: AsyncCallback&lt;void&gt;): void ...@@ -442,14 +486,18 @@ setDate(date: Date, callback: AsyncCallback&lt;void&gt;): void
**示例：** **示例：**
```js ```js
let data = new Date(); let date = new Date();
systemTime.setDate(data,(error, data) => { try {
if (error) { systemTime.setDate(date, (error) => {
console.error('Failed to set system date. Cause:' + JSON.stringify(error)); if (error) {
return; console.info(`Failed to setting date. message: ${error.message}, code: ${error.code}`);
} return;
console.info('Succeeded in setting system date. Data:' + JSON.stringify(data)); }
}); console.info(`Succeeded in setting date.`);
});
} catch(e) {
console.info(`Failed to set date. message: ${e.message}, code: ${e.code}`);
}
``` ```
## systemTime.setDate ## systemTime.setDate
...@@ -470,8 +518,8 @@ setDate(date: Date): Promise&lt;void&gt; ...@@ -470,8 +518,8 @@ setDate(date: Date): Promise&lt;void&gt;
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | -------------------- | | ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 | | Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**错误码：** **错误码：**
...@@ -485,12 +533,16 @@ setDate(date: Date): Promise&lt;void&gt; ...@@ -485,12 +533,16 @@ setDate(date: Date): Promise&lt;void&gt;
**示例：** **示例：**
```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>
...@@ -503,8 +555,8 @@ getDate(callback: AsyncCallback&lt;Date&gt;): void ...@@ -503,8 +555,8 @@ getDate(callback: AsyncCallback&lt;Date&gt;): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------- | ---- | --------------------- | | -------- | ------------------------- | ---- | ---------------------------- |
| callback | AsyncCallback&lt;Date&gt; | 是 | 回调函数，返回当前系统日期。 | | callback | AsyncCallback&lt;Date&gt; | 是 | 回调函数，返回当前系统日期。 |
**错误码：** **错误码：**
...@@ -518,13 +570,17 @@ getDate(callback: AsyncCallback&lt;Date&gt;): void ...@@ -518,13 +570,17 @@ getDate(callback: AsyncCallback&lt;Date&gt;): void
**示例：** **示例：**
```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>
...@@ -537,18 +593,30 @@ getDate(): Promise&lt;Date&gt; ...@@ -537,18 +593,30 @@ 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
...@@ -563,10 +631,10 @@ setTimezone(timezone: string, callback: AsyncCallback&lt;void&gt;): void ...@@ -563,10 +631,10 @@ setTimezone(timezone: string, callback: AsyncCallback&lt;void&gt;): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------- | ---- | -------------------------- | | -------- | ------------------------- | ---- | ------------------------------------------------------- |
| timezone | string | 是 | 系统时区。 具体可见[支持的系统时区](#支持的系统时区) 。 | | timezone | string | 是 | 系统时区。 具体可见[支持的系统时区](#支持的系统时区) 。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
**错误码：** **错误码：**
...@@ -579,13 +647,17 @@ setTimezone(timezone: string, callback: AsyncCallback&lt;void&gt;): void ...@@ -579,13 +647,17 @@ setTimezone(timezone: string, callback: AsyncCallback&lt;void&gt;): void
**示例：** **示例：**
```js ```js
systemTime.setTimezone('Asia/Shanghai', (error, data) => { try {
if (error) { systemTime.setTimezone('Asia/Shanghai', (error) => {
console.error('Failed to set system time zone. Cause:' + JSON.stringify(error)); if (error) {
return; console.info(`Failed to setting timezone. message: ${error.message}, code: ${error.code}`);
} 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
...@@ -600,14 +672,14 @@ setTimezone(timezone: string): Promise&lt;void&gt; ...@@ -600,14 +672,14 @@ setTimezone(timezone: string): Promise&lt;void&gt;
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ---------- | | -------- | ------ | ---- | ------------------------------------------------------ |
| timezone | string | 是 | 系统时区。具体可见[支持的系统时区](#支持的系统时区) 。 | | timezone | string | 是 | 系统时区。具体可见[支持的系统时区](#支持的系统时区) 。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | -------------------- | | ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 | | Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**错误码：** **错误码：**
...@@ -621,11 +693,15 @@ setTimezone(timezone: string): Promise&lt;void&gt; ...@@ -621,11 +693,15 @@ setTimezone(timezone: string): Promise&lt;void&gt;
**示例：** **示例：**
```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>
...@@ -638,8 +714,8 @@ getTimezone(callback: AsyncCallback&lt;string&gt;): void ...@@ -638,8 +714,8 @@ getTimezone(callback: AsyncCallback&lt;string&gt;): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------- | ---- | ------------------------ | | -------- | --------------------------- | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback&lt;string&gt; | 是 | 回调函数，返回系统时区。具体可见[支持的系统时区](#支持的系统时区) 。 | | callback | AsyncCallback&lt;string&gt; | 是 | 回调函数，返回系统时区。具体可见[支持的系统时区](#支持的系统时区) 。 |
**错误码：** **错误码：**
...@@ -653,13 +729,17 @@ getTimezone(callback: AsyncCallback&lt;string&gt;): void ...@@ -653,13 +729,17 @@ getTimezone(callback: AsyncCallback&lt;string&gt;): void
**示例：** **示例：**
```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>
...@@ -672,8 +752,8 @@ getTimezone(): Promise&lt;string&gt; ...@@ -672,8 +752,8 @@ getTimezone(): Promise&lt;string&gt;
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | ------------------------------------- | | --------------------- | ------------------------------------------------------------ |
| Promise&lt;string&gt; | Promise对象，返回系统时区。具体可见[支持的系统时区](#支持的系统时区) 。 | | Promise&lt;string&gt; | Promise对象，返回系统时区。具体可见[支持的系统时区](#支持的系统时区) 。 |
**错误码：** **错误码：**
...@@ -687,47 +767,51 @@ getTimezone(): Promise&lt;string&gt; ...@@ -687,47 +767,51 @@ getTimezone(): Promise&lt;string&gt;
**示例：** **示例：**
```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}`);
}
``` ```
## 支持的系统时区 ## 支持的系统时区
支持的系统时区及各时区与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 |
| America/Noronha | -2 | | America/Noronha | -2 |
| America/St_Johns | -3 | | America/St_Johns | -3 |
| Africa/Kinshasa | 1 | | Africa/Kinshasa | 1 |
| America/Santiago | -3 | | America/Santiago | -3 |
| Asia/Shanghai | 8 | | Asia/Shanghai | 8 |
| Asia/Nicosia | 3 | | Asia/Nicosia | 3 |
| Europe/Berlin | 2 | | Europe/Berlin | 2 |
| America/Guayaquil | -5 | | America/Guayaquil | -5 |
| Europe/Madrid | 2 | | Europe/Madrid | 2 |
| Pacific/Pohnpei | 11 | | Pacific/Pohnpei | 11 |
| America/Godthab | -2 | | America/Godthab | -2 |
| Asia/Jakarta | 7 | | Asia/Jakarta | 7 |
| Pacific/Tarawa | 12 | | Pacific/Tarawa | 12 |
| Asia/Almaty | 6 | | Asia/Almaty | 6 |
| Pacific/Majuro | 12 | | Pacific/Majuro | 12 |
| Asia/Ulaanbaatar | 8 | | Asia/Ulaanbaatar | 8 |
| America/Mexico_City | -5 | | America/Mexico_City | -5 |
| Asia/Kuala_Lumpur | 8 | | Asia/Kuala_Lumpur | 8 |
| Pacific/Auckland | 12 | | Pacific/Auckland | 12 |
| Pacific/Tahiti | -10 | | Pacific/Tahiti | -10 |
| Pacific/Port_Moresby | 10 | | Pacific/Port_Moresby | 10 |
| Asia/Gaza | 3 | | Asia/Gaza | 3 |
| Europe/Lisbon | 1 | | Europe/Lisbon | 1 |
| Europe/Moscow | 3 | | Europe/Moscow | 3 |
| Europe/Kiev | 3 | | Europe/Kiev | 3 |
| Pacific/Wake | 12 | | Pacific/Wake | 12 |
| America/New_York | -4 | | America/New_York | -4 |
| Asia/Tashkent | 5 | | Asia/Tashkent | 5 |
\ No newline at end of file \ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-system-timer.md
浏览文件 @ 424e39c5
...@@ -20,12 +20,12 @@ import systemTimer from '@ohos.systemTimer'; ...@@ -20,12 +20,12 @@ 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 | 精准定时器。 |
| TIMER_TYPE_IDLE | number | 8 | IDLE模式定时器（暂不支持）。 | | TIMER_TYPE_IDLE | number | 8 | IDLE模式定时器（暂不支持）。 |
## TimerOptions ## TimerOptions
...@@ -33,13 +33,13 @@ import systemTimer from '@ohos.systemTimer'; ...@@ -33,13 +33,13 @@ 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。 |
## systemTimer.createTimer ## systemTimer.createTimer
...@@ -61,19 +61,23 @@ createTimer(options: TimerOptions, callback: AsyncCallback&lt;number&gt;): void ...@@ -61,19 +61,23 @@ createTimer(options: TimerOptions, callback: AsyncCallback&lt;number&gt;): void
```js ```js
export default { export default {
systemTimer () { systemTimer () {
let options = { let options = {
type: systemTimer.TIMER_TYPE_REALTIME, type: systemTimer.TIMER_TYPE_REALTIME,
repeat: false repeat: false
}; };
systemTimer.createTimer(options, (error, data) => { try {
if (error) { systemTimer.createTimer(options, (error, timerId) => {
console.error(`Failed to create timer. Cause:` + JSON.stringify(error)); if (error) {
return; console.info(`Failed to create timer. message: ${error.message}, code: ${error.code}`);
} 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}`);
} }
}
} }
``` ```
...@@ -101,17 +105,21 @@ createTimer(options: TimerOptions): Promise&lt;number&gt; ...@@ -101,17 +105,21 @@ createTimer(options: TimerOptions): Promise&lt;number&gt;
```js ```js
export default { export default {
systemTimer () { systemTimer () {
let options = { let options = {
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) => {
}).catch((error) => { console.info(`Succeeded in creating timer. timerId: ${timerId}`);
console.error(`Failed to create timer. Cause:` + JSON.stringify(error)); }).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&lt;void&g ...@@ -135,21 +143,26 @@ startTimer(timer: number, triggerTime: number, callback: AsyncCallback&lt;void&g
```js ```js
export default { export default {
async systemTimer () { async systemTimer () {
let options = { let options = {
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}`);
} }
}
} }
``` ```
...@@ -178,20 +191,24 @@ startTimer(timer: number, triggerTime: number): Promise&lt;void&gt; ...@@ -178,20 +191,24 @@ startTimer(timer: number, triggerTime: number): Promise&lt;void&gt;
```js ```js
export default { export default {
async systemTimer (){ async systemTimer (){
let options = { let options = {
type: systemTimer.TIMER_TYPE_REALTIME, type: systemTimer.TIMER_TYPE_REALTIME,
repeat:false 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));
});
} }
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&lt;void&gt;): void ...@@ -215,20 +232,25 @@ stopTimer(timer: number, callback: AsyncCallback&lt;void&gt;): void
```js ```js
export default { export default {
async systemTimer () { async systemTimer () {
let options = { let options = {
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}`);
}
} }
} }
``` ```
...@@ -258,19 +280,23 @@ stopTimer(timer: number): Promise&lt;void&gt; ...@@ -258,19 +280,23 @@ stopTimer(timer: number): Promise&lt;void&gt;
```js ```js
export default { export default {
async systemTimer (){ async systemTimer (){
let options = { let options = {
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}`);
}
} }
} }
``` ```
...@@ -294,23 +320,28 @@ destroyTimer(timer: number, callback: AsyncCallback&lt;void&gt;): void ...@@ -294,23 +320,28 @@ destroyTimer(timer: number, callback: AsyncCallback&lt;void&gt;): void
```js ```js
export default { export default {
async systemTimer () { async systemTimer () {
let options = { let options = {
type: systemTimer.TIMER_TYPE_REALTIME, type: systemTimer.TIMER_TYPE_REALTIME,
repeat:false 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) console.info(`Succeeded in destroying timer.`);
let triggerTime = new Date().getTime() });
triggerTime += 3000 } catch(e) {
systemTimer.startTimer(timerId, triggerTime) console.info(`Failed to destroying timer. message: ${e.message}, code: ${e.code}`);
systemTimer.stopTimer(timerId)
systemTimer.destroyTimer(timerId, (error) => {
if (error) {
console.error(`Failed to destroy timer. Cause:` + JSON.stringify(error));
return;
}
});
} }
}
} }
``` ```
...@@ -338,21 +369,25 @@ destroyTimer(timer: number): Promise&lt;void&gt; ...@@ -338,21 +369,25 @@ destroyTimer(timer: number): Promise&lt;void&gt;
```js ```js
export default { export default {
async systemTimer (){ async systemTimer (){
let options = { let options = {
type: systemTimer.TIMER_TYPE_REALTIME, type: systemTimer.TIMER_TYPE_REALTIME,
repeat:false 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));
});
} }
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
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或