Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.todoist.calendar Namespace Reference

Classes

class  TodoistProjectData
 
class  TodoistProjectEntity
 

Functions

None async_register_services (HomeAssistant hass, TodoistCoordinator coordinator)
 
None async_setup_entry (HomeAssistant hass, ConfigEntry entry, AddEntitiesCallback async_add_entities)
 
None async_setup_platform (HomeAssistant hass, ConfigType config, AddEntitiesCallback async_add_entities, DiscoveryInfoType|None discovery_info=None)
 
datetime|date|None get_start (Due due)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
 NEW_TASK_SERVICE_SCHEMA
 
 PLATFORM_SCHEMA
 
 SCAN_INTERVAL = timedelta(minutes=1)
 

Detailed Description

Support for Todoist task management (https://todoist.com).

Function Documentation

◆ async_register_services()

None homeassistant.components.todoist.calendar.async_register_services ( HomeAssistant  hass,
TodoistCoordinator   coordinator 
)
Register services.

Definition at line 206 of file calendar.py.

◆ async_setup_entry()

None homeassistant.components.todoist.calendar.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  entry,
AddEntitiesCallback   async_add_entities 
)
Set up the Todoist calendar platform config entry.

Definition at line 115 of file calendar.py.

◆ async_setup_platform()

None homeassistant.components.todoist.calendar.async_setup_platform ( HomeAssistant  hass,
ConfigType  config,
AddEntitiesCallback  async_add_entities,
DiscoveryInfoType | None   discovery_info = None 
)
Set up the Todoist platform.

Definition at line 132 of file calendar.py.

◆ get_start()

datetime | date | None homeassistant.components.todoist.calendar.get_start ( Due  due)
Return the task due date as a start date or date time.

Definition at line 749 of file calendar.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.todoist.calendar._LOGGER = logging.getLogger(__name__)
private

Definition at line 65 of file calendar.py.

◆ NEW_TASK_SERVICE_SCHEMA

homeassistant.components.todoist.calendar.NEW_TASK_SERVICE_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Required(CONTENT): cv.string,
4  vol.Optional(DESCRIPTION): cv.string,
5  vol.Optional(PROJECT_NAME, default="inbox"): vol.All(cv.string, vol.Lower),
6  vol.Optional(SECTION_NAME): vol.All(cv.string, vol.Lower),
7  vol.Optional(LABELS): cv.ensure_list_csv,
8  vol.Optional(ASSIGNEE): cv.string,
9  vol.Optional(PRIORITY): vol.All(vol.Coerce(int), vol.Range(min=1, max=4)),
10  vol.Exclusive(DUE_DATE_STRING, "due_date"): cv.string,
11  vol.Optional(DUE_DATE_LANG): vol.All(cv.string, vol.In(DUE_DATE_VALID_LANGS)),
12  vol.Exclusive(DUE_DATE, "due_date"): cv.string,
13  vol.Exclusive(REMINDER_DATE_STRING, "reminder_date"): cv.string,
14  vol.Optional(REMINDER_DATE_LANG): vol.All(
15  cv.string, vol.In(DUE_DATE_VALID_LANGS)
16  ),
17  vol.Exclusive(REMINDER_DATE, "reminder_date"): cv.string,
18  }
19 )

Definition at line 67 of file calendar.py.

◆ PLATFORM_SCHEMA

homeassistant.components.todoist.calendar.PLATFORM_SCHEMA
Initial value:
1 = CALENDAR_PLATFORM_SCHEMA.extend(
2  {
3  vol.Required(CONF_TOKEN): cv.string,
4  vol.Optional(CONF_EXTRA_PROJECTS, default=[]): vol.All(
5  cv.ensure_list,
6  vol.Schema(
7  [
8  vol.Schema(
9  {
10  vol.Required(CONF_NAME): cv.string,
11  vol.Optional(CONF_PROJECT_DUE_DATE): vol.Coerce(int),
12  vol.Optional(CONF_PROJECT_WHITELIST, default=[]): vol.All(
13  cv.ensure_list, [vol.All(cv.string, vol.Lower)]
14  ),
15  vol.Optional(
16  CONF_PROJECT_LABEL_WHITELIST, default=[]
17  ): vol.All(cv.ensure_list, [vol.All(cv.string)]),
18  }
19  )
20  ]
21  ),
22  ),
23  }
24 )

Definition at line 87 of file calendar.py.

◆ SCAN_INTERVAL

homeassistant.components.todoist.calendar.SCAN_INTERVAL = timedelta(minutes=1)

Definition at line 112 of file calendar.py.