homeassistant.components.icloud.account.IcloudAccount Class Reference

Public Member Functions
None	__init__ (self, HomeAssistant hass, str username, str password, Store icloud_dir, bool with_family, int max_interval, int gps_accuracy_threshold, ConfigEntry config_entry)
dict[str, Any]	devices (self)
dict[str, str]	family_members_fullname (self)
float	fetch_interval (self)
list[Any]	get_devices_with_name (self, str name)
None	keep_alive (self, now=None)
str|None	owner_fullname (self)
None	setup (self)
str	signal_device_new (self)
str	signal_device_update (self)
None	update_devices (self)
str	username (self)

Public Attributes
	api
	hass

Private Member Functions
int	_determine_interval (self)
def	_require_reauth (self)
None	_schedule_next_fetch (self)

Private Attributes
	_config_entry
	_devices
	_family_members_fullname
	_fetch_interval
	_gps_accuracy_threshold
	_icloud_dir
	_max_interval
	_owner_fullname
	_password
	_retried_fetch
	_username
	_with_family

Detailed Description

Representation of an iCloud account.

Definition at line 74 of file account.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.icloud.account.IcloudAccount.__init__	(		self,
		HomeAssistant	hass,
		str	username,
		str	password,
		Store	icloud_dir,
		bool	with_family,
		int	max_interval,
		int	gps_accuracy_threshold,
		ConfigEntry	config_entry
	)

Initialize an iCloud account.

Definition at line 77 of file account.py.

Member Function Documentation

_determine_interval()

int homeassistant.components.icloud.account.IcloudAccount._determine_interval (   self )

private

Calculate new interval between two API fetch (in minutes).

Definition at line 229 of file account.py.

_require_reauth()

def homeassistant.components.icloud.account.IcloudAccount._require_reauth (   self )

private

Require the user to log in again.

Definition at line 225 of file account.py.

_schedule_next_fetch()

None homeassistant.components.icloud.account.IcloudAccount._schedule_next_fetch (   self )

private

Definition at line 302 of file account.py.

devices()

dict[str, Any] homeassistant.components.icloud.account.IcloudAccount.devices

(

self

)

Return the account devices.

Definition at line 354 of file account.py.

family_members_fullname()

dict[str, str] homeassistant.components.icloud.account.IcloudAccount.family_members_fullname

(

self

)

Return the account family members fullname.

Definition at line 344 of file account.py.

fetch_interval()

float homeassistant.components.icloud.account.IcloudAccount.fetch_interval

(

self

)

Return the account fetch interval.

Definition at line 349 of file account.py.

get_devices_with_name()

list[Any] homeassistant.components.icloud.account.IcloudAccount.get_devices_with_name	(		self,
		str	name
	)

Get devices by name.

Definition at line 321 of file account.py.

keep_alive()

None homeassistant.components.icloud.account.IcloudAccount.keep_alive	(		self,
			now = None
	)

Keep the API alive.

Definition at line 310 of file account.py.

owner_fullname()

str | None homeassistant.components.icloud.account.IcloudAccount.owner_fullname

(

self

)

Return the account owner fullname.

Definition at line 339 of file account.py.

setup()

None homeassistant.components.icloud.account.IcloudAccount.setup

(

self

)

Set up an iCloud account.

Definition at line 108 of file account.py.

signal_device_new()

str homeassistant.components.icloud.account.IcloudAccount.signal_device_new

(

self

)

Event specific per Freebox entry to signal new device.

Definition at line 359 of file account.py.

signal_device_update()

str homeassistant.components.icloud.account.IcloudAccount.signal_device_update

(

self

)

Event specific per Freebox entry to signal updates in devices.

Definition at line 364 of file account.py.

update_devices()

None homeassistant.components.icloud.account.IcloudAccount.update_devices

(

self

)

Update iCloud devices.

Definition at line 160 of file account.py.

username()

str homeassistant.components.icloud.account.IcloudAccount.username

(

self

)

Return the account username.

Definition at line 334 of file account.py.

Member Data Documentation

_config_entry

homeassistant.components.icloud.account.IcloudAccount._config_entry

private

Definition at line 104 of file account.py.

_devices

homeassistant.components.icloud.account.IcloudAccount._devices

private

Definition at line 157 of file account.py.

_family_members_fullname

homeassistant.components.icloud.account.IcloudAccount._family_members_fullname

private

Definition at line 150 of file account.py.

_fetch_interval

homeassistant.components.icloud.account.IcloudAccount._fetch_interval

private

Definition at line 175 of file account.py.

_gps_accuracy_threshold

homeassistant.components.icloud.account.IcloudAccount._gps_accuracy_threshold

private

Definition at line 95 of file account.py.

_icloud_dir

homeassistant.components.icloud.account.IcloudAccount._icloud_dir

private

Definition at line 97 of file account.py.

_max_interval

homeassistant.components.icloud.account.IcloudAccount._max_interval

private

Definition at line 94 of file account.py.

_owner_fullname

homeassistant.components.icloud.account.IcloudAccount._owner_fullname

private

Definition at line 148 of file account.py.

_password

homeassistant.components.icloud.account.IcloudAccount._password

private

Definition at line 91 of file account.py.

_retried_fetch

homeassistant.components.icloud.account.IcloudAccount._retried_fetch

private

Definition at line 103 of file account.py.

_username

homeassistant.components.icloud.account.IcloudAccount._username

private

Definition at line 90 of file account.py.

_with_family

homeassistant.components.icloud.account.IcloudAccount._with_family

private

Definition at line 92 of file account.py.

api

homeassistant.components.icloud.account.IcloudAccount.api

Definition at line 111 of file account.py.

hass

homeassistant.components.icloud.account.IcloudAccount.hass

Definition at line 89 of file account.py.

---

The documentation for this class was generated from the following file:

• core/homeassistant/components/icloud/account.py