Task extends PublicCallable
FinalYes
Table of Contents
Methods
- __construct() : mixed
- accept() : mixed
- Accept a specified task
- add() : mixed
- Add a new task
- approve() : mixed
- Approve (confirm the result of) a specified task
- complete() : mixed
- Complete a specified task
- decline() : mixed
- Decline a specified task
- defer() : mixed
- Defer (put aside) a specified task
- delete() : mixed
- Delete a task
- disapprove() : mixed
- Disapprove (reject the result of) a specified task
- get() : mixed
- Get a task
- getAllowedActions() : mixed
- Get a list of actions that you can do with a specified task
- getErrorCollection() : mixed
- getForbiddenMethods() : mixed
- getList() : mixed
- Get a list of tasks
- pause() : mixed
- Pause execution of a specified task
- renew() : mixed
- Renew (switch to status "pending, await execution") a specified task
- start() : mixed
- Start execution of a specified task
- startWatch() : mixed
- Start an execution timer for a specified task
- stopWatch() : mixed
- Stop an execution timer for a specified task
- update() : mixed
- Update a task with some new data
Methods
__construct()
public
__construct() : mixed
accept()
Accept a specified task
public
accept(mixed $id) : mixed
Parameters
- $id : mixed
add()
Add a new task
public
add(array<string|int, mixed> $data[, array<string|int, mixed> $parameters = array() ]) : mixed
Parameters
- $data : array<string|int, mixed>
- $parameters : array<string|int, mixed> = array()
approve()
Approve (confirm the result of) a specified task
public
approve(mixed $id) : mixed
Parameters
- $id : mixed
complete()
Complete a specified task
public
complete(mixed $id) : mixed
Parameters
- $id : mixed
decline()
Decline a specified task
public
decline(mixed $id) : mixed
Parameters
- $id : mixed
defer()
Defer (put aside) a specified task
public
defer(mixed $id) : mixed
Parameters
- $id : mixed
delete()
Delete a task
public
delete(mixed $id[, array<string|int, mixed> $parameters = array() ]) : mixed
Parameters
- $id : mixed
- $parameters : array<string|int, mixed> = array()
disapprove()
Disapprove (reject the result of) a specified task
public
disapprove(mixed $id) : mixed
Parameters
- $id : mixed
get()
Get a task
public
get(mixed $id) : mixed
Parameters
- $id : mixed
getAllowedActions()
Get a list of actions that you can do with a specified task
public
getAllowedActions(mixed $id) : mixed
Parameters
- $id : mixed
getErrorCollection()
public
getErrorCollection() : mixed
getForbiddenMethods()
public
static getForbiddenMethods() : mixed
getList()
Get a list of tasks
public
getList([array<string|int, mixed> $order = array() ][, array<string|int, mixed> $filter = array() ][, array<string|int, mixed> $select = array() ][, array<string|int, mixed> $parameters = array() ]) : mixed
Parameters
- $order : array<string|int, mixed> = array()
- $filter : array<string|int, mixed> = array()
- $select : array<string|int, mixed> = array()
- $parameters : array<string|int, mixed> = array()
pause()
Pause execution of a specified task
public
pause(mixed $id) : mixed
Parameters
- $id : mixed
renew()
Renew (switch to status "pending, await execution") a specified task
public
renew(mixed $id) : mixed
Parameters
- $id : mixed
start()
Start execution of a specified task
public
start(mixed $id) : mixed
Parameters
- $id : mixed
startWatch()
Start an execution timer for a specified task
public
startWatch(mixed $id) : mixed
Parameters
- $id : mixed
stopWatch()
Stop an execution timer for a specified task
public
stopWatch(mixed $id) : mixed
Parameters
- $id : mixed
update()
Update a task with some new data
public
update(mixed $id, array<string|int, mixed> $data[, array<string|int, mixed> $parameters = array() ]) : mixed
Parameters
- $id : mixed
- $data : array<string|int, mixed>
- $parameters : array<string|int, mixed> = array()