EnergyKit · IOS API REFERENCE

ElectricVehicleLoadEvent.Session.GuidanceState

struct · iOS 26.0+ · SDK 27.1

struct GuidanceState

Identifies the provided guidance and its usability by the load device

Members (4)

init · iOS 26.0+

init

TypeScript

static init(wasFollowingGuidance: boolean, guidanceToken: string): ElectricVehicleLoadEvent_Session_GuidanceState

Swift declaration

init(wasFollowingGuidance: Bool, guidanceToken: UUID)

Initialize the GuidanceState for the ``ElectricVehicleLoadEvent`` - Parameters: - wasFollowingGuidance: Whether the device was applying ``ElectricityGuidance`` for its energy use at the time of the event. - guidanceToken: The token provided at time of ``ElectricityGuidance`` fetch.

get · iOS 26.0+

wasFollowingGuidance

TypeScript

get wasFollowingGuidance(): boolean

Swift declaration

let wasFollowingGuidance: Bool

A Boolean value that indicates whether the device was applying the electricity guidance at the time of the event.

get · iOS 26.0+

guidanceToken

TypeScript

get guidanceToken(): string

Swift declaration

var guidanceToken: UUID

The guidance token for the guidance that you requested.

set · iOS 26.0+

guidanceToken

TypeScript

set guidanceToken(value: string)

Swift declaration

var guidanceToken: UUID

The guidance token for the guidance that you requested.

Skipped declarations

No declarations were skipped in this snapshot.

All EnergyKit types →