CookCommands

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

Known direct subclasses
Cook

API for the Cook trait.


Summary

Public functions

suspend CookTrait.CookCommand.Response
cook(
    start: Boolean,
    cookingMode: CookTrait.CookingMode,
    foodPreset: String,
    quantity: Float,
    unit: CookTrait.Unit
)

Start or stop cooking.

BatchableCommand<CookTrait.CookCommand.Response>
cookBatchable(
    start: Boolean,
    cookingMode: CookTrait.CookingMode,
    foodPreset: String,
    quantity: Float,
    unit: CookTrait.Unit
)

The batchable version of cook command.

Public functions

cook

suspend fun cook(
    start: Boolean,
    cookingMode: CookTrait.CookingMode,
    foodPreset: String,
    quantity: Float,
    unit: CookTrait.Unit
): CookTrait.CookCommand.Response

Start or stop cooking.

Parameters
start: Boolean

If set to true, start cooking, if false, stop current cooking mode.

cookingMode: CookTrait.CookingMode

Cooking mode for the device, as indicated by the currentCookingMode attribute.

foodPreset: String

The food preset requested by the user, as indicated by the currentFoodPreset attribute.

quantity: Float

Quantity of the food requested by the user.

unit: CookTrait.Unit

Unit associated with the quantity, as indicated by the currentFoodUnit attribute.

cookBatchable

fun cookBatchable(
    start: Boolean,
    cookingMode: CookTrait.CookingMode,
    foodPreset: String,
    quantity: Float,
    unit: CookTrait.Unit
): BatchableCommand<CookTrait.CookCommand.Response>

The batchable version of cook command.

Start or stop cooking.

Parameters
start: Boolean

If set to true, start cooking, if false, stop current cooking mode.

cookingMode: CookTrait.CookingMode

Cooking mode for the device, as indicated by the currentCookingMode attribute.

foodPreset: String

The food preset requested by the user, as indicated by the currentFoodPreset attribute.

quantity: Float

Quantity of the food requested by the user.

unit: CookTrait.Unit

Unit associated with the quantity, as indicated by the currentFoodUnit attribute.