js-apis-system-time.md 27.3 KB
Newer Older
1
# @ohos.systemTime (系统时间、时区)
Z
zengyawen 已提交
2

M
MangTsang 已提交
3
本模块主要由系统时间和系统时区功能组成。开发者可以设置、获取系统时间及系统时区。
4

5 6
> **说明:**
>
7 8
> - 从API Version 9 开始,该模块接口不再维护,推荐使用新模块接口[@ohos.systemDateTime (系统时间、时区)](js-apis-system-date-time.md)
> - 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
Z
zengyawen 已提交
9 10

## 导入模块
Z
zengyawen 已提交
11

12
```js
Z
zengyawen 已提交
13 14 15
import systemTime from '@ohos.systemTime';
```

W
wangtong 已提交
16
## systemTime.setTime<sup>(deprecated)</sup>
Z
zengyawen 已提交
17 18 19

setTime(time : number, callback : AsyncCallback&lt;void&gt;) : void

20
设置系统时间,使用callback异步回调。
Z
zengyawen 已提交
21

22
**需要权限:** ohos.permission.SET_TIME
Z
zengyawen 已提交
23

24
**系统能力:** SystemCapability.MiscServices.Time
Z
zengyawen 已提交
25

26 27
**参数:**

28 29
| 参数名   | 类型            | 必填 | 说明                                       |
| -------- | ----------- | ---- | ---------------- |
30
| time     | number                    | 是   | 目标时间戳(ms)。                         |
31
| callback | AsyncCallback&lt;void&gt; | 是   | 回调函数。 |
Z
zengyawen 已提交
32

W
wangtong 已提交
33 34 35 36 37 38 39 40
**错误码:**

以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)

| 错误码ID | 错误信息                                                     |
| -------- | ------------------------------------------------------------ |
| -1       | The parameter check failed or permission denied or system error. |

41
**示例:**
42

43 44 45
```js
// time对应的时间为2021-01-20 02:36:25
let time = 1611081385000;
W
wangtong 已提交
46
try {
47 48 49 50 51 52 53
  systemTime.setTime(time, (error) => {
    if (error) {
      console.info(`Failed to setting time. message: ${error.message}, code: ${error.code}`);
      return;
    }
    }console.info(`Succeeded in setting time`);
  });
W
wangtong 已提交
54
} catch(e) {
55
  console.info(`Failed to set time. message: ${e.message}, code: ${e.code}`);
W
wangtong 已提交
56
}
57
```
Z
zengyawen 已提交
58

W
wangtong 已提交
59
## systemTime.setTime<sup>(deprecated)</sup>
Z
zengyawen 已提交
60 61 62

setTime(time : number) : Promise&lt;void&gt;

63
设置系统时间,使用Promise异步回调。
Z
zengyawen 已提交
64

65
**需要权限:** ohos.permission.SET_TIME
Z
zengyawen 已提交
66

67
**系统能力:** SystemCapability.MiscServices.Time
Z
zengyawen 已提交
68

69 70
**参数:**

71 72 73
| 参数名 | 类型   | 必填 | 说明               |
| ------ | ------ | ---- | ------------------ |
| time   | number | 是   | 目标时间戳(ms)。 |
74 75

**返回值:**
Z
zengyawen 已提交
76

77 78 79
| 类型                | 说明                      |
| ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
Z
zengyawen 已提交
80

W
wangtong 已提交
81 82 83 84 85 86 87 88
**错误码:**

以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)

| 错误码ID | 错误信息                                                     |
| -------- | ------------------------------------------------------------ |
| -1       | The parameter check failed or permission denied or system error. |

89
**示例:**
90

91 92 93
```js
// time对应的时间为2021-01-20 02:36:25
let time = 1611081385000;
W
wangtong 已提交
94
try {
95 96 97 98 99
  systemTime.setTime(time).then(() => {
    console.info(`Succeeded in setting time.`);
  }).catch((error) => {
    console.info(`Failed to setting time. message: ${error.message}, code: ${error.code}`);
  });
W
wangtong 已提交
100
} catch(e) {
101
  console.info(`Failed to set time. message: ${e.message}, code: ${e.code}`);
W
wangtong 已提交
102
}
103
```
Z
zengyawen 已提交
104

