docs/hooks

From Yombo
Jump to: navigation, search

Hooks

 

For explanation, see: Hooking into hooks

Hook name Summary Implemented By Status Common Stops on
Exception
_atoms_set_ Called just after the atom value is set. atoms Active No No
_automation_source_list_ Collects automation source platforms. automation Active No No
_command_before_load_ Called if command doesn't exist already in system, before _command_loaded_. commands Active No No
_command_before_update_ If the command does exist in the system, this hook called before it's updated. commands Active No No
_command_loaded_ Called after the command is loaded into the system, after _command_before_load_. commands Active No No
_command_updated_ Called after the command is update, after _command_before_update_. commands Active No No
_command_before_import_ Called before the command is imported into the system. commands Active No No
_configuration_set_ Called when a configuration has been set. configuration Active Yes No
_configuration_delete_ Called when a configuration has been deleted. configuration Active No No
_configuration_details_ Provide a description for a configuration variable and is i18n friendly. configuration Active No No
_device_type_loaded_ Called after the device type is loaded into the system, after _device_type_before_load_. device types Active No No
_device_type_before_update_ Called if device type does exist already in system, before _device_type_updated_. device types Active No No
_device_type_updated_ Called after the device type is updated into the system, after _device_type_before_update_. device types Active No No
_device_types_before_import_ Called before the device type is imported into the system. device types Active No No
_device_type_before_load_ Called if device type doesn't exist already in system, before _device_type_loaded_. device types Active No No
_device_deleted_ Called after a device has been deleted from the system. devices Active No No
_device_before_update_ Called just before a device is updated. devices Active No No
_device_disabled_ Called after a device has been disabled in Yombo API and the local system. devices Active No No
_device_before_edit_ Called before the device details have been updated with the Yombo API. devices Active No No
_device_updated_ Called just after a device has been updated. devices Active Yes No
_device_enabled_ Called after a device has been enabled in Yombo API and the local system. devices Active No No
_device_edited_ Called after the device details have been updated with the Yombo API. devices Active No No
_device_command_ Used to send commands to devices. Modules use this to receive commands for devices they manage. devices Active No No
_device_before_import_ Called just before a device object is created. devices Active Yes No
_device_before_add_ Called before a new device is submitted to Yombo API to be added. devices Active No No
_device_command_status_ Used to send updates on the status of a device command. devices Active No No
_device_imported_ Called when a new device has been created. devices Active Yes No
_device_added_ Called after a device has been added to the system. devices Active No No
_device_status_ Sent when a device changes status. devices Active Yes No
_device_defore_delete_ Called before a device about to be delete from both the Yombo API and the system. devices Active No No
_input_type_before_update_ Called before an input type is updated within the gateway. input types Active No No
_input_type_updated_ Called after an input type is updated within the gateway. input types Active No No
_sslcerts_ Called on startup to get any required SSL/TLS certificates. sslcerts Active No No
_states_set_ Called just after the state value is set. states Active Yes No
_states_preset_ Called just before the state value is set. states Active Yes Yes
_statistics_lifetimes_ Sets resolution and duration of a statistic. statistics Active No No
_time_event_ The Times library lets the system know when sunrise, sunset, dusk, dawn, or twilight is. Will trigger system events when these start or stop. times Active Yes No
_webinterface_add_routes_ Allows libraries and module to add web interface routes (pages). web interface Active Yes No