# CookTrait

    struct CookTrait

This trait belongs to devices that can cook food according to various food presets and supported
cooking modes.
- `


  ### [supportedEventTypes](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/CookTrait#/s:15GoogleHomeTypes0A0O9CookTraitV014supportedEventC0Say0aB3SDK0G0_pXpGvpZ)


  ` No supported events for `CookTrait`.

  #### Declaration

  Swift

      static let supportedEventTypes: [any Event.Type]

- `


  ### [supportedCommandTypes](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/CookTrait#/s:15GoogleHomeTypes0A0O9CookTraitV016supportedCommandC0Say0aB3SDK0G0_pXpGvpZ)


  ` List of the commands that are supported by `CookTrait`.

  #### Declaration

  Swift

      static let supportedCommandTypes: [any Command.Type]

- `


  ### [identifier](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/CookTrait#/s:15GoogleHomeTypes0A0O9CookTraitV10identifierSSvpZ)


  ` The trait identifier.

  #### Declaration

  Swift

      static let identifier: String

- `


  ### [metadata](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/CookTrait#/s:15GoogleHomeTypes0A0O9CookTraitV8metadata0aB3SDK0E8MetadataVvp)


  ` Metadata about this `Trait`.

  #### Declaration

  Swift

      let metadata: TraitMetadata

- `


  ### [attributes](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/CookTrait#/s:15GoogleHomeTypes0A0O9CookTraitV10attributesAE10AttributesVvp)


  ` List of attributes for the `CookTrait`.

  #### Declaration

  Swift

      let attributes: https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google.html.CookTrait.https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/CookTrait/Attributes.html

- `


  ### [init(decoder:interactionProxy:metadata:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/CookTrait#/s:15GoogleHomeTypes0A0O9CookTraitV7decoder16interactionProxy8metadataAE0aB3SDK0E7DecoderV_AI011InteractionH0_pSgAI0E8MetadataVtKcfc)


  ` Creates a new Trait instance using data read from the given `TraitDecoder`.
  Throws
  `HomeError.parseError` when parsing fails.

  #### Declaration

  Swift

      init(decoder: TraitDecoder, interactionProxy: (any InteractionProxy)?, metadata: TraitMetadata) throws

  #### Parameters

  |---|---|
  | ` decoder ` | The raw data representing this Trait. |
  | ` interactionProxy ` | Proxy to the Interaction Client. |
  | ` metadata ` | Metadata about this Trait. |

- `


  ### [encode(with:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/CookTrait#/s:15GoogleHomeTypes0A0O9CookTraitV6encode4withy0aB3SDK0E7EncoderC_tKF)


  ` Writes this object to the given `TraitEncoder`.
  Throws `HomeError.encodingFailed` if the data could not be encoded.

  #### Declaration

  Swift

      func encode(with encoder: TraitEncoder) throws

- `


  ### [forceRead()](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/CookTrait#/s:15GoogleHomeTypes0A0O9CookTraitV9forceReadyyYaKF)


  ` This API provides the ability to invalidate state retrieved through subscriptions to the
  target device in the cases where state is not being reported correctly, either intentionally
  (e.g attributes in Matter traits with the "C" quality) or unintentionally due to poor
  implementations.

  When successful, this API will result in a forced read of the convening scope as specified by
  the sub-class and return the result through existing Trait subscriptions if present and
  active.

  This API is to be used sparingly as it can impact the performance and battery life of the
  target device. As such, this API may be throttled by the platform.
  Callers SHALL be prepared to deal with `HomeError`s thrown by this call.

  #### Declaration

  Swift

      func forceRead() async throws

- `


  ### [Attributes](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/CookTrait/Attributes.html)


  ` Attributes for the `https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/CookTrait.html`.

  #### Declaration

  Swift

      struct Attributes

- `


  ### [==(_:_:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/CookTrait#/s:15GoogleHomeTypes0A0O9CookTraitV2eeoiySbAE_AEtFZ)


  ` Returns a Boolean value indicating whether two values are equal.

  Equality is the inverse of inequality. For any values `a` and `b`,
  `a == b` implies that `a != b` is `false`.

  #### Declaration

  Swift

      static func == (lhs: https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google.html.CookTrait, rhs: https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google.html.CookTrait) -> Bool

  #### Parameters

  |---|---|
  | ` lhs ` | A value to compare. |
  | ` rhs ` | Another value to compare. |

