Home Assistant Unofficial Reference 2024.12.1
homeassistant.data_entry_flow.AbortFlow Class Reference
Inheritance diagram for homeassistant.data_entry_flow.AbortFlow:
[legend]
Collaboration diagram for homeassistant.data_entry_flow.AbortFlow:
[legend]

Public Member Functions

None __init__ (self, str reason, Mapping[str, str]|None description_placeholders=None)
 
- Public Member Functions inherited from homeassistant.exceptions.HomeAssistantError
None __init__ (self, *object args, str|None translation_domain=None, str|None translation_key=None, dict[str, str]|None translation_placeholders=None)
 
str __str__ (self)
 

Public Attributes

 description_placeholders
 
 reason
 
- Public Attributes inherited from homeassistant.exceptions.HomeAssistantError
 generate_message
 
 translation_domain
 
 translation_key
 
 translation_placeholders
 

Additional Inherited Members

- Static Public Attributes inherited from homeassistant.exceptions.HomeAssistantError
 bool
 
 None
 

Detailed Description

Exception to indicate a flow needs to be aborted.

Definition at line 133 of file data_entry_flow.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.data_entry_flow.AbortFlow.__init__ (   self,
str  reason,
Mapping[str, str] | None   description_placeholders = None 
)
Initialize an abort flow exception.

Definition at line 136 of file data_entry_flow.py.

Member Data Documentation

◆ description_placeholders

homeassistant.data_entry_flow.AbortFlow.description_placeholders

Definition at line 142 of file data_entry_flow.py.

◆ reason

homeassistant.data_entry_flow.AbortFlow.reason

Definition at line 141 of file data_entry_flow.py.


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