TimerCommands

@Generated(value = ["GoogleHomePlatformCodegen"])
interface TimerCommands

Known direct subclasses
Timer

API for the Timer trait.


Summary

Public functions

suspend Unit
timerAdjust(adjustmentTimeSeconds: Int)

Adjusts the device timer duration.

BatchableCommand<Unit>
timerAdjustBatchable(adjustmentTimeSeconds: Int)

The batchable version of timerAdjust command.

suspend Unit

Cancels the device timer.

BatchableCommand<Unit>

The batchable version of timerCancel command.

suspend Unit

Pauses the device timer.

BatchableCommand<Unit>

The batchable version of timerPause command.

suspend Unit

Resumes the device timer.

BatchableCommand<Unit>

The batchable version of timerResume command.

suspend Unit
timerStart(timerTimeSeconds: Int)

Starts a new device timer.

BatchableCommand<Unit>
timerStartBatchable(timerTimeSeconds: Int)

The batchable version of timerStart command.

Public functions

timerAdjust

suspend fun timerAdjust(adjustmentTimeSeconds: Int): Unit

Adjusts the device timer duration.

Parameters
adjustmentTimeSeconds: Int

Positive or negative adjustment of the timer in seconds, which must be in the range of -maxTimerLimitSeconds to maxTimerLimitSeconds.

timerAdjustBatchable

fun timerAdjustBatchable(adjustmentTimeSeconds: Int): BatchableCommand<Unit>

The batchable version of timerAdjust command.

Adjusts the device timer duration.

Parameters
adjustmentTimeSeconds: Int

Positive or negative adjustment of the timer in seconds, which must be in the range of -maxTimerLimitSeconds to maxTimerLimitSeconds.

Returns
BatchableCommand<Unit>

BatchableCommand

timerCancel

suspend fun timerCancel(): Unit

Cancels the device timer.

timerCancelBatchable

fun timerCancelBatchable(): BatchableCommand<Unit>

The batchable version of timerCancel command.

Cancels the device timer.

Returns
BatchableCommand<Unit>

BatchableCommand

timerPause

suspend fun timerPause(): Unit

Pauses the device timer.

timerPauseBatchable

fun timerPauseBatchable(): BatchableCommand<Unit>

The batchable version of timerPause command.

Pauses the device timer.

Returns
BatchableCommand<Unit>

BatchableCommand

timerResume

suspend fun timerResume(): Unit

Resumes the device timer.

timerResumeBatchable

fun timerResumeBatchable(): BatchableCommand<Unit>

The batchable version of timerResume command.

Resumes the device timer.

Returns
BatchableCommand<Unit>

BatchableCommand

timerStart

suspend fun timerStart(timerTimeSeconds: Int): Unit

Starts a new device timer.

Parameters
timerTimeSeconds: Int

Duration of the timer in seconds, which must be in the range of 1 to maxTimerLimitSeconds.

timerStartBatchable

fun timerStartBatchable(timerTimeSeconds: Int): BatchableCommand<Unit>

The batchable version of timerStart command.

Starts a new device timer.

Parameters
timerTimeSeconds: Int

Duration of the timer in seconds, which must be in the range of 1 to maxTimerLimitSeconds.

Returns
BatchableCommand<Unit>

BatchableCommand