homeassistant.components.onboarding Namespace Reference

Namespaces
	const
	views

Classes
class	OnboardingData
class	OnboardingStorage
class	OnboardingStoreData

Functions
None	async_add_listener (HomeAssistant hass, Callable[[], None] listener)
bool	async_is_onboarded (HomeAssistant hass)
bool	async_is_user_onboarded (HomeAssistant hass)
bool	async_setup (HomeAssistant hass, ConfigType config)

Variables
	CONFIG_SCHEMA = cv.empty_config_schema(DOMAIN)
	STORAGE_KEY = DOMAIN
int	STORAGE_VERSION = 4

Detailed Description

Support to help onboard new users.

Function Documentation

async_add_listener()

None homeassistant.components.onboarding.async_add_listener	(	HomeAssistant	hass,
		Callable[[], None]	listener
	)

Add a listener to be called when onboarding is complete.

Definition at line 82 of file __init__.py.

async_is_onboarded()

bool homeassistant.components.onboarding.async_is_onboarded

(

HomeAssistant

hass

)

Return if Home Assistant has been onboarded.

Definition at line 68 of file __init__.py.

async_is_user_onboarded()

bool homeassistant.components.onboarding.async_is_user_onboarded

(

HomeAssistant

hass

)

Return if a user has been created as part of onboarding.

Definition at line 76 of file __init__.py.

async_setup()

bool homeassistant.components.onboarding.async_setup	(	HomeAssistant	hass,
		ConfigType	config
	)

Set up the onboarding component.

Definition at line 97 of file __init__.py.

Variable Documentation

CONFIG_SCHEMA

homeassistant.components.onboarding.CONFIG_SCHEMA = cv.empty_config_schema(DOMAIN)

Definition at line 28 of file __init__.py.

STORAGE_KEY

homeassistant.components.onboarding.STORAGE_KEY = DOMAIN

Definition at line 25 of file __init__.py.

STORAGE_VERSION

int homeassistant.components.onboarding.STORAGE_VERSION = 4

Definition at line 26 of file __init__.py.