homeassistant.components.remember_the_milk.entity.RememberTheMilkEntity Class Reference

Inheritance diagram for homeassistant.components.remember_the_milk.entity.RememberTheMilkEntity:

Collaboration diagram for homeassistant.components.remember_the_milk.entity.RememberTheMilkEntity:

Public Member Functions
def	__init__ (self, name, api_key, shared_secret, token, rtm_config)
None	complete_task (self, ServiceCall call)
None	create_task (self, ServiceCall call)
def	name (self)
def	state (self)
Public Member Functions inherited from homeassistant.helpers.entity.Entity
None	__init_subclass__ (cls, **Any kwargs)
str	__repr__ (self)
None	add_to_platform_abort (self)
None	add_to_platform_finish (self)
None	add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
bool	assumed_state (self)
None	async_added_to_hass (self)
None	async_device_update (self, bool warning=True)
None	async_internal_added_to_hass (self)
None	async_internal_will_remove_from_hass (self)
None	async_on_remove (self, CALLBACK_TYPE func)
None	async_registry_entry_updated (self)
None	async_remove (self, *bool force_remove=False)
None	async_removed_from_registry (self)
None	async_schedule_update_ha_state (self, bool force_refresh=False)
None	async_set_context (self, Context context)
None	async_update_ha_state (self, bool force_refresh=False)
None	async_will_remove_from_hass (self)
None	async_write_ha_state (self)
str|None	attribution (self)
bool	available (self)
dict[str, Any]|None	capability_attributes (self)
str|None	device_class (self)
DeviceInfo|None	device_info (self)
bool	enabled (self)
EntityCategory|None	entity_category (self)
str|None	entity_picture (self)
bool	entity_registry_enabled_default (self)
bool	entity_registry_visible_default (self)
Mapping[str, Any]|None	extra_state_attributes (self)
bool	force_update (self)
HassJobType	get_hassjob_type (self, str function_name)
er.EntityOptionsType|None	get_initial_entity_options (self)
bool	has_entity_name (self)
str|None	icon (self)
None	schedule_update_ha_state (self, bool force_refresh=False)
bool	should_poll (self)
dict[str, Any]|None	state_attributes (self)
str|None	suggested_object_id (self)
int|None	supported_features (self)
str|None	translation_key (self)
Mapping[str, str]	translation_placeholders (self)
str|None	unique_id (self)
str|None	unit_of_measurement (self)
bool	use_device_name (self)
Public Member Functions inherited from homeassistant.helpers.entity.CachedProperties
None	__init__ (cls, str name, tuple[type,...] bases, dict[Any, Any] namespace, **Any kwargs)
Any	__new__ (mcs, str name, tuple[type,...] bases, dict[Any, Any] namespace, set[str]|None cached_properties=None, **Any kwargs)

Private Member Functions
def	_check_token (self)

Private Attributes
	_api_key
	_name
	_rtm_api
	_rtm_config
	_shared_secret
	_token
	_token_valid

Additional Inherited Members
Public Attributes inherited from homeassistant.helpers.entity.Entity
	device_entry
	entity_id
	hass
	parallel_updates
	platform
	registry_entry
Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool
	EntityPlatform
	HomeAssistant
	None
	StateInfo
	StateType
	str

Detailed Description

Representation of an interface to Remember The Milk.

Definition at line 14 of file entity.py.

Constructor & Destructor Documentation

__init__()

def homeassistant.components.remember_the_milk.entity.RememberTheMilkEntity.__init__	(		self,
			name,
			api_key,
			shared_secret,
			token,
			rtm_config
	)

Create new instance of Remember The Milk component.

Definition at line 17 of file entity.py.

Member Function Documentation

_check_token()

def homeassistant.components.remember_the_milk.entity.RememberTheMilkEntity._check_token (   self )

private

Check if the API token is still valid.

If it is not valid any more, delete it from the configuration. This
will trigger a new authentication process.

Definition at line 29 of file entity.py.

complete_task()

None homeassistant.components.remember_the_milk.entity.RememberTheMilkEntity.complete_task	(		self,
		ServiceCall	call
	)

Complete a task that was previously created by this component.

Definition at line 98 of file entity.py.

create_task()

None homeassistant.components.remember_the_milk.entity.RememberTheMilkEntity.create_task	(		self,
		ServiceCall	call
	)

Create a new task on Remember The Milk.

You can use the smart syntax to define the attributes of a new task,
e.g. "my task #some_tag ^today" will add tag "some_tag" and set the
due date to today.

Definition at line 47 of file entity.py.

name()

def homeassistant.components.remember_the_milk.entity.RememberTheMilkEntity.name

(

self

)

Return the name of the device.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 133 of file entity.py.

state()

def homeassistant.components.remember_the_milk.entity.RememberTheMilkEntity.state

(

self

)

Return the state of the device.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 138 of file entity.py.

Member Data Documentation

_api_key

homeassistant.components.remember_the_milk.entity.RememberTheMilkEntity._api_key

private

Definition at line 20 of file entity.py.

_name

homeassistant.components.remember_the_milk.entity.RememberTheMilkEntity._name

private

Definition at line 19 of file entity.py.

_rtm_api

homeassistant.components.remember_the_milk.entity.RememberTheMilkEntity._rtm_api

private

Definition at line 24 of file entity.py.

_rtm_config

homeassistant.components.remember_the_milk.entity.RememberTheMilkEntity._rtm_config

private

Definition at line 23 of file entity.py.

_shared_secret

homeassistant.components.remember_the_milk.entity.RememberTheMilkEntity._shared_secret

private

Definition at line 21 of file entity.py.

_token

homeassistant.components.remember_the_milk.entity.RememberTheMilkEntity._token

private

Definition at line 22 of file entity.py.

_token_valid

homeassistant.components.remember_the_milk.entity.RememberTheMilkEntity._token_valid

private

Definition at line 25 of file entity.py.

---

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

• core/homeassistant/components/remember_the_milk/entity.py