Namespaces
	const

	intent

Classes
class	TodoItem

class	TodoItemFieldDescription

class	TodoListEntity

Functions
dict[str, str]	_api_items_factory (Iterable[tuple[str, Any]] obj)

None	_async_add_todo_item (TodoListEntity entity, ServiceCall call)

dict[str, Any]	_async_get_todo_items (TodoListEntity entity, ServiceCall call)

None	_async_remove_completed_items (TodoListEntity entity, ServiceCall _)

None	_async_remove_todo_items (TodoListEntity entity, ServiceCall call)

None	_async_update_todo_item (TodoListEntity entity, ServiceCall call)

TodoItem\|None	_find_by_uid_or_summary (str value, list[TodoItem]\|None items)

None	_validate_supported_features (int\|None supported_features, dict[str, Any] call_data)

bool	async_setup (HomeAssistant hass, ConfigType config)

bool	async_setup_entry (HomeAssistant hass, ConfigEntry entry)

bool	async_unload_entry (HomeAssistant hass, ConfigEntry entry)

None	websocket_handle_subscribe_todo_items (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)

None	websocket_handle_todo_item_list (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)

None	websocket_handle_todo_item_move (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)

Variables
	_LOGGER = logging.getLogger(__name__)

dictionary	CACHED_PROPERTIES_WITH_ATTR_

string	ENTITY_ID_FORMAT = DOMAIN + ".{}"

	PLATFORM_SCHEMA = cv.PLATFORM_SCHEMA

	PLATFORM_SCHEMA_BASE = cv.PLATFORM_SCHEMA_BASE

	SCAN_INTERVAL = datetime.timedelta(seconds=60)

dictionary	TODO_ITEM_FIELD_SCHEMA

list	TODO_ITEM_FIELD_VALIDATIONS = [cv.has_at_most_one_key(ATTR_DUE_DATE, ATTR_DUE_DATETIME)]

list	TODO_ITEM_FIELDS

Detailed Description

The todo integration.

Function Documentation

◆ _api_items_factory()

dict[str, str] homeassistant.components.todo._api_items_factory ( Iterable[tuple[str, Any]] obj )

private

Convert CalendarEvent dataclass items to dictionary of attributes.

Definition at line 366 of file __init__.py.

◆ _async_add_todo_item()

None homeassistant.components.todo._async_add_todo_item	(	TodoListEntity	entity,
		ServiceCall	call
	)

private

Add an item to the To-do list.

Definition at line 461 of file __init__.py.

◆ _async_get_todo_items()

dict[str, Any] homeassistant.components.todo._async_get_todo_items	(	TodoListEntity	entity,
		ServiceCall	call
	)

private

Return items in the To-do list.

Definition at line 523 of file __init__.py.

◆ _async_remove_completed_items()

None homeassistant.components.todo._async_remove_completed_items	(	TodoListEntity	entity,
		ServiceCall	_
	)

private

Remove all completed items from the To-do list.

Definition at line 536 of file __init__.py.

◆ _async_remove_todo_items()

None homeassistant.components.todo._async_remove_todo_items	(	TodoListEntity	entity,
		ServiceCall	call
	)

private

Remove an item in the To-do list.

Definition at line 508 of file __init__.py.

◆ _async_update_todo_item()

None homeassistant.components.todo._async_update_todo_item	(	TodoListEntity	entity,
		ServiceCall	call
	)

private

Update an item in the To-do list.

Definition at line 477 of file __init__.py.

◆ _find_by_uid_or_summary()

TodoItem \| None homeassistant.components.todo._find_by_uid_or_summary	(	str	value,
		list[TodoItem] \| None	items
	)

private

Find a To-do List item by uid or summary name.

Definition at line 451 of file __init__.py.

◆ _validate_supported_features()

None homeassistant.components.todo._validate_supported_features	(	int \| None	supported_features,
		dict[str, Any]	call_data
	)

private

Validate service call fields against entity supported features.

Definition at line 100 of file __init__.py.

◆ async_setup()

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

Set up Todo entities.

Definition at line 115 of file __init__.py.

◆ async_setup_entry()

bool homeassistant.components.todo.async_setup_entry	(	HomeAssistant	hass,
		ConfigEntry	entry
	)

Set up a config entry.

Definition at line 198 of file __init__.py.

◆ async_unload_entry()

bool homeassistant.components.todo.async_unload_entry	(	HomeAssistant	hass,
		ConfigEntry	entry
	)

Unload a config entry.

Definition at line 203 of file __init__.py.

◆ websocket_handle_subscribe_todo_items()

