homeassistant.components.analytics.analytics.Analytics Class Reference

Public Member Functions
None	__init__ (self, HomeAssistant hass)
str	endpoint (self)
None	load (self)
bool	onboarded (self)
dict	preferences (self)
None	save_preferences (self, dict preferences)
None	send_analytics (self, datetime|None _=None)
bool	supervisor (self)
str|None	uuid (self)

Public Attributes
	session

Private Member Functions
bool	_async_should_report_integration (self, Integration integration, set[str] yaml_domains, set[str] entity_registry_platforms)

Private Attributes
	_data
	_store

Detailed Description

Analytics helper class for the analytics integration.

Definition at line 98 of file analytics.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.analytics.analytics.Analytics.__init__	(		self,
		HomeAssistant	hass
	)

Initialize the Analytics class.

Definition at line 101 of file analytics.py.

Member Function Documentation

_async_should_report_integration()

bool homeassistant.components.analytics.analytics.Analytics._async_should_report_integration (   self, Integration  integration, set[str]  yaml_domains, set[str]  entity_registry_platforms  )

private

Return a bool to indicate if this integration should be reported.

Definition at line 344 of file analytics.py.

endpoint()

str homeassistant.components.analytics.analytics.Analytics.endpoint

(

self

)

Return the endpoint that will receive the payload.

Definition at line 130 of file analytics.py.

load()

None homeassistant.components.analytics.analytics.Analytics.load

(

self

)

Load preferences.

Definition at line 142 of file analytics.py.

onboarded()

bool homeassistant.components.analytics.analytics.Analytics.onboarded

(

self

)

Return bool if the user has made a choice.

Definition at line 120 of file analytics.py.

preferences()

dict homeassistant.components.analytics.analytics.Analytics.preferences

(

self

)

Return the current active preferences.

Definition at line 109 of file analytics.py.

save_preferences()

None homeassistant.components.analytics.analytics.Analytics.save_preferences	(		self,
		dict	preferences
	)

Save preferences.

Definition at line 163 of file analytics.py.

send_analytics()

None homeassistant.components.analytics.analytics.Analytics.send_analytics	(		self,
		datetime | None	_ = None
	)

Send analytics.

Definition at line 176 of file analytics.py.

supervisor()

bool homeassistant.components.analytics.analytics.Analytics.supervisor

(

self

)

Return bool if a supervisor is present.

Definition at line 138 of file analytics.py.

uuid()

str | None homeassistant.components.analytics.analytics.Analytics.uuid

(

self

)

Return the uuid for the analytics integration.

Definition at line 125 of file analytics.py.

Member Data Documentation

_data

homeassistant.components.analytics.analytics.Analytics._data

private

Definition at line 105 of file analytics.py.

_store

homeassistant.components.analytics.analytics.Analytics._store

private

Definition at line 106 of file analytics.py.

session

homeassistant.components.analytics.analytics.Analytics.session

Definition at line 104 of file analytics.py.

---

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

• core/homeassistant/components/analytics/analytics.py