Nextcloud PHP API (stable18)

IJob

Interface IJob

Tags
since
7.0.0

Table of Contents

execute()  : mixed
Run the background job with the registered argument
getArgument()  : mixed
Get the argument associated with the background job This is the argument that will be passed to the background job
getId()  : int
Get the id of the background job This id is determined by the job list when a job is added to the list
getLastRun()  : int
Get the last time this job was run as unix timestamp
setArgument()  : mixed
setId()  : mixed
setLastRun()  : mixed

Methods

execute()

Run the background job with the registered argument

public execute(IJobList $jobList[, ILogger|null $logger = null ]) : mixed
Parameters
$jobList : IJobList

The job list that manages the state of this job

$logger : ILogger|null = null
Tags
since
7.0.0
Return values
mixed

getArgument()

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

public getArgument() : mixed
Tags
since
7.0.0
Return values
mixed

getId()

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

public getId() : int
Tags
since
7.0.0
Return values
int

getLastRun()

Get the last time this job was run as unix timestamp

public getLastRun() : int
Tags
since
7.0.0
Return values
int

setArgument()

public setArgument(mixed $argument) : mixed
Parameters
$argument : mixed
Tags
since
7.0.0
Return values
mixed

setId()

public setId(int $id) : mixed
Parameters
$id : int
Tags
since
7.0.0
Return values
mixed

setLastRun()

public setLastRun(int $lastRun) : mixed
Parameters
$lastRun : int
Tags
since
7.0.0
Return values
mixed

Search results