EnergyKit · IOS API REFERENCE

EnergyVenue

struct · iOS 26.0+ · SDK 27.1

struct EnergyVenue

A physical site that uses or produces electricity at that location.

Members (5)

get · iOS 26.0+

id

TypeScript

get id(): string

Swift declaration

let id: UUID

A unique identifier for the venue. Use this identifier to submit ``ElectricalLoadEvent``s for ``ElectricityGuidance``.

get · iOS 26.0+

name

TypeScript

get name(): string

Swift declaration

let name: String

The name of the Home to which the venue corresponds.

static · iOS 26.1+

venue

TypeScript

static venueMatchingHomeUniqueIdentifier(matchingHomeUniqueIdentifier: string): Promise<EnergyVenue>

Swift declaration

static func venue(matchingHomeUniqueIdentifier: UUID) async throws -> EnergyVenue

Returns an energy venue for the given HomeKit identifier. Throws ``EnergyKitError/venueUnavailable`` if a matching venue wasn't found. - Parameter homeUniqueIdentifier: The <doc://com.apple.documentation/documentation/homekit/hmhome/uniqueidentifier>.

static · iOS 26.1+

venue

TypeScript

static venueFor(id: string): Promise<EnergyVenue>

Swift declaration

static func venue(for id: UUID) async throws -> EnergyVenue

Returns an electricity venue for the given venue identifier, if found. Throws ``EnergyKitError/venueUnavailable`` if the system didn't find a matching venue. - Parameter id: The venue identifier.

static · iOS 26.1+

venues

TypeScript

static venues(): Promise<Array<EnergyVenue>>

Swift declaration

static func venues() async throws -> [EnergyVenue]

Returns a list of electricity venues.

Skipped declarations

1 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

EnergyVenue.submitEvents(_:)

This declaration needs Swift generic type arguments. (no canonical witness for Event)

All EnergyKit types →