W
wangtong 已提交
105
## systemTime.getCurrentTime<sup>(deprecated)</sup>
Z
zengyawen 已提交
106

107
getCurrentTime(isNano: boolean, callback: AsyncCallback&lt;number&gt;): void
Z
zengyawen 已提交
108

109
获取自Unix纪元以来经过的时间,使用callback异步回调。
Z
zengyawen 已提交
110

111
**系统能力:** SystemCapability.MiscServices.Time
Z
zengyawen 已提交
112

113 114
**参数:**

115 116 117 118
| 参数名   | 类型       | 必填 | 说明                             |
| -------- | -------------- | ---- | ------------------ |
| isNano   | boolean                     | 是   | 返回结果是否为纳秒数。<br>- true:表示返回结果为纳秒数(ns)。 <br>- false:表示返回结果为毫秒数(ms)。 |
| callback | AsyncCallback&lt;number&gt; | 是   | 回调函数,返回自Unix纪元以来经过的时间。         |
Z
zengyawen 已提交
119

W
wangtong 已提交
120 121 122 123 124 125 126 127
**错误码:**

以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)

| 错误码ID | 错误信息                                    |
| -------- | ------------------------------------------- |
| -1       | The parameter check failed or system error. |

128
**示例:**
129

130
```js
W
wangtong 已提交
131
try {
132 133 134 135 136 137 138
  systemTime.getCurrentTime(true, (error, time) => {
    if (error) {
      console.info(`Failed to getting currentTime. message: ${error.message}, code: ${error.code}`);
      return;
    }
    console.info(`Succeeded in getting currentTime: ${time}`);
  });
W
wangtong 已提交
139
} catch(e) {
140
  console.info(`Failed to get currentTime. message: ${e.message}, code: ${e.code}`);
W
wangtong 已提交
141
}
142
```
Z
zengyawen 已提交
143

W
wangtong 已提交
144
## systemTime.getCurrentTime<sup>(deprecated)</sup>
145 146 147

getCurrentTime(callback: AsyncCallback&lt;number&gt;): void

148
获取自Unix纪元以来经过的时间,使用callback异步回调。
149 150 151 152 153

**系统能力:** SystemCapability.MiscServices.Time

**参数:**

154 155 156
| 参数名   | 类型               | 必填 | 说明                            |
| -------- | ----------- | ---- | ---------------------------------- |
| callback | AsyncCallback&lt;number&gt; | 是   | 回调函数,返回自Unix纪元以来经过的时间。         |
157

W
wangtong 已提交
158 159 160 161 162 163 164 165
**错误码:**

以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)

| 错误码ID | 错误信息                                    |
| -------- | ------------------------------------------- |
| -1       | The parameter check failed or system error. |

166 167
**示例:**

168
```js
W
wangtong 已提交
169
try {
170 171 172 173 174 175 176
  systemTime.getCurrentTime((error, time) => {
    if (error) {
      console.info(`Failed to getting currentTime. message: ${error.message}, code: ${error.code}`);
      return;
    }
    console.info(`Succeeded in getting currentTime : ${time}`);
  });
W
wangtong 已提交
177
} catch(e) {
178
  console.info(`Failed to get currentTime. message: ${e.message}, code: ${e.code}`);
W
wangtong 已提交
179
}
180
```
181

W
wangtong 已提交
182
## systemTime.getCurrentTime<sup>(deprecated)</sup>
Z
zengyawen 已提交
183 184 185

getCurrentTime(isNano?: boolean): Promise&lt;number&gt;

186
获取自Unix纪元以来经过的时间,使用Promise异步回调。
Z
zengyawen 已提交
187

188
**系统能力:** SystemCapability.MiscServices.Time
Z
zengyawen 已提交
189

190 191
**参数:**

192 193
| 参数名 | 类型    | 必填 | 说明                     |
| ------ | ------- | ---- | ------------------------- |
194
| isNano | boolean | 否   | 返回结果是否为纳秒数,默认值为false。<br/>默认值为false。<br/>- true:表示返回结果为纳秒数(ns)。 <br/>- false:表示返回结果为毫秒数(ms)。 |
Z
zengyawen 已提交
195

