AbleCloud PHP SDK  1.8.x
PHP SDK of AbleCloud API
Public 成员函数 | 所有成员列表
ACTimerTaskMgr类 参考
类 ACTimerTaskMgr 继承关系图:
Inheritance graph
[图例]
ACTimerTaskMgr 的协作图:
Collaboration graph
[图例]

Public 成员函数

 __construct ($name, $version, $context)
 
 addTask ($task, $user)
 
 modifyTask ($taskId, $task, $user)
 
 listTasks ($user, $deviceId)
 
 deleteTask ($user, $deviceId, $taskId)
 
 stopTask ($user, $deviceId, $taskId)
 
 startTask ($user, $deviceId, $taskId)
 
- Public 成员函数 继承自 ACService
 __construct ($name, $version, $context)
 
 getName ()
 
 getVersion ()
 
 getContext ()
 
 getLastError ()
 

额外继承的成员函数

- Protected 成员函数 继承自 ACService
 resetLastError ($errCode=0, $errMessage='')
 

详细描述

APP端定时任务服务。

构造及析构函数说明

◆ __construct()

ACTimerTaskMgr::__construct (   $name,
  $version,
  $context 
)

构造函数。

参数
$namestring AbleCloud APP端定时任务管理服务的名字。
$versionint AbleCloud APP端定时任务管理服务的版本。
$contextACContext ACContext对象,表示访问该远程服务所依赖的环境信息。

成员函数说明

◆ addTask()

ACTimerTaskMgr::addTask (   $task,
  $user 
)

添加一个新定时任务。

参数
$taskACTimerTask对象,表示要新添加的任务。
$userACUser对象,表示定义该任务的用户。
返回
返回TRUE表示操作成功,否则表示操作失败。失败时,可调用getLastError()获取错误信息。

◆ deleteTask()

ACTimerTaskMgr::deleteTask (   $user,
  $deviceId,
  $taskId 
)

删除一个定时任务。

参数
$userACUser对象,是要被删除的任务所关联的用户。
$deviceId整数,是要被删除的任务所关联的设备的逻辑ID。
$taskId整数,是要被删除的任务的ID。
返回
操作成功时返回TRUE;操作失败时返回FALSE,并且可调用getLastError()获取错误信息。

◆ listTasks()

ACTimerTaskMgr::listTasks (   $user,
  $deviceId 
)

查询用户针对某设备定制的定时任务。

参数
$userACUser对象,表示创建该定时任务的用户。
$deviceId整数,是设备的逻辑ID。
返回
操作成功时,返回一个数组,数组的元素是ACTimerTask对象。操作失败时返回NULL,并且可调用getLastError()获取错误信息。

◆ modifyTask()

ACTimerTaskMgr::modifyTask (   $taskId,
  $task,
  $user 
)

修改指定的定时任务。

参数
$taskId整数,表示要被修改的任务的ID。
$taskACTimerTask对象,表示任务的新内容。
$userACUser对象,表示定义$taskId这个任务的用户。
返回
返回TRUE表示操作成功,否则表示操作失败。失败时,可调用getLastError()获取错误信息。

◆ startTask()

ACTimerTaskMgr::startTask (   $user,
  $deviceId,
  $taskId 
)

启动一个定时任务。

参数
$userACUser对象,是要被启动的任务所关联的用户。
$deviceId整数,是要被启动的任务所关联的设备的逻辑ID。
$taskId整数,是要被启动的任务的ID。
返回
操作成功时返回TRUE;操作失败时返回FALSE,并且可调用getLastError()获取错误信息。

◆ stopTask()

ACTimerTaskMgr::stopTask (   $user,
  $deviceId,
  $taskId 
)

停止一个定时任务。

参数
$userACUser对象,是要被停止的任务所关联的用户。
$deviceId整数,是要被停止的任务所关联的设备的逻辑ID。
$taskId整数,是要被停止的任务的ID。
返回
操作成功时返回TRUE;操作失败时返回FALSE,并且可调用getLastError()获取错误信息。

该类的文档由以下文件生成: