EnergyKit · IOS API REFERENCE

ElectricityInsightQuery.Options

struct · iOS 26.0+ · SDK 27.1

struct Options

A set of options that specify optional information to include in electricity insight records returned from the insight service. Using an empty ``ElectricityInsightQuery/Options`` returns the total value of ``ElectricityInsightRecord`` without cleanliness or tariff breakdown.

Members (4)

get · iOS 26.0+

cleanliness

TypeScript

get cleanliness(): ElectricityInsightQuery_Options

Swift declaration

static let cleanliness: ElectricityInsightQuery.Options

A query that includes cleanliness insights.

get · iOS 26.0+

tariff

TypeScript

get tariff(): ElectricityInsightQuery_Options

Swift declaration

static let tariff: ElectricityInsightQuery.Options

A query that includes tariff-based insights.

init · iOS 26.0+

init

TypeScript

init(rawValue: number): ElectricityInsightQuery_Options

Swift declaration

init(rawValue: UInt)

Creates an option set with the given raw value. - Parameter rawValue: The raw value to use.

get · iOS 26.0+

rawValue

TypeScript

getRawValue($self: ElectricityInsightQuery_Options): number

Swift declaration

let rawValue: UInt

The raw value of the option set.

Skipped declarations

No declarations were skipped in this snapshot.

All EnergyKit types →