196 197
**返回值:**

198 199 200
| 类型        | 说明                               |
| --------------------- | --------------------------- |
| Promise&lt;number&gt; | Promise对象,返回自Unix纪元以来经过的时间。 |
Z
zengyawen 已提交
201

W
wangtong 已提交
202 203 204 205 206 207 208 209
**错误码:**

以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)

| 错误码ID | 错误信息                                    |
| -------- | ------------------------------------------- |
| -1       | The parameter check failed or system error. |

210
**示例:**
211

212
```js
W
wangtong 已提交
213
try {
214 215 216 217 218
  systemTime.getCurrentTime().then((time) => {
    console.info(`Succeeded in getting currentTime : ${time}`);
  }).catch((error) => {
    console.info(`Failed to getting currentTime. message: ${error.message}, code: ${error.code}`);
  });
W
wangtong 已提交
219
} catch(e) {
220
  console.info(`Failed to get currentTime. message: ${e.message}, code: ${e.code}`);
W
wangtong 已提交
221
}
222
```
Z
zengyawen 已提交
223

W
wangtong 已提交
224
## systemTime.getRealActiveTime<sup>(deprecated)</sup>
Z
zengyawen 已提交
225

226
getRealActiveTime(isNano: boolean, callback: AsyncCallback&lt;number&gt;): void
Z
zengyawen 已提交
227

228
获取自系统启动以来经过的时间,不包括深度睡眠时间,使用callback异步回调。
Z
zengyawen 已提交
229

230
**系统能力:** SystemCapability.MiscServices.Time
Z
zengyawen 已提交
231

232 233
**参数:**

234 235 236
| 参数名   | 类型                        | 必填 | 说明   |
| -------- | ---------- | ---- | -------------------------- |
| isNano   | boolean                     | 是   | 返回结果是否为纳秒数。<br/>- true:表示返回结果为纳秒数(ns)。 <br/>- false:表示返回结果为毫秒数(ms)。 |
237
| callback | AsyncCallback&lt;number&gt; | 是   | 回调函数,返回自系统启动以来经过的时间,但不包括度睡眠时间。 |
Z
zengyawen 已提交
238

W
wangtong 已提交
239 240 241 242 243 244 245 246
**错误码:**

以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)

| 错误码ID | 错误信息                                    |
| -------- | ------------------------------------------- |
| -1       | The parameter check failed or system error. |

247
**示例:**
248

249
```js
W
wangtong 已提交
250
try {
251 252 253 254 255 256 257
  systemTime.getRealActiveTime(true, (error, time) => {
    if (error) {
      console.info(`Failed to getting real active time. message: ${error.message}, code: ${error.code}`);
      return;
    }
    console.info(`Succeeded in getting real active time : ${time}`);
  });
W
wangtong 已提交
258
} catch(e) {
259
  console.info(`Failed to get real active time. message: ${e.message}, code: ${e.code}`);
W
wangtong 已提交
260
}
261
```
Z
zengyawen 已提交
262

W
wangtong 已提交
263
## systemTime.getRealActiveTime<sup>(deprecated)</sup>
264 265 266

getRealActiveTime(callback: AsyncCallback&lt;number&gt;): void

267
获取自系统启动以来经过的时间,不包括深度睡眠时间,使用callback异步回调。
268 269 270 271 272

**系统能力:** SystemCapability.MiscServices.Time

**参数:**

273 274
| 参数名   | 类型                        | 必填 | 说明    |
| -------- | -------------- | ---- | --------------------- |
275 276
| callback | AsyncCallback&lt;number&gt; | 是   | 回调函数,返回自系统启动以来经过的时间,但不包括度睡眠时间。 |

W
wangtong 已提交
277 278 279 280 281 282 283 284
**错误码:**

以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)

| 错误码ID | 错误信息                                    |
| -------- | ------------------------------------------- |
| -1       | The parameter check failed or system error. |

285 286
**示例:**

