Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.dominos.DominosOrder Class Reference
Inheritance diagram for homeassistant.components.dominos.DominosOrder:
[legend]
Collaboration diagram for homeassistant.components.dominos.DominosOrder:
[legend]

Public Member Functions

def __init__ (self, order_info, dominos)
 
def name (self)
 
def order (self)
 
def orderable (self)
 
def place (self)
 
def product_codes (self)
 
def state (self)
 
def update (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, strtranslation_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)
 

Public Attributes

 dominos
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Private Attributes

 _name
 
 _orderable
 
 _product_codes
 

Additional Inherited Members

- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Detailed Description

Represents a Dominos order entity.

Definition at line 185 of file __init__.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.dominos.DominosOrder.__init__ (   self,
  order_info,
  dominos 
)
Set up the entity.

Definition at line 188 of file __init__.py.

Member Function Documentation

◆ name()

def homeassistant.components.dominos.DominosOrder.name (   self)
Return the orders name.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 196 of file __init__.py.

◆ order()

def homeassistant.components.dominos.DominosOrder.order (   self)
Create the order object.

Definition at line 233 of file __init__.py.

◆ orderable()

def homeassistant.components.dominos.DominosOrder.orderable (   self)
Return the true if orderable.

Definition at line 206 of file __init__.py.

◆ place()

def homeassistant.components.dominos.DominosOrder.place (   self)
Place the order.

Definition at line 250 of file __init__.py.

◆ product_codes()

def homeassistant.components.dominos.DominosOrder.product_codes (   self)
Return the orders product codes.

Definition at line 201 of file __init__.py.

◆ state()

def homeassistant.components.dominos.DominosOrder.state (   self)
Return the state either closed, orderable or unorderable.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 211 of file __init__.py.

◆ update()

def homeassistant.components.dominos.DominosOrder.update (   self)
Update the order state and refreshes the store.

Definition at line 218 of file __init__.py.

Member Data Documentation

◆ _name

homeassistant.components.dominos.DominosOrder._name
private

Definition at line 190 of file __init__.py.

◆ _orderable

homeassistant.components.dominos.DominosOrder._orderable
private

Definition at line 192 of file __init__.py.

◆ _product_codes

homeassistant.components.dominos.DominosOrder._product_codes
private

Definition at line 191 of file __init__.py.

◆ dominos

homeassistant.components.dominos.DominosOrder.dominos

Definition at line 193 of file __init__.py.


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