summaryrefslogtreecommitdiffstats
path: root/lib/public/backgroundjob/ijob.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/backgroundjob/ijob.php')
-rw-r--r--lib/public/backgroundjob/ijob.php10
1 files changed, 10 insertions, 0 deletions
diff --git a/lib/public/backgroundjob/ijob.php b/lib/public/backgroundjob/ijob.php
index 9206590dd05..3a1be86ef4e 100644
--- a/lib/public/backgroundjob/ijob.php
+++ b/lib/public/backgroundjob/ijob.php
@@ -23,6 +23,12 @@
namespace OCP\BackgroundJob;
+/**
+ * Interface IJob
+ *
+ * @package OCP\BackgroundJob
+ * @since 7.0.0
+ */
interface IJob {
/**
* Run the background job with the registered argument
@@ -30,6 +36,7 @@ interface IJob {
* @param \OCP\BackgroundJob\IJobList $jobList The job list that manages the state of this job
* @param \OC\Log $logger
* @return void
+ * @since 7.0.0
*/
public function execute($jobList, $logger = null);
@@ -38,6 +45,7 @@ interface IJob {
* This id is determined by the job list when a job is added to the list
*
* @return int
+ * @since 7.0.0
*/
public function getId();
@@ -45,6 +53,7 @@ interface IJob {
* Get the last time this job was run as unix timestamp
*
* @return int
+ * @since 7.0.0
*/
public function getLastRun();
@@ -53,6 +62,7 @@ interface IJob {
* This is the argument that will be passed to the background job
*
* @return mixed
+ * @since 7.0.0
*/
public function getArgument();
}