Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.onvif.event.WebHookManager Class Reference

Public Member Functions

None __init__ (self, EventManager event_manager)
 
bool async_start (self)
 
None async_stop (self)
 

Public Attributes

 state
 

Private Member Functions

None _async_create_webhook_subscription (self)
 
None _async_handle_webhook (self, HomeAssistant hass, str webhook_id, Request request)
 
None _async_process_webhook (self, HomeAssistant hass, str webhook_id, bytes|None content)
 
None _async_register_webhook (self)
 
bool _async_start_webhook (self)
 
def _async_unregister_webhook (self)
 
None _async_unsubscribe_webhook (self)
 

Private Attributes

 _device
 
 _event_manager
 
 _hass
 
 _name
 
 _notification_manager
 
 _old_webhook_unique_id
 
 _webhook_unique_id
 
 _webhook_url
 

Detailed Description

Manage ONVIF webhook subscriptions.

If the camera supports webhooks, we will use that instead of
pullpoint subscriptions as soon as we detect that the camera
can reach our webhook.

Definition at line 471 of file event.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.onvif.event.WebHookManager.__init__ (   self,
EventManager  event_manager 
)
Initialize webhook manager.

Definition at line 479 of file event.py.

Member Function Documentation

◆ _async_create_webhook_subscription()

None homeassistant.components.onvif.event.WebHookManager._async_create_webhook_subscription (   self)
private
Create webhook subscription.

Definition at line 522 of file event.py.

◆ _async_handle_webhook()

None homeassistant.components.onvif.event.WebHookManager._async_handle_webhook (   self,
HomeAssistant  hass,
str  webhook_id,
Request   request 
)
private
Handle incoming webhook.

Definition at line 597 of file event.py.

◆ _async_process_webhook()

None homeassistant.components.onvif.event.WebHookManager._async_process_webhook (   self,
HomeAssistant  hass,
str  webhook_id,
bytes | None   content 
)
private
Process incoming webhook data in the background.

Definition at line 616 of file event.py.

◆ _async_register_webhook()

None homeassistant.components.onvif.event.WebHookManager._async_register_webhook (   self)
private
Register the webhook for motion events.

Definition at line 566 of file event.py.

◆ _async_start_webhook()

bool homeassistant.components.onvif.event.WebHookManager._async_start_webhook (   self)
private
Start webhook.

Definition at line 551 of file event.py.

◆ _async_unregister_webhook()

def homeassistant.components.onvif.event.WebHookManager._async_unregister_webhook (   self)
private
Unregister the webhook for motion events.

Definition at line 588 of file event.py.

◆ _async_unsubscribe_webhook()

None homeassistant.components.onvif.event.WebHookManager._async_unsubscribe_webhook (   self)
private
Unsubscribe from the webhook.

Definition at line 645 of file event.py.

◆ async_start()

bool homeassistant.components.onvif.event.WebHookManager.async_start (   self)
Start polling events.

Definition at line 501 of file event.py.

◆ async_stop()

None homeassistant.components.onvif.event.WebHookManager.async_stop (   self)
Unsubscribe from events.

Definition at line 515 of file event.py.

Member Data Documentation

◆ _device

homeassistant.components.onvif.event.WebHookManager._device
private

Definition at line 484 of file event.py.

◆ _event_manager

homeassistant.components.onvif.event.WebHookManager._event_manager
private

Definition at line 483 of file event.py.

◆ _hass

homeassistant.components.onvif.event.WebHookManager._hass
private

Definition at line 485 of file event.py.

◆ _name

homeassistant.components.onvif.event.WebHookManager._name
private

Definition at line 495 of file event.py.

◆ _notification_manager

homeassistant.components.onvif.event.WebHookManager._notification_manager
private

Definition at line 530 of file event.py.

◆ _old_webhook_unique_id

homeassistant.components.onvif.event.WebHookManager._old_webhook_unique_id
private

Definition at line 488 of file event.py.

◆ _webhook_unique_id

homeassistant.components.onvif.event.WebHookManager._webhook_unique_id
private

Definition at line 494 of file event.py.

◆ _webhook_url

homeassistant.components.onvif.event.WebHookManager._webhook_url
private

Definition at line 584 of file event.py.

◆ state

homeassistant.components.onvif.event.WebHookManager.state

Definition at line 481 of file event.py.


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