287
```js
W
wangtong 已提交
288
try {
289 290 291 292 293 294 295
  systemTime.getRealActiveTime((error, time) => {
    if (error) {
      console.info(`Failed to getting real active time. message: ${error.message}, code: ${error.code}`);
      return;
    }
    console.info(`Succeeded in getting real active time : ${time}`);
  });
W
wangtong 已提交
296
} catch(e) {
297
  console.info(`Failed to get real active time. message: ${e.message}, code: ${e.code}`);
W
wangtong 已提交
298
}
299
```
Z
zengyawen 已提交
300

W
wangtong 已提交
301
## systemTime.getRealActiveTime<sup>(deprecated)</sup>
Z
zengyawen 已提交
302 303 304

getRealActiveTime(isNano?: boolean): Promise&lt;number&gt;

305
获取自系统启动以来经过的时间,不包括深度睡眠时间,使用Promise异步回调。
Z
zengyawen 已提交
306

307
**系统能力:** SystemCapability.MiscServices.Time
Z
zengyawen 已提交
308

309 310
**参数:**

311 312
| 参数名 | 类型    | 必填 | 说明                              |
| ------ | ------- | ---- | ----------------------------------- |
313
| isNano | boolean | 否   | 返回结果是否为纳秒数,默认值为false。<br/>默认值为false。<br/>- true:表示返回结果为纳秒数(ns)。 <br/>- false:表示返回结果为毫秒数(ms)。 |
Z
zengyawen 已提交
314

315 316
**返回值:**

317 318 319
| 类型                  | 说明         |
| -------------- | -------------------------------- |
| Promise&lt;number&gt; | Promise对象,返回自系统启动以来经过的时间,但不包括深度睡眠时间。 |
Z
zengyawen 已提交
320

W
wangtong 已提交
321 322 323 324 325 326 327 328
**错误码:**

以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)

| 错误码ID | 错误信息                                    |
| -------- | ------------------------------------------- |
| -1       | The parameter check failed or system error. |

329
**示例:**
330

331
```js
W
wangtong 已提交
332
try {
333 334 335 336 337
  systemTime.getRealActiveTime().then((time) => {
    console.info(`Succeeded in getting real active time : ${time}`);
  }).catch((error) => {
    console.info(`Failed to getting real active time. message: ${error.message}, code: ${error.code}`);
  });
W
wangtong 已提交
338
} catch(e) {
339
  console.info(`Failed to get real active time. message: ${e.message}, code: ${e.code}`);
W
wangtong 已提交
340
}
341
```
Z
zengyawen 已提交
342

W
wangtong 已提交
343
## systemTime.getRealTime<sup>(deprecated)</sup>
Z
zengyawen 已提交
344

345
getRealTime(isNano: boolean, callback: AsyncCallback&lt;number&gt;): void
Z
zengyawen 已提交
346

347
获取自系统启动以来经过的时间,包括深度睡眠时间,使用callback异步回调。
Z
zengyawen 已提交
348

349
**系统能力:** SystemCapability.MiscServices.Time
Z
zengyawen 已提交
350

351 352
**参数:**

353 354 355
| 参数名   | 类型                        | 必填 | 说明   |
| -------- | --------------- | ---- | ------------------------------- |
| isNano   | boolean                     | 是   | 返回结果是否为纳秒数。<br/>- true:表示返回结果为纳秒数(ns)。 <br/>- false:表示返回结果为毫秒数(ms)。 |
356
| callback | AsyncCallback&lt;number&gt; | 是   | 回调函数,返回自系统启动以来经过的时间,包括深度睡眠时间。   |
Z
zengyawen 已提交
357

W
wangtong 已提交
358 359 360 361 362 363 364 365
**错误码:**

以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)

| 错误码ID | 错误信息                                    |
| -------- | ------------------------------------------- |
| -1       | The parameter check failed or system error. |

366
**示例:**
367

368
```js
W
wangtong 已提交
369
try {
370 371 372 373 374 375 376
  systemTime.getRealTime(true, (error, time) => {
    if (error) {
      console.info(`Failed to getting real time. message: ${error.message}, code: ${error.code}`);
      return;
    }
    console.info(`Succeeded in getting real time : ${time}`);
  });
W
wangtong 已提交
377
} catch(e) {
378
  console.info(`Failed to get real time. message: ${e.message}, code: ${e.code}`);
W
wangtong 已提交
379
}
380
```
Z
zengyawen 已提交
381

