Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.remember_the_milk.RememberTheMilkConfiguration Class Reference

Public Member Functions

def __init__ (self, hass)
 
def delete_rtm_id (self, profile_name, hass_id)
 
def delete_token (self, profile_name)
 
def get_rtm_id (self, profile_name, hass_id)
 
def get_token (self, profile_name)
 
def save_config (self)
 
def set_rtm_id (self, profile_name, hass_id, list_id, time_series_id, rtm_task_id)
 
def set_token (self, profile_name, token)
 

Private Member Functions

def _initialize_profile (self, profile_name)
 

Private Attributes

 _config
 
 _config_file_path
 

Detailed Description

Internal configuration data for RememberTheMilk class.

This class stores the authentication token it get from the backend.

Definition at line 157 of file __init__.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.remember_the_milk.RememberTheMilkConfiguration.__init__ (   self,
  hass 
)
Create new instance of configuration.

Definition at line 163 of file __init__.py.

Member Function Documentation

◆ _initialize_profile()

def homeassistant.components.remember_the_milk.RememberTheMilkConfiguration._initialize_profile (   self,
  profile_name 
)
private
Initialize the data structures for a profile.

Definition at line 205 of file __init__.py.

◆ delete_rtm_id()

def homeassistant.components.remember_the_milk.RememberTheMilkConfiguration.delete_rtm_id (   self,
  profile_name,
  hass_id 
)
Delete a key mapping.

Definition at line 235 of file __init__.py.

◆ delete_token()

def homeassistant.components.remember_the_milk.RememberTheMilkConfiguration.delete_token (   self,
  profile_name 
)
Delete a token for a profile.

Usually called when the token has expired.

Definition at line 197 of file __init__.py.

◆ get_rtm_id()

def homeassistant.components.remember_the_milk.RememberTheMilkConfiguration.get_rtm_id (   self,
  profile_name,
  hass_id 
)
Get the RTM ids for a Home Assistant task ID.

The id of a RTM tasks consists of the tuple:
list id, timeseries id and the task id.

Definition at line 212 of file __init__.py.

◆ get_token()

def homeassistant.components.remember_the_milk.RememberTheMilkConfiguration.get_token (   self,
  profile_name 
)
Get the server token for a profile.

Definition at line 185 of file __init__.py.

◆ save_config()

def homeassistant.components.remember_the_milk.RememberTheMilkConfiguration.save_config (   self)
Write the configuration to a file.

Definition at line 180 of file __init__.py.

◆ set_rtm_id()

def homeassistant.components.remember_the_milk.RememberTheMilkConfiguration.set_rtm_id (   self,
  profile_name,
  hass_id,
  list_id,
  time_series_id,
  rtm_task_id 
)
Add/Update the RTM task ID for a Home Assistant task IS.

Definition at line 224 of file __init__.py.

◆ set_token()

def homeassistant.components.remember_the_milk.RememberTheMilkConfiguration.set_token (   self,
  profile_name,
  token 
)
Store a new server token for a profile.

Definition at line 191 of file __init__.py.

Member Data Documentation

◆ _config

homeassistant.components.remember_the_milk.RememberTheMilkConfiguration._config
private

Definition at line 167 of file __init__.py.

◆ _config_file_path

homeassistant.components.remember_the_milk.RememberTheMilkConfiguration._config_file_path
private

Definition at line 165 of file __init__.py.


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