Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.assist_pipeline.pipeline.PipelineStorageCollectionWebsocket Class Reference
Inheritance diagram for homeassistant.components.assist_pipeline.pipeline.PipelineStorageCollectionWebsocket:
[legend]
Collaboration diagram for homeassistant.components.assist_pipeline.pipeline.PipelineStorageCollectionWebsocket:
[legend]

Public Member Functions

None async_setup (self, HomeAssistant hass)
 
None ws_delete_item (self, HomeAssistant hass, websocket_api.ActiveConnection connection, dict msg)
 
None ws_get_item (self, HomeAssistant hass, websocket_api.ActiveConnection connection, dict msg)
 
None ws_list_item (self, HomeAssistant hass, websocket_api.ActiveConnection connection, dict msg)
 
None ws_set_preferred_item (self, HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
 
- Public Member Functions inherited from homeassistant.components.assist_pipeline.pipeline.PipelineStorageCollection
None async_delete_item (self, str item_id)
 
str async_get_preferred_item (self)
 
None async_set_preferred_item (self, str item_id)
 
- Public Member Functions inherited from homeassistant.components.assist_pipeline.pipeline.Pipeline
Pipeline from_json (cls, dict[str, Any] data)
 
dict[str, Any] to_json (self)
 

Additional Inherited Members

- Static Public Attributes inherited from homeassistant.components.assist_pipeline.pipeline.Pipeline
 bool
 
 default_factory
 
 str
 

Detailed Description

Class to expose storage collection management over websocket.

Definition at line 1655 of file pipeline.py.

Member Function Documentation

◆ async_setup()

None homeassistant.components.assist_pipeline.pipeline.PipelineStorageCollectionWebsocket.async_setup (   self,
HomeAssistant  hass 
)
Set up the websocket commands.

Definition at line 1661 of file pipeline.py.

◆ ws_delete_item()

None homeassistant.components.assist_pipeline.pipeline.PipelineStorageCollectionWebsocket.ws_delete_item (   self,
HomeAssistant  hass,
websocket_api.ActiveConnection  connection,
dict   msg 
)
Delete an item.

Definition at line 1691 of file pipeline.py.

◆ ws_get_item()

None homeassistant.components.assist_pipeline.pipeline.PipelineStorageCollectionWebsocket.ws_get_item (   self,
HomeAssistant  hass,
websocket_api.ActiveConnection  connection,
dict   msg 
)
Get an item.

Definition at line 1701 of file pipeline.py.

◆ ws_list_item()

None homeassistant.components.assist_pipeline.pipeline.PipelineStorageCollectionWebsocket.ws_list_item (   self,
HomeAssistant  hass,
websocket_api.ActiveConnection  connection,
dict   msg 
)
List items.

Definition at line 1726 of file pipeline.py.

◆ ws_set_preferred_item()

None homeassistant.components.assist_pipeline.pipeline.PipelineStorageCollectionWebsocket.ws_set_preferred_item (   self,
HomeAssistant  hass,
websocket_api.ActiveConnection  connection,
dict[str, Any]  msg 
)
Set the preferred item.

Definition at line 1738 of file pipeline.py.


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