W
wangtong 已提交
382
## systemTime.getRealTime<sup>(deprecated)</sup>
Z
zengyawen 已提交
383

384 385
getRealTime(callback: AsyncCallback&lt;number&gt;): void

386
获取自系统启动以来经过的时间,包括深度睡眠时间,使用callback异步回调。
387 388 389 390 391

**系统能力:** SystemCapability.MiscServices.Time

**参数:**

392 393
| 参数名   | 类型                        | 必填 | 说明      |
| -------- | --------- | ---- | --------------------------- |
394 395
| callback | AsyncCallback&lt;number&gt; | 是   | 回调函数,返回自系统启动以来经过的时间,包括深度睡眠时间。   |

W
wangtong 已提交
396 397 398 399 400 401 402 403
**错误码:**

以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)

| 错误码ID | 错误信息                                    |
| -------- | ------------------------------------------- |
| -1       | The parameter check failed or system error. |

404 405
**示例:**

406
```js
W
wangtong 已提交
407
try {
408 409 410 411 412 413 414
  systemTime.getRealTime((error, time) => {
    if (error) {
      console.info(`Failed to getting real time. message: ${error.message}, code: ${error.code}`);
      return;
    }
    console.info(`Succeeded in getting real time : ${time}`);
  });
W
wangtong 已提交
415
} catch(e) {
416
  console.info(`Failed to get real time. message: ${e.message}, code: ${e.code}`);
W
wangtong 已提交
417
}
418
```
419

W
wangtong 已提交
420
## systemTime.getRealTime<sup>(deprecated)</sup>
421

422
getRealTime(isNano?: boolean): Promise&lt;number&gt;
Z
zengyawen 已提交
423

424
获取自系统启动以来经过的时间,包括深度睡眠时间,使用Promise异步回调。
Z
zengyawen 已提交
425

426
**系统能力:** SystemCapability.MiscServices.Time
Z
zengyawen 已提交
427

428 429
**参数:**

430 431
| 参数名 | 类型    | 必填 | 说明                               |
| ------ | ------- | ---- | ------------------------------- |
432
| isNano | boolean | 否   | 返回结果是否为纳秒数,默认值为false。<br/>默认值为false。<br/>- true:表示返回结果为纳秒数(ns)。 <br/>- false:表示返回结果为毫秒数(ms)。 |
Z
zengyawen 已提交
433

434 435
**返回值:**

436 437 438
| 类型                  | 说明       |
| --------------------- | ------------------------------- |
| Promise&lt;number&gt; | Promise对象,返回自系统启动以来经过的时间,包括深度睡眠时间。 |
Z
zengyawen 已提交
439

W
wangtong 已提交
440 441 442 443 444 445 446 447
**错误码:**

以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)

| 错误码ID | 错误信息                                    |
| -------- | ------------------------------------------- |
| -1       | The parameter check failed or system error. |

448
**示例:**
449

450
```js
W
wangtong 已提交
451
try {
452 453 454 455 456
  systemTime.getRealTime().then((time) => {
    console.info(`Succeeded in getting real time : ${time}`);
  }).catch((error) => {
    console.info(`Failed to getting real time. message: ${error.message}, code: ${error.code}`);
  });
W
wangtong 已提交
457
} catch(e) {
458
  console.info(`Failed to get real time. message: ${e.message}, code: ${e.code}`);
W
wangtong 已提交
459
}
460
```
Z
zengyawen 已提交
461

W
wangtong 已提交
462
## systemTime.setDate<sup>(deprecated)</sup>
Z
zengyawen 已提交
463 464 465

setDate(date: Date, callback: AsyncCallback&lt;void&gt;): void

466
设置系统日期,使用callback异步回调。
Z
zengyawen 已提交
467

468
**需要权限:** ohos.permission.SET_TIME
Z
zengyawen 已提交
469

470
**系统能力:** SystemCapability.MiscServices.Time
Z
zengyawen 已提交
471

