homeassistant.components.websocket_api.auth.AuthPhase Class Reference

Public Member Functions
None	__init__ (self, WebSocketAdapter logger, HomeAssistant hass, Callable[[bytes|str|dict[str, Any]], None] send_message, CALLBACK_TYPE cancel_ws, Request request, Callable[[bytes], Coroutine[Any, Any, None]] send_bytes_text)
ActiveConnection	async_handle (self, JsonValueType msg)

Private Attributes
	_cancel_ws
	_hass
	_logger
	_request
	_send_bytes_text
	_send_message

Detailed Description

Connection that requires client to authenticate first.

Definition at line 49 of file auth.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.websocket_api.auth.AuthPhase.__init__	(		self,
		WebSocketAdapter	logger,
		HomeAssistant	hass,
		Callable[[bytes | str | dict[str, Any]], None]	send_message,
		CALLBACK_TYPE	cancel_ws,
		Request	request,
		Callable[[bytes], Coroutine[Any, Any, None]]	send_bytes_text
	)

Initialize the authenticated connection.

Definition at line 52 of file auth.py.

Member Function Documentation

async_handle()

ActiveConnection homeassistant.components.websocket_api.auth.AuthPhase.async_handle	(		self,
		JsonValueType	msg
	)

Handle authentication.

Definition at line 71 of file auth.py.

Member Data Documentation

_cancel_ws

homeassistant.components.websocket_api.auth.AuthPhase._cancel_ws

private

Definition at line 65 of file auth.py.

_hass

homeassistant.components.websocket_api.auth.AuthPhase._hass

private

Definition at line 62 of file auth.py.

_logger

homeassistant.components.websocket_api.auth.AuthPhase._logger

private

Definition at line 66 of file auth.py.

_request

homeassistant.components.websocket_api.auth.AuthPhase._request

private

Definition at line 67 of file auth.py.

_send_bytes_text

homeassistant.components.websocket_api.auth.AuthPhase._send_bytes_text

private

Definition at line 69 of file auth.py.

_send_message

homeassistant.components.websocket_api.auth.AuthPhase._send_message

private

Definition at line 64 of file auth.py.

---

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

• core/homeassistant/components/websocket_api/auth.py