Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.fritzbox_callmonitor.base.FritzBoxPhonebook Class Reference

Public Member Functions

None __init__ (self, str host, str username, str password, int|None phonebook_id=None, list[str]|None prefixes=None)
 
str get_name (self, str number)
 
list[int] get_phonebook_ids (self)
 
None init_phonebook (self)
 
None update_phonebook (self)
 

Public Attributes

 fph
 
 host
 
 number_dict
 
 password
 
 phonebook_dict
 
 phonebook_id
 
 prefixes
 
 username
 

Detailed Description

Connects to a FritzBox router and downloads its phone book.

Definition at line 22 of file base.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.fritzbox_callmonitor.base.FritzBoxPhonebook.__init__ (   self,
str  host,
str  username,
str  password,
int | None   phonebook_id = None,
list[str] | None   prefixes = None 
)
Initialize the class.

Definition at line 29 of file base.py.

Member Function Documentation

◆ get_name()

str homeassistant.components.fritzbox_callmonitor.base.FritzBoxPhonebook.get_name (   self,
str  number 
)
Return a name for a given phone number.

Definition at line 71 of file base.py.

◆ get_phonebook_ids()

list[int] homeassistant.components.fritzbox_callmonitor.base.FritzBoxPhonebook.get_phonebook_ids (   self)
Return list of phonebook ids.

Definition at line 67 of file base.py.

◆ init_phonebook()

None homeassistant.components.fritzbox_callmonitor.base.FritzBoxPhonebook.init_phonebook (   self)
Establish a connection to the FRITZ!Box and check if phonebook_id is valid.

Definition at line 44 of file base.py.

◆ update_phonebook()

None homeassistant.components.fritzbox_callmonitor.base.FritzBoxPhonebook.update_phonebook (   self)
Update the phone book dictionary.

Definition at line 54 of file base.py.

Member Data Documentation

◆ fph

homeassistant.components.fritzbox_callmonitor.base.FritzBoxPhonebook.fph

Definition at line 46 of file base.py.

◆ host

homeassistant.components.fritzbox_callmonitor.base.FritzBoxPhonebook.host

Definition at line 38 of file base.py.

◆ number_dict

homeassistant.components.fritzbox_callmonitor.base.FritzBoxPhonebook.number_dict

Definition at line 60 of file base.py.

◆ password

homeassistant.components.fritzbox_callmonitor.base.FritzBoxPhonebook.password

Definition at line 40 of file base.py.

◆ phonebook_dict

homeassistant.components.fritzbox_callmonitor.base.FritzBoxPhonebook.phonebook_dict

Definition at line 59 of file base.py.

◆ phonebook_id

homeassistant.components.fritzbox_callmonitor.base.FritzBoxPhonebook.phonebook_id

Definition at line 41 of file base.py.

◆ prefixes

homeassistant.components.fritzbox_callmonitor.base.FritzBoxPhonebook.prefixes

Definition at line 42 of file base.py.

◆ username

homeassistant.components.fritzbox_callmonitor.base.FritzBoxPhonebook.username

Definition at line 39 of file base.py.


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