homeassistant.components.intent.timers.TimerInfo Class Reference

Public Member Functions
None	__post_init__ (self)
None	add_time (self, int seconds)
None	cancel (self)
int	created_seconds (self)
None	finish (self)
str	name_normalized (self)
None	pause (self)
int	seconds_left (self)
None	unpause (self)

Public Attributes
	is_active
	seconds
	updated_at

Static Public Attributes
	bool
	int
	None

Private Attributes
	_created_seconds

Detailed Description

Information for a single timer.

Definition at line 36 of file timers.py.

Member Function Documentation

__post_init__()

None homeassistant.components.intent.timers.TimerInfo.__post_init__

(

self

)

Post initialization.

Definition at line 99 of file timers.py.

add_time()

None homeassistant.components.intent.timers.TimerInfo.add_time	(		self,
		int	seconds
	)

Add time to the timer.

Seconds may be negative to remove time instead.

Definition at line 144 of file timers.py.

cancel()

None homeassistant.components.intent.timers.TimerInfo.cancel

(

self

)

Cancel the timer.

Definition at line 127 of file timers.py.

created_seconds()

int homeassistant.components.intent.timers.TimerInfo.created_seconds

(

self

)

Return number of seconds on the timer when it was created.

This value is increased if time is added to the timer, exceeding its
original created_seconds.

Definition at line 114 of file timers.py.

finish()

None homeassistant.components.intent.timers.TimerInfo.finish

(

self

)

Finish the timer.

Definition at line 153 of file timers.py.

name_normalized()

str homeassistant.components.intent.timers.TimerInfo.name_normalized

(

self

)

Return normalized timer name.

Definition at line 123 of file timers.py.

pause()

None homeassistant.components.intent.timers.TimerInfo.pause

(

self

)

Pause the timer.

Definition at line 133 of file timers.py.

seconds_left()

int homeassistant.components.intent.timers.TimerInfo.seconds_left

(

self

)

Return number of seconds left on the timer.

Definition at line 104 of file timers.py.

unpause()

None homeassistant.components.intent.timers.TimerInfo.unpause

(

self

)

Unpause the timer.

Definition at line 139 of file timers.py.

Member Data Documentation

_created_seconds

homeassistant.components.intent.timers.TimerInfo._created_seconds

private

Definition at line 101 of file timers.py.

bool

homeassistant.components.intent.timers.TimerInfo.bool

static

Definition at line 72 of file timers.py.

int

homeassistant.components.intent.timers.TimerInfo.int

static

Definition at line 96 of file timers.py.

is_active

homeassistant.components.intent.timers.TimerInfo.is_active

Definition at line 131 of file timers.py.

None

homeassistant.components.intent.timers.TimerInfo.None

static

Definition at line 75 of file timers.py.

seconds

homeassistant.components.intent.timers.TimerInfo.seconds

Definition at line 129 of file timers.py.

updated_at

homeassistant.components.intent.timers.TimerInfo.updated_at

Definition at line 130 of file timers.py.

---

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

• core/homeassistant/components/intent/timers.py