homeassistant.components.caldav.calendar Namespace Reference

Classes
class	WebDavCalendarEntity

Functions
None	async_setup_entry (HomeAssistant hass, CalDavConfigEntry entry, AddEntitiesCallback async_add_entities)
None	async_setup_platform (HomeAssistant hass, ConfigType config, AddEntitiesCallback async_add_entities, DiscoveryInfoType|None disc_info=None)

Variables
	_LOGGER = logging.getLogger(__name__)
string	CONF_CALENDAR = "calendar"
string	CONF_CALENDARS = "calendars"
string	CONF_CUSTOM_CALENDARS = "custom_calendars"
string	CONF_DAYS = "days"
string	CONF_SEARCH = "search"
int	CONFIG_ENTRY_DEFAULT_DAYS = 7
	PLATFORM_SCHEMA
string	SUPPORTED_COMPONENT = "VEVENT"

Detailed Description

Support for WebDav Calendar.

Function Documentation

async_setup_entry()

None homeassistant.components.caldav.calendar.async_setup_entry	(	HomeAssistant	hass,
		CalDavConfigEntry	entry,
		AddEntitiesCallback	async_add_entities
	)

Set up the CalDav calendar platform for a config entry.

Definition at line 143 of file calendar.py.

async_setup_platform()

None homeassistant.components.caldav.calendar.async_setup_platform	(	HomeAssistant	hass,
		ConfigType	config,
		AddEntitiesCallback	async_add_entities,
		DiscoveryInfoType | None	disc_info = None
	)

Set up the WebDav Calendar platform.

Definition at line 74 of file calendar.py.

Variable Documentation

_LOGGER

homeassistant.components.caldav.calendar._LOGGER = logging.getLogger(__name__)

private

Definition at line 36 of file calendar.py.

CONF_CALENDAR

string homeassistant.components.caldav.calendar.CONF_CALENDAR = "calendar"

Definition at line 40 of file calendar.py.

CONF_CALENDARS

string homeassistant.components.caldav.calendar.CONF_CALENDARS = "calendars"

Definition at line 38 of file calendar.py.

CONF_CUSTOM_CALENDARS

string homeassistant.components.caldav.calendar.CONF_CUSTOM_CALENDARS = "custom_calendars"

Definition at line 39 of file calendar.py.

CONF_DAYS

string homeassistant.components.caldav.calendar.CONF_DAYS = "days"

Definition at line 42 of file calendar.py.

CONF_SEARCH

string homeassistant.components.caldav.calendar.CONF_SEARCH = "search"

Definition at line 41 of file calendar.py.

CONFIG_ENTRY_DEFAULT_DAYS

int homeassistant.components.caldav.calendar.CONFIG_ENTRY_DEFAULT_DAYS = 7

Definition at line 45 of file calendar.py.

PLATFORM_SCHEMA

homeassistant.components.caldav.calendar.PLATFORM_SCHEMA

Initial value:

=  CALENDAR_PLATFORM_SCHEMA.extend(
    {
        vol.Required(CONF_URL): vol.Url(),
        vol.Optional(CONF_CALENDARS, default=[]): vol.All(cv.ensure_list, [cv.string]),
        vol.Inclusive(CONF_USERNAME, "authentication"): cv.string,
        vol.Inclusive(CONF_PASSWORD, "authentication"): cv.string,
        vol.Optional(CONF_CUSTOM_CALENDARS, default=[]): vol.All(
            cv.ensure_list,
            [
                vol.Schema(
                    {
                        vol.Required(CONF_CALENDAR): cv.string,
                        vol.Required(CONF_NAME): cv.string,
                        vol.Required(CONF_SEARCH): cv.string,
                    }
                )
            ],
        ),
        vol.Optional(CONF_VERIFY_SSL, default=True): cv.boolean,
        vol.Optional(CONF_DAYS, default=1): cv.positive_int,
    }
)

Definition at line 50 of file calendar.py.

SUPPORTED_COMPONENT

string homeassistant.components.caldav.calendar.SUPPORTED_COMPONENT = "VEVENT"

Definition at line 48 of file calendar.py.