Constructor
new $k.ExternalCommandJob()
Extends
Methods
(static) cancelSchedule(name)
Cancel a job schedule
Parameters:
| Name | Type | Description |
|---|---|---|
name | string | The schedule name |
- Version
- Experimental feature, might be removed at any time
- Since
- 5.5.0
(static) schedule(name, interval, user, command, jobArgumentsopt, timeoutopt)
Add a job schedule
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
name | string | The schedule name | |
interval | number | The interval in minutes | |
user | $k. | The user or user instance | |
command | string | The command | |
jobArguments | string | <optional> | The arguments |
timeout | <optional> | This parameter is currently ignored |
- Version
- Experimental feature, might be removed at any time
- Since
- 5.5.0
Throws:
If the user is not allowed
If the schedule name is already in use
- Type
- JSERangeError
insert()
Add the job to the job queue
- Overrides
setCommand(commandString)
Set the external command line to be executed.
Parameters:
| Name | Type | Description |
|---|---|---|
commandString | string | Name of the command to call |
setPriority(priorityNumber)
Sets the priority of the job. Default priority is 100. The lower the number the higher the priority.
Parameters:
| Name | Type | Description |
|---|---|---|
priorityNumber | number | Priority |
- Inherited From
setTimeout(seconds)
Set the timeout [seconds] for external command execution. Default value is 60 seconds.
Parameters:
| Name | Type | Description |
|---|---|---|
seconds | number | Integer number of seconds |