None homeassistant.components.todo.websocket_handle_subscribe_todo_items	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Subscribe to To-do list item updates.

Definition at line 331 of file __init__.py.

◆ websocket_handle_todo_item_list()

None homeassistant.components.todo.websocket_handle_todo_item_list	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Handle the list of To-do items in a To-do- list.

Definition at line 386 of file __init__.py.

◆ websocket_handle_todo_item_move()

None homeassistant.components.todo.websocket_handle_todo_item_move	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Handle move of a To-do item within a To-do list.

Definition at line 421 of file __init__.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.todo._LOGGER = logging.getLogger(__name__)

private

Definition at line 48 of file __init__.py.

◆ CACHED_PROPERTIES_WITH_ATTR_

dictionary homeassistant.components.todo.CACHED_PROPERTIES_WITH_ATTR_

Initial value:

 =  {
     "todo_items",
 }

Definition at line 236 of file __init__.py.

◆ ENTITY_ID_FORMAT

string homeassistant.components.todo.ENTITY_ID_FORMAT = DOMAIN + ".{}"

Definition at line 50 of file __init__.py.

◆ PLATFORM_SCHEMA

homeassistant.components.todo.PLATFORM_SCHEMA = cv.PLATFORM_SCHEMA

Definition at line 51 of file __init__.py.

◆ PLATFORM_SCHEMA_BASE

homeassistant.components.todo.PLATFORM_SCHEMA_BASE = cv.PLATFORM_SCHEMA_BASE

Definition at line 52 of file __init__.py.

◆ SCAN_INTERVAL

homeassistant.components.todo.SCAN_INTERVAL = datetime.timedelta(seconds=60)

Definition at line 53 of file __init__.py.

◆ TODO_ITEM_FIELD_SCHEMA

dictionary homeassistant.components.todo.TODO_ITEM_FIELD_SCHEMA

Initial value:

 =  {
     vol.Optional(desc.service_field): desc.validation for desc in TODO_ITEM_FIELDS
 }

Definition at line 94 of file __init__.py.

◆ TODO_ITEM_FIELD_VALIDATIONS

list homeassistant.components.todo.TODO_ITEM_FIELD_VALIDATIONS = [cv.has_at_most_one_key(ATTR_DUE_DATE, ATTR_DUE_DATETIME)]

Definition at line 97 of file __init__.py.

◆ TODO_ITEM_FIELDS

list homeassistant.components.todo.TODO_ITEM_FIELDS

Initial value:

 =  [
     TodoItemFieldDescription(
         service_field=ATTR_DUE_DATE,
         validation=vol.Any(cv.date, None),
         todo_item_field=ATTR_DUE,
         required_feature=TodoListEntityFeature.SET_DUE_DATE_ON_ITEM,
     ),
     TodoItemFieldDescription(
         service_field=ATTR_DUE_DATETIME,
         validation=vol.Any(vol.All(cv.datetime, dt_util.as_local), None),
         todo_item_field=ATTR_DUE,
         required_feature=TodoListEntityFeature.SET_DUE_DATETIME_ON_ITEM,
     ),
     TodoItemFieldDescription(
         service_field=ATTR_DESCRIPTION,
         validation=vol.Any(cv.string, None),
         todo_item_field=ATTR_DESCRIPTION,
         required_feature=TodoListEntityFeature.SET_DESCRIPTION_ON_ITEM,
     ),
 ]

Definition at line 73 of file __init__.py.

Home Assistant Unofficial Reference 2024.12.1

Namespaces

Classes

Functions

Variables

Detailed Description

Function Documentation

◆ _api_items_factory()

◆ _async_add_todo_item()

◆ _async_get_todo_items()

◆ _async_remove_completed_items()

◆ _async_remove_todo_items()

◆ _async_update_todo_item()

◆ _find_by_uid_or_summary()

◆ _validate_supported_features()

◆ async_setup()

◆ async_setup_entry()

◆ async_unload_entry()

◆ websocket_handle_subscribe_todo_items()

◆ websocket_handle_todo_item_list()

◆ websocket_handle_todo_item_move()

Variable Documentation

◆ _LOGGER

◆ CACHED_PROPERTIES_WITH_ATTR_

◆ ENTITY_ID_FORMAT

◆ PLATFORM_SCHEMA

◆ PLATFORM_SCHEMA_BASE

◆ SCAN_INTERVAL

◆ TODO_ITEM_FIELD_SCHEMA

◆ TODO_ITEM_FIELD_VALIDATIONS

◆ TODO_ITEM_FIELDS