1# @ohos.systemDateTime (系统时间、时区)
2
3本模块主要由系统时间和系统时区功能组成。开发者可以设置、获取系统时间及系统时区。
4
5> **说明:**
6>
7> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
8
9## 导入模块
10
11```ts
12import { systemDateTime } from '@kit.BasicServicesKit';
13```
14
15## TimeType<sup>10+</sup>
16
17定义获取时间的枚举类型。
18
19**系统能力**: SystemCapability.MiscServices.Time
20
21| 名称    | 值   | 说明                                             |
22| ------- | ---- | ------------------------------------------------ |
23| STARTUP | 0    | 自系统启动以来经过的毫秒数,包括深度睡眠时间。   |
24| ACTIVE  | 1    | 自系统启动以来经过的毫秒数,不包括深度睡眠时间。 |
25
26## systemDateTime.getCurrentTime<sup>(deprecated)</sup>
27
28getCurrentTime(isNano: boolean, callback: AsyncCallback&lt;number&gt;): void
29
30获取自Unix纪元以来经过的时间,使用callback异步回调。
31
32> **说明:**
33>
34> 从API Version 12开始不再维护,建议使用[systemDateTime.getTime<sup>10+</sup>](#systemdatetimegettime10)替代。
35
36**系统能力:** SystemCapability.MiscServices.Time
37
38**参数:**
39
40| 参数名   | 类型       | 必填 | 说明                             |
41| -------- | -------------- | ---- | ------------------ |
42| isNano   | boolean                     | 是   | 返回结果是否为纳秒数。<br>- true:表示返回结果为纳秒数(ns)。 <br>- false:表示返回结果为毫秒数(ms)。 |
43| callback | AsyncCallback&lt;number&gt; | 是   | 回调函数,返回自Unix纪元以来经过的时间戳。         |
44
45**错误码:**
46
47以下错误码的详细介绍请参见[时间时区错误码](./errorcode-time.md)。
48
49| 错误码ID | 错误信息                                                              |
50| -------- |-------------------------------------------------------------------|
51| 401       | Parameter error. Possible causes: 1.Incorrect parameter types. |
52
53**示例:**
54
55```ts
56import { BusinessError } from '@kit.BasicServicesKit';
57
58try {
59  systemDateTime.getCurrentTime(true, (error: BusinessError, time: number) => {
60    if (error) {
61      console.info(`Failed to get currentTime. message: ${error.message}, code: ${error.code}`);
62      return;
63    }
64    console.info(`Succeeded in getting currentTime : ${time}`);
65  });
66} catch(e) {
67  let error = e as BusinessError;
68  console.info(`Failed to get currentTime. message: ${error.message}, code: ${error.code}`);
69}
70```
71
72## systemDateTime.getCurrentTime<sup>(deprecated)</sup>
73
74getCurrentTime(callback: AsyncCallback&lt;number&gt;): void
75
76获取自Unix纪元以来经过的时间,使用callback异步回调。
77
78> **说明:**
79>
80> 从API Version 12开始不再维护,建议使用[systemDateTime.getTime<sup>10+</sup>](#systemdatetimegettime10)替代。
81
82**系统能力:** SystemCapability.MiscServices.Time
83
84**参数:**
85
86| 参数名   | 类型               | 必填 | 说明                            |
87| -------- | ----------- | ---- | ---------------------------------- |
88| callback | AsyncCallback&lt;number&gt; | 是   | 回调函数,返回自Unix纪元以来经过的时间戳(ms)。         |
89
90**错误码:**
91
92以下错误码的详细介绍请参见[时间时区错误码](./errorcode-time.md)。
93
94| 错误码ID    | 错误信息                                                              |
95|----------|-------------------------------------------------------------------|
96| 401      | Parameter error. Possible causes: 1.Incorrect parameter types. |
97
98**示例:**
99
100```ts
101import { BusinessError } from '@kit.BasicServicesKit';
102
103try {
104  systemDateTime.getCurrentTime((error: BusinessError, time: number) => {
105    if (error) {
106      console.info(`Failed to get currentTime. message: ${error.message}, code: ${error.code}`);
107      return;
108    }
109    console.info(`Succeeded in getting currentTime : ${time}`);
110  });
111} catch(e) {
112  let error = e as BusinessError;
113  console.info(`Failed to get currentTime. message: ${error.message}, code: ${error.code}`);
114}
115```
116
117## systemDateTime.getCurrentTime<sup>(deprecated)</sup>
118
119getCurrentTime(isNano?: boolean): Promise&lt;number&gt;
120
121获取自Unix纪元以来经过的时间,使用Promise异步回调。
122
123> **说明:**
124>
125> 从API Version 12开始不再维护,建议使用[systemDateTime.getTime<sup>10+</sup>](#systemdatetimegettime10)替代。
126
127**系统能力:** SystemCapability.MiscServices.Time
128
129**参数:**
130
131| 参数名 | 类型    | 必填 | 说明                     |
132| ------ | ------- | ---- | ------------------------- |
133| isNano | boolean | 否   | 返回结果是否为纳秒数,默认值为false。<br/>- true:表示返回结果为纳秒数(ns)。 <br/>- false:表示返回结果为毫秒数(ms)。 |
134
135**返回值:**
136
137| 类型        | 说明                               |
138| --------------------- | --------------------------- |
139| Promise&lt;number&gt; | Promise对象,返回自Unix纪元以来经过的时间戳。 |
140
141**错误码:**
142
143以下错误码的详细介绍请参见[时间时区错误码](./errorcode-time.md)。
144
145| 错误码ID   | 错误信息                                                              |
146|---------|-------------------------------------------------------------------|
147| 401     | Parameter error. Possible causes: 1.Incorrect parameter types. |
148
149**示例:**
150
151```ts
152import { BusinessError } from '@kit.BasicServicesKit';
153
154try {
155  systemDateTime.getCurrentTime().then((time: number) => {
156    console.info(`Succeeded in getting currentTime : ${time}`);
157  }).catch((error: BusinessError) => {
158    console.info(`Failed to get currentTime. message: ${error.message}, code: ${error.code}`);
159  });
160} catch(e) {
161  let error = e as BusinessError;
162  console.info(`Failed to get currentTime. message: ${error.message}, code: ${error.code}`);
163}
164```
165
166## systemDateTime.getRealActiveTime<sup>(deprecated)</sup>
167
168getRealActiveTime(isNano: boolean, callback: AsyncCallback&lt;number&gt;): void
169
170获取自系统启动以来经过的时间,不包括深度睡眠时间,使用callback异步回调。
171
172> **说明:**
173>
174> 从API Version 12开始不再维护,建议使用[systemDateTime.getUptime<sup>10+</sup>](#systemdatetimegetuptime10)替代。
175
176**系统能力:** SystemCapability.MiscServices.Time
177
178**参数:**
179
180| 参数名   | 类型                        | 必填 | 说明   |
181| -------- | ---------- | ---- | -------------------------- |
182| isNano   | boolean                     | 是   | 返回结果是否为纳秒数。<br/>- true:表示返回结果为纳秒数(ns)。 <br/>- false:表示返回结果为毫秒数(ms)。 |
183| callback | AsyncCallback&lt;number&gt; | 是   | 回调函数,返回自系统启动以来经过的时间,但不包括深度睡眠时间。 |
184
185**错误码:**
186
187以下错误码的详细介绍请参见[时间时区错误码](./errorcode-time.md)。
188
189| 错误码ID   | 错误信息                                                              |
190|---------|-------------------------------------------------------------------|
191| 401     | Parameter error. Possible causes: 1.Incorrect parameter types. |
192
193**示例:**
194
195```ts
196import { BusinessError } from '@kit.BasicServicesKit';
197
198try {
199  systemDateTime.getRealActiveTime(true, (error: BusinessError, time: number) => {
200    if (error) {
201      console.info(`Failed to get real active time. message: ${error.message}, code: ${error.code}`);
202      return;
203    }
204    console.info(`Succeeded in getting real active time : ${time}`);
205  });
206} catch(e) {
207  let error = e as BusinessError;
208  console.info(`Failed to get real active time. message: ${error.message}, code: ${error.code}`);
209}
210```
211
212## systemDateTime.getRealActiveTime<sup>(deprecated)</sup>
213
214getRealActiveTime(callback: AsyncCallback&lt;number&gt;): void
215
216获取自系统启动以来经过的时间,不包括深度睡眠时间,使用callback异步回调。
217
218> **说明:**
219>
220> 从API Version 12开始不再维护,建议使用[systemDateTime.getUptime<sup>10+</sup>](#systemdatetimegetuptime10)替代。
221
222**系统能力:** SystemCapability.MiscServices.Time
223
224**参数:**
225
226| 参数名   | 类型                        | 必填 | 说明    |
227| -------- | -------------- | ---- | --------------------- |
228| callback | AsyncCallback&lt;number&gt; | 是   | 回调函数,返回自系统启动以来经过的时间,但不包括度睡眠时间。 |
229
230**错误码:**
231
232以下错误码的详细介绍请参见[时间时区错误码](./errorcode-time.md)。
233
234| 错误码ID   | 错误信息                                                              |
235|---------|-------------------------------------------------------------------|
236| 401     | Parameter error. Possible causes: 1.Incorrect parameter types. |
237
238**示例:**
239
240```ts
241import { BusinessError } from '@kit.BasicServicesKit';
242
243try {
244  systemDateTime.getRealActiveTime((error: BusinessError, time: number) => {
245    if (error) {
246      console.info(`Failed to get real active time. message: ${error.message}, code: ${error.code}`);
247      return;
248    }
249    console.info(`Succeeded in getting real active time : ${time}`);
250  });
251} catch(e) {
252  let error = e as BusinessError;
253  console.info(`Failed to get real active time. message: ${error.message}, code: ${error.code}`);
254}
255```
256
257## systemDateTime.getRealActiveTime<sup>(deprecated)</sup>
258
259getRealActiveTime(isNano?: boolean): Promise&lt;number&gt;
260
261获取自系统启动以来经过的时间,不包括深度睡眠时间,使用Promise异步回调。
262
263> **说明:**
264>
265> 从API Version 12开始不再维护,建议使用[systemDateTime.getUptime<sup>10+</sup>](#systemdatetimegetuptime10)替代。
266
267**系统能力:** SystemCapability.MiscServices.Time
268
269**参数:**
270
271| 参数名 | 类型    | 必填 | 说明                              |
272| ------ | ------- | ---- | ----------------------------------- |
273| isNano | boolean | 否   | 返回结果是否为纳秒数,默认值为false。<br/>- true:表示返回结果为纳秒数(ns)。 <br/>- false:表示返回结果为毫秒数(ms)。 |
274
275**返回值:**
276
277| 类型                  | 说明         |
278| -------------- | -------------------------------- |
279| Promise&lt;number&gt; | Promise对象,返回自系统启动以来经过的时间,但不包括深度睡眠时间。 |
280
281**错误码:**
282
283以下错误码的详细介绍请参见[时间时区错误码](./errorcode-time.md)。
284
285| 错误码ID   | 错误信息                                                              |
286|---------|-------------------------------------------------------------------|
287| 401     | Parameter error. Possible causes: 1.Incorrect parameter types. |
288
289**示例:**
290
291```ts
292import { BusinessError } from '@kit.BasicServicesKit';
293
294try {
295  systemDateTime.getRealActiveTime().then((time: number) => {
296    console.info(`Succeeded in getting real active time : ${time}`);
297  }).catch((error: BusinessError) => {
298    console.info(`Failed to get real active time. message: ${error.message}, code: ${error.code}`);
299  });
300} catch(e) {
301  let error = e as BusinessError;
302  console.info(`Failed to get real active time. message: ${error.message}, code: ${error.code}`);
303}
304```
305
306## systemDateTime.getRealTime<sup>(deprecated)</sup>
307
308getRealTime(isNano: boolean, callback: AsyncCallback&lt;number&gt;): void
309
310获取自系统启动以来经过的时间,包括深度睡眠时间,使用callback异步回调。
311
312> **说明:**
313>
314> 从API Version 12开始不再维护,建议使用[systemDateTime.getUptime<sup>10+</sup>](#systemdatetimegetuptime10)替代。
315
316**系统能力:** SystemCapability.MiscServices.Time
317
318**参数:**
319
320| 参数名   | 类型                        | 必填 | 说明   |
321| -------- | --------------- | ---- | ------------------------------- |
322| isNano   | boolean                     | 是   | 返回结果是否为纳秒数。<br/>- true:表示返回结果为纳秒数(ns)。 <br/>- false:表示返回结果为毫秒数(ms)。 |
323| callback | AsyncCallback&lt;number&gt; | 是   | 回调函数,返回自系统启动以来经过的时间,包括深度睡眠时间。   |
324
325**错误码:**
326
327以下错误码的详细介绍请参见[时间时区错误码](./errorcode-time.md)。
328
329| 错误码ID   | 错误信息                                                              |
330|---------|-------------------------------------------------------------------|
331| 401     | Parameter error. Possible causes: 1.Incorrect parameter types. |
332
333**示例:**
334
335```ts
336import { BusinessError } from '@kit.BasicServicesKit';
337
338try {
339  systemDateTime.getRealTime(true, (error: BusinessError, time: number) => {
340    if (error) {
341      console.info(`Failed to get real time. message: ${error.message}, code: ${error.code}`);
342      return;
343    }
344    console.info(`Succeeded in getting real time : ${time}`);
345  });
346} catch(e) {
347  let error = e as BusinessError;
348  console.info(`Failed to get real time. message: ${error.message}, code: ${error.code}`);
349}
350```
351
352## systemDateTime.getRealTime<sup>(deprecated)</sup>
353
354getRealTime(callback: AsyncCallback&lt;number&gt;): void
355
356获取自系统启动以来经过的时间,包括深度睡眠时间,使用callback异步回调。
357
358> **说明:**
359>
360> 从API Version 12开始不再维护,建议使用[systemDateTime.getUptime<sup>10+</sup>](#systemdatetimegetuptime10)替代。
361
362**系统能力:** SystemCapability.MiscServices.Time
363
364**参数:**
365
366| 参数名   | 类型                        | 必填 | 说明      |
367| -------- | --------- | ---- | --------------------------- |
368| callback | AsyncCallback&lt;number&gt; | 是   | 回调函数,返回自系统启动以来经过的时间,包括深度睡眠时间。   |
369
370**错误码:**
371
372以下错误码的详细介绍请参见[时间时区错误码](./errorcode-time.md)。
373
374| 错误码ID   | 错误信息                                                              |
375|---------|-------------------------------------------------------------------|
376| 401     | Parameter error. Possible causes: 1.Incorrect parameter types. |
377
378**示例:**
379
380```ts
381import { BusinessError } from '@kit.BasicServicesKit';
382
383try {
384  systemDateTime.getRealTime((error: BusinessError, time: number) => {
385    if (error) {
386      console.info(`Failed to get real time. message: ${error.message}, code: ${error.code}`);
387      return;
388    }
389    console.info(`Succeeded in getting real time : ${time}`);
390  });
391} catch(e) {
392  let error = e as BusinessError;
393  console.info(`Failed to get real time. message: ${error.message}, code: ${error.code}`);
394}
395```
396
397## systemDateTime.getRealTime<sup>(deprecated)</sup>
398
399getRealTime(isNano?: boolean): Promise&lt;number&gt;
400
401获取自系统启动以来经过的时间,包括深度睡眠时间,使用Promise异步回调。
402
403> **说明:**
404>
405> 从API Version 12开始不再维护,建议使用[systemDateTime.getUptime<sup>10+</sup>](#systemdatetimegetuptime10)替代。
406
407**系统能力:** SystemCapability.MiscServices.Time
408
409**参数:**
410
411| 参数名 | 类型    | 必填 | 说明                               |
412| ------ | ------- | ---- | ------------------------------- |
413| isNano | boolean | 否   | 返回结果是否为纳秒数,默认值为false。<br/>- true:表示返回结果为纳秒数(ns)。 <br/>- false:表示返回结果为毫秒数(ms)。 |
414
415**返回值:**
416
417| 类型                  | 说明       |
418| --------------------- | ------------------------------- |
419| Promise&lt;number&gt; | Promise对象,返回自系统启动以来经过的时间,包括深度睡眠时间。 |
420
421**错误码:**
422
423以下错误码的详细介绍请参见[时间时区错误码](./errorcode-time.md)。
424
425| 错误码ID   | 错误信息                                                              |
426|---------|-------------------------------------------------------------------|
427| 401     | Parameter error. Possible causes: 1.Incorrect parameter types. |
428
429**示例:**
430
431```ts
432import { BusinessError } from '@kit.BasicServicesKit';
433
434try {
435  systemDateTime.getRealTime().then((time: number) => {
436    console.info(`Succeeded in getting real time : ${time}`);
437  }).catch((error: BusinessError) => {
438    console.info(`Failed to get real time. message: ${error.message}, code: ${error.code}`);
439  });
440} catch(e) {
441  let error = e as BusinessError;
442  console.info(`Failed to get real time. message: ${error.message}, code: ${error.code}`);
443}
444```
445
446## systemDateTime.getTime<sup>10+</sup>
447
448getTime(isNanoseconds?: boolean): number
449
450 使用同步方式获取自Unix纪元以来经过的时间。
451
452**系统能力:** SystemCapability.MiscServices.Time
453
454**参数:**
455
456| 参数名        | 类型    | 必填 | 说明                                                         |
457| ------------- | ------- | ---- | ------------------------------------------------------------ |
458| isNanoseconds | boolean | 否   | 返回结果是否为纳秒数。<br>- true:表示返回结果为纳秒数(ns)。 <br>- false:表示返回结果为毫秒数(ms)。<br>默认值为false。 |
459
460**返回值**:
461
462| 类型   | 说明                       |
463| ------ | -------------------------- |
464| number | 自Unix纪元以来经过的时间。 |
465
466**示例:**
467
468```ts
469import { BusinessError } from '@kit.BasicServicesKit';
470
471try {
472  let time = systemDateTime.getTime(true)
473} catch(e) {
474  let error = e as BusinessError;
475  console.info(`Failed to get time. message: ${error.message}, code: ${error.code}`);
476}
477```
478
479## systemDateTime.getUptime<sup>10+</sup>
480
481getUptime(timeType: TimeType, isNanoseconds?: boolean): number
482
483使用同步方式获取自系统启动以来经过的时间。
484
485**系统能力:** SystemCapability.MiscServices.Time
486
487**参数:**
488
489| 参数名        | 类型                    | 必填 | 说明                                                                                |
490| ------------- | ----------------------- | ---- |-----------------------------------------------------------------------------------|
491| timeType      | [TimeType](#timetype10) | 是   | 获取时间的类型,仅能为`STARTUP`或者`ACTIVE`。                                                  |
492| isNanoseconds | boolean                 | 否   | 返回结果是否为纳秒数。<br/>- true:表示返回结果为纳秒数(ns)。 <br/>- false:表示返回结果为毫秒数(ms)。<br>默认值为false。 |
493
494**返回值:**
495
496| 类型   | 说明                       |
497| ------ | -------------------------- |
498| number | 自系统启动以来经过的时间。 |
499
500**错误码:**
501
502以下错误码的详细介绍请参见[时间时区错误码](errorcode-time.md)。
503
504| 错误码ID | 错误信息                                                                                                           |
505| -------- |----------------------------------------------------------------------------------------------------------------|
506| 401       | Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. This error code was added due to missing issues. |
507
508**示例:**
509
510```ts
511import { BusinessError } from '@kit.BasicServicesKit';
512
513try {
514  let time = systemDateTime.getUptime(systemDateTime.TimeType.ACTIVE, false);
515} catch(e) {
516  let error = e as BusinessError;
517  console.info(`Failed to get uptime. message: ${error.message}, code: ${error.code}`);
518}
519```
520
521## systemDateTime.getDate<sup>(deprecated)</sup>
522
523getDate(callback: AsyncCallback&lt;Date&gt;): void
524
525获取当前系统日期,使用callback异步回调。
526
527> **说明:**
528>
529> 从API version 9开始支持,从API 10开始废弃。建议使用new Date()替代,new Date()返回Date实例对象。
530
531**系统能力:** SystemCapability.MiscServices.Time
532
533**参数:**
534
535| 参数名   | 类型           | 必填 | 说明                   |
536| -------- | -------------- | ---- | --------------------- |
537| callback | AsyncCallback&lt;Date&gt; | 是   | 回调函数,返回当前系统日期。 |
538
539**错误码:**
540
541以下错误码的详细介绍请参见[时间时区错误码](./errorcode-time.md)。
542
543| 错误码ID | 错误信息                                                 |
544|-------|------------------------------------------------------|
545| 401   | Parameter error. Possible causes: 1.System error. |
546
547**示例:**
548
549```ts
550import { BusinessError } from '@kit.BasicServicesKit';
551
552try {
553  systemDateTime.getDate((error: BusinessError, date: Date) => {
554    if (error) {
555      console.info(`Failed to get date. message: ${error.message}, code: ${error.code}`);
556      return;
557    }
558    console.info(`Succeeded in getting date : ${date}`);;
559  });
560} catch(e) {
561  let error = e as BusinessError;
562  console.info(`Failed to get date. message: ${error.message}, code: ${error.code}`);
563}
564```
565
566## systemDateTime.getDate<sup>(deprecated)</sup>
567
568getDate(): Promise&lt;Date&gt;
569
570获取当前系统日期,使用Promise异步回调。
571
572> **说明:**
573>
574> 从API version 9开始支持,从API 10开始废弃。建议使用new Date()替代,new Date()返回Date实例对象。
575
576**系统能力:** SystemCapability.MiscServices.Time
577
578**返回值:**
579
580| 类型                | 说明                                      |
581| ------------------- | ----------------------------------------- |
582| Promise&lt;Date&gt; | Promise对象,返回当前系统日期。 |
583
584**错误码:**
585
586以下错误码的详细介绍请参见[时间时区错误码](./errorcode-time.md)。
587
588| 错误码ID | 错误信息                                                 |
589|-------|------------------------------------------------------|
590| 401   | Parameter error. Possible causes: 1.System error. |
591
592**示例:**
593
594```ts
595import { BusinessError } from '@kit.BasicServicesKit';
596
597try {
598  systemDateTime.getDate().then((date: Date) => {
599    console.info(`Succeeded in getting date : ${date}`);
600  }).catch((error: BusinessError) => {
601    console.info(`Failed to get date. message: ${error.message}, code: ${error.code}`);
602  });
603} catch(e) {
604  let error = e as BusinessError;
605  console.info(`Failed to get date. message: ${error.message}, code: ${error.code}`);
606}
607```
608
609## systemDateTime.getTimezone
610
611getTimezone(callback: AsyncCallback&lt;string&gt;): void
612
613获取系统时区,使用callback异步回调。
614
615**系统能力:** SystemCapability.MiscServices.Time
616
617**参数:**
618
619| 参数名   | 类型              | 必填 | 说明                 |
620| -------- | --------- | ---- | ------------------------ |
621| callback | AsyncCallback&lt;string&gt; | 是   | 回调函数,返回系统时区。具体可见[支持的系统时区](#支持的系统时区) 。 |
622
623**示例:**
624
625```ts
626import { BusinessError } from '@kit.BasicServicesKit';
627
628try {
629  systemDateTime.getTimezone((error: BusinessError, data: string) => {
630    if (error) {
631      console.info(`Failed to get timezone. message: ${error.message}, code: ${error.code}`);
632      return;
633    }
634    console.info(`Succeeded in get timezone : ${data}`);;
635  });
636} catch(e) {
637  let error = e as BusinessError;
638  console.info(`Failed to get timezone. message: ${error.message}, code: ${error.code}`);
639}
640```
641
642## systemDateTime.getTimezone
643
644getTimezone(): Promise&lt;string&gt;
645
646获取系统时区,使用Promise异步回调。
647
648**系统能力:** SystemCapability.MiscServices.Time
649
650**返回值:**
651
652| 类型                  | 说明                                  |
653| --------------------- | ------------------------------------- |
654| Promise&lt;string&gt; | Promise对象,返回系统时区。具体可见[支持的系统时区](#支持的系统时区) 。 |
655
656**示例:**
657
658```ts
659import { BusinessError } from '@kit.BasicServicesKit';
660
661try {
662  systemDateTime.getTimezone().then((data: string) => {
663    console.info(`Succeeded in getting timezone: ${data}`);
664  }).catch((error: BusinessError) => {
665    console.info(`Failed to get timezone. message: ${error.message}, code: ${error.code}`);
666  });
667} catch(e) {
668  let error = e as BusinessError;
669  console.info(`Failed to get timezone. message: ${error.message}, code: ${error.code}`);
670}
671```
672
673## systemDateTime.getTimezoneSync<sup>10+</sup>
674
675getTimezoneSync(): string
676
677获取系统时区,使用同步方式。
678
679**系统能力:** SystemCapability.MiscServices.Time
680
681**返回值:**
682
683| 类型   | 说明                                                       |
684| ------ | ---------------------------------------------------------- |
685| string | 返回系统时区。具体可见[支持的系统时区](#支持的系统时区) 。 |
686
687**示例:**
688
689```ts
690import { BusinessError } from '@kit.BasicServicesKit';
691
692try {
693  let timezone = systemDateTime.getTimezoneSync();
694} catch(e) {
695  let error = e as BusinessError;
696  console.info(`Failed to get timezone. message: ${error.message}, code: ${error.code}`);
697}
698```
699
700## 支持的系统时区
701
702支持的系统时区及各时区与0时区相比的偏移量(单位:h)可见下表。
703
704| 时区                           | 偏移量         |
705| ------------------------------ | --------------------- |
706| Antarctica/McMurdo             | 12                    |
707| America/Argentina/Buenos_Aires | -3                    |
708| Australia/Sydney               | 10                    |
709| America/Noronha                | -2                    |
710| America/St_Johns               | -3                    |
711| Africa/Kinshasa                | 1                     |
712| America/Santiago               | -3                    |
713| Asia/Shanghai                  | 8                     |
714| Asia/Nicosia                   | 3                     |
715| Europe/Berlin                  | 2                     |
716| America/Guayaquil              | -5                    |
717| Europe/Madrid                  | 2                     |
718| Pacific/Pohnpei                | 11                    |
719| America/Godthab                | -2                    |
720| Asia/Jakarta                   | 7                     |
721| Pacific/Tarawa                 | 12                    |
722| Asia/Almaty                    | 6                     |
723| Pacific/Majuro                 | 12                    |
724| Asia/Ulaanbaatar               | 8                     |
725| America/Mexico_City            | -5                    |
726| Asia/Kuala_Lumpur              | 8                     |
727| Pacific/Auckland               | 12                    |
728| Pacific/Tahiti                 | -10                   |
729| Pacific/Port_Moresby           | 10                    |
730| Asia/Gaza                      | 3                     |
731| Europe/Lisbon                  | 1                     |
732| Europe/Moscow                  | 3                     |
733| Europe/Kiev                    | 3                     |
734| Pacific/Wake                   | 12                    |
735| America/New_York               | -4                    |
736| Asia/Tashkent                  | 5                     |