\OCP\BackgroundJobIJob

Interface IJob

Summary

Methods
Constants
execute()
setId()
setLastRun()
setArgument()
getId()
getLastRun()
getArgument()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

execute()

execute(\OCP\BackgroundJob\IJobList  $jobList, \OCP\ILogger  $logger = null) 

Run the background job with the registered argument

Parameters

\OCP\BackgroundJob\IJobList $jobList

The job list that manages the state of this job

\OCP\ILogger $logger

setId()

setId(integer  $id) 

Parameters

integer $id

setLastRun()

setLastRun(integer  $lastRun) 

Parameters

integer $lastRun

setArgument()

setArgument(mixed  $argument) 

Parameters

mixed $argument

getId()

getId() : integer

Get the id of the background job This id is determined by the job list when a job is added to the list

Returns

integer

getLastRun()

getLastRun() : integer

Get the last time this job was run as unix timestamp

Returns

integer

getArgument()

getArgument() : mixed

Get the argument associated with the background job This is the argument that will be passed to the background job

Returns

mixed