homeassistant.components.hassio.ingress.HassIOIngress Class Reference

Inheritance diagram for homeassistant.components.hassio.ingress.HassIOIngress:

Collaboration diagram for homeassistant.components.hassio.ingress.HassIOIngress:

Public Member Functions
None	__init__ (self, str host, aiohttp.ClientSession websession)

Static Public Attributes
web.Response|web.StreamResponse|web.WebSocketResponse	delete = _handle
web.Response|web.StreamResponse|web.WebSocketResponse	get = _handle
string	name = "api:hassio:ingress"
web.Response|web.StreamResponse|web.WebSocketResponse	options = _handle
web.Response|web.StreamResponse|web.WebSocketResponse	patch = _handle
web.Response|web.StreamResponse|web.WebSocketResponse	post = _handle
web.Response|web.StreamResponse|web.WebSocketResponse	put = _handle
bool	requires_auth = False
string	url = "/api/hassio_ingress/{token}/{path:.*}"

Private Member Functions
URL	_create_url (self, str token, str path)
web.Response|web.StreamResponse|web.WebSocketResponse	_handle (self, web.Request request, str token, str path)
web.Response|web.StreamResponse	_handle_request (self, web.Request request, str token, str path)
web.WebSocketResponse	_handle_websocket (self, web.Request request, str token, str path)

Private Attributes
	_host
	_url
	_websession

Detailed Description

Hass.io view to handle base part.

Definition at line 59 of file ingress.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.hassio.ingress.HassIOIngress.__init__	(		self,
		str	host,
		aiohttp.ClientSession	websession
	)

Initialize a Hass.io ingress view.

Definition at line 66 of file ingress.py.

Member Function Documentation

_create_url()

URL homeassistant.components.hassio.ingress.HassIOIngress._create_url (   self, str  token, str  path  )

private

Create URL to service.

Definition at line 73 of file ingress.py.

_handle()

web.Response | web.StreamResponse | web.WebSocketResponse homeassistant.components.hassio.ingress.HassIOIngress._handle (   self, web.Request  request, str  token, str   path  )

private

Route data to Hass.io ingress service.

Definition at line 87 of file ingress.py.

_handle_request()

web.Response | web.StreamResponse homeassistant.components.hassio.ingress.HassIOIngress._handle_request (   self, web.Request  request, str  token, str   path  )

private

Ingress route for request.

Definition at line 156 of file ingress.py.

_handle_websocket()

web.WebSocketResponse homeassistant.components.hassio.ingress.HassIOIngress._handle_websocket (   self, web.Request  request, str  token, str   path  )

private

Ingress route for websocket.

Definition at line 111 of file ingress.py.

Member Data Documentation

_host

homeassistant.components.hassio.ingress.HassIOIngress._host

private

Definition at line 68 of file ingress.py.

_url

homeassistant.components.hassio.ingress.HassIOIngress._url

private

Definition at line 70 of file ingress.py.

_websession

homeassistant.components.hassio.ingress.HassIOIngress._websession

private

Definition at line 69 of file ingress.py.

delete

web.Response | web.StreamResponse | web.WebSocketResponse homeassistant.components.hassio.ingress.HassIOIngress.delete = _handle

static

Definition at line 107 of file ingress.py.

get

web.Response | web.StreamResponse | web.WebSocketResponse homeassistant.components.hassio.ingress.HassIOIngress.get = _handle

static

Definition at line 104 of file ingress.py.

name

string homeassistant.components.hassio.ingress.HassIOIngress.name = "api:hassio:ingress"

static

Definition at line 62 of file ingress.py.

options

web.Response | web.StreamResponse | web.WebSocketResponse homeassistant.components.hassio.ingress.HassIOIngress.options = _handle

static

Definition at line 109 of file ingress.py.

patch

web.Response | web.StreamResponse | web.WebSocketResponse homeassistant.components.hassio.ingress.HassIOIngress.patch = _handle

static

Definition at line 108 of file ingress.py.

post

web.Response | web.StreamResponse | web.WebSocketResponse homeassistant.components.hassio.ingress.HassIOIngress.post = _handle

static

Definition at line 105 of file ingress.py.

put

web.Response | web.StreamResponse | web.WebSocketResponse homeassistant.components.hassio.ingress.HassIOIngress.put = _handle

static

Definition at line 106 of file ingress.py.

requires_auth

bool homeassistant.components.hassio.ingress.HassIOIngress.requires_auth = False

static

Definition at line 64 of file ingress.py.

url

string homeassistant.components.hassio.ingress.HassIOIngress.url = "/api/hassio_ingress/{token}/{path:.*}"

static

Definition at line 63 of file ingress.py.

---

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

• core/homeassistant/components/hassio/ingress.py