- `


  ### [hash(into:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/CookTrait#/s:15GoogleHomeTypes0A0O9CookTraitV4hash4intoys6HasherVz_tF)


  ` Hashes the essential components of this value by feeding them into the
  given hasher.

  Implement this method to conform to the `Hashable` protocol. The
  components used for hashing must be the same as the components compared
  in your type's `==` operator implementation. Call `hasher.combine(_:)`
  with each of these components.
  Important

  In your implementation of `hash(into:)`,
  don't call `finalize()` on the `hasher` instance provided,
  or replace it with a different instance.
  Doing so may become a compile-time error in the future.

  #### Declaration

  Swift

      func hash(into hasher: inout Hasher)

- `


  ### [FoodSynonym](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/CookTrait/FoodSynonym.html)


  ` Available food synonyms for a language.

  #### Declaration

  Swift

      struct FoodSynonym

- `


  ### [FoodPreset](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/CookTrait/FoodPreset.html)


  ` Internal name of the food preset. This name can be non-user-friendly, and is shared across all
  languages.

  #### Declaration

  Swift

      struct FoodPreset

- `


  ### [supportsCookCommand](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/CookTrait#/s:15GoogleHomeTypes0A0O9CookTraitV08supportsD7CommandSbvp)


  ` Whether the device supports the `cook` command for this trait.

  #### Declaration

  Swift

      var supportsCookCommand: Bool { get }

- `


  ### [cook(start:cookingMode:foodPreset:quantity:unit:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/CookTrait#/s:15GoogleHomeTypes0A0O9CookTraitV4cook5start11cookingMode10foodPreset8quantity4unitAE0D7CommandV8ResponseVSb_AE07CookingI0OSSSfAE4UnitOtYaKF)


  ` Start or stop cooking.

  #### Declaration

  Swift

      func cook(start: Bool, cookingMode: https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google.html.CookTrait.https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/CookTrait/CookingMode.html, foodPreset: String, quantity: Float32, unit: https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google.html.CookTrait.https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/CookTrait/Unit.html) async throws -> https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google.html.CookTrait.CookCommandResponse

  #### Parameters

  |---|---|
  | ` start ` | If set to `true`, start cooking, if `false`, stop current cooking mode. |
  | ` cookingMode ` | Cooking mode for the device, as indicated by the `https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/CookTrait/Attributes.html#/s:15GoogleHomeTypes0A0O9CookTraitV10AttributesV18currentCookingModeAE0hI0OSgvp` attribute. |
  | ` foodPreset ` | The food preset requested by the user, as indicated by the `https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/CookTrait/Attributes.html#/s:15GoogleHomeTypes0A0O9CookTraitV10AttributesV17currentFoodPresetSSSgvp` attribute. |
  | ` quantity ` | Quantity of the food requested by the user. |
  | ` unit ` | Unit associated with the quantity, as indicated by the `https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/CookTrait/Attributes.html#/s:15GoogleHomeTypes0A0O9CookTraitV10AttributesV15currentFoodUnitAE0I0OSgvp` attribute. |

- `


  ### [cookBatchable(start:cookingMode:foodPreset:quantity:unit:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/CookTrait#/s:15GoogleHomeTypes0A0O9CookTraitV13cookBatchable5start11cookingMode10foodPreset8quantity4unit0aB3SDK0G7CommandVyAE0dP0V8ResponseVGSb_AE07CookingJ0OSSSfAE4UnitOtKF)


  ` The batchable version of cook command above.
  See also
  cook

  #### Declaration

  Swift

      func cookBatchable(start: Bool, cookingMode: https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google.html.CookTrait.https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/CookTrait/CookingMode.html, foodPreset: String, quantity: Float32, unit: https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google.html.CookTrait.https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/CookTrait/Unit.html) throws -> BatchableCommand<https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google.html.CookTrait.CookCommandResponse>

- `


  ### [CookingMode](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/CookTrait/CookingMode.html)


  ` The current cooking mode.

  #### Declaration

  Swift

      enum CookingMode

- `


  ### [Unit](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/CookTrait/Unit.html)


  ` The available Units.

  #### Declaration

  Swift

      enum Unit