Skip to content

Scheduler

An instance of the forvendi.BreezzApi.BreezzScheduler class (accessible via forvendi.BreezzApi.SCHEDULER) provides methods for starting, terminating, and re-running scheduled background jobs programmatically.


Related Documentation


run()

Runs a scheduled job using the default framework configuration.

Signature:

public void run()

Return Value: void

Usage Example:

forvendi.BreezzApi.SCHEDULER.run();

run(String schedulerConfigName)

Runs a scheduled job using a specific scheduler configuration name.

Signature:

public void run(String schedulerConfigName)

Parameters:

  • schedulerConfigName: Developer name of the scheduler configuration to execute.

Return Value: void

Usage Example:

forvendi.BreezzApi.SCHEDULER.run('DailyAccountCleanupConfig');

kill()

Terminates the active scheduler process. Every active scheduled job managed by the scheduler process will be stopped.

Signature:

public void kill()

Return Value: void

Usage Example:

forvendi.BreezzApi.SCHEDULER.kill();

rerun()

Re-runs the scheduler process by first terminating existing scheduled jobs and then restarting them based on active configurations.

Signature:

public void rerun()

Return Value: void

Usage Example:

forvendi.BreezzApi.SCHEDULER.rerun();