Public Member Functions
None	__init__ (self, HomeAssistant hass, ONVIFCamera device, ConfigEntry config_entry, str name)

Callable[[], None]	async_add_listener (self, CALLBACK_TYPE update_callback)

None	async_callback_listeners (self)

None	async_mark_events_stale (self)

None	async_parse_messages (self, messages)

None	async_remove_listener (self, CALLBACK_TYPE update_callback)

bool	async_start (self, bool try_pullpoint, bool try_webhook)

None	async_stop (self)

None	async_webhook_failed (self)

None	async_webhook_working (self)

list[Event]	get_platform (self, platform)

Event\|None	get_uid (self, str uid)

set[str]	get_uids_by_platform (self, str platform)

bool	started (self)

Public Attributes
	config_entry

	device

	hass

	name

	pullpoint_manager

	unique_id

	webhook_manager

Private Attributes
	_listeners

Detailed Description

ONVIF Event Manager.

Definition at line 71 of file event.py.

Constructor & Destructor Documentation

◆ init()

None homeassistant.components.onvif.event.EventManager.__init__	(		self,
		HomeAssistant	hass,
		ONVIFCamera	device,
		ConfigEntry	config_entry,
		str	name
	)

Initialize event manager.

Definition at line 74 of file event.py.

Member Function Documentation

◆ async_add_listener()

Callable[[], None] homeassistant.components.onvif.event.EventManager.async_add_listener	(		self,
		CALLBACK_TYPE	update_callback
	)

Listen for data updates.

Definition at line 104 of file event.py.

◆ async_callback_listeners()

None homeassistant.components.onvif.event.EventManager.async_callback_listeners ( self )

Update listeners.

Definition at line 141 of file event.py.

◆ async_mark_events_stale()

None homeassistant.components.onvif.event.EventManager.async_mark_events_stale ( self )

Mark all events as stale when the subscriptions fail since we are out of sync.

Definition at line 221 of file event.py.

◆ async_parse_messages()

None homeassistant.components.onvif.event.EventManager.async_parse_messages	(	self,
		messages
	)

Parse notification message.

Definition at line 146 of file event.py.

◆ async_remove_listener()

None homeassistant.components.onvif.event.EventManager.async_remove_listener	(		self,
		CALLBACK_TYPE	update_callback
	)

Remove data update.

Definition at line 120 of file event.py.

◆ async_start()

bool homeassistant.components.onvif.event.EventManager.async_start	(		self,
		bool	try_pullpoint,
		bool	try_webhook
	)

Start polling events.

Definition at line 125 of file event.py.

◆ async_stop()

None homeassistant.components.onvif.event.EventManager.async_stop ( self )

Unsubscribe from events.

Definition at line 134 of file event.py.

◆ async_webhook_failed()

None homeassistant.components.onvif.event.EventManager.async_webhook_failed ( self )

Mark webhook as failed.

Definition at line 205 of file event.py.

◆ async_webhook_working()

None homeassistant.components.onvif.event.EventManager.async_webhook_working ( self )

Mark webhook as working.

Definition at line 213 of file event.py.

◆ get_platform()

list[Event] homeassistant.components.onvif.event.EventManager.get_platform	(	self,
		platform
	)

Retrieve events for given platform.

Definition at line 192 of file event.py.

◆ get_uid()

Event \| None homeassistant.components.onvif.event.EventManager.get_uid	(		self,
		str	uid
	)

Retrieve event for given id.

Definition at line 188 of file event.py.

◆ get_uids_by_platform()

set[str] homeassistant.components.onvif.event.EventManager.get_uids_by_platform	(		self,
		str	platform
	)

Retrieve uids for a given platform.

Definition at line 196 of file event.py.

◆ started()

bool homeassistant.components.onvif.event.EventManager.started ( self )

Return True if event manager is started.

Definition at line 96 of file event.py.

Member Data Documentation

◆ _listeners

homeassistant.components.onvif.event.EventManager._listeners

private

Definition at line 136 of file event.py.

◆ config_entry

homeassistant.components.onvif.event.EventManager.config_entry

Definition at line 84 of file event.py.

◆ device

homeassistant.components.onvif.event.EventManager.device

Definition at line 83 of file event.py.

◆ hass

homeassistant.components.onvif.event.EventManager.hass

Definition at line 82 of file event.py.

◆ name

homeassistant.components.onvif.event.EventManager.name

Definition at line 86 of file event.py.

◆ pullpoint_manager

homeassistant.components.onvif.event.EventManager.pullpoint_manager

Definition at line 89 of file event.py.

◆ unique_id

homeassistant.components.onvif.event.EventManager.unique_id

Definition at line 85 of file event.py.

◆ webhook_manager

homeassistant.components.onvif.event.EventManager.webhook_manager

Definition at line 88 of file event.py.

The documentation for this class was generated from the following file:

core/homeassistant/components/onvif/event.py

Home Assistant Unofficial Reference 2024.12.1

Public Member Functions

Public Attributes

Private Attributes