Skip to content

D
Docs

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

通知 159
Star 292
Fork 28
D
Docs
切换分支/标签
查找文件 普通视图历史永久链接Permalink
js-apis-system-timer.md 11.2 KB
Newer Older
Z
Signed-off-by: zhangjunxi <zhangjunxi1@huawei.com>  
zhangjunxi 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 
# 设置系统时间

本模块主要由时间、时区和定时三大功能组成。其中，定时服务用来管理和使用时间、时区。开发者可以通过对系统进行设置、获取等操作管理系统时间、时区，也可以通过定时功能实现定时服务如闹钟服务等。

> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。


## 导入模块


```
import systemTimer from '@ohos.systemTimer';
import wantAgent from '@ohos.wantAgent';
```


## systemTime.createTimer

createTimer(options: TimerOptions, callback: AsyncCallback&lt;number&gt;): void

创建定时器。

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

**参数：**

| 参数名   | 类型              | 必填 | 说明                                                                                    |
| -------- | ------------------| ---- | --------------------------------------------------------------------------------------- |
| options  | TimerOptions      | 是   | const TIMER_TYPE_REALTIME: 设置为系统启动时间定时器，否则为walltime定时器; <br/>const TIMER_TYPE_WAKEUP: 设置为唤醒定时器，否则为非唤醒; <br/>const TIMER_TYPE_EXACT: 设置为精准定时器，否则为非精准定时器; <br/>const TIMER_TYPE_IDLE: number: 设置为IDLE模式定时器，否则为非IDLE模式定时器（暂不支持） |
| repeat   | boolean           | 是   | true 为循环定时器，false为单次定时器。                                                  |
| interval | number            | 否   | 如果是循环定时器，repeat值应大于5000毫秒，非重复定时器置为0。                           |
| wantAgent| wantAgent         | 否   | 设置通知的wantagent，定时器到期后通知。                                                 |

**返回值：**

| 类型                      | 说明                                                         |
| ------------------------- | ------------------------------------------------------------ |
| syncCallback&lt;number&gt;| 以回调函数的形式返回定时器的ID。                             |

**示例：**

  ```js
  var options = TimerOptions {   
        type:TIMER_TYPE_REALTIME,   
        repeat:false  
      }
  systemTime.createTimer(options, (error, data) => {
      if (error) {
          console.error(`failed to systemTime.createTimer ` + JSON.stringify(error));
          return;
      }
      console.log(`systemTime.createTimer success data : ` + JSON.stringify(data));
  });
  ```


## systemTime.createTimer

createTimer(options: TimerOptions): Promise&lt;number&gt;

创建定时器。

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

**参数：**

| 参数名   | 类型              | 必填 | 说明                                                                                    |
| -------- | ------------------| ---- | --------------------------------------------------------------------------------------- |
| options  | TimerOptions      | 是   | const TIMER_TYPE_REALTIME: 设置为系统启动时间定时器，否则为walltime定时器; <br/>const TIMER_TYPE_WAKEUP: 设置为唤醒定时器，否则为非唤醒; <br/>const TIMER_TYPE_EXACT: 设置为精准定时器，否则为非精准定时器; <br/>const TIMER_TYPE_IDLE: number: 设置为IDLE模式定时器，否则为非IDLE模式定时器（暂不支持） |
| repeat   | boolean           | 是   | true 为循环定时器，false为单次定时器。                                                  |
| interval | number            | 否   | 如果是循环定时器，repeat值应大于5000毫秒，非重复定时器置为0。                           |
| wantAgent| wantAgent         | 否   | 设置通知的wantagent，定时器到期后通知。                                                 |

**返回值：**

| 类型                  | 说明                                                         |
| --------------------- | ------------------------------------------------------------ |
| Promise&lt;number&gt; | 以Promise形式返回定时器的ID。                                |

**示例：**

  ```js
  var options = TimerOptions {   
        type:TIMER_TYPE_REALTIME,   
        repeat:false  
      }
  systemTime.createTimer(options).then((data) => {
      console.log(`systemTime.createTimer success data : ` + JSON.stringify(data));
  }).catch((error) => {
      console.error(`failed to systemTime.createTimer because ` + JSON.stringify(error));
  });
  ```


## systemTime.startTimer

startTimer(timer: number, triggerTime: number, callback: AsyncCallback&lt;void&gt;): void

开始定时器。

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

**参数：**

| 参数名      | 类型                        | 必填 | 说明                                                         |
| ----------- | --------------------------- | ---- | ------------------------------------------------------------ |
| timer       | number                      | 是   | 定时器的ID。                                                 |                                                                                                             
| triggerTime | number                      | 是   | 定时器的触发时间，单位：毫秒。                               |


**示例：**

  ```js
  var options = TimerOptions {   
        type:TIMER_TYPE_REALTIME,   
        repeat:false  
      }
  let timerId = systemTimer.Timer(options) 
  systemTime.startTimer(timerId, 10000, (error, data) => {
      if (error) {
          console.error(`failed to systemTime.startTimer ` + JSON.stringify(error));
          return;
      }
      console.log(`systemTime.startTimer success data : ` + JSON.stringify(data));
  });
  ```
  
## systemTime.startTimer

startTimer(timer: number, triggerTime: number): Promise&lt;void&gt;

开始定时器。

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

**参数：**

| 参数名      | 类型                        | 必填 | 说明                                                         |
| ----------- | --------------------------- | ---- | ------------------------------------------------------------ |
| timer       | number                      | 是   | 定时器的ID。                                                                                                                                                             
| triggerTime | number                      | 是   | 定时器的触发时间，单位：毫秒。                               |                                                                                                                    


**示例：**

  ```js
  var options = TimerOptions {   
        type:TIMER_TYPE_REALTIME,   
        repeat:false  
      }
  let timerId = systemTimer.Timer(options)
  systemTime.startTimer(timerId, 10000).then((data) => {
      console.log(`systemTime.startTimer success data : ` + JSON.stringify(data));
  }).catch((error) => {
      console.error(`failed to systemTime.startTimer because ` + JSON.stringify(error));
  });
  ```


## systemTime.stopTimer

stopTimer(timer: number, callback: AsyncCallback&lt;void&gt;): void

停止定时器。

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

**参数：**

| 参数名   | 类型                        | 必填 | 说明                                                         |
| -------- | --------------------------- | ---- | ------------------------------------------------------------ |
| timer    | number                      | 是   | 定时器的ID。                                                 |

**示例：**

  ```js
  var options = TimerOptions {   
        type:TIMER_TYPE_REALTIME,   
        repeat:false  
      }
  let timerId = systemTimer.Timer(options)
  let startTimerRes = systemTimer.startTimer(timerId, 100000)
  systemTime.stopTimer(timerId, (error, data) => {
      if (error) {
          console.error(`failed to systemTime.stopTimer ` + JSON.stringify(error));
          return;
      }
      console.log(`systemTime.stopTimer success data : ` + JSON.stringify(data));
  });
  ```


## systemTime.stopTimer

stopTimer(timer: number): Promise&lt;void&gt;

停止定时器。

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

**参数：**

| 参数名 | 类型    | 必填 | 说明                                                         |
| ------ | ------- | ---- | ------------------------------------------------------------ |
| timer  | number  | 是   | 定时器的ID。                                                 |                                                                                                                      

**示例：**

  ```js
  var options = TimerOptions {   
        type:TIMER_TYPE_REALTIME,   
        repeat:false  
      }
  let timerId = systemTimer.Timer(options)
  let startTimerRes = systemTimer.startTimer(timerId, 100000)
  systemTime.stopTimer(timerId).then((data) => {
      console.log(`systemTime.stopTimer success data : ` + JSON.stringify(data));
  }).catch((error) => {
      console.error(`failed to systemTime.stopTimer because ` + JSON.stringify(error));
  });
  ```


## systemTime.destroyTimer

destroyTimer(timer: number, callback: AsyncCallback&lt;void&gt;): void

销毁定时器。

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

**参数：**

| 参数名   | 类型                        | 必填 | 说明                                                         |
| -------- | --------------------------- | ---- | ------------------------------------------------------------ |
| timer    | number                      | 是   | 定时器的ID。                                                 |

**示例：**

  ```js
  var options = TimerOptions {   
        type:TIMER_TYPE_REALTIME,   
        repeat:false  
      }
  let timerId = systemTimer.Timer(options)
  let startTimerRes = systemTimer.startTimer(timerId, 100000)
  let stopTimerRes = systemTimer.stopTimer(timerId)
  systemTime.destroyTimer(timerId, (error, data) => {
      if (error) {
          console.error(`failed to systemTime.destroyTimer ` + JSON.stringify(error));
          return;
      }
      console.log(`systemTime.destroyTimer success data : ` + JSON.stringify(data));
  });
  ```


## systemTime.destroyTimer

destroyTimer(timer: number): Promise&lt;void&gt;

销毁定时器。

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

**参数：**

| 参数名 | 类型    | 必填 | 说明                                                         |
| ------ | ------- | ---- | ------------------------------------------------------------ |
| timer  | number  | 是   | 定时器的ID。                                                 |

**示例：**

  ```js
  var options = TimerOptions {   
        type:TIMER_TYPE_REALTIME,   
        repeat:false  
      }
  let timerId = systemTimer.Timer(options)
  let startTimerRes = systemTimer.startTimer(timerId, 100000)
  let stopTimerRes = systemTimer.stopTimer(timerId)
  systemTime.destroyTimer(timerId).then((data) => {
      console.log(`systemTime.destroyTimer success data : ` + JSON.stringify(data));
  }).catch((error) => {
      console.error(`failed to systemTime.destroyTimer because ` + JSON.stringify(error));
  });
  ```