DispenseCommands

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

Known direct subclasses
Dispense

API for the Dispense trait.

Summary

Public functions
suspend DispenseTrait.DispenseCommand.Response
dispense(
    item: String,
    amount: Float,
    unit: DispenseTrait.Unit,
    presetName: String
)

Start or stop dispensing.
BatchableCommand<DispenseTrait.DispenseCommand.Response>
dispenseBatchable(
    item: String,
    amount: Float,
    unit: DispenseTrait.Unit,
    presetName: String
)

The batchable version of dispense command.

Public functions

dispense

suspend fun dispense(
    item: String,
    amount: Float,
    unit: DispenseTrait.Unit,
    presetName: String
): DispenseTrait.DispenseCommand.Response

Start or stop dispensing.

Parameters
item: String

Name of the item to dispense.
amount: Float

Amount to dispense.
unit: DispenseTrait.Unit

Unit for the amount.
presetName: String

Name of the preset to dispense.

dispenseBatchable

fun dispenseBatchable(
    item: String,
    amount: Float,
    unit: DispenseTrait.Unit,
    presetName: String
): BatchableCommand<DispenseTrait.DispenseCommand.Response>

The batchable version of dispense command.

Start or stop dispensing.

Parameters
item: String

Name of the item to dispense.
amount: Float

Amount to dispense.
unit: DispenseTrait.Unit

Unit for the amount.
presetName: String

Name of the preset to dispense.
Returns
BatchableCommand<DispenseTrait.DispenseCommand.Response>

BatchableCommand