homeassistant.helpers.issue_registry Namespace Reference

Classes
class	EventIssueRegistryUpdatedData
class	IssueEntry
class	IssueRegistry
class	IssueRegistryStore
class	IssueSeverity

Functions
None	async_create_issue (HomeAssistant hass, str domain, str issue_id, *str|None breaks_in_ha_version=None, dict[str, str|int|float|None]|None data=None, bool is_fixable, bool is_persistent=False, str|None issue_domain=None, str|None learn_more_url=None, IssueSeverity severity, str translation_key, dict[str, str]|None translation_placeholders=None)
None	async_delete_issue (HomeAssistant hass, str domain, str issue_id)
IssueRegistry	async_get (HomeAssistant hass)
None	async_ignore_issue (HomeAssistant hass, str domain, str issue_id, bool ignore)
None	async_load (HomeAssistant hass, *bool read_only=False)
None	create_issue (HomeAssistant hass, str domain, str issue_id, *str|None breaks_in_ha_version=None, dict[str, str|int|float|None]|None data=None, bool is_fixable, bool is_persistent=False, str|None issue_domain=None, str|None learn_more_url=None, IssueSeverity severity, str translation_key, dict[str, str]|None translation_placeholders=None)
None	delete_issue (HomeAssistant hass, str domain, str issue_id)

Variables
string	STORAGE_KEY = "repairs.issue_registry"
int	STORAGE_VERSION_MAJOR = 1
int	STORAGE_VERSION_MINOR = 2

Detailed Description

Persistently store issues raised by integrations.

Function Documentation

async_create_issue()

None homeassistant.helpers.issue_registry.async_create_issue	(	HomeAssistant	hass,
		str	domain,
		str	issue_id,
		*str | None	breaks_in_ha_version = None,
		dict[str, str | int | float | None] | None	data = None,
		bool	is_fixable,
		bool	is_persistent = False,
		str | None	issue_domain = None,
		str | None	learn_more_url = None,
		IssueSeverity	severity,
		str	translation_key,
		dict[str, str] | None	translation_placeholders = None
	)

Create an issue, or replace an existing one.

Definition at line 326 of file issue_registry.py.

async_delete_issue()

None homeassistant.helpers.issue_registry.async_delete_issue	(	HomeAssistant	hass,
		str	domain,
		str	issue_id
	)

Delete an issue.

It is not an error to delete an issue that does not exist.

Definition at line 402 of file issue_registry.py.

async_get()

IssueRegistry homeassistant.helpers.issue_registry.async_get

(

HomeAssistant

hass

)

Get issue registry.

Definition at line 312 of file issue_registry.py.

async_ignore_issue()

None homeassistant.helpers.issue_registry.async_ignore_issue	(	HomeAssistant	hass,
		str	domain,
		str	issue_id,
		bool	ignore
	)

Ignore an issue.

Will raise if the issue does not exist.

Definition at line 422 of file issue_registry.py.

async_load()

None homeassistant.helpers.issue_registry.async_load	(	HomeAssistant	hass,
		*bool	read_only = False
	)

Load issue registry.

Definition at line 317 of file issue_registry.py.

create_issue()

None homeassistant.helpers.issue_registry.create_issue	(	HomeAssistant	hass,
		str	domain,
		str	issue_id,
		*str | None	breaks_in_ha_version = None,
		dict[str, str | int | float | None] | None	data = None,
		bool	is_fixable,
		bool	is_persistent = False,
		str | None	issue_domain = None,
		str | None	learn_more_url = None,
		IssueSeverity	severity,
		str	translation_key,
		dict[str, str] | None	translation_placeholders = None
	)

Create an issue, or replace an existing one.

Definition at line 365 of file issue_registry.py.

delete_issue()

None homeassistant.helpers.issue_registry.delete_issue	(	HomeAssistant	hass,
		str	domain,
		str	issue_id
	)

Delete an issue.

It is not an error to delete an issue that does not exist.

Definition at line 411 of file issue_registry.py.

Variable Documentation

STORAGE_KEY

string homeassistant.helpers.issue_registry.STORAGE_KEY = "repairs.issue_registry"

Definition at line 28 of file issue_registry.py.

STORAGE_VERSION_MAJOR

int homeassistant.helpers.issue_registry.STORAGE_VERSION_MAJOR = 1

Definition at line 29 of file issue_registry.py.

STORAGE_VERSION_MINOR

int homeassistant.helpers.issue_registry.STORAGE_VERSION_MINOR = 2

Definition at line 30 of file issue_registry.py.