Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.google_assistant.trait.LockUnlockTrait Class Reference
Inheritance diagram for homeassistant.components.google_assistant.trait.LockUnlockTrait:
[legend]
Collaboration diagram for homeassistant.components.google_assistant.trait.LockUnlockTrait:
[legend]

Public Member Functions

def execute (self, command, data, params, challenge)
 
dict[str, Any] query_attributes (self)
 
dict[str, Any] sync_attributes (self)
 
- Public Member Functions inherited from homeassistant.components.google_assistant.trait._Trait
None __init__ (self, HomeAssistant hass, state, config)
 
def can_execute (self, command, params)
 
dict[str, Any]|None query_notifications (self)
 
dict[str, Any] sync_options (self)
 

Static Public Member Functions

def might_2fa (domain, features, device_class)
 
def supported (domain, features, device_class, _)
 

Static Public Attributes

list commands = [COMMAND_LOCK_UNLOCK]
 
 name = TRAIT_LOCK_UNLOCK
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.google_assistant.trait._Trait
 config
 
 hass
 
 state
 

Detailed Description

Trait to lock or unlock a lock.

https://developers.google.com/actions/smarthome/traits/lockunlock

Definition at line 1497 of file trait.py.

Member Function Documentation

◆ execute()

def homeassistant.components.google_assistant.trait.LockUnlockTrait.execute (   self,
  command,
  data,
  params,
  challenge 
)
Execute an LockUnlock command.

Reimplemented from homeassistant.components.google_assistant.trait._Trait.

Definition at line 1528 of file trait.py.

◆ might_2fa()

def homeassistant.components.google_assistant.trait.LockUnlockTrait.might_2fa (   domain,
  features,
  device_class 
)
static
Return if the trait might ask for 2FA.

Reimplemented from homeassistant.components.google_assistant.trait._Trait.

Definition at line 1512 of file trait.py.

◆ query_attributes()

dict[str, Any] homeassistant.components.google_assistant.trait.LockUnlockTrait.query_attributes (   self)
Return LockUnlock query attributes.

Reimplemented from homeassistant.components.google_assistant.trait._Trait.

Definition at line 1520 of file trait.py.

◆ supported()

def homeassistant.components.google_assistant.trait.LockUnlockTrait.supported (   domain,
  features,
  device_class,
  _ 
)
static
Test if state is supported.

Reimplemented from homeassistant.components.google_assistant.trait._Trait.

Definition at line 1507 of file trait.py.

◆ sync_attributes()

dict[str, Any] homeassistant.components.google_assistant.trait.LockUnlockTrait.sync_attributes (   self)
Return LockUnlock attributes for a sync request.

Reimplemented from homeassistant.components.google_assistant.trait._Trait.

Definition at line 1516 of file trait.py.

Member Data Documentation

◆ commands

list homeassistant.components.google_assistant.trait.LockUnlockTrait.commands = [COMMAND_LOCK_UNLOCK]
static

Definition at line 1504 of file trait.py.

◆ name

homeassistant.components.google_assistant.trait.LockUnlockTrait.name = TRAIT_LOCK_UNLOCK
static

Definition at line 1503 of file trait.py.


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