TimeTrex API Manual

SystemJobQueue
in package

Table of Contents

$api_message_id  : mixed
$progress_bar_obj  : mixed
$user_generic_status_batch_id  : mixed
Add()  : mixed
DeletePending()  : mixed
DeletePendingDuplicates()  : mixed
getAPIMessageID()  : mixed
getBatchStatus()  : mixed
getProgressBarObject()  : null|ProgressBar
getUserGenericStatusBatchID()  : mixed
Purge()  : mixed
sendNotificationToBrowser()  : mixed
setAPIMessageID()  : mixed
setUserGenericStatusBatchID()  : mixed
waitUntilBatchCompleted()  : mixed

Properties

Methods

Add()

public static Add(mixed $name, mixed $batch_id, mixed $class, mixed $method, mixed $args[, mixed $priority = null ][, mixed $extra_data = null ][, mixed $effective_date = null ][, mixed $user_id = null ]) : mixed
Parameters
$name : mixed
$batch_id : mixed
$class : mixed
$method : mixed
$args : mixed
$priority : mixed = null
$extra_data : mixed = null
$effective_date : mixed = null
$user_id : mixed = null
Return values
mixed

DeletePending()

public static DeletePending(mixed $class, mixed $method, mixed $batch_id[, mixed $user_id = null ]) : mixed
Parameters
$class : mixed
$method : mixed
$batch_id : mixed
$user_id : mixed = null
Return values
mixed

DeletePendingDuplicates()

public static DeletePendingDuplicates(mixed $class, mixed $method[, mixed $user_id = null ]) : mixed
Parameters
$class : mixed
$method : mixed
$user_id : mixed = null
Return values
mixed

getBatchStatus()

public static getBatchStatus(mixed $batch_id) : mixed
Parameters
$batch_id : mixed
Return values
mixed

getUserGenericStatusBatchID()

public static getUserGenericStatusBatchID() : mixed
Return values
mixed

sendNotificationToBrowser()

public static sendNotificationToBrowser([mixed $user_id = null ][, mixed $payload = null ]) : mixed
Parameters
$user_id : mixed = null
$payload : mixed = null
Return values
mixed

setAPIMessageID()

public static setAPIMessageID(mixed $value) : mixed
Parameters
$value : mixed
Return values
mixed

setUserGenericStatusBatchID()

public static setUserGenericStatusBatchID(mixed $value) : mixed
Parameters
$value : mixed
Return values
mixed

waitUntilBatchCompleted()

public static waitUntilBatchCompleted(mixed $batch_id, mixed $api_message_id[, mixed $retry_timeout = 2 ][, mixed $timeout = 3600 ]) : mixed
Parameters
$batch_id : mixed
$api_message_id : mixed
$retry_timeout : mixed = 2
$timeout : mixed = 3600
Return values
mixed

Search results