diff --git a/zh-cn/application-dev/reference/apis/js-apis-system-time.md b/zh-cn/application-dev/reference/apis/js-apis-system-time.md index 40e5f6498283fd9625f251508de80b7e2b0d8faa..613ba9f8f34590d04f029cc59abd8823129a42ce 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-system-time.md +++ b/zh-cn/application-dev/reference/apis/js-apis-system-time.md @@ -22,7 +22,7 @@ setTime(time : number, callback : AsyncCallback<void>) : void **需要权限:** ohos.permission.SET_TIME -**系统能力:** SystemCapability.Miscservices.Time +**系统能力:** SystemCapability.MiscServices.Time **参数:** @@ -201,7 +201,7 @@ getRealActiveTime(isNano?: boolean): Promise<number> ## systemTime.getRealTime8+ -getRealTime(callback: AsyncCallback<number>): void +getRealTime(isNano?: boolean, callback: AsyncCallback<number>): void 获取自系统启动以来经过的时间,包括深度睡眠时间,使用callback形式返回结果。 @@ -229,7 +229,7 @@ getRealTime(callback: AsyncCallback<number>): void ## systemTime.getRealTime8+ -getRealTime(): Promise<number> +getRealTime(isNano?: boolean): Promise<number> 获取自系统启动以来经过的时间,包括深度睡眠时间,使用Promise形式返回结果。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-system-timer.md b/zh-cn/application-dev/reference/apis/js-apis-system-timer.md new file mode 100644 index 0000000000000000000000000000000000000000..0fe674445a17c2986c17543fbbdc3a6216120baa --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-system-timer.md @@ -0,0 +1,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<number>): void + +创建定时器。 + +**系统能力:** SystemCapability.MiscServices.Time + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------| ---- | --------------------------------------------------------------------------------------- | +| options | TimerOptions | 是 | const TIMER_TYPE_REALTIME: 设置为系统启动时间定时器,否则为walltime定时器;
const TIMER_TYPE_WAKEUP: 设置为唤醒定时器,否则为非唤醒;
const TIMER_TYPE_EXACT: 设置为精准定时器,否则为非精准定时器;
const TIMER_TYPE_IDLE: number: 设置为IDLE模式定时器,否则为非IDLE模式定时器(暂不支持) | +| repeat | boolean | 是 | true 为循环定时器,false为单次定时器。 | +| interval | number | 否 | 如果是循环定时器,repeat值应大于5000毫秒,非重复定时器置为0。 | +| wantAgent| wantAgent | 否 | 设置通知的wantagent,定时器到期后通知。 | + +**返回值:** + +| 类型 | 说明 | +| ------------------------- | ------------------------------------------------------------ | +| syncCallback<number>| 以回调函数的形式返回定时器的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<number> + +创建定时器。 + +**系统能力:** SystemCapability.MiscServices.Time + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------| ---- | --------------------------------------------------------------------------------------- | +| options | TimerOptions | 是 | const TIMER_TYPE_REALTIME: 设置为系统启动时间定时器,否则为walltime定时器;
const TIMER_TYPE_WAKEUP: 设置为唤醒定时器,否则为非唤醒;
const TIMER_TYPE_EXACT: 设置为精准定时器,否则为非精准定时器;
const TIMER_TYPE_IDLE: number: 设置为IDLE模式定时器,否则为非IDLE模式定时器(暂不支持) | +| repeat | boolean | 是 | true 为循环定时器,false为单次定时器。 | +| interval | number | 否 | 如果是循环定时器,repeat值应大于5000毫秒,非重复定时器置为0。 | +| wantAgent| wantAgent | 否 | 设置通知的wantagent,定时器到期后通知。 | + +**返回值:** + +| 类型 | 说明 | +| --------------------- | ------------------------------------------------------------ | +| Promise<number> | 以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<void>): 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<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).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<void>): 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<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).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<void>): 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<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).then((data) => { + console.log(`systemTime.destroyTimer success data : ` + JSON.stringify(data)); + }).catch((error) => { + console.error(`failed to systemTime.destroyTimer because ` + JSON.stringify(error)); + }); + ``` \ No newline at end of file