Constants

TYPE_USER

TYPE_USER

TYPE_ADMIN

TYPE_ADMIN

STATUS_PENDING

STATUS_PENDING

STATUS_RUNNING

STATUS_RUNNING

STATUS_COMPLETE

STATUS_COMPLETE

STATUS_FAILED

STATUS_FAILED

STATUS_PAUSED

STATUS_PAUSED

STATUS_TEMPLATE

STATUS_TEMPLATE

STATUS_INTERRUPT

STATUS_INTERRUPT

FLAG_STOPPABLE

FLAG_STOPPABLE

FLAG_RESUMABLE

FLAG_RESUMABLE

FLAG_HAS_PROGRESS

FLAG_HAS_PROGRESS

Properties

$id

$id : string

Type

string

$flags

$flags : integer

A boolean combination of the FLAG_XXX constants

Type

integer

$label

$label : string

Type

string

$userId

$userId : string

Type

string

$wsId

$wsId : string

Type

string

$wsIdentifier

$wsIdentifier : string

Type

string

$status

$status : integer

Type

integer

$statusMessage

$statusMessage : string

Type

string

$progress

$progress : integer

Type

integer

$action

$action : string

Type

string

$parameters

$parameters : array

Type

array

$type

$type : integer

Type

integer

$parentId

$parentId : string

Type

string — Uid of parent task

$statusChangeDate

$statusChangeDate : integer

Type

integer

$creationDate

$creationDate : integer

Type

integer

$nodes

$nodes : array

Type

array

$impersonateUsers

$impersonateUsers : string

Type

string

Methods

__construct()

__construct() 

Task constructor.

getChildrenTasks()

getChildrenTasks() : array<mixed,\Pydio\Tasks\Task>

Returns

array<mixed,\Pydio\Tasks\Task>

getId()

getId() : string

Returns

string

setId()

setId(string  $id) 

Parameters

string $id

getFlags()

getFlags() : integer

Returns

integer

setFlags()

setFlags(integer  $flags) 

Parameters

integer $flags

isStoppable()

isStoppable() : integer

Returns

integer

isResumable()

isResumable() : integer

Returns

integer

hasProgress()

hasProgress() : integer

Returns

integer

getLabel()

getLabel() : string

Returns

string

setLabel()

setLabel(string  $label) 

Parameters

string $label

setActionLabel()

setActionLabel(array  $messages, string  $actionLabelId) 

Set label like 'Launching task $actionLabel in background'

Parameters

array $messages
string $actionLabelId

getUserId()

getUserId() : string

Returns

string

setUserId()

setUserId(string  $userId) 

Parameters

string $userId

getWsId()

getWsId() : string

Returns

string

setWsId()

setWsId(string  $wsId) 

Parameters

string $wsId

getWsIdentifier()

getWsIdentifier() : string

Returns

string

setWsIdentifier()

setWsIdentifier(string  $wsIdentifier) 

Parameters

string $wsIdentifier

getStatus()

getStatus() : integer

Returns

integer

setStatus()

setStatus(integer  $status) 

Parameters

integer $status

getStatusMessage()

getStatusMessage() : string

Returns

string

setStatusMessage()

setStatusMessage(string  $statusMessage) 

Parameters

string $statusMessage

getProgress()

getProgress() : integer

Returns

integer

setProgress()

setProgress(integer  $progress) 

Parameters

integer $progress

getAction()

getAction() : string

Returns

string

setAction()

setAction(string  $action) 

Parameters

string $action

getParameters()

getParameters() : array

Returns

array

setParameters()

setParameters(array  $parameters) 

Parameters

array $parameters

attachToNode()

attachToNode(  $nodePath) 

Parameters

$nodePath

getImpersonateUsers()

getImpersonateUsers() : string

Returns

string

setImpersonateUsers()

setImpersonateUsers(string  $impersonateUsers) 

Parameters

string $impersonateUsers

getType()

getType() : integer

Returns

integer

setType()

setType(integer  $type) 

Parameters

integer $type

getParentId()

getParentId() : string

Returns

string

setParentId()

setParentId(string  $parentId) 

Parameters

string $parentId

getStatusChangeDate()

getStatusChangeDate() : \DateTime

Returns

\DateTime

setStatusChangeDate()

setStatusChangeDate(integer  $statusChangeDate) 

Parameters

integer $statusChangeDate

getCreationDate()

getCreationDate() : \DateTime

Returns

\DateTime

setCreationDate()

setCreationDate(integer  $creationDate) 

Parameters

integer $creationDate