<!--
{
  "availability" : [
    "iOS: 26.0.0 -",
    "iPadOS: 26.0.0 -",
    "macCatalyst: -"
  ],
  "documentType" : "symbol",
  "framework" : "EnergyKit",
  "identifier" : "/documentation/EnergyKit/EnergyKitError",
  "metadataVersion" : "0.1.0",
  "role" : "Enumeration",
  "symbol" : {
    "kind" : "Enumeration",
    "modules" : [
      "EnergyKit"
    ],
    "preciseIdentifier" : "s:9EnergyKit0aB5ErrorO"
  },
  "title" : "EnergyKitError"
}
-->

# EnergyKitError

A specialized error that provides localized messages describing the error and why it occurred.

```
enum EnergyKitError
```

## Topics

### Viewing error reasons

[`case guidanceUnavailable`](/documentation/EnergyKit/EnergyKitError/guidanceUnavailable)

An error that indicates the framework fails to provide guidance for a location.

[`case inProgress`](/documentation/EnergyKit/EnergyKitError/inProgress)

An error that indicates a request is already in progress.

[`case invalidLoadEvent`](/documentation/EnergyKit/EnergyKitError/invalidLoadEvent)

An error that indicates an invalid load event.

[`case permissionDenied`](/documentation/EnergyKit/EnergyKitError/permissionDenied)

An error that indicates the client doesn’t have permission to access a requested API.

[`case serviceUnavailable`](/documentation/EnergyKit/EnergyKitError/serviceUnavailable)

An error that indicates when a requested service fails to start.

[`case venueUnavailable`](/documentation/EnergyKit/EnergyKitError/venueUnavailable)

An error that indicates a referenced venue is invalid, nonexistent, or restricted by the person.

[`case locationServicesDenied`](/documentation/EnergyKit/EnergyKitError/locationServicesDenied)

An error that indicates that Location Services is off in the home’s settings.

[`case rateLimitExceeded`](/documentation/EnergyKit/EnergyKitError/rateLimitExceeded)

An error that indicates the app exceeds the rate limit for using the framework.

[`case unsupportedRegion`](/documentation/EnergyKit/EnergyKitError/unsupportedRegion)

An error that indicates the device resides in an unsupported region.

### Reading error messages

[`var errorDescription: String?`](/documentation/EnergyKit/EnergyKitError/errorDescription)

A localized message describing what error occurred.

[`var failureReason: String?`](/documentation/EnergyKit/EnergyKitError/failureReason)

A localized message providing text if the person requests help.

[`var helpAnchor: String?`](/documentation/EnergyKit/EnergyKitError/helpAnchor)

A localized message providing text if the user requests help

[`var recoverySuggestion: String?`](/documentation/EnergyKit/EnergyKitError/recoverySuggestion)

A localized message describing how to recover from the failure.

## Relationships

### Conforms To

[`Sendable`](/documentation/Swift/Sendable)

[`Equatable`](/documentation/Swift/Equatable)

[`LocalizedError`](/documentation/Foundation/LocalizedError)

[`Hashable`](/documentation/Swift/Hashable)

[`Error`](/documentation/Swift/Error)

[`SendableMetatype`](/documentation/Swift/SendableMetatype)

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)