472 473
**参数:**

474 475
| 参数名   | 类型                      | 必填 | 说明             |
| -------- | ------------- | ---- | --------------------- |
476
| date     | Date                      | 是   | 目标日期。                                 |
477
| callback | AsyncCallback&lt;void&gt; | 是   | 回调函数。 |
Z
zengyawen 已提交
478

W
wangtong 已提交
479 480 481 482 483 484 485 486
**错误码:**

以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)

| 错误码ID | 错误信息                                                     |
| -------- | ------------------------------------------------------------ |
| -1       | The parameter check failed or permission denied or system error. |

487
**示例:**
488

489
```js
W
wangtong 已提交
490 491
let date = new Date();
try {
492 493 494 495 496 497 498
  systemTime.setDate(date, (error) => {
    if (error) {
      console.info(`Failed to setting date. message: ${error.message}, code: ${error.code}`);
      return;
    }
    console.info(`Succeeded in setting date.`);
  });
W
wangtong 已提交
499
} catch(e) {
500
  console.info(`Failed to set date. message: ${e.message}, code: ${e.code}`);
W
wangtong 已提交
501
}
502
```
Z
zengyawen 已提交
503

W
wangtong 已提交
504
## systemTime.setDate<sup>(deprecated)</sup>
Z
zengyawen 已提交
505 506 507

setDate(date: Date): Promise&lt;void&gt;

508
设置系统日期,使用Promise异步回调。
Z
zengyawen 已提交
509

510
**需要权限:** ohos.permission.SET_TIME
Z
zengyawen 已提交
511

512
**系统能力:** SystemCapability.MiscServices.Time
Z
zengyawen 已提交
513

514 515
**参数:**

516 517 518
| 参数名 | 类型 | 必填 | 说明       |
| ------ | ---- | ---- | ---------- |
| date   | Date | 是   | 目标日期。 |
Z
zengyawen 已提交
519

520 521
**返回值:**

522 523
| 类型                | 说明                 |
| ------------------- | -------------------- |
524
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
Z
zengyawen 已提交
525

W
wangtong 已提交
526 527 528 529 530 531 532 533
**错误码:**

以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)

| 错误码ID | 错误信息                                                     |
| -------- | ------------------------------------------------------------ |
| -1       | The parameter check failed or permission denied or system error. |

534
**示例:**
535

536
```js
W
wangtong 已提交
537 538
let date = new Date(); 
try {
539 540 541 542 543
  systemTime.setDate(date).then(() => {
    console.info(`Succeeded in setting date.`);
  }).catch((error) => {
    console.info(`Failed to setting date. message: ${error.message}, code: ${error.code}`);
  });
W
wangtong 已提交
544
} catch(e) {
545
  console.info(`Failed to set date. message: ${e.message}, code: ${e.code}`);
W
wangtong 已提交
546
}
547
```
Z
zengyawen 已提交
548

W
wangtong 已提交
549
## systemTime.getDate<sup>(deprecated)</sup>
Z
zengyawen 已提交
550 551 552

getDate(callback: AsyncCallback&lt;Date&gt;): void

553
获取当前系统日期,使用callback异步回调。
Z
zengyawen 已提交
554

555
**系统能力:** SystemCapability.MiscServices.Time
Z
zengyawen 已提交
556

557 558
**参数:**

559 560
| 参数名   | 类型           | 必填 | 说明                   |
| -------- | -------------- | ---- | --------------------- |
561
| callback | AsyncCallback&lt;Date&gt; | 是   | 回调函数,返回当前系统日期。 |
Z
zengyawen 已提交
562

W
wangtong 已提交
563 564 565 566 567 568 569 570
**错误码:**

以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)

| 错误码ID | 错误信息                                    |
| -------- | ------------------------------------------- |
| -1       | The parameter check failed or system error. |

571
**示例:**
572

573
```js
W
wangtong 已提交
574
try {
575 576 577 578 579 580 581
  systemTime.getDate((error, date) => {
    if (error) {
      console.info(`Failed to get date. message: ${error.message}, code: ${error.code}`);
      return;
    }
    console.info(`Succeeded in get date : ${date}`);;
  });
W
wangtong 已提交
582
} catch(e) {
583
  console.info(`Failed to get date. message: ${e.message}, code: ${e.code}`);
W
wangtong 已提交
584
}
585
```
Z
zengyawen 已提交
586

W
wangtong 已提交
587
## systemTime.getDate<sup>(deprecated)</sup>
Z
zengyawen 已提交
588 589 590

getDate(): Promise&lt;Date&gt;

591
获取当前系统日期,使用Promise异步回调。
Z
zengyawen 已提交
592

593
**系统能力:** SystemCapability.MiscServices.Time
Z
zengyawen 已提交
594

595 596
**返回值:**

597 598
| 类型                | 说明                                      |
| ------------------- | ----------------------------------------- |
599
| Promise&lt;Date&gt; | Promise对象,返回当前系统日期。 |
Z
zengyawen 已提交
600

W
wangtong 已提交
601 602 603 604 605 606 607 608
**错误码:**

以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)

| 错误码ID | 错误信息                                    |
| -------- | ------------------------------------------- |
| -1       | The parameter check failed or system error. |

609
**示例:**
610

611
```js
W
wangtong 已提交
612
try {
613 614 615 616 617
  systemTime.getDate().then((date) => {
    console.info(`Succeeded in getting date : ${date}`);
  }).catch((error) => {
    console.info(`Failed to getting date. message: ${error.message}, code: ${error.code}`);
  });
W
wangtong 已提交
618
} catch(e) {
619
  console.info(`Failed to get date. message: ${e.message}, code: ${e.code}`);
W
wangtong 已提交
620
}
621
```
Z
zengyawen 已提交
622

W
wangtong 已提交
623
## systemTime.setTimezone<sup>(deprecated)</sup>
Z
zengyawen 已提交
624 625 626

setTimezone(timezone: string, callback: AsyncCallback&lt;void&gt;): void

627
设置系统时区,使用callback异步回调。
Z
zengyawen 已提交
628

629
**需要权限:** ohos.permission.SET_TIME_ZONE
Z
zengyawen 已提交
630

631
**系统能力:** SystemCapability.MiscServices.Time
Z
zengyawen 已提交
632

633 634
**参数:**

635 636
| 参数名   | 类型              | 必填 | 说明                  |
| -------- | ------------- | ---- | -------------------------- |
637
| timezone | string                    | 是   | 系统时区。 具体可见[支持的系统时区](#支持的系统时区) 。        |
638
| callback | AsyncCallback&lt;void&gt; | 是   | 回调函数。 |
Z
zengyawen 已提交
639

W
wangtong 已提交
640 641 642 643 644 645 646 647
**错误码:**

以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)

| 错误码ID | 错误信息                                                     |
| -------- | ------------------------------------------------------------ |
| -1       | The parameter check failed or permission denied or system error. |

648
**示例:**
649

650
```js
W
wangtong 已提交
651
try {
652 653 654 655 656 657 658
  systemTime.setTimezone('Asia/Shanghai', (error) => {
    if (error) {
      console.info(`Failed to setting timezone. message: ${error.message}, code: ${error.code}`);
      return;
    }
    console.info(`Succeeded in setting timezone.`);
  });
W
wangtong 已提交
659
} catch(e) {
660
  console.info(`Failed to set timezone. message: ${e.message}, code: ${e.code}`);
W
wangtong 已提交
661
}
662
```
Z
zengyawen 已提交
663

W
wangtong 已提交
664
## systemTime.setTimezone<sup>(deprecated)</sup>
Z
zengyawen 已提交
665 666 667

setTimezone(timezone: string): Promise&lt;void&gt;

668
设置系统时区,使用Promise异步回调。
Z
zengyawen 已提交
669

670
**需要权限:** ohos.permission.SET_TIME_ZONE
Z
zengyawen 已提交
671

672
**系统能力:** SystemCapability.MiscServices.Time
Z
zengyawen 已提交
673

674 675
**参数:**

676 677
| 参数名   | 类型   | 必填 | 说明       |
| -------- | ------ | ---- | ---------- |
678
| timezone | string | 是   | 系统时区。具体可见[支持的系统时区](#支持的系统时区) 。 |
Z
zengyawen 已提交
679

680 681
**返回值:**

682 683
| 类型                | 说明                 |
| ------------------- | -------------------- |
684
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
Z
zengyawen 已提交
685

W
wangtong 已提交
686 687 688 689 690 691 692 693
**错误码:**

以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)

| 错误码ID | 错误信息                                                     |
| -------- | ------------------------------------------------------------ |
| -1       | The parameter check failed or permission denied or system error. |

694
**示例:**
695

696
```js
W
wangtong 已提交
697
try {
698 699 700 701 702
  systemTime.setTimezone('Asia/Shanghai').then(() => {
    console.info(`Succeeded in setting timezone.`);
  }).catch((error) => {
    console.info(`Failed to setting timezone. message: ${error.message}, code: ${error.code}`);
  });
W
wangtong 已提交
703
} catch(e) {
704
  console.info(`Failed to set timezone. message: ${e.message}, code: ${e.code}`);
W
wangtong 已提交
705
}
706
```
Z
zengyawen 已提交
707

W
wangtong 已提交
708
## systemTime.getTimezone<sup>(deprecated)</sup>
Z
zengyawen 已提交
709

710
getTimezone(callback: AsyncCallback&lt;string&gt;): void
Z
zengyawen 已提交
711

712
获取系统时区,使用callback异步回调。
Z
zengyawen 已提交
713

714
**系统能力:** SystemCapability.MiscServices.Time
Z
zengyawen 已提交
715

716 717
**参数:**

718 719
| 参数名   | 类型              | 必填 | 说明                 |
| -------- | --------- | ---- | ------------------------ |
720
| callback | AsyncCallback&lt;string&gt; | 是   | 回调函数,返回系统时区。具体可见[支持的系统时区](#支持的系统时区) 。 |
Z
zengyawen 已提交
721

W
wangtong 已提交
722 723 724 725 726 727 728 729
**错误码:**

以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)

| 错误码ID | 错误信息                                    |
| -------- | ------------------------------------------- |
| -1       | The parameter check failed or system error. |

730
**示例:**
731

732
```js
W
wangtong 已提交
733
try {
734 735 736 737 738 739 740
  systemTime.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}`);;
  });
W
wangtong 已提交
741
} catch(e) {
742
  console.info(`Failed to get timezone. message: ${e.message}, code: ${e.code}`);
W
wangtong 已提交
743
}
744
```
Z
zengyawen 已提交
745

W
wangtong 已提交
746
## systemTime.getTimezone<sup>(deprecated)</sup>
Z
zengyawen 已提交
747

748
getTimezone(): Promise&lt;string&gt;
Z
zengyawen 已提交
749

750
获取系统时区,使用Promise异步回调。
Z
zengyawen 已提交
751

752
**系统能力:** SystemCapability.MiscServices.Time
Z
zengyawen 已提交
753

754 755
**返回值:**

756 757
| 类型                  | 说明                                  |
| --------------------- | ------------------------------------- |
758
| Promise&lt;string&gt; | Promise对象,返回系统时区。具体可见[支持的系统时区](#支持的系统时区) 。 |
Z
zengyawen 已提交
759

W
wangtong 已提交
760 761 762 763 764 765 766 767
**错误码:**

以下错误码的详细介绍请参见[时间时区错误码](../errorcodes/errorcode-time.md)

| 错误码ID | 错误信息                                    |
| -------- | ------------------------------------------- |
| -1       | The parameter check failed or system error. |

768
**示例:**
769

770
```js
W
wangtong 已提交
771
try {
772 773 774 775 776
  systemTime.getTimezone().then((data) => {
    console.info(`Succeeded in getting timezone: ${data}`);
  }).catch((error) => {
    console.info(`Failed to getting timezone. message: ${error.message}, code: ${error.code}`);
  });
W
wangtong 已提交
777
} catch(e) {
778
  console.info(`Failed to get timezone. message: ${e.message}, code: ${e.code}`);
W
wangtong 已提交
779
}
780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818
```

## 支持的系统时区

支持的系统时区及各时区与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                     |