ACTimerTask (AbleCloud Java API)

java.lang.Object
- com.ablecloud.common.ACTimerTask

public class ACTimerTask
extends java.lang.Object

APP端定时任务。

构造器概要

构造器
构造器和说明

ACTimerTask()

构造器
构造器和说明
`ACTimerTask()`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`java.lang.String`	`getCreateTime()` 取任务的创建时间。
`java.lang.String`	`getDescription()` 取任务的描述信息。
`long`	`getDevice()` 取本任务要操作的设备。
`ACDeviceMsg`	`getDeviceMessage()` 取任务执行时，要发送给设备的消息。
`java.lang.String`	`getModifyTime()` 取任务的更新时间。
`java.lang.String`	`getName()` 取任务的名字。
`byte`	`getStatus()` 获取任务的状态。
`long`	`getTaskFlag()` 检查定时任务是使用云端定时还是使用设备端定时。
`long`	`getTaskId()` 取任务的ID。
`java.lang.String`	`getTimeCycle()` 取本任务的定时规则。
`java.util.Calendar`	`getTimePoint()` 取初次执行任务的时间。
`long`	`getUser()` 取制定本任务的用户的ID。
`void`	`setCreateTime(java.lang.String timeString)` 设置任务的创建时间。
`void`	`setDescription(java.lang.String description)` 设置任务的描述信息。
`void`	`setDevice(long deviceId)` 设置本任务要操作的设备。
`void`	`setDeviceMessage(ACDeviceMsg msg)` 设置任务执行时要发送给设备的消息。
`void`	`setModifyTime(java.lang.String timeString)` 设置任务的修改时间。
`void`	`setName(java.lang.String name)` 设置任务的名字。
`void`	`setStatus(byte status)` 设置任务的状态。
`void`	`setTaskFlag(long taskFlag)` 设置是使用云端定时还是使用设备端定时。
`void`	`setTaskId(long taskId)` 设置任务的ID。
`void`	`setTimeCycle(java.lang.String timeCycle)` 设置任务的定时规则。
`void`	`setTimePoint(java.util.Calendar timePoint)` 设置初次执行该任务的时间。
`void`	`setUser(long userId)` 制定本任务的用户。

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - ACTimerTask
```
public ACTimerTask()
```
- 方法详细资料
  - setName
```
public void setName(java.lang.String name)
```
    设置任务的名字。
    
    参数:
    
    name - 任务的名字。
  - getName
```
public java.lang.String getName()
```
    取任务的名字。
    
    返回:
    
    返回任务的名字。
  - setDescription
```
public void setDescription(java.lang.String description)
```
    设置任务的描述信息。
    
    参数:
    
    description - 任务的描述信息。
  - getDescription
```
public java.lang.String getDescription()
```
    取任务的描述信息。
    
    返回:
    
    返回任务的描述信息。
  - setTimePoint
```
public void setTimePoint(java.util.Calendar timePoint)
```
    设置初次执行该任务的时间。周期任务的周期执行时间也以此时间为基准。
    
    参数:
    
    timePoint - 初次执行该任务的时间。
  - getTimePoint
```
public java.util.Calendar getTimePoint()
```
    取初次执行任务的时间。周期任务的周期执行时间也以此时间为基准。
    
    返回:
    
    返回初次执行该任务的时间。
  - setTimeCycle
```
public void setTimeCycle(java.lang.String timeCycle)
```
    设置任务的定时规则。
    
    参数:
    
    timeCycle - 任务的周期执行规则。 once - 单次执行任务； hour - 每隔一小时执行一次； day - 每隔一天执行一次； month - 每隔一个月执行一次； year - 每隔一年执行一次； week - 指定每周的某一天或某几天执行一次。如week[0,1,2,3,4,5,6]表示周日至周六每天都执行一次；week[1,3,6]表示每周一、周三、周六各执行一次。每天执行的时间以ACTimerTask.timePoint指定的时间（忽略年-月-日）为准。
  - getTimeCycle
```
public java.lang.String getTimeCycle()
```
    取本任务的定时规则。
    
    返回:
    
    返回本任务的定时规则。
  - setUser
```
public void setUser(long userId)
```
    制定本任务的用户。
    
    参数:
    
    userId - 制定本任务的用户的ID。
  - getUser
```
public long getUser()
```
    取制定本任务的用户的ID。
    
    返回:
    
    制定本任务的用户的ID。
  - setDevice
```
public void setDevice(long deviceId)
```
    设置本任务要操作的设备。
    
    参数:
    
    deviceId - 要操作的设备的逻辑ID。
  - getDevice
```
public long getDevice()
```
    取本任务要操作的设备。
    
    返回:
    
    返回本任务要操作的设备的逻辑ID。
  - setDeviceMessage
```
public void setDeviceMessage(ACDeviceMsg msg)
```
    设置任务执行时要发送给设备的消息。
    
    参数:
    
    msg - 任务执行时要发送给设备的消息。
  - getDeviceMessage
```
public ACDeviceMsg getDeviceMessage()
```
    取任务执行时，要发送给设备的消息。
    
    返回:
    
    返回任务执行时要发送给设备的消息。
  - setTaskId
```
public void setTaskId(long taskId)
```
    设置任务的ID。该ID由云端分配。
    
    参数:
    
    taskId -
  - getTaskId
```
public long getTaskId()
```
    取任务的ID。
    
    返回:
    
    返回本任务的ID。
  - setStatus
```
public void setStatus(byte status)
```
    设置任务的状态。
    
    参数:
    
    status - 任务的状态：0 - 已停止；1 - 已启动；2 - 已冻结。
  - getStatus
```
public byte getStatus()
```
    获取任务的状态。
    
    返回:
    
    返回任务的状态码：0 - 已停止；1 - 已启动；2 - 已冻结。
  - setCreateTime
```
public void setCreateTime(java.lang.String timeString)
```
    设置任务的创建时间。
    
    参数:
    
    timeString - 任务的创建时间。
  - getCreateTime
```
public java.lang.String getCreateTime()
```
    取任务的创建时间。
    
    返回:
    
    返回本任务的创建时间。
  - setModifyTime
```
public void setModifyTime(java.lang.String timeString)
```
    设置任务的修改时间。
    
    参数:
    
    timeString - 任务的修改时间。
  - getModifyTime
```
public java.lang.String getModifyTime()
```
    取任务的更新时间。
    
    返回:
    
    返回任务的更新时间。
  - setTaskFlag
```
public void setTaskFlag(long taskFlag)
```
    设置是使用云端定时还是使用设备端定时。云端定时表示该任务由云端的定时器驱动；设备端定时表示该任务由设备端的定时器驱动。
    
    参数:
    
    taskFlag - 为0时表示使用云端定时，为其它值时表示使用设备端定时。
  - getTaskFlag
```
public long getTaskFlag()
```
    检查定时任务是使用云端定时还是使用设备端定时。
    
    返回:
    
    返回0表示设备使用云端定时，返回1表示设备使用设备端定时。

类 ACTimerTask

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

ACTimerTask

方法详细资料

setName

getName

setDescription

getDescription

setTimePoint

getTimePoint

setTimeCycle

getTimeCycle

setUser

getUser

setDevice

getDevice

setDeviceMessage

getDeviceMessage

setTaskId

getTaskId

setStatus

getStatus

setCreateTime

getCreateTime

setModifyTime

getModifyTime

setTaskFlag

getTaskFlag