Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.haveibeenpwned.sensor.HaveIBeenPwnedData Class Reference

Public Member Functions

def __init__ (self, emails, api_key)
 
def set_next_email (self)
 
def update (self, **kwargs)
 
def update_no_throttle (self)
 

Public Attributes

 data
 

Private Attributes

 _api_key
 
 _current_index
 
 _email
 
 _email_count
 
 _emails
 

Detailed Description

Class for handling the data retrieval.

Definition at line 136 of file sensor.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.haveibeenpwned.sensor.HaveIBeenPwnedData.__init__ (   self,
  emails,
  api_key 
)
Initialize the data object.

Definition at line 139 of file sensor.py.

Member Function Documentation

◆ set_next_email()

def homeassistant.components.haveibeenpwned.sensor.HaveIBeenPwnedData.set_next_email (   self)
Set the next email to be looked up.

Definition at line 148 of file sensor.py.

◆ update()

def homeassistant.components.haveibeenpwned.sensor.HaveIBeenPwnedData.update (   self,
**  kwargs 
)
Get the latest data for current email from REST service.

Definition at line 158 of file sensor.py.

◆ update_no_throttle()

def homeassistant.components.haveibeenpwned.sensor.HaveIBeenPwnedData.update_no_throttle (   self)
Get the data for a specific email.

Definition at line 153 of file sensor.py.

Member Data Documentation

◆ _api_key

homeassistant.components.haveibeenpwned.sensor.HaveIBeenPwnedData._api_key
private

Definition at line 146 of file sensor.py.

◆ _current_index

homeassistant.components.haveibeenpwned.sensor.HaveIBeenPwnedData._current_index
private

Definition at line 142 of file sensor.py.

◆ _email

homeassistant.components.haveibeenpwned.sensor.HaveIBeenPwnedData._email
private

Definition at line 144 of file sensor.py.

◆ _email_count

homeassistant.components.haveibeenpwned.sensor.HaveIBeenPwnedData._email_count
private

Definition at line 141 of file sensor.py.

◆ _emails

homeassistant.components.haveibeenpwned.sensor.HaveIBeenPwnedData._emails
private

Definition at line 145 of file sensor.py.

◆ data

homeassistant.components.haveibeenpwned.sensor.HaveIBeenPwnedData.data

Definition at line 143 of file sensor.py.


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