diff options
author | Alex Grönholm <alex.gronholm@nextday.fi> | 2014-05-28 06:34:21 +0300 |
---|---|---|
committer | Alex Grönholm <alex.gronholm@nextday.fi> | 2014-05-28 06:34:21 +0300 |
commit | c987a5fa48a3f59c68256db3599be6586b5bd866 (patch) | |
tree | 4754d23ba07ecb59f521ab62f9388529bc8f2962 /docs | |
parent | 05bab82b518f0e3d3b4c2c000e149375b6d8681a (diff) | |
download | apscheduler-c987a5fa48a3f59c68256db3599be6586b5bd866.tar.gz |
Added API documentation for apscheduler.events
Diffstat (limited to 'docs')
-rw-r--r-- | docs/modules/events.rst | 50 |
1 files changed, 48 insertions, 2 deletions
diff --git a/docs/modules/events.rst b/docs/modules/events.rst index 2506156..a33fafb 100644 --- a/docs/modules/events.rst +++ b/docs/modules/events.rst @@ -3,8 +3,8 @@ .. automodule:: apscheduler.events -Module Contents ---------------- +API +--- .. autoclass:: SchedulerEvent :members: @@ -14,3 +14,49 @@ Module Contents .. autoclass:: JobEvent :members: + + +Event codes +----------- + +The following event codes are numeric constants importable from :mod:`apscheduler.events`. + +.. list-table:: + :header-rows: 1 + + * - Constant + - Description + - Event class + * - EVENT_SCHEDULER_START + - The scheduler was started + - :class:`SchedulerEvent` + * - EVENT_SCHEDULER_SHUTDOWN + - The scheduler was shut down + - :class:`SchedulerEvent` + * - EVENT_JOBSTORE_ADDED + - A job store was added to the scheduler + - :class:`JobStoreEvent` + * - EVENT_JOBSTORE_REMOVED + - A job store was removed from the scheduler + - :class:`JobStoreEvent` + * - EVENT_JOBSTORE_JOB_ADDED + - A job was added to a job store + - :class:`JobStoreEvent` + * - EVENT_JOBSTORE_JOB_REMOVED + - A job was removed from a job store + - :class:`JobStoreEvent` + * - EVENT_JOBSTORE_JOB_MODIFIED + - A job was modified from outside the scheduler + - :class:`JobStoreEvent` + * - EVENT_JOB_EXECUTED + - A job was executed successfully + - :class:`JobEvent` + * - EVENT_JOB_ERROR + - A job raised an exception during execution + - :class:`JobEvent` + * - EVENT_JOB_MISSED + - A job's execution was missed + - :class:`JobEvent` + * - EVENT_ALL + - A catch-all mask that includes every event